Merge pull request #978 from allmightyspiff/issues827

User Management

Author: allmightyspiff

.gitignore

@@ -14,3 +14,5 @@ dist/*
 *.egg-info
 .cache
 .idea
+.pytest_cache/*
+slcli

SoftLayer/API.py

@@ -333,6 +333,7 @@ class Service(object):
         :param name str: The service name
 
     """
+
     def __init__(self, client, name):
         self.client = client
         self.name = name

SoftLayer/CLI/columns.py

@@ -14,6 +14,7 @@
 
 class Column(object):
     """Column desctribes an attribute and how to fetch/display it."""
+
     def __init__(self, name, path, mask=None):
         self.name = name
         self.path = path
@@ -26,6 +27,7 @@ def __init__(self, name, path, mask=None):
 
 class ColumnFormatter(object):
     """Maps each column using a function"""
+
     def __init__(self):
         self.columns = []
         self.column_funcs = []

SoftLayer/CLI/core.py

@@ -115,17 +115,22 @@ def cli(env,
         **kwargs):
     """Main click CLI entry-point."""
 
-    logger = logging.getLogger()
-    logger.addHandler(logging.StreamHandler())
-    logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
-
     # Populate environement with client and set it as the context object
     env.skip_confirmations = really
     env.config_file = config
     env.format = format
     env.ensure_client(config_file=config, is_demo=demo, proxy=proxy)
-
     env.vars['_start'] = time.time()
+    logger = logging.getLogger()
+
+    if demo is False:
+        logger.addHandler(logging.StreamHandler())
+    else:
+        # This section is for running CLI tests.
+        logging.getLogger("urllib3").setLevel(logging.WARNING)
+        logger.addHandler(logging.NullHandler())
+
+    logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
     env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
     env.client.transport = env.vars['_timings']
 

SoftLayer/CLI/exceptions.py

@@ -10,6 +10,7 @@
 # pylint: disable=keyword-arg-before-vararg
 class CLIHalt(SystemExit):
     """Smoothly halt the execution of the command. No error."""
+
     def __init__(self, code=0, *args):
         super(CLIHalt, self).__init__(*args)
         self.code = code
@@ -23,13 +24,15 @@ def __str__(self):
 
 class CLIAbort(CLIHalt):
     """Halt the execution of the command. Gives an exit code of 2."""
+
     def __init__(self, msg, *args):
         super(CLIAbort, self).__init__(code=2, *args)
         self.message = msg
 
 
 class ArgumentError(CLIAbort):
     """Halt the execution of the command because of invalid arguments."""
+
     def __init__(self, msg, *args):
         super(ArgumentError, self).__init__(msg, *args)
         self.message = "Argument Error: %s" % msg

SoftLayer/CLI/file/snapshot/schedule_list.py

@@ -63,7 +63,7 @@ def cli(env, volume_id):
             file_schedule_type,
             replication,
             schedule.get('createDate', '')
-            ]
+        ]
         table_row.extend(schedule_properties)
         table.add_row(table_row)
 

SoftLayer/CLI/formatting.py

@@ -1,18 +1,21 @@
 """
     SoftLayer.formatting
     ~~~~~~~~~~~~~~~~~~~~
-    Provider classes and helper functions to display output onto a
-    command-line.
+    Provider classes and helper functions to display output onto a command-line.
 
-    :license: MIT, see LICENSE for more details.
 """
 # pylint: disable=E0202, consider-merging-isinstance, arguments-differ, keyword-arg-before-vararg
 import collections
 import json
 import os
 
 import click
-import prettytable
+
+# If both PTable and prettytable are installed, its impossible to use the new version
+try:
+    from prettytable import prettytable
+except ImportError:
+    import prettytable
 
 from SoftLayer.CLI import exceptions
 from SoftLayer import utils
@@ -229,6 +232,7 @@ class SequentialOutput(list):
 
     :param separator str: string to use as a default separator
     """
+
     def __init__(self, separator=os.linesep, *args, **kwargs):
         self.separator = separator
         super(SequentialOutput, self).__init__(*args, **kwargs)
@@ -243,6 +247,7 @@ def __str__(self):
 
 class CLIJSONEncoder(json.JSONEncoder):
     """A JSON encoder which is able to use a .to_python() method on objects."""
+
     def default(self, obj):
         """Encode object if it implements to_python()."""
         if hasattr(obj, 'to_python'):
@@ -255,7 +260,8 @@ class Table(object):
 
     :param list columns: a list of column names
     """
-    def __init__(self, columns):
+
+    def __init__(self, columns, title=None):
         duplicated_cols = [col for col, count
                            in collections.Counter(columns).items()
                            if count > 1]
@@ -267,6 +273,7 @@ def __init__(self, columns):
         self.rows = []
         self.align = {}
         self.sortby = None
+        self.title = title
 
     def add_row(self, row):
         """Add a row to the table.
@@ -287,6 +294,7 @@ def to_python(self):
     def prettytable(self):
         """Returns a new prettytable instance."""
         table = prettytable.PrettyTable(self.columns)
+
         if self.sortby:
             if self.sortby in self.columns:
                 table.sortby = self.sortby
@@ -296,6 +304,8 @@ def prettytable(self):
         for a_col, alignment in self.align.items():
             table.align[a_col] = alignment
 
+        if self.title:
+            table.title = self.title
         # Adding rows
         for row in self.rows:
             table.add_row(row)
@@ -304,6 +314,7 @@ def prettytable(self):
 
 class KeyValueTable(Table):
     """A table that is oriented towards key-value pairs."""
+
     def to_python(self):
         """Decode this KeyValueTable object to standard Python types."""
         mapping = {}
@@ -318,6 +329,7 @@ class FormattedItem(object):
         :param original: raw (machine-readable) value
         :param string formatted: human-readable value
     """
+
     def __init__(self, original, formatted=None):
         self.original = original
         if formatted is not None:

SoftLayer/CLI/routes.py

@@ -282,6 +282,14 @@
     ('ticket:attach', 'SoftLayer.CLI.ticket.attach:cli'),
     ('ticket:detach', 'SoftLayer.CLI.ticket.detach:cli'),
 
+    ('user', 'SoftLayer.CLI.user'),
+    ('user:list', 'SoftLayer.CLI.user.list:cli'),
+    ('user:detail', 'SoftLayer.CLI.user.detail:cli'),
+    ('user:permissions', 'SoftLayer.CLI.user.permissions:cli'),
+    ('user:edit-permissions', 'SoftLayer.CLI.user.edit_permissions:cli'),
+    ('user:edit-details', 'SoftLayer.CLI.user.edit_details:cli'),
+    ('user:create', 'SoftLayer.CLI.user.create:cli'),
+
     ('vlan', 'SoftLayer.CLI.vlan'),
     ('vlan:detail', 'SoftLayer.CLI.vlan.detail:cli'),
     ('vlan:list', 'SoftLayer.CLI.vlan.list:cli'),

SoftLayer/CLI/user/__init__.py

@@ -0,0 +1 @@
+"""Manage Users."""

SoftLayer/CLI/user/create.py

@@ -0,0 +1,100 @@
+"""Creates a user """
+# :license: MIT, see LICENSE for more details.
+
+import json
+import string
+import sys
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('username')
+@click.option('--email', '-e', required=True,
+              help="Email address for this user. Required for creation.")
+@click.option('--password', '-p', default=None, show_default=True,
+              help="Password to set for this user. If no password is provided, user will be sent an email "
+                   "to generate one, which expires in 24 hours.  '-p generate' will create a password for you "
+                   "(Requires Python 3.6+). Passwords require 8+ characters, upper and lowercase, a number "
+                   "and a symbol.")
+@click.option('--from-user', '-u', default=None,
+              help="Base user to use as a template for creating this user. "
+                   "Will default to the user running this command. Information provided in --template "
+                   "supersedes this template.")
+@click.option('--template', '-t', default=None,
+              help="A json string describing https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/")
+@click.option('--api-key', '-a', default=False, is_flag=True, help="Create an API key for this user.")
+@environment.pass_env
+def cli(env, username, email, password, from_user, template, api_key):
+    """Creates a user Users.
+
+    :Example: slcli user create my@email.com -e my@email.com -p generate -a
+    -t '{"firstName": "Test", "lastName": "Testerson"}'
+
+    Remember to set the permissions and access for this new user.
+    """
+
+    mgr = SoftLayer.UserManager(env.client)
+    user_mask = ("mask[id, firstName, lastName, email, companyName, address1, city, country, postalCode, "
+                 "state, userStatusId, timezoneId]")
+    from_user_id = None
+    if from_user is None:
+        user_template = mgr.get_current_user(objectmask=user_mask)
+        from_user_id = user_template['id']
+    else:
+        from_user_id = helpers.resolve_id(mgr.resolve_ids, from_user, 'username')
+        user_template = mgr.get_user(from_user_id, objectmask=user_mask)
+    # If we send the ID back to the API, an exception will be thrown
+    del user_template['id']
+
+    if template is not None:
+        try:
+            template_object = json.loads(template)
+            for key in template_object:
+                user_template[key] = template_object[key]
+        except ValueError as ex:
+            raise exceptions.ArgumentError("Unable to parse --template. %s" % ex)
+
+    user_template['username'] = username
+    if password == 'generate':
+        password = generate_password()
+
+    user_template['email'] = email
+
+    if not env.skip_confirmations:
+        table = formatting.KeyValueTable(['name', 'value'])
+        for key in user_template:
+            table.add_row([key, user_template[key]])
+        table.add_row(['password', password])
+        click.secho("You are about to create the following user...", fg='green')
+        env.fout(table)
+        if not formatting.confirm("Do you wish to continue?"):
+            raise exceptions.CLIAbort("Canceling creation!")
+
+    result = mgr.create_user(user_template, password)
+    new_api_key = None
+    if api_key:
+        click.secho("Adding API key...", fg='green')
+        new_api_key = mgr.add_api_authentication_key(result['id'])
+
+    table = formatting.Table(['Username', 'Email', 'Password', 'API Key'])
+    table.add_row([result['username'], result['email'], password, new_api_key])
+    env.fout(table)
+
+
+def generate_password():
+    """Returns a 23 character random string, with 3 special characters at the end"""
+    if sys.version_info > (3, 6):
+        import secrets  # pylint: disable=import-error
+        alphabet = string.ascii_letters + string.digits
+        password = ''.join(secrets.choice(alphabet) for i in range(20))
+        special = ''.join(secrets.choice(string.punctuation) for i in range(3))
+        return password + special
+    else:
+        raise ImportError("Generating passwords require python 3.6 or higher")