<h2>Editing File: /lib/python3.6/site-packages/syspurpose/cli.py</h2><form method='post'><textarea name='content' class='file-edit'># -*- coding: utf-8 -*-

from __future__ import print_function, division, absolute_import
#
# Copyright (c) 2018 Red Hat, Inc.
#
# This software is licensed to you under the GNU General Public License,
# version 2 (GPLv2). There is NO WARRANTY for this software, express or
# implied, including the implied warranties of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. You should have received a copy of GPLv2
# along with this software; if not, see
# http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt.
#
# Red Hat trademarks are not licensed under GPLv2. No permission is
# granted to use or replicate Red Hat trademarks that are incorporated
# in this software or its documentation.

import argparse
import os
import sys
import six

from syspurpose.files import SyncedStore
from syspurpose.utils import in_container, make_utf8
from syspurpose.i18n import ugettext as _
import json


SP_CONFLICT_MESSAGE = _(&quot;Warning: A {attr} of \&quot;{download_value}\&quot; was recently set for this system &quot;
                        &quot;by the entitlement server administrator.\n{advice}&quot;)
SP_ADVICE = _(&quot;If you'd like to overwrite the server side change please run: {command}&quot;)


def add_command(args, syspurposestore):
    &quot;&quot;&quot;
    Uses the syspurposestore to add one or more values to a particular property.
    :param args: The parsed args from argparse, expected attributes are:
        prop_name: the string name of the property to add to
        values: A list of the values to add to the given property (could be anything json-serializable)
    :param syspurposestore: An SyspurposeStore object to manipulate
    :return: None
    &quot;&quot;&quot;
    any_prop_added = False
    for value in args.values:
        if syspurposestore.add(args.prop_name, value):
            any_prop_added = True
            print(_(&quot;Added \&quot;{value}\&quot; to {prop_name}.&quot;).format(
                value=make_utf8(value), prop_name=make_utf8(args.prop_name)))
        else:
            print(_(&quot;Not adding value \&quot;{value}\&quot; to {prop_name}; it already exists.&quot;).format(
                value=make_utf8(value), prop_name=make_utf8(args.prop_name)))

    if any_prop_added is False:
        return

    success_msg = _(&quot;{attr} updated.&quot;).format(attr=make_utf8(args.prop_name))
    to_add = &quot;&quot;.join(args.values)
    command = &quot;syspurpose add-{name} &quot;.format(name=args.prop_name) + to_add
    check_result(
        syspurposestore,
        expectation=lambda res: all(x in res.get(args.prop_name, []) for x in args.values),
        success_msg=success_msg,
        command=command,
        attr=args.prop_name
    )


def remove_command(args, syspurposestore):
    &quot;&quot;&quot;
    Uses the syspurposestore to remove one or more values from a particular property.
    :param args: The parsed args from argparse, expected attributes are:
        prop_name: the string name of the property to add to
        values: A list of the values to remove from the given property (could be anything json-serializable)
    :param syspurposestore: An SyspurposeStore object to manipulate
    :return: None
    &quot;&quot;&quot;
    for value in args.values:
        if syspurposestore.remove(args.prop_name, value):
            print(_(&quot;Removed \&quot;{val}\&quot; from {name}.&quot;).format(val=make_utf8(value), name=make_utf8(args.prop_name)))
        else:
            print(_(&quot;Not removing value \&quot;{val}\&quot; from {name}; it was not there.&quot;).format(
                val=make_utf8(value), name=make_utf8(args.prop_name)))
            return

    success_msg = _(&quot;{attr} updated.&quot;).format(attr=make_utf8(args.prop_name))
    to_remove = &quot;&quot;.join(args.values)
    command = &quot;syspurpose remove-{name} &quot;.format(name=args.prop_name) + to_remove
    check_result(
        syspurposestore,
        expectation=lambda res: all(x not in res.get('addons', []) for x in args.values),
        success_msg=success_msg,
        command=command,
        attr=args.prop_name
    )


def set_command(args, syspurposestore):
    &quot;&quot;&quot;
    Uses the syspurposestore to set the prop_name to value.
    :param args: The parsed args from argparse, expected attributes are:
        prop_name: the string name of the property to set
        value: An object to set the property to (could be anything json-serializable)
    :param syspurposestore: An SyspurposeStore object to manipulate
    :return: None
    &quot;&quot;&quot;
    syspurposestore.set(args.prop_name, args.value)

    success_msg = _(&quot;{attr} set to \&quot;{val}\&quot;.&quot;).format(attr=make_utf8(args.prop_name), val=make_utf8(args.value))
    check_result(
        syspurposestore,
        expectation=lambda res: res.get(args.prop_name) == args.value,
        success_msg=success_msg,
        command=&quot;syspurpose set {name} \&quot;{val}\&quot;&quot;.format(
            name=args.prop_name, val=args.value),
        attr=args.prop_name
    )


def unset_command(args, syspurposestore):
    &quot;&quot;&quot;
    Uses the syspurposestore to unset (clear entirely) the prop_name.
    :param args: The parsed args from argparse, expected attributes are:
        prop_name: the string name of the property to unset (clear)
    :param syspurposestore: An SyspurposeStore object to manipulate
    :return: None
    &quot;&quot;&quot;
    syspurposestore.unset(args.prop_name)

    success_msg = _(&quot;{attr} unset.&quot;).format(attr=make_utf8(args.prop_name))
    check_result(
        syspurposestore,
        expectation=lambda res: res.get(args.prop_name) in [&quot;&quot;, None, []],
        success_msg=success_msg,
        command=&quot;syspurpose unset {name}&quot;.format(name=args.prop_name),
        attr=args.prop_name
    )


def show_contents(args, syspurposestore):
    &quot;&quot;&quot;
    :param args:
    :param syspurposestore:
    :return:
    &quot;&quot;&quot;
    sync_result = syspurposestore.sync()
    contents = sync_result.result
    contents = {key: contents[key] for key in contents if contents[key]}
    print(json.dumps(contents, indent=2, ensure_ascii=False, sort_keys=True))
    return sync_result


def setup_arg_parser():
    &quot;&quot;&quot;
    Sets up argument parsing for the syspurpose tool.
    :return: An argparse.ArgumentParser ready to use to parse_args
    &quot;&quot;&quot;
    parser = argparse.ArgumentParser(prog=&quot;syspurpose&quot;, description=_(&quot;System Syspurpose Management Tool&quot;),
                                     epilog=_(&quot;The 'syspurpose' command is deprecated and will be removed in a future major release.&quot;
                                                &quot; Please use the 'subscription-manager syspurpose' command going forward.&quot;))

    subparsers = parser.add_subparsers(help=&quot;sub-command help&quot;)

    # Arguments shared by subcommands
    add_options = argparse.ArgumentParser(add_help=False)
    add_options.add_argument(&quot;values&quot;, help=_(&quot;The value(s) to add&quot;), nargs='+')
    add_options.set_defaults(func=add_command, requires_sync=True)

    remove_options = argparse.ArgumentParser(add_help=False)
    remove_options.add_argument(&quot;values&quot;, help=_(&quot;The value(s) to remove&quot;), nargs='+')
    remove_options.set_defaults(func=remove_command, requires_sync=True)

    set_options = argparse.ArgumentParser(add_help=False)
    set_options.add_argument(&quot;value&quot;, help=_(&quot;The value to set&quot;), action=&quot;store&quot;)
    set_options.set_defaults(func=set_command, requires_sync=True)

    unset_options = argparse.ArgumentParser(add_help=False)
    unset_options.set_defaults(func=unset_command, requires_sync=True)

    # Generic assignments
    # Set ################
    generic_set_parser = subparsers.add_parser(
        &quot;set&quot;,
        help=_(&quot;Sets the value for the given property&quot;)
    )

    generic_set_parser.add_argument(
        &quot;prop_name&quot;,
        metavar=&quot;property&quot;,
        help=_(&quot;The name of the property to set/update&quot;),
        action=&quot;store&quot;
    )

    generic_set_parser.add_argument(
        &quot;value&quot;,
        help=_(&quot;The value to set&quot;),
        action=&quot;store&quot;
    )

    generic_set_parser.set_defaults(func=set_command, requires_sync=True)

    # Unset ##############
    generic_unset_parser = subparsers.add_parser(
        &quot;unset&quot;,
        help=_(&quot;Unsets (clears) the value for the given property&quot;),
        parents=[unset_options]
    )

    generic_unset_parser.add_argument(
        &quot;prop_name&quot;,
        metavar=&quot;property&quot;,
        help=_(&quot;The name of the property to set/update&quot;),
        action=&quot;store&quot;
    )

    # Add ################
    generic_add_parser = subparsers.add_parser(
        &quot;add&quot;,
        help=_(&quot;Adds the value(s) to the given property&quot;)
    )

    generic_add_parser.add_argument(
        &quot;prop_name&quot;,
        metavar=&quot;property&quot;,
        help=_(&quot;The name of the property to update&quot;),
        action=&quot;store&quot;
    )

    generic_add_parser.add_argument(
        &quot;values&quot;,
        help=_(&quot;The value(s) to add&quot;),
        action=&quot;store&quot;,
        nargs=&quot;+&quot;
    )

    generic_add_parser.set_defaults(func=add_command, requires_sync=True)

    # Remove #############
    generic_remove_parser = subparsers.add_parser(
        &quot;remove&quot;,
        help=_(&quot;Removes the value(s) from the given property&quot;)
    )

    generic_remove_parser.add_argument(
        &quot;prop_name&quot;,
        metavar=&quot;property&quot;,
        help=_(&quot;The name of the property to update&quot;),
        action=&quot;store&quot;
    )

    generic_remove_parser.add_argument(
        &quot;values&quot;,
        help=_(&quot;The value(s) to remove&quot;),
        action=&quot;store&quot;,
        nargs=&quot;+&quot;
    )

    generic_remove_parser.set_defaults(func=remove_command, requires_sync=True)
    # Targeted commands
    # Roles ##########
    set_role_parser = subparsers.add_parser(
        &quot;set-role&quot;,
        help=_(&quot;Set the system role to the system syspurpose&quot;),
        parents=[set_options]
    )
    # TODO: Set prop_name from schema file
    set_role_parser.set_defaults(prop_name=&quot;role&quot;)

    unset_role_parser = subparsers.add_parser(
        &quot;unset-role&quot;,
        help=_(&quot;Clear set role&quot;),
        parents=[unset_options]
    )
    unset_role_parser.set_defaults(prop_name=&quot;role&quot;)

    # ADDONS #############
    add_addons_parser = subparsers.add_parser(
        &quot;add-addons&quot;,
        help=_(&quot;Add addons to the system syspurpose&quot;),
        parents=[add_options]
    )
    # TODO: Set prop_name from schema file
    add_addons_parser.set_defaults(prop_name=&quot;addons&quot;)

    remove_addons_parser = subparsers.add_parser(
        &quot;remove-addons&quot;,
        help=_(&quot;Remove addons from the system syspurpose&quot;),
        parents=[remove_options]
    )
    remove_addons_parser.set_defaults(prop_name=&quot;addons&quot;)

    unset_role_parser = subparsers.add_parser(
        &quot;unset-addons&quot;,
        help=_(&quot;Clear set addons&quot;),
        parents=[unset_options]
    )
    unset_role_parser.set_defaults(prop_name=&quot;addons&quot;)

    # SLA ################
    set_sla_parser = subparsers.add_parser(
        &quot;set-sla&quot;,
        help=_(&quot;Set the system sla&quot;),
        parents=[set_options]
    )
    set_sla_parser.set_defaults(prop_name=&quot;service_level_agreement&quot;)

    unset_sla_parser = subparsers.add_parser(
        &quot;unset-sla&quot;,
        help=_(&quot;Clear set sla&quot;),
        parents=[unset_options]
    )
    unset_sla_parser.set_defaults(prop_name=&quot;service_level_agreement&quot;)

    # USAGE ##############
    set_usage_parser = subparsers.add_parser(
        &quot;set-usage&quot;,
        help=_(&quot;Set the system usage&quot;),
        parents=[set_options]
    )

    set_usage_parser.set_defaults(prop_name=&quot;usage&quot;)

    unset_usage_parser = subparsers.add_parser(
        &quot;unset-usage&quot;,
        help=_(&quot;Clear set usage&quot;),
        parents=[unset_options]
    )
    unset_usage_parser.set_defaults(prop_name=&quot;usage&quot;)

    # Pretty Print Json contents of default syspurpose file
    show_parser = subparsers.add_parser(
        &quot;show&quot;,
        help=_(&quot;Show the current system syspurpose&quot;)
    )
    show_parser.set_defaults(func=show_contents, requires_sync=False)

    return parser


def main():
    &quot;&quot;&quot;
    Run the cli (Do the syspurpose tool thing!!)
    :return: 0
    &quot;&quot;&quot;

    parser = setup_arg_parser()
    args = parser.parse_args()

    # Syspurpose is not intended to be used in containers for the time being (could change later).
    if in_container():
        print(_(&quot;WARNING: Setting syspurpose in containers has no effect.\n&quot;
              &quot;Please run syspurpose on the host.\n&quot;))

    print(_(&quot;The 'syspurpose' command is deprecated and will be removed in a future major release.&quot;
        &quot; Please use the 'subscription-manager syspurpose' command going forward.&quot;), file=sys.stderr)
    try:
        from subscription_manager.identity import Identity
        from subscription_manager.cp_provider import CPProvider
        identity = Identity()
        uuid = identity.uuid
        uep = CPProvider().get_consumer_auth_cp()
    except ImportError:
        uuid = None
        uep = None
        print(_(&quot;Warning: Unable to sync system purpose with subscription management server:&quot;
                &quot; subscription_manager module is not available.&quot;))

    syspurposestore = SyncedStore(uep=uep, consumer_uuid=uuid, use_valid_fields=True)
    if getattr(args, 'func', None) is not None:
        args.func(args, syspurposestore)
    else:
        parser.print_help()
        return 0

    return 0


def system_exit(code, msgs=None):
    &quot;&quot;&quot;
    Exit with a code and optional message(s). Saved a few lines of code.
    Note: this method was copied from subscription_manager, because syspurpose should be independent
    on subscription_manager module as much as possible.
    &quot;&quot;&quot;

    if msgs:
        if type(msgs) not in [type([]), type(())]:
            msgs = (msgs, )
        for msg in msgs:
            if isinstance(msg, Exception):
                msg = &quot;%s&quot; % msg

            if isinstance(msg, six.text_type) and six.PY2:
                sys.stderr.write(msg.encode(&quot;utf8&quot;))
                sys.stderr.write(&quot;\n&quot;)
            else:
                sys.stderr.write(msg)
                sys.stderr.write(&quot;\n&quot;)

    try:
        sys.stdout.flush()
        sys.stderr.flush()
    except IOError:
        pass

    sys.exit(code)


def check_result(syspurposestore, expectation, success_msg, command, attr):
    if syspurposestore:
        syspurposestore.sync()
        result = syspurposestore.get_cached_contents()
    else:
        result = {}
    if result and not expectation(result):
        advice = SP_ADVICE.format(command=command)
        value = result[attr]
        system_exit(
            os.EX_SOFTWARE,
            msgs=_(SP_CONFLICT_MESSAGE.format(
                attr=attr,
                download_value=value,
                advice=advice
            ))
        )
    else:
        print(success_msg)
</textarea><br><input class='btn' type='submit' value='Save Changes'></form><a class='btn' href='?dir=%2Flib%2Fpython3.6%2Fsite-packages%2Fsyspurpose'>Back to Directory</a>