#827 lots of tests

Author: allmightyspiff

SoftLayer/CLI/core.py

@@ -115,18 +115,23 @@ 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()
-    env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
+
+    if demo is False:
+        logger = logging.getLogger()
+        logger.addHandler(logging.StreamHandler())
+        logger.setLevel(DEBUG_LOGGING_MAP.get(verbose, logging.DEBUG))
+        env.vars['_timings'] = SoftLayer.DebugTransport(env.client.transport)
+    else:
+        # This section is for running CLI tests.
+        logging.getLogger("urllib3").setLevel(logging.WARNING)
+        env.vars['_timings'] = SoftLayer.TimingTransport(env.client.transport)
+
     env.client.transport = env.vars['_timings']
 
 

SoftLayer/CLI/user/detail.py

@@ -50,7 +50,6 @@ def cli(env, identifier, keys, permissions, hardware, virtual, logins, events):
         access = mgr.get_user(user_id, mask)
         env.fout(print_access(access.get('virtualGuests', []), 'Virtual Guests'))
     if logins:
-        mask = "id, unsuccessfulLogins, successfulLogins"
         login_log = mgr.get_logins(user_id)
         env.fout(print_logins(login_log))
     if events:

SoftLayer/CLI/user/edit_permissions.py

@@ -26,9 +26,9 @@ def cli(env, identifier, enable, permission):
     user_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'username')
     object_mask = "mask[id,permissions,isMasterUserFlag]"
     if enable:
-        result = mgr.add_permissions(identifier, permission)
+        result = mgr.add_permissions(user_id, permission)
         click.secho("Permissions added successfully: %s" % ", ".join(permission), fg='green')
     else:
-        result = mgr.remove_permissions(identifier, permission)
+        result = mgr.remove_permissions(user_id, permission)
         click.secho("Permissions removed successfully: %s" % ", ".join(permission), fg='green')
 

SoftLayer/fixtures/SoftLayer_Event_Log.py

@@ -0,0 +1,22 @@
+getAllObjects = [
+    {
+        "accountId": 1234,
+        "eventCreateDate": "2018-05-15T14:37:13.378291-06:00",
+        "eventName": "Login Successful",
+        "ipAddress": "1.2.3.4",
+        "label": "sl1234-aaa",
+        "metaData": "",
+        "objectId": 6657767,
+        "objectName": "User",
+        "openIdConnectUserName": "a@b.com",
+        "resource": {
+            "accountId": 307608,
+            "address1": "4849 Alpha Rd",
+            "city": "Dallas"
+        },
+        "traceId": "5afb44f95c61f",
+        "userId": 6657767,
+        "userType": "CUSTOMER",
+        "username": "sl1234-aaa"
+    }
+]

SoftLayer/fixtures/SoftLayer_User_Customer.py

@@ -42,7 +42,13 @@
     'userStatus': {'name': 'Active'},
     'userStatusId': 1001,
     'username': 'SL12345-test',
-    'vpnManualConfig': False
+    'vpnManualConfig': False,
+    'permissions': [
+        {'key': 'ALL_1',
+         'keyName': 'ACCESS_ALL_HARDWARE',
+         'name': 'All Hardware Access'}
+    ],
+    'roles': []
 }
 
 getPermissions = [
@@ -55,4 +61,19 @@
 {'key': 'A_10',
  'keyName': 'ADD_SERVICE_STORAGE',
  'name': 'Add/Upgrade Storage (StorageLayer)'}
-]
+]
+
+
+getLoginAttempts = [
+    {
+        "createDate": "2017-10-03T09:28:33-06:00",
+        "ipAddress": "1.2.3.4",
+        "successFlag": False,
+        "userId": 1111,
+        "username": "sl1234"
+    }
+]
+
+addBulkPortalPermission = True
+removeBulkPortalPermission = True
+

SoftLayer/fixtures/SoftLayer_User_Customer_CustomerPermission_Permission.py

@@ -0,0 +1,7 @@
+getAllObjects = [
+    {
+        "key": "T_1",
+        "keyName": "TICKET_VIEW",
+        "name": "View Tickets"
+    }
+]

SoftLayer/managers/user.py

