Merge pull request #1415 from ATGE/issues/1410

Add username lookup to slcli  object-storage credential

Author: allmightyspiff

SoftLayer/CLI/object_storage/credential/create.py

@@ -6,6 +6,7 @@
 import SoftLayer
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
 
 
 @click.command()
@@ -15,14 +16,15 @@ def cli(env, identifier):
     """Create credentials for an IBM Cloud Object Storage Account"""
 
     mgr = SoftLayer.ObjectStorageManager(env.client)
-    credential = mgr.create_credential(identifier)
+    storage_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Object Storage')
+    credential = mgr.create_credential(storage_id)
     table = formatting.Table(['id', 'password', 'username', 'type_name'])
     table.sortby = 'id'
     table.add_row([
-        credential['id'],
-        credential['password'],
-        credential['username'],
-        credential['type']['name']
+        credential.get('id'),
+        credential.get('password'),
+        credential.get('username'),
+        credential.get('type', {}).get('name')
     ])
 
     env.fout(table)

SoftLayer/CLI/object_storage/credential/delete.py

@@ -5,6 +5,7 @@
 
 import SoftLayer
 from SoftLayer.CLI import environment
+from SoftLayer.CLI import helpers
 
 
 @click.command()
@@ -16,6 +17,7 @@ def cli(env, identifier, credential_id):
     """Delete the credential of an Object Storage Account."""
 
     mgr = SoftLayer.ObjectStorageManager(env.client)
-    credential = mgr.delete_credential(identifier, credential_id=credential_id)
+    storage_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Object Storage')
+    credential = mgr.delete_credential(storage_id, credential_id=credential_id)
 
     env.fout(credential)

SoftLayer/CLI/object_storage/credential/limit.py

@@ -6,6 +6,7 @@
 import SoftLayer
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
 
 
 @click.command()
@@ -15,7 +16,8 @@ def cli(env, identifier):
     """Credential limits for this IBM Cloud Object Storage account."""
 
     mgr = SoftLayer.ObjectStorageManager(env.client)
-    credential_limit = mgr.limit_credential(identifier)
+    storage_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Object Storage')
+    credential_limit = mgr.limit_credential(storage_id)
     table = formatting.Table(['limit'])
     table.add_row([
         credential_limit,

SoftLayer/CLI/object_storage/credential/list.py

@@ -6,6 +6,7 @@
 import SoftLayer
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
 
 
 @click.command()
@@ -15,15 +16,17 @@ def cli(env, identifier):
     """Retrieve credentials used for generating an AWS signature. Max of 2."""
 
     mgr = SoftLayer.ObjectStorageManager(env.client)
-    credential_list = mgr.list_credential(identifier)
+    storage_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Object Storage')
+    credential_list = mgr.list_credential(storage_id)
+
     table = formatting.Table(['id', 'password', 'username', 'type_name'])
 
     for credential in credential_list:
         table.add_row([
-            credential['id'],
-            credential['password'],
-            credential['username'],
-            credential['type']['name']
+            credential.get('id'),
+            credential.get('password'),
+            credential.get('username'),
+            credential.get('type', {}).get('name')
         ])
 
     env.fout(table)

SoftLayer/fixtures/SoftLayer_Network_Storage_Hub_Cleversafe_Account.py

@@ -46,3 +46,7 @@
         "storageLocation": "us-standard"
     }
 ]
+
+getCredentialLimit = 2
+
+credentialDelete = True

SoftLayer/managers/object_storage.py

@@ -6,6 +6,9 @@
     :license: MIT, see LICENSE for more details.
 """
 
+from SoftLayer.exceptions import SoftLayerError
+from SoftLayer import utils
+
 LIST_ACCOUNTS_MASK = '''mask[
     id,username,notes,vendorName,serviceResource
 ]'''
@@ -15,7 +18,7 @@
 ]'''
 
 
-class ObjectStorageManager(object):
+class ObjectStorageManager(utils.IdentifierMixin, object):
     """Manager for SoftLayer Object Storage accounts.
 
     See product information here: https://www.ibm.com/cloud/object-storage
@@ -26,11 +29,16 @@ class ObjectStorageManager(object):
 
     def __init__(self, client):
         self.client = client
+        self.resolvers = [self._get_id_from_username]
 
-    def list_accounts(self, limit=10):
+    def list_accounts(self, object_mask=None, object_filter=None, limit=10):
         """Lists your object storage accounts."""
