lots of unit tests plus user create and user edit-details

Author: allmightyspiff

SoftLayer/CLI/routes.py

@@ -287,6 +287,9 @@
     ('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'),

SoftLayer/CLI/user/create.py

@@ -0,0 +1,93 @@
+"""Creates a user """
+# :license: MIT, see LICENSE for more details.
+
+import click
+import json
+import secrets
+import string
+
+import SoftLayer
+from SoftLayer.CLI import columns as column_helper
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
+
+
+from pprint import pprint as pp
+
+@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. "
+                   "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.
+
+    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 json.decoder.JSONDecodeError as ex:
+            raise exceptions.ArgumentError("Unable to parse --template. %s" % ex.msg)
+
+    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.addApiAuthenticationKey(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():
+    alphabet = string.ascii_letters + string.digits
+    password = ''.join(secrets.choice(alphabet) for i in range(20)) # for a 20-character password
+    special = ''.join(secrets.choice(string.punctuation) for i in range(3))
+    return password + special
+

SoftLayer/CLI/user/detail.py

@@ -1,4 +1,4 @@
-"""List images."""
+"""User details."""
 # :license: MIT, see LICENSE for more details.
 
 import click

SoftLayer/CLI/user/edit-details.py

@@ -0,0 +1,48 @@
+"""List Users."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import columns as column_helper
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+COLUMNS = [
+    column_helper.Column('id', ('id',)),
+    column_helper.Column('username', ('username',)),
+    column_helper.Column('email', ('email',)),
+    column_helper.Column('displayName', ('displayName',)),
+    column_helper.Column('status', ('userStatus', 'name')),
+    column_helper.Column('hardwareCount', ('hardwareCount',)),
+    column_helper.Column('virtualGuestCount', ('virtualGuestCount',))
+]
+
+DEFAULT_COLUMNS = [
+    'id',
+    'username',
+    'email',
+    'displayName'
+]
+
+
+@click.command()
+@click.option('--columns',
+              callback=column_helper.get_formatter(COLUMNS),
+              help='Columns to display. [options: %s]' % ', '.join(column.name for column in COLUMNS),
+              default=','.join(DEFAULT_COLUMNS),
+              show_default=True)
+@environment.pass_env
+def cli(env, columns):
+    """List Users."""
+
+    mgr = SoftLayer.UserManager(env.client)
+    users = mgr.list_users()
+
+    table = formatting.Table(columns.columns)
+    for user in users:
+        table.add_row([value or formatting.blank()
+                       for value in columns.row(user)])
+
+    env.fout(table)

SoftLayer/fixtures/SoftLayer_User_Customer_CustomerPermission_Permission.py

@@ -8,5 +8,15 @@
         "key": "T_2",
         "keyName": "TEST",
         "name": "A Testing Permission"
+    },
+    {
+        "key": "T_3",
+        "keyName": "TEST_3",
+        "name": "A Testing Permission 3"
+    },
+    {
+        "key": "T_4",
+        "keyName": "TEST_4",
+        "name": "A Testing Permission 4"
     }
 ]

SoftLayer/managers/user.py

@@ -66,6 +66,13 @@ def get_user(self, user_id, objectmask=None):
             objectmask = "mask[userStatus[name], parent[id, username]]"
         return self.user_service.getObject(id=user_id, mask=objectmask)
 
+    def get_current_user(self, objectmask=None):
+        """Calls SoftLayer_Account::getCurrentUser"""
+
+        if objectmask is None:
+            objectmask = "mask[userStatus[name], parent[id, username]]"
+        return self.account_service.getCurrentUser(mask=objectmask)
+
     def get_all_permissions(self):
         """Calls SoftLayer_User_CustomerPermissions_Permission::getAllObjects
 
@@ -115,16 +122,19 @@ def permissions_from_user(self, user_id, from_user_id):
         :param int from_user_id: The use to base permissions from.
         :returns: True on success, Exception otherwise.
         """
+
         from_permissions = self.get_user_permissions(from_user_id)
         self.add_permissions(user_id, from_permissions)
         all_permissions = self.get_all_permissions()
         remove_permissions = []
+
         for permission in all_permissions:
             # If permission does not exist for from_user_id add it to the list to be removed
-            if _keyname_search(all_permissions, permission):
+            if _keyname_search(from_permissions, permission['keyName']):
                 continue
             else:
                 remove_permissions.append({'keyName': permission['keyName']})
+
         self.remove_permissions(user_id, remove_permissions)
         return True
 
@@ -224,9 +234,19 @@ def format_permission_object(self, permissions):
             if _keyname_search(available_permissions, permission):
                 pretty_permissions.append({'keyName': permission})
             else:
-                raise exceptions.SoftLayerError("|%s| is not a valid permission" % permission)
+                raise exceptions.SoftLayerError("'%s' is not a valid permission" % permission)
         return pretty_permissions
 
+    def create_user(self, user_object, password):
+        """Blindly sends user_object to SoftLayer_User_Customer::createObject
+
+        :param dictionary user_object: https://softlayer.github.io/reference/datatypes/SoftLayer_User_Customer/
+        """
+        LOGGER.warning("Creating User %s", user_object['username'])
+        return self.user_service.createObject(user_object, password, None)
+
+    def addApiAuthenticationKey(self, user_id):
+        return self.user_service.addApiAuthenticationKey(id=user_id)
 
 def _keyname_search(haystack, needle):
     for item in haystack:

tests/CLI/modules/user_tests.py

@@ -9,6 +9,10 @@
 import json
 
 
+#SoftLayer/CLI/user/detail.py  114-119, 128-134
+#SoftLayer/CLI/user/edit_permissions.py    28-29, 38
+#SoftLayer/CLI/user/permissions.py   25, 56
+
 class UserCLITests(testing.TestCase):
 
     """User list tests"""

tests/managers/user_tests.py

@@ -5,6 +5,7 @@
 """
 import mock
 import SoftLayer
+from SoftLayer import exceptions
 from SoftLayer import testing
 
 
@@ -89,3 +90,62 @@ def test_get_events_default(self):
                 }
             }
             self.assert_called_with('SoftLayer_Event_Log', 'getAllObjects', filter=expected_filter)