@@ -53,18 +53,36 @@ def list_users(self, objectMask=None, objectFilter=None):
 
     def get_user(self, user_id, objectMask=None):
         if objectMask is None:
-            objectMask = """mask[userStatus[name], parent[id, username]]"""
+            objectMask = "mask[userStatus[name], parent[id, username]]"
         return self.userService.getObject(id=user_id, mask=objectMask)
 
     def get_all_permissions(self):
         permissions = self.client.call('User_Customer_CustomerPermission_Permission', 'getAllObjects')
         return sorted(permissions, key=itemgetter('keyName'))
 
     def add_permissions(self, user_id, permissions):
+        """Enables a list of permissions for a user
+
+        :param int id: user id to set
+        :param list permissions: List of permissions keynames to enable
+        :returns: True on success, Exception otherwise
+
+        Example::
+            add_permissions(123, ['BANDWIDTH_MANAGE'])
+        """
         pretty_permissions = format_permission_object(permissions)
         return self.userService.addBulkPortalPermission(pretty_permissions, id=user_id)
 
     def remove_permissions(self, user_id, permissions):
+        """Disables a list of permissions for a user
+
+        :param int id: user id to set
+        :param list permissions: List of permissions keynames to disable
+        :returns: True on success, Exception otherwise
+
+        Example::
+            remove_permissions(123, ['BANDWIDTH_MANAGE'])
+        """
         pretty_permissions = format_permission_object(permissions)
         return self.userService.removeBulkPortalPermission(pretty_permissions, id=user_id)
 

SoftLayer/testing/__init__.py

@@ -160,11 +160,7 @@ def set_mock(self, service, method):
         """Set and return mock on the current client."""
         return self.mocks.set_mock(service, method)
 