-        return self.client.call('Account', 'getHubNetworkStorage',
-                                mask=LIST_ACCOUNTS_MASK, iter=True, limit=limit)
+        object_mask = object_mask if object_mask else LIST_ACCOUNTS_MASK
+        return self.client.call('Account',
+                                'getHubNetworkStorage',
+                                mask=object_mask,
+                                filter=object_filter,
+                                limit=limit)
 
     def list_endpoints(self):
         """Lists the known object storage endpoints."""
@@ -96,3 +104,19 @@ def list_credential(self, identifier):
 
         return self.client.call('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getCredentials',
                                 id=identifier)
+
+    def _get_id_from_username(self, username):
+        """Looks up a username's id
+
+        :param string username: Username to lookup
+        :returns: The id that matches username.
+        """
+        _mask = "mask[id,username]"
+        _filter = {'hubNetworkStorage': {'username': utils.query_filter(username)}}
+        account = self.list_accounts(_mask, _filter)
+        if len(account) == 1:
+            return [account[0]['id']]
+        elif len(account) > 1:
+            raise SoftLayerError("Multiple object storage accounts found with the name: {}".format(username))
+        else:
+            raise SoftLayerError("Unable to find object storage account id for: {}".format(username))

tests/CLI/modules/object_storage_tests.py

@@ -5,6 +5,7 @@
     :license: MIT, see LICENSE for more details.
 """
 import json
+from unittest import mock
 
 from SoftLayer import testing
 
@@ -39,68 +40,44 @@ def test_list_endpoints(self):
                            'public': 'https://dal05/auth/v1.0/'}])
 
     def test_create_credential(self):
-        accounts = self.set_mock('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'credentialCreate')
-        accounts.return_value = {
-            "accountId": "12345",
-            "createDate": "2019-04-05T13:25:25-06:00",
-            "id": 11111,
-            "password": "nwUEUsx6PiEoN0B1Xe9z9hUCy",
-            "username": "XfHhBNBPlPdl",
-            "type": {
-                "description": "A credential for generating S3 Compatible Signatures.",
-                "keyName": "S3_COMPATIBLE_SIGNATURE",
-                "name": "S3 Compatible Signature"
-            }
-        }
-
         result = self.run_command(['object-storage', 'credential', 'create', '100'])
+        self.assert_no_fail(result)
 
+    @mock.patch('SoftLayer.CLI.helpers.resolve_id')
+    def test_create_credential_by_username(self, resolve_id_mock):
+        resolve_id_mock.return_value = 100
+        result = self.run_command(['object-storage', 'credential', 'create', 'test'])
         self.assert_no_fail(result)
-        self.assertEqual(json.loads(result.output),
-                         [{'id': 11111,
-                           'password': 'nwUEUsx6PiEoN0B1Xe9z9hUCy',
-                           'type_name': 'S3 Compatible Signature',
-                           'username': 'XfHhBNBPlPdl'}]
-                         )
 
     def test_delete_credential(self):
-        accounts = self.set_mock('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'credentialDelete')
-        accounts.return_value = True
-
         result = self.run_command(['object-storage', 'credential', 'delete', '-c', 100, '100'])
-
         self.assert_no_fail(result)
         self.assertEqual(result.output, 'True\n')
 
-    def test_limit_credential(self):
-        accounts = self.set_mock('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getCredentialLimit')
-        accounts.return_value = 2
+    @mock.patch('SoftLayer.CLI.helpers.resolve_id')
+    def test_delete_credential_by_username(self, resolve_id_mock):
+        resolve_id_mock.return_value = 100
+        result = self.run_command(['object-storage', 'credential', 'delete', 'test'])
+        self.assert_no_fail(result)
 
+    def test_limit_credential(self):
         result = self.run_command(['object-storage', 'credential', 'limit', '100'])
 
         self.assert_no_fail(result)
-        self.assertEqual(json.loads(result.output), [{'limit': 2}])
+        self.assertIn('limit', result.output)
 
-    def test_list_credential(self):
-        accounts = self.set_mock('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getCredentials')
-        accounts.return_value = [{'id': 1103123,
-                                  'password': 'nwUEUsx6PiEoN0B1Xe9z9hUCyXM',
-                                  'type': {'name': 'S3 Compatible Signature'},
-                                  'username': 'XfHhBNBPlPdlWya'},
-                                 {'id': 1103333,
-                                  'password': 'nwUEUsx6PiEoN0B1Xe9z9',
-                                  'type': {'name': 'S3 Compatible Signature'},
-                                  'username': 'XfHhBNBPlPd'}]
+    @mock.patch('SoftLayer.CLI.helpers.resolve_id')
+    def test_limit_credential_by_username(self, resolve_id_mock):
+        resolve_id_mock.return_value = 100
+        result = self.run_command(['object-storage', 'credential', 'limit', 'test'])
+        self.assert_no_fail(result)
 
+    def test_list_credential(self):
         result = self.run_command(['object-storage', 'credential', 'list', '100'])
+        self.assert_no_fail(result)
 
+    @mock.patch('SoftLayer.CLI.helpers.resolve_id')
+    def test_list_credential_by_username(self, resolve_id_mock):
+        resolve_id_mock.return_value = 100
+        result = self.run_command(['object-storage', 'credential', 'list', 'test'])
         self.assert_no_fail(result)
-        self.assertEqual(json.loads(result.output),
-                         [{'id': 1103123,
-                           'password': 'nwUEUsx6PiEoN0B1Xe9z9hUCyXM',
-                           'type_name': 'S3 Compatible Signature',
-                           'username': 'XfHhBNBPlPdlWya'},
-                          {'id': 1103333,
-                           'password': 'nwUEUsx6PiEoN0B1Xe9z9',
-                           'type_name': 'S3 Compatible Signature',
-                           'username': 'XfHhBNBPlPd'}])

tests/managers/object_storage_tests.py

@@ -6,6 +6,7 @@
 """
 import SoftLayer
 from SoftLayer import fixtures
