code cleanup

Author: allmightyspiff

SoftLayer/CLI/routes.py

@@ -287,7 +287,7 @@
     ('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:edit-details', 'SoftLayer.CLI.user.edit_details:cli'),
     ('user:create', 'SoftLayer.CLI.user.create:cli'),
 
     ('vlan', 'SoftLayer.CLI.vlan'),

SoftLayer/CLI/user/create.py

@@ -1,29 +1,29 @@
 """Creates a user """
 # :license: MIT, see LICENSE for more details.
 
-import click
 import json
-import secrets
 import string
+import sys
+
+import click
 
 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 SoftLayer.CLI import helpers
 
 
-from pprint import pprint as pp
-
 @click.command()
 @click.argument('username')
-@click.option('--email', '-e', required=True, 
+@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, 
+                   "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.")
@@ -34,13 +34,15 @@
 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"}'
+    :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]")
+                 "state, userStatusId, timezoneId]")
     from_user_id = None
     if from_user is None:
         user_template = mgr.get_current_user(objectmask=user_mask)
@@ -56,8 +58,8 @@ def cli(env, username, email, password, from_user, template, api_key):
             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)
+        except ValueError as ex:
+            raise exceptions.ArgumentError("Unable to parse --template. %s" % ex)
 
     user_template['username'] = username
     if password == 'generate':
@@ -79,15 +81,20 @@ def cli(env, username, email, password, from_user, template, api_key):
     new_api_key = None
     if api_key:
         click.secho("Adding API key...", fg='green')
-        new_api_key = mgr.addApiAuthenticationKey(result['id'])
+        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():
-    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
 
+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")

SoftLayer/CLI/user/edit-details.py SoftLayer/CLI/user/edit_details.pySoftLayer/CLI/user/edit-details.py renamed to SoftLayer/CLI/user/edit_details.py

@@ -1,11 +1,14 @@
 """List Users."""
 # :license: MIT, see LICENSE for more details.
 
-import click
+
 import json
 
+import click
+
 import SoftLayer
 from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
 from SoftLayer.CLI import helpers
 
 
@@ -20,7 +23,7 @@ def cli(env, user, template):
     JSON strings should be enclosed in '' and each item should be enclosed in ""
 
     :Example: slcli user edit-details testUser -t '{"firstName": "Test", "lastName": "Testerson"}'
-    ."""
+    """
     mgr = SoftLayer.UserManager(env.client)
     user_id = helpers.resolve_id(mgr.resolve_ids, user, 'username')
 
@@ -30,11 +33,11 @@ def cli(env, user, template):
             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)
+        except ValueError as ex:
+            raise exceptions.ArgumentError("Unable to parse --template. %s" % ex)
 
     result = mgr.edit_user(user_id, user_template)
     if result:
         click.secho("%s updated successfully" % (user), fg='green')
     else:
-        click.secho("Failed to update %s" % (user), fg='red')
+        click.secho("Failed to update %s" % (user), fg='red')

SoftLayer/managers/user.py

@@ -253,9 +253,14 @@ def edit_user(self, user_id, user_object):
         """
         return self.user_service.editObject(user_object, id=user_id)
 
-    def addApiAuthenticationKey(self, user_id):
+    def add_api_authentication_key(self, user_id):
+        """Calls SoftLayer_User_Customer::addApiAuthenticationKey
+
+        :param int user_id: User to add API key to
+        """
         return self.user_service.addApiAuthenticationKey(id=user_id)
 
+
 def _keyname_search(haystack, needle):
     for item in haystack:
         if item.get('keyName') == needle:

tests/CLI/modules/user_tests.py

@@ -9,10 +9,6 @@
 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

@@ -111,9 +111,9 @@ def test_permissions_from_user(self, user_permissions):
         ]
         self.manager.permissions_from_user(1234, 5678)
         self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission',
-                                 args=(user_permissions.return_value,))
+                                args=(user_permissions.return_value,))
         self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission',
-                                 args=(removed_permissions,))
+                                args=(removed_permissions,))
 
     def test_get_id_from_username_one_match(self):
         account_mock = self.set_mock('SoftLayer_Account', 'getUsers')