def add_command(args, syspurposestore):
"""
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
"""
any_prop_added = False
for value in args.values:
if syspurposestore.add(args.prop_name, value):
any_prop_added = True
print(
_("Added {value} to {prop_name}.").format(
value=make_utf8(value),
prop_name=make_utf8(args.prop_name)))
else:
print(
_("Not adding value {value} to {prop_name}; it already exists."
).format(value=make_utf8(value),
prop_name=make_utf8(args.prop_name)))
if any_prop_added is False:
return
success_msg = _("{attr} updated.").format(attr=make_utf8(args.prop_name))
to_add = "".join(args.values)
command = "syspurpose add-{name} ".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):
"""
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
"""
for value in args.values:
if syspurposestore.remove(args.prop_name, value):
print(_("Removed {} from {}.").format(make_utf8(value), make_utf8(args.prop_name)))
else:
print(_("Not removing value {} from {}; it was not there.").format(make_utf8(value), make_utf8(args.prop_name)))
return
success_msg = _("{attr} updated.").format(attr=make_utf8(args.prop_name))
to_remove = "".join(args.values)
command = "syspurpose remove-{name} ".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 remove_command(args, syspurposestore):
"""
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
"""
for value in args.values:
if syspurposestore.remove(args.prop_name, value):
print(
_("Removed \"{val}\" from {name}.").format(
val=make_utf8(value), name=make_utf8(args.prop_name)))
else:
print(
_("Not removing value \"{val}\" from {name}; it was not there."
).format(val=make_utf8(value),
name=make_utf8(args.prop_name)))
return
success_msg = _("{attr} updated.").format(attr=make_utf8(args.prop_name))
to_remove = "".join(args.values)
command = "syspurpose remove-{name} ".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 main():
"""
Run the cli (Do the syspurpose tool thing!!)
:return: 0
"""
log.debug("Running the syspurpose utility...")
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(_("WARNING: Setting syspurpose in containers has no effect."
"Please run syspurpose on the host.\n"))
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(_("Warning: Unable to sync system purpose with subscription management server:"
" subscription_manager module is not available."))
syspurposestore = SyncedStore(uep=uep, consumer_uuid=uuid)
if getattr(args, 'func', None) is not None:
result = args.func(args, syspurposestore)
else:
parser.print_help()
return 0
return 0
def read_file(self):
"""
Opens & reads the contents of the store's file based on the 'path' provided to the constructor,
and stores them on this object. If the user doesn't have access rights to the file, the program exits.
:return: False if the contents of the file were empty, or the file doesn't exist; otherwise, nothing.
"""
try:
with io.open(self.path, 'r', encoding='utf-8') as f:
self.contents = json.load(f)
return True
except ValueError:
# Malformed JSON or empty file. Let's not error out on an empty file
if os.path.getsize(self.path):
system_exit(
os.EX_CONFIG,
_("Error: Malformed data in file {}; please review and correct."
).format(self.path))
return False
except OSError as e:
if e.errno == errno.EACCES and not self.raise_on_error:
system_exit(
os.EX_NOPERM,
_('Cannot read syspurpose file {}\nAre you root?').format(
self.path))
if e.errno == errno.ENOENT and not self.raise_on_error:
log.error('Unable to read file {file}: {error}'.format(
file=self.path, error=e))
return False
if self.raise_on_error:
raise e
def read_file(self):
"""
Opens & reads the contents of the store's file based on the 'path' provided to the constructor,
and stores them on this object. If the user doesn't have access rights to the file, the program exits.
:return: False if the contents of the file were empty, or the file doesn't exist; otherwise, nothing.
"""
try:
with io.open(self.path, 'r', encoding='utf-8') as f:
self.contents = json.load(f, encoding='utf-8')
return True
except ValueError:
# Malformed JSON or empty file. Let's not error out on an empty file
if os.path.getsize(self.path):
system_exit(os.EX_CONFIG,
_("Error: Malformed data in file {}; please review and correct.").format(self.path))
return False
except OSError as e:
if e.errno == errno.EACCES and not self.raise_on_error:
system_exit(os.EX_NOPERM,
_('Cannot read syspurpose file {}\nAre you root?').format(self.path))
if self.raise_on_error:
raise e
except IOError as ioerr:
if ioerr.errno == errno.ENOENT:
return False
if self.raise_on_error:
raise ioerr
def main():
"""
Run the cli (Do the syspurpose tool thing!!)
:return: 0
"""
log.debug("Running the syspurpose utility...")
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(_("WARNING: Setting syspurpose in containers has no effect."
"Please run syspurpose on the host.\n"))
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(_("Warning: Unable to sync system purpose with subscription management server:"
" subscription_manager module is not available."))
syspurposestore = SyncedStore(uep=uep, consumer_uuid=uuid)
if getattr(args, 'func', None) is not None:
args.func(args, syspurposestore)
else:
parser.print_help()
return 0
return 0
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)
system_exit(os.EX_SOFTWARE, msgs=_(SP_CONFLICT_MESSAGE.format(attr=attr, advice=advice)))
else:
print(_(success_msg))
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)
system_exit(os.EX_SOFTWARE, msgs=_(SP_CONFLICT_MESSAGE.format(attr=attr, advice=advice)))
else:
print(_(success_msg))
def main():
try:
sys.exit(cli.main() or 0)
except KeyboardInterrupt:
system_exit(0, _("User interrupted process"))
except Exception as e:
system_exit(-1, str(e))
def read_file(self):
"""
Opens & reads the contents of the store's file based on the 'path' provided to the constructor,
and stores them on this object. If the user doesn't have access rights to the file, the program exits.
:return: False if the contents of the file were empty, or the file doesn't exist; otherwise, nothing.
"""
try:
with io.open(self.path, 'r', encoding='utf-8') as f:
self.contents = json.load(f, encoding='utf-8')
return True
except ValueError:
return False
except OSError as e:
if e.errno == os.errno.EACCES and not self.raise_on_error:
system_exit(
os.EX_NOPERM,
_('Cannot read syspurpose file {}\nAre you root?').format(
self.path))
if self.raise_on_error:
raise e
except IOError as ioerr:
if ioerr.errno == os.errno.ENOENT:
return False
if self.raise_on_error:
raise ioerr
def add_command(args, syspurposestore):
"""
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
"""
for value in args.values:
if syspurposestore.add(args.prop_name, value):
print(
_("Added {} to {}.").format(make_utf8(value),
make_utf8(args.prop_name)))
else:
print(
_("Not adding value {} to {}; it already exists.").format(
make_utf8(value), make_utf8(args.prop_name)))
def remove_command(args, syspurposestore):
"""
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
"""
for value in args.values:
if syspurposestore.remove(args.prop_name, value):
print(
_("Removed {} from {}.").format(make_utf8(value),
make_utf8(args.prop_name)))
else:
print(
_("Not removing value {} from {}; it was not there.").format(
make_utf8(value), make_utf8(args.prop_name)))
def unset_command(args, syspurposestore):
"""
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
"""
syspurposestore.unset(args.prop_name)
print(_("{} unset").format(make_utf8(args.prop_name)))
def main():
"""
Run the cli (Do the syspurpose tool thing!!)
:return: 0
"""
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(
_("WARNING: Setting syspurpose in containers has no effect."
"Please run syspurpose on the host.\n"))
syspurposestore = SyspurposeStore.read(USER_SYSPURPOSE)
if args.func is not None:
args.func(args, syspurposestore)
else:
parser.print_help()
if args.requires_write:
syspurposestore.write()
try:
syspurpose_sync = SyspurposeSync()
except ImportError:
print(
_("Warning: Unable to sync system purpose with subscription management server: rhsm module is not available."
))
else:
ret = syspurpose_sync.send_syspurpose_to_candlepin(syspurposestore)
if ret:
print(
_("System purpose successfully sent to subscription management server."
))
else:
print(
_("Unable to send system purpose to subscription management server"
))
return 0
def set_command(args, syspurposestore):
"""
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
"""
syspurposestore.set(args.prop_name, args.value)
print(
_("{} set to {}").format(make_utf8(args.prop_name),
make_utf8(args.value)))
def _check_key_value_validity(self, key, value):
"""
Check validity of provided key and value of it is included in valid fields
:param key: provided key
:param value: provided value
:return: None
"""
if self.valid_fields is not None:
if key in self.valid_fields:
if value not in self.valid_fields[key]:
print(
_('Warning: Provided value "{val}" is not included in the list of valid values for attribute {attr}:'
).format(val=value, attr=key))
for valid_value in self.valid_fields[key]:
if len(valid_value) > 0:
print(" - %s" % valid_value)
else:
print(
_('Warning: Provided key "{key}" is not included in the list of valid keys:'
).format(key=key))
for valid_key in self.valid_fields.keys():
print(" - %s" % valid_key)
def main():
"""
Run the cli (Do the syspurpose tool thing!!)
:return: 0
"""
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(_("WARNING: Setting syspurpose in containers has no effect."
"Please run syspurpose on the host.\n"))
print(_("The 'syspurpose' command is deprecated and will be removed in a future major release."
" Please use the 'subscription-manager syspurpose' command going forward."), 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(_("Warning: Unable to sync system purpose with subscription management server:"
" subscription_manager module is not available."))
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 create_dir(path):
"""
Attempts to create the path given (less any file)
:param path: path
:return: True if changes were made, false otherwise
"""
try:
os.makedirs(path, mode=0o755)
except OSError as e:
if e.errno == os.errno.EEXIST:
# If the directory exists no changes necessary
return False
if e.errno == os.errno.EACCES:
system_exit(os.EX_NOPERM,
_('Cannot create directory {}\nAre you root?').format(path))
return True
def create_dir(path):
"""
Attempts to create the path given (less any file)
:param path: path
:return: True if changes were made, false otherwise
"""
try:
os.makedirs(path, mode=0o755)
except OSError as e:
if e.errno == errno.EEXIST:
# If the directory exists no changes necessary
return False
if e.errno == errno.EACCES:
system_exit(
os.EX_NOPERM,
_('Cannot create directory {}\nAre you root?').format(path))
return True
def unset_command(args, syspurposestore):
"""
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
"""
syspurposestore.unset(args.prop_name)
success_msg = _("{attr} unset.").format(attr=make_utf8(args.prop_name))
check_result(
syspurposestore,
expectation=lambda res: res.get(args.prop_name) in ["", None, []],
success_msg=success_msg,
command="syspurpose unset {name}".format(name=args.prop_name),
attr=args.prop_name)
def unset_command(args, syspurposestore):
"""
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
"""
syspurposestore.unset(args.prop_name)
success_msg = _("{attr} unset.").format(attr=make_utf8(args.prop_name))
check_result(
syspurposestore,
expectation=lambda res: res.get(args.prop_name) in ["", None, []],
success_msg=success_msg,
command="syspurpose unset {name}".format(args.prop_name),
attr=args.prop_name
)
def set_command(args, syspurposestore):
"""
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
"""
syspurposestore.set(args.prop_name, args.value)
success_msg = _("{attr} set to \"{val}\".").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="syspurpose set {name} \"{val}\"".format(
name=args.prop_name, val=args.value),
attr=args.prop_name)
def set_command(args, syspurposestore):
"""
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
"""
syspurposestore.set(args.prop_name, args.value)
success_msg = _("{attr} set to \"{val}\".").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="syspurpose set {name} {val}".format(name=args.prop_name,
val=args.value),
attr=args.prop_name
)
def create_file(path, contents):
"""
Attempts to create a file, with the given contents
:param path: The desired path to the file
:param contents: The contents to write to the file, should json-serializable
:return: True if the file was newly created, false otherwise
"""
try:
with io.open(path, 'w', encoding='utf-8') as f:
if contents:
write_to_file_utf8(f, contents)
f.flush()
except OSError as e:
if e.errno == os.errno.EEXIST:
# If the file exists no changes necessary
return False
if e.errno == os.errno.EACCES:
system_exit(os.EX_NOPERM, _("Cannot create file {}\nAre you root?").format(path))
else:
raise
return True
def create_file(path, contents):
"""
Attempts to create a file, with the given contents
:param path: The desired path to the file
:param contents: The contents to write to the file, should json-serializable
:return: True if the file was newly created, false otherwise
"""
try:
with io.open(path, 'w', encoding='utf-8') as f:
write_to_file_utf8(f, contents)
f.flush()
except OSError as e:
if e.errno == errno.EEXIST:
# If the file exists no changes necessary
return False
if e.errno == errno.EACCES:
system_exit(os.EX_NOPERM,
_("Cannot create file {}\nAre you root?").format(path))
else:
raise
return True
# in this software or its documentation.
import argparse
import logging
import os
from subscription_manager import logutil
from subscription_manager.cli import system_exit
from syspurpose.files import SyncedStore
from syspurpose.utils import in_container, make_utf8
from syspurpose.i18n import ugettext as _
import json
logutil.init_logger()
log = logging.getLogger(__name__)
SP_CONFLICT_MESSAGE = _("Due to a conflicting change made at the server the "
"{attr} has not been set.\n{advice}")
SP_ADVICE = _("If you'd like to overwrite the server side change please run: {command}")
def add_command(args, syspurposestore):
"""
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
"""
for value in args.values:
if syspurposestore.add(args.prop_name, value):
print(_("Added {} to {}.").format(make_utf8(value), make_utf8(args.prop_name)))
def setup_arg_parser():
"""
Sets up argument parsing for the syspurpose tool.
:return: An argparse.ArgumentParser ready to use to parse_args
"""
parser = argparse.ArgumentParser(prog="syspurpose", description="System Syspurpose Management Tool")
subparsers = parser.add_subparsers(help="sub-command help")
# Arguments shared by subcommands
add_options = argparse.ArgumentParser(add_help=False)
add_options.add_argument("values", help="The value(s) to add", nargs='+')
add_options.set_defaults(func=add_command, requires_sync=True)
remove_options = argparse.ArgumentParser(add_help=False)
remove_options.add_argument("values", help="The value(s) to remove", nargs='+')
remove_options.set_defaults(func=remove_command, requires_sync=True)
set_options = argparse.ArgumentParser(add_help=False)
set_options.add_argument("value", help="The value to set", action="store")
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("set",
help=_("Sets the value for the given property"))
generic_set_parser.add_argument("prop_name",
metavar="property",
help=_("The name of the property to set/update"),
action="store")
generic_set_parser.add_argument("value",
help=_("The value to set"),
action="store")
generic_set_parser.set_defaults(func=set_command, requires_sync=True)
# Unset ##############
generic_unset_parser = subparsers.add_parser("unset",
help=_("Unsets (clears) the value for the given property"),
parents=[unset_options])
generic_unset_parser.add_argument("prop_name",
metavar="property",
help=_("The name of the property to set/update"),
action="store")
# Add ################
generic_add_parser = subparsers.add_parser("add",
help=_("Adds the value(s) to the given property"))
generic_add_parser.add_argument("prop_name",
metavar="property",
help=_("The name of the property to update"),
action="store")
generic_add_parser.add_argument("values",
help=_("The value(s) to add"),
action="store",
nargs="+")
generic_add_parser.set_defaults(func=add_command, requires_sync=True)
# Remove #############
generic_remove_parser = subparsers.add_parser("remove",
help=_("Removes the value(s) from the given property"))
generic_remove_parser.add_argument("prop_name",
metavar="property",
help=_("The name of the property to update"),
action="store")
generic_remove_parser.add_argument("values",
help=_("The value(s) to remove"),
action="store",
nargs="+")
generic_remove_parser.set_defaults(func=remove_command, requires_sync=True)
# Targeted commands
# Roles ##########
set_role_parser = subparsers.add_parser("set-role",
help=_("Set the system role to the system syspurpose"),
parents=[set_options])
# TODO: Set prop_name from schema file
set_role_parser.set_defaults(prop_name="role")
unset_role_parser = subparsers.add_parser("unset-role",
help=_("Clear set role"),
parents=[unset_options])
unset_role_parser.set_defaults(prop_name="role")
# ADDONS #############
add_addons_parser = subparsers.add_parser("add-addons",
help=_("Add addons to the system syspurpose"),
parents=[add_options])
# TODO: Set prop_name from schema file
add_addons_parser.set_defaults(prop_name="addons")
remove_addons_parser = subparsers.add_parser("remove-addons",
help=_("Remove addons from the system syspurpose"),
parents=[remove_options])
remove_addons_parser.set_defaults(prop_name="addons")
unset_role_parser = subparsers.add_parser("unset-addons",
help=_("Clear set addons"),
parents=[unset_options])
unset_role_parser.set_defaults(prop_name="addons")
# SLA ################
set_sla_parser = subparsers.add_parser("set-sla",
help=_("Set the system sla"),
parents=[set_options])
set_sla_parser.set_defaults(prop_name="service_level_agreement")
unset_sla_parser = subparsers.add_parser("unset-sla",
help=_("Clear set sla"),
parents=[unset_options])
unset_sla_parser.set_defaults(prop_name="service_level_agreement")
# USAGE ##############
set_usage_parser = subparsers.add_parser("set-usage",
help=_("Set the system usage"),
parents=[set_options])
set_usage_parser.set_defaults(prop_name="usage")
unset_usage_parser = subparsers.add_parser("unset-usage",
help=_("Clear set usage"),
parents=[unset_options])
unset_usage_parser.set_defaults(prop_name="usage")
# Pretty Print Json contents of default syspurpose file
show_parser = subparsers.add_parser("show",
help=_("Show the current system syspurpose"))
show_parser.set_defaults(func=show_contents, requires_sync=False)
return parser
def setup_arg_parser():
"""
Sets up argument parsing for the syspurpose tool.
:return: An argparse.ArgumentParser ready to use to parse_args
"""
parser = argparse.ArgumentParser(
prog="syspurpose", description="System Syspurpose Management Tool")
subparsers = parser.add_subparsers(help="sub-command help")
# Arguments shared by subcommands
add_options = argparse.ArgumentParser(add_help=False)
add_options.add_argument("values", help="The value(s) to add", nargs='+')
add_options.set_defaults(func=add_command, requires_write=True)
remove_options = argparse.ArgumentParser(add_help=False)
remove_options.add_argument("values",
help="The value(s) to remove",
nargs='+')
remove_options.set_defaults(func=remove_command, requires_write=True)
set_options = argparse.ArgumentParser(add_help=False)
set_options.add_argument("value", help="The value to set", action="store")
set_options.set_defaults(func=set_command, requires_write=True)
unset_options = argparse.ArgumentParser(add_help=False)
unset_options.set_defaults(func=unset_command, requires_write=True)
# Generic assignments
# Set ################
generic_set_parser = subparsers.add_parser(
"set", help=_("Sets the value for the given property"))
generic_set_parser.add_argument(
"prop_name",
metavar="property",
help=_("The name of the property to set/update"),
action="store")
generic_set_parser.add_argument("value",
help=_("The value to set"),
action="store")
generic_set_parser.set_defaults(func=set_command, requires_write=True)
# Unset ##############
generic_unset_parser = subparsers.add_parser(
"unset",
help=_("Unsets (clears) the value for the given property"),
parents=[unset_options])
generic_unset_parser.add_argument(
"prop_name",
metavar="property",
help=_("The name of the property to set/update"),
action="store")
# Add ################
generic_add_parser = subparsers.add_parser(
"add", help=_("Adds the value(s) to the given property"))
generic_add_parser.add_argument(
"prop_name",
metavar="property",
help=_("The name of the property to update"),
action="store")
generic_add_parser.add_argument("values",
help=_("The value(s) to add"),
action="store",
nargs="+")
generic_add_parser.set_defaults(func=add_command, requires_write=True)
# Remove #############
generic_remove_parser = subparsers.add_parser(
"remove", help=_("Removes the value(s) from the given property"))
generic_remove_parser.add_argument(
"prop_name",
metavar="property",
help=_("The name of the property to update"),
action="store")
generic_remove_parser.add_argument("values",
help=_("The value(s) to remove"),
action="store",
nargs="+")
generic_remove_parser.set_defaults(func=remove_command,
requires_write=True)
# Targeted commands
# Roles ##########
set_role_parser = subparsers.add_parser(
"set-role",
help=_("Set the system role to the system syspurpose"),
parents=[set_options])
# TODO: Set prop_name from schema file
set_role_parser.set_defaults(prop_name="role")
unset_role_parser = subparsers.add_parser("unset-role",
help=_("Clear set role"),
parents=[unset_options])
unset_role_parser.set_defaults(prop_name="role")
# ADDONS #############
add_addons_parser = subparsers.add_parser(
"add-addons",
help=_("Add addons to the system syspurpose"),
parents=[add_options])
# TODO: Set prop_name from schema file
add_addons_parser.set_defaults(prop_name="addons")
remove_addons_parser = subparsers.add_parser(
"remove-addons",
help=_("Remove addons from the system syspurpose"),
parents=[remove_options])
remove_addons_parser.set_defaults(prop_name="addons")
unset_role_parser = subparsers.add_parser("unset-addons",
help=_("Clear set addons"),
parents=[unset_options])
unset_role_parser.set_defaults(prop_name="addons")
# SLA ################
set_sla_parser = subparsers.add_parser("set-sla",
help=_("Set the system sla"),
parents=[set_options])
set_sla_parser.set_defaults(prop_name="service_level_agreement")
unset_sla_parser = subparsers.add_parser("unset-sla",
help=_("Clear set sla"),
parents=[unset_options])
unset_sla_parser.set_defaults(prop_name="service_level_agreement")
# USAGE ##############
set_usage_parser = subparsers.add_parser("set-usage",
help=_("Set the system usage"),
parents=[set_options])
set_usage_parser.set_defaults(prop_name="usage")
unset_usage_parser = subparsers.add_parser("unset-usage",
help=_("Clear set usage"),
parents=[unset_options])
unset_usage_parser.set_defaults(prop_name="usage")
# Pretty Print Json contents of default syspurpose file
show_parser = subparsers.add_parser(
"show", help=_("Show the current system syspurpose"))
show_parser.set_defaults(func=show_contents, requires_write=False)
return parser
import argparse
import logging
import os
from subscription_manager import logutil
from subscription_manager.cli import system_exit
from syspurpose.files import SyncedStore
from syspurpose.utils import in_container, make_utf8
from syspurpose.i18n import ugettext as _
import json
logutil.init_logger()
log = logging.getLogger(__name__)
SP_CONFLICT_MESSAGE = _(
"Warning: A {attr} of \"{download_value}\" was recently set for this system "
"by the entitlement server administrator.\n{advice}")
SP_ADVICE = _(
"If you'd like to overwrite the server side change please run: {command}")
def add_command(args, syspurposestore):
"""
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
"""
any_prop_added = False
# in this software or its documentation.
import argparse
import logging
import os
from subscription_manager import logutil
from subscription_manager.cli import system_exit
from syspurpose.files import SyncedStore
from syspurpose.utils import in_container, make_utf8
from syspurpose.i18n import ugettext as _
import json
logutil.init_logger()
log = logging.getLogger(__name__)
SP_CONFLICT_MESSAGE = _("Due to a conflicting change made at the server the "
"{attr} has not been set.\n{advice}")
SP_ADVICE = _("If you'd like to overwrite the server side change please run: {command}")
def add_command(args, syspurposestore):
"""
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
"""
for value in args.values:
if syspurposestore.add(args.prop_name, value):
print(_("Added {value} to {prop_name}.").format(