+from SoftLayer import SoftLayerError
 from SoftLayer import testing
 
 
@@ -79,43 +80,26 @@ def test_limit_credential(self):
         self.assertEqual(credential, 2)
 
     def test_list_credential(self):
-        accounts = self.set_mock('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getCredentials')
-        accounts.return_value = [
-            {
-                "id": 1103123,
-                "password": "nwUEUsx6PiEoN0B1Xe9z9hUCyXsf4sf",
-                "username": "XfHhBNBPlPdlWyaP3fsd",
-                "type": {
-                    "name": "S3 Compatible Signature"
-                }
-            },
-            {
-                "id": 1102341,
-                "password": "nwUEUsx6PiEoN0B1Xe9z9hUCyXMkAF",
-                "username": "XfHhBNBPlPdlWyaP",
-                "type": {
-                    "name": "S3 Compatible Signature"
-                }
-            }
-        ]
-        credential = self.object_storage.list_credential(100)
-        self.assertEqual(credential,
-                         [
-                             {
-                                 "id": 1103123,
-                                 "password": "nwUEUsx6PiEoN0B1Xe9z9hUCyXsf4sf",
-                                 "username": "XfHhBNBPlPdlWyaP3fsd",
-                                 "type": {
-                                     "name": "S3 Compatible Signature"
-                                 }
-                             },
-                             {
-                                 "id": 1102341,
-                                 "password": "nwUEUsx6PiEoN0B1Xe9z9hUCyXMkAF",
-                                 "username": "XfHhBNBPlPdlWyaP",
-                                 "type": {
-                                     "name": "S3 Compatible Signature"
-                                 }
-                             }
-                         ]
-                         )
+        credentials = self.object_storage.list_credential(100)
+        self.assertIsInstance(credentials, list)
+        self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account',
+                                'getCredentials',
+                                identifier=100)
+
+    def test_resolve_ids(self):
+        accounts = self.set_mock('SoftLayer_Account', 'getHubNetworkStorage')
+        accounts.return_value = [{'id': 12345, 'username': 'test'}]
+        identifier = self.object_storage.resolve_ids('test')
+        self.assertEqual(identifier, [12345])
+        self.assert_called_with('SoftLayer_Account', 'getHubNetworkStorage')
+
+    def test_resolve_ids_fail_multiple(self):
+        accounts = self.set_mock('SoftLayer_Account', 'getHubNetworkStorage')
+        accounts.return_value = [{'id': 12345, 'username': 'test'},
+                                 {'id': 12345, 'username': 'test'}]
+        self.assertRaises(SoftLayerError, self.object_storage.resolve_ids, 'test')
+
+    def test_resolve_ids_fail_no_found(self):
+        accounts = self.set_mock('SoftLayer_Account', 'getHubNetworkStorage')
+        accounts.return_value = []
+        self.assertRaises(SoftLayerError, self.object_storage.resolve_ids, 'test')