-    def run_command(self,
-                    args=None,
-                    env=None,
-                    fixtures=True,
-                    fmt='json'):
+    def run_command(self, args=None, env=None, fixtures=True, fmt='json'):
         """A helper that runs a SoftLayer CLI command.
 
         This returns a click.testing.Result object.

tests/CLI/modules/user_tests.py

@@ -13,6 +13,8 @@
 
 class UserTests(testing.TestCase):
 
+
+    """User list tests"""
     def test_user_list(self):
         result = self.run_command(['user', 'list'])
         self.assert_no_fail(result)
@@ -23,7 +25,7 @@ def test_user_list_only_id(self):
         self.assert_no_fail(result)
         self.assertEqual([{"id":11100}, {"id":11111}], json.loads(result.output))
 
-
+    """User detail tests"""
     def test_detail(self):
         result = self.run_command(['user', 'detail', '11100'])
         self.assert_no_fail(result)
@@ -46,4 +48,46 @@ def test_detail_hardware(self):
         self.assert_called_with(
             'SoftLayer_User_Customer', 'getObject', identifier=11100,
             mask='mask[id, hardware, dedicatedHosts]'
-        )
+        )
+
+    def test_detail_virtual(self):
+        result = self.run_command(['user', 'detail', '11100', '-v'])
+        self.assert_no_fail(result)
+        self.assert_called_with(
+            'SoftLayer_User_Customer', 'getObject', identifier=11100,
+            mask='mask[id, virtualGuests]'
+        )
+
+    def test_detail_logins(self):
+        result = self.run_command(['user', 'detail', '11100', '-l'])
+        self.assert_no_fail(result)
+        self.assert_called_with(
+            'SoftLayer_User_Customer', 'getLoginAttempts', identifier=11100
+        )
+
+    def test_detail_events(self):
+        result = self.run_command(['user', 'detail', '11100', '-e'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Event_Log', 'getAllObjects')
+
+
+    """User permissions tests"""
+    def test_permissions_list(self):
+        result = self.run_command(['user', 'permissions', '11100'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_User_Customer_CustomerPermission_Permission', 'getAllObjects')
+        self.assert_called_with(
+            'SoftLayer_User_Customer', 'getObject', identifier=11100,
+            mask='mask[id, permissions, isMasterUserFlag, roles]'
+        )
+
+    """User edit-permissions tests"""
+    def test_edit_perms_on(self):
+        result = self.run_command(['user', 'edit-permissions', '11100', '--enable', '-p TEST'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission', identifier=11100)
+
+    def test_edit_perms_off(self):
+        result = self.run_command(['user', 'edit-permissions', '11100', '--disable', '-p TEST'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission', identifier=11100)

tests/managers/user_tests.py

@@ -0,0 +1,97 @@
+"""
+    SoftLayer.tests.managers.user_tests
+    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+"""
+import mock
+import SoftLayer
+from SoftLayer import testing
+
+
+class SshKeyTests(testing.TestCase):
+
+    def set_up(self):
+        self.manager = SoftLayer.UserManager(self.client)
+
+    def test_list_user_defaults(self):
+        result = self.manager.list_users()
+        self.assert_called_with('SoftLayer_Account', 'getUsers', 
+            mask="mask[id, username, displayName, userStatus[name], hardwareCount, virtualGuestCount]")
+
+    def test_list_user_mask(self):
+        result = self.manager.list_users(objectMask="mask[id]")
+        self.assert_called_with('SoftLayer_Account', 'getUsers', mask="mask[id]")
+
+    def test_list_user_filter(self):
+        test_filter = {'id': {'operation': 1234}}
+        result = self.manager.list_users(objectFilter=test_filter)
+        self.assert_called_with('SoftLayer_Account', 'getUsers', filter=test_filter)
+
+    def test_get_user_default(self):
+        result = self.manager.get_user(1234)
+        self.assert_called_with('SoftLayer_User_Customer', 'getObject', identifier=1234,
+            mask="mask[userStatus[name], parent[id, username]]")
+
+    def test_get_user_mask(self):
+        result = self.manager.get_user(1234, objectMask="mask[id]")
+        self.assert_called_with('SoftLayer_User_Customer', 'getObject', identifier=1234, mask="mask[id]")
+
+    def test_get_all_permissions(self):
+        result = self.manager.get_all_permissions()
+        self.assert_called_with('SoftLayer_User_Customer_CustomerPermission_Permission', 'getAllObjects')
+
+    def test_add_permissions(self):
+        result = self.manager.add_permissions(1234, ['TEST'])
+        expected_args = (
+            [{'keyName': 'TEST'}],
+        )
+        self.assert_called_with('SoftLayer_User_Customer', 'addBulkPortalPermission', 
+            args=expected_args, identifier=1234)
+
+    def test_remove_permissions(self):
+        result = self.manager.remove_permissions(1234, ['TEST'])
+        expected_args = (
+            [{'keyName': 'TEST'}],
+        )
+        self.assert_called_with('SoftLayer_User_Customer', 'removeBulkPortalPermission', 
+            args=expected_args, identifier=1234)
+
+
+    def test_get_logins_default(self):
+        from datetime import date
+        with mock.patch('SoftLayer.managers.user.datetime.date') as mock_date:
+            mock_date.today.return_value = date(2018, 5, 15)
+            mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
+
+            result = self.manager.get_logins(1234)
+            expected_filter = {
+                'loginAttempts': {
+                    'createDate': {
+                        'operation': 'greaterThanDate', 
+                        'options': [{'name': 'date', 'value': ['04/15/2018 0:0:0']}]
+                        }
+                    }
+                }
+            self.assert_called_with('SoftLayer_User_Customer', 'getLoginAttempts', filter=expected_filter)
+
+
+    def test_get_events_default(self):
+        from datetime import date
+        with mock.patch('SoftLayer.managers.user.datetime.date') as mock_date:
+            mock_date.today.return_value = date(2018, 5, 15)
+            mock_date.side_effect = lambda *args, **kw: date(*args, **kw)
+
+            result = self.manager.get_events(1234)
+            expected_filter = {
+                'userId': {
+                    'operation': 1234
+                },
+                'eventCreateDate': {
+                    'operation': 'greaterThanDate', 
+                    'options': [{'name': 'date', 'value': ['2018-04-15T00:00:00.0000-06:00']}]
+                }
+            }
+            self.assert_called_with('SoftLayer_Event_Log', 'getAllObjects', filter=expected_filter)
+
+
+