Merge pull request #1668 from caberos/issue1667

new feature block object-storage permissions command

Author: allmightyspiff

SoftLayer/CLI/block/object_storage_permission.py

@@ -0,0 +1,44 @@
+"""Display permission details for a cloud object storage."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+
+@click.command(cls=SoftLayer.CLI.command.SLCommand, )
+@click.argument('object_id')
+@environment.pass_env
+def cli(env, object_id):
+    """Display permission details for a cloud object storage."""
+
+    block_manager = SoftLayer.BlockStorageManager(env.client)
+
+    cloud = block_manager.get_network_message_delivery_accounts(object_id)
+    end_points = block_manager.get_end_points(object_id)
+
+    table = formatting.Table(['Name', 'Value'])
+
+    table_credentials = formatting.Table(['Id', 'Access Key ID', 'Secret Access Key', 'Description'])
+
+    for credential in cloud.get('credentials'):
+        table_credentials.add_row([credential.get('id'),
+                                   credential.get('username'),
+                                   credential.get('password'),
+                                   credential['type']['description']])
+
+    table_url = formatting.Table(['Region',
+                                  'Location',
+                                  'Type',
+                                  'URL'])
+    for end_point in end_points:
+        table_url.add_row([end_point.get('region') or '',
+                           end_point.get('location') or '',
+                           end_point.get('type'),
+                           end_point.get('url'), ])
+
+    table.add_row(['UUID', cloud.get('uuid')])
+    table.add_row(['Credentials', table_credentials])
+    table.add_row(['EndPoint URL´s', table_url])
+    env.fout(table)

SoftLayer/CLI/routes.py

@@ -128,6 +128,7 @@
     ('block:volume-set-note', 'SoftLayer.CLI.block.set_note:cli'),
     ('block:object-list', 'SoftLayer.CLI.block.object_list:cli'),
     ('block:object-storage-detail', 'SoftLayer.CLI.block.object_storage_detail:cli'),
+    ('block:object-storage-permission', 'SoftLayer.CLI.block.object_storage_permission:cli'),
 
     ('email', 'SoftLayer.CLI.email'),
     ('email:list', 'SoftLayer.CLI.email.list:cli'),

SoftLayer/fixtures/SoftLayer_Network_Storage_Hub_Cleversafe_Account.py

@@ -47,6 +47,47 @@
     }
 ]
 
+getEndpoints = [
+    {
+        'legacy': False,
+        'region': 'us-geo',
+        'type': 'public',
+        'url': 's3.us.cloud-object-storage.appdomain.cloud'
+    },
+    {
+        'legacy': False,
+        'region': 'us-geo',
+        'type': 'private',
+        'url': 's3.private.us.cloud-object-storage.appdomain.cloud'
+    }
+]
 getCredentialLimit = 2
 
 credentialDelete = True
+
+getObject = {
+    'id': 123456,
+    'username': 'SLOSC307608-1',
+    'credentials': [
+        {
+            'id': 1933496,
+            'password': 'Um1Bp420FIFNvAg2QHjn5Sci2c2x4RNDXpVDDvnf',
+            'username': 'Kv9aNIhtNa7ZRceCTgep',
+            'type': {
+                'description': 'A credential for generating S3 Compatible Signatures.',
+                'keyName': 'S3_COMPATIBLE_SIGNATURE'
+            }
+        },
+        {
+
+            'id': 1732820,
+            'password': 'q6NtwqeuXDaRqGc0Jrugg2sDgbatyNsoN9sPEmjo',
+            'username': '252r9BN8ibuDSQAXLOeL',
+            'type': {
+                'description': 'A credential for generating S3 Compatible Signatures.',
+                'keyName': 'S3_COMPATIBLE_SIGNATURE',
+            }
+        }
+    ],
+    'uuid': '01c449c484ae4a58a42d9b79d4c5e4ed'
+}

SoftLayer/managers/storage.py

@@ -9,6 +9,7 @@
 from SoftLayer.managers import storage_utils
 from SoftLayer import utils
 
+
 # pylint: disable=too-many-public-methods
 
 
@@ -586,3 +587,22 @@ def convert_dupe_status(self, volume_id):
         return self.client.call('Network_Storage',
                                 'getDuplicateConversionStatus',
                                 id=volume_id)
+
+    def get_network_message_delivery_accounts(self, object_id):
+        """Return  object data of the cloud storage.
+
+        :param object_id cloud object storage identifier
+        Returns: Get instances
+        """
+        object_mask = 'mask[uuid,credentials]'
+        return self.client.call('SoftLayer_Network_Storage_Hub_Cleversafe_Account',
+                                'getObject', mask=object_mask, id=object_id)
+
+    def get_end_points(self, object_id):
+        """Returns a collection of endpoint URLs available to this IBM Cloud Object Storage account.
+
+        :param object_id cloud object storage identifier
+        Returns: Returns a collection of endpoint URLs.
+        """
+        return self.client.call('SoftLayer_Network_Storage_Hub_Cleversafe_Account',
+                                'getEndpoints',  id=object_id)

docs/cli/block.rst

@@ -168,3 +168,7 @@ Block Commands
     :prog: block duplicate-convert-status
     :show-nested:
 
+.. click:: SoftLayer.CLI.block.object_storage_permission:cli
+    :prog: block object-storage-permission
+    :show-nested:
+

tests/CLI/modules/block_tests.py

@@ -444,7 +444,7 @@ def test_snapshot_restore(self):
 
         self.assert_no_fail(result)
         self.assertEqual(result.output, 'Block volume 12345678 is being'
-                                        ' restored using snapshot 87654321\n')
+                         ' restored using snapshot 87654321\n')
 
     @mock.patch('SoftLayer.BlockStorageManager.order_snapshot_space')
     def test_snapshot_order_order_not_placed(self, order_mock):
@@ -831,3 +831,10 @@ def test_object_details(self):
 
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getBuckets')
+
+    def test_object_permissions(self):
+        result = self.run_command(['block', 'object-storage-permission', '1234'])
+
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getObject')
+        self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getEndpoints')

tests/managers/block_tests.py

@@ -1123,3 +1123,11 @@ def test_get_cloud_list(self):
     def test_get_bucket(self):
         self.block.get_buckets(1234)
         self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getBuckets')
+
+    def test_get_cloud_endPoints(self):
+        self.block.get_end_points(123456)
+        self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getEndpoints')
+
+    def test_get_cloud_object(self):
+        self.block.get_network_message_delivery_accounts(123456)
+        self.assert_called_with('SoftLayer_Network_Storage_Hub_Cleversafe_Account', 'getObject')