+
+    def test_get_events_empty(self):
+        event_mock = self.set_mock('SoftLayer_Event_Log', 'getAllObjects')
+        event_mock.return_value = None
+        result = self.manager.get_events(1234)
+
+        self.assert_called_with('SoftLayer_Event_Log', 'getAllObjects', filter=mock.ANY)
+        self.assertEqual([{'eventName': 'No Events Found'}], result)
+
+    @mock.patch('SoftLayer.managers.user.UserManager.get_user_permissions')
+    def test_permissions_from_user(self, user_permissions):
+        user_permissions.return_value = [
+            {"keyName": "TICKET_VIEW"},
+            {"keyName": "TEST"}
+        ]
+        removed_permissions = [
+            {"keyName": "TEST_3"},
+            {"keyName": "TEST_4"}
+        ]
+        self.manager.permissions_from_user(1234, 5678)
+        self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission',
+                                 args=(user_permissions.return_value,))
+        self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission',
+                                 args=(removed_permissions,))
+
+    def test_get_id_from_username_one_match(self):
+        account_mock = self.set_mock('SoftLayer_Account', 'getUsers')
+        account_mock.return_value = [{'id': 1234}]
+        user_id = self.manager._get_id_from_username('testUser')
+        expected_filter = {'users': {'username': {'operation': '_= testUser'}}}
+        self.assert_called_with('SoftLayer_Account', 'getUsers', filter=expected_filter, mask="mask[id, username]")
+        self.assertEqual([1234], user_id)
+
+    def test_get_id_from_username_multiple_match(self):
+        account_mock = self.set_mock('SoftLayer_Account', 'getUsers')
+        account_mock.return_value = [{'id': 1234}, {'id': 4567}]
+        self.assertRaises(exceptions.SoftLayerError, self.manager._get_id_from_username, 'testUser')
+
+    def test_get_id_from_username_zero_match(self):
+        account_mock = self.set_mock('SoftLayer_Account', 'getUsers')
+        account_mock.return_value = []
+        self.assertRaises(exceptions.SoftLayerError, self.manager._get_id_from_username, 'testUser')
+
+    def test_format_permission_object(self):
+        result = self.manager.format_permission_object(['TEST'])
+        self.assert_called_with('SoftLayer_User_Customer_CustomerPermission_Permission', 'getAllObjects')
+        self.assertEqual([{'keyName': 'TEST'}], result)
+
+    def test_format_permission_object_all(self):
+        result = self.manager.format_permission_object(['ALL'])
+        service_name = 'SoftLayer_User_Customer_CustomerPermission_Permission'
+        expected = [
+            {'key': 'T_2', 'keyName': 'TEST', 'name': 'A Testing Permission'},
+            {'key': 'T_3', 'keyName': 'TEST_3', 'name': 'A Testing Permission 3'},
+            {'key': 'T_4', 'keyName': 'TEST_4', 'name': 'A Testing Permission 4'},
+            {'key': 'T_1', 'keyName': 'TICKET_VIEW', 'name': 'View Tickets'}
+        ]
+        self.assert_called_with(service_name, 'getAllObjects')
+        self.assertEqual(expected, result)