Add to block and file storage volume lis order.

Author: Fernando Ojeda

SoftLayer/CLI/block/list.py

@@ -58,6 +58,7 @@
 @click.command()
 @click.option('--username', '-u', help='Volume username')
 @click.option('--datacenter', '-d', help='Datacenter shortname')
+@click.option('--order', '-o', help='Filter by ID of the order that purchased the block storage')
 @click.option('--storage-type',
               help='Type of storage volume',
               type=click.Choice(['performance', 'endurance']))
@@ -68,11 +69,12 @@
                   ', '.join(column.name for column in COLUMNS)),
               default=','.join(DEFAULT_COLUMNS))
 @environment.pass_env
-def cli(env, sortby, columns, datacenter, username, storage_type):
+def cli(env, sortby, columns, datacenter, username, storage_type, order):
     """List block storage."""
     block_manager = SoftLayer.BlockStorageManager(env.client)
     block_volumes = block_manager.list_block_volumes(datacenter=datacenter,
                                                      username=username,
+                                                     order=order,
                                                      storage_type=storage_type,
                                                      mask=columns.mask())
 

SoftLayer/CLI/file/list.py

@@ -56,6 +56,7 @@
 @click.command()
 @click.option('--username', '-u', help='Volume username')
 @click.option('--datacenter', '-d', help='Datacenter shortname')
+@click.option('--order', '-o', help='Filter by ID of the order that purchased the block storage')
 @click.option('--storage-type',
               help='Type of storage volume',
               type=click.Choice(['performance', 'endurance']))
@@ -66,11 +67,12 @@
                   ', '.join(column.name for column in COLUMNS)),
               default=','.join(DEFAULT_COLUMNS))
 @environment.pass_env
-def cli(env, sortby, columns, datacenter, username, storage_type):
+def cli(env, sortby, columns, datacenter, username, order, storage_type):
     """List file storage."""
     file_manager = SoftLayer.FileStorageManager(env.client)
     file_volumes = file_manager.list_file_volumes(datacenter=datacenter,
                                                   username=username,
+                                                  order=order,
                                                   storage_type=storage_type,
                                                   mask=columns.mask())
 

SoftLayer/managers/block.py

@@ -25,9 +25,10 @@ def list_block_volume_limit(self):
         """
         return self.get_volume_count_limits()
 
-    def list_block_volumes(self, datacenter=None, username=None, storage_type=None, **kwargs):
+    def list_block_volumes(self, datacenter=None, username=None, order=None, storage_type=None, **kwargs):
         """Returns a list of block volumes.
 
+        :param order: Volume order id.
         :param datacenter: Datacenter short name (e.g.: dal09)
         :param username: Name of volume.
         :param storage_type: Type of volume: Endurance or Performance
@@ -67,6 +68,10 @@ def list_block_volumes(self, datacenter=None, username=None, storage_type=None,
             _filter['iscsiNetworkStorage']['username'] = \
                 (utils.query_filter(username))
 
+        if order:
+            _filter['iscsiNetworkStorage']['billingItem']['orderItem'][
+                'order']['id'] = (utils.query_filter(order))
+
         kwargs['filter'] = _filter.to_dict()
         return self.client.call('Account', 'getIscsiNetworkStorage', **kwargs)
 

SoftLayer/managers/file.py

@@ -22,9 +22,10 @@ def list_file_volume_limit(self):
         """
         return self.get_volume_count_limits()
 
-    def list_file_volumes(self, datacenter=None, username=None, storage_type=None, **kwargs):
+    def list_file_volumes(self, datacenter=None, username=None, order=None, storage_type=None, **kwargs):
         """Returns a list of file volumes.
 
+        :param order: Volume order id.
         :param datacenter: Datacenter short name (e.g.: dal09)
         :param username: Name of volume.
         :param storage_type: Type of volume: Endurance or Performance
@@ -64,6 +65,10 @@ def list_file_volumes(self, datacenter=None, username=None, storage_type=None, *
             _filter['nasNetworkStorage']['username'] = \
                 (utils.query_filter(username))
 
+        if order:
+            _filter['nasNetworkStorage']['billingItem']['orderItem'][
+                'order']['id'] = (utils.query_filter(order))
+
         kwargs['filter'] = _filter.to_dict()
         return self.client.call('Account', 'getNasNetworkStorage', **kwargs)
 

tests/CLI/modules/block_tests.py

@@ -141,6 +141,27 @@ def test_volume_list(self):
             }],
             json.loads(result.output))
 
+    def test_volume_list_order(self):
+        result = self.run_command(['block', 'volume-list', '--order=1234567'])
+
+        self.assert_no_fail(result)
+        self.assertEqual([
+            {
+                'bytes_used': None,
+                'capacity_gb': 20,
+                'datacenter': 'dal05',
+                'id': 100,
+                'iops': None,
+                'ip_addr': '10.1.2.3',
+                'lunId': None,
+                'notes': "{'status': 'availabl",
+                'rep_partner_count': None,
+                'storage_type': 'ENDURANCE',
+                'username': 'username',
+                'active_transactions': None
+            }],
+            json.loads(result.output))
+
     @mock.patch('SoftLayer.BlockStorageManager.list_block_volumes')
     def test_volume_count(self, list_mock):
         list_mock.return_value = [

tests/CLI/modules/file_tests.py

@@ -55,6 +55,26 @@ def test_volume_list(self):
             }],
             json.loads(result.output))
 
+    def test_volume_list_order(self):
+        result = self.run_command(['file', 'volume-list', '--order=1234567'])
+
+        self.assert_no_fail(result)
+        self.assertEqual([
+            {
+                'bytes_used': None,
+                'capacity_gb': 10,
+                'datacenter': 'Dallas',
+                'id': 1,
+                'ip_addr': '127.0.0.1',
+                'storage_type': 'ENDURANCE',
+                'username': 'user',
+                'active_transactions': None,
+                'mount_addr': '127.0.0.1:/TEST',
+                'notes': None,
+                'rep_partner_count': None
+            }],
+            json.loads(result.output))
+
     @mock.patch('SoftLayer.FileStorageManager.list_file_volumes')
     def test_volume_count(self, list_mock):
         list_mock.return_value = [

tests/managers/block_tests.py

@@ -157,6 +157,46 @@ def test_list_block_volumes(self):
             mask='mask[%s]' % expected_mask
         )
 
+    def test_list_block_volumes_additional_filter_order(self):
+        result = self.block.list_block_volumes(order=1234567)
+
+        self.assertEqual(SoftLayer_Account.getIscsiNetworkStorage,
+                         result)
+
+        expected_filter = {
+            'iscsiNetworkStorage': {
+                'storageType': {
+                    'keyName': {'operation': '*= BLOCK_STORAGE'}
+                },
+                'serviceResource': {
+                    'type': {
+                        'type': {'operation': '!~ ISCSI'}
+                    }
+                },
+                'billingItem': {
+                    'orderItem': {
+                        'order': {
+                            'id': {'operation': 1234567}}}}
+            }
+        }
+
+        expected_mask = 'id,' \
+                        'username,' \
+                        'lunId,' \
+                        'capacityGb,' \
+                        'bytesUsed,' \
+                        'serviceResource.datacenter[name],' \
+                        'serviceResourceBackendIpAddress,' \
+                        'activeTransactionCount,' \
+                        'replicationPartnerCount'
+
+        self.assert_called_with(
+            'SoftLayer_Account',
+            'getIscsiNetworkStorage',
+            filter=expected_filter,
+            mask='mask[%s]' % expected_mask
+        )
+
     def test_list_block_volumes_with_additional_filters(self):
         result = self.block.list_block_volumes(datacenter="dal09",
                                                storage_type="Endurance",

tests/managers/file_tests.py

@@ -365,6 +365,46 @@ def test_list_file_volumes(self):
             mask='mask[%s]' % expected_mask
         )
 
+    def test_list_file_volumes_additional_filter_order(self):
+        result = self.file.list_file_volumes(order=1234567)
+
+        self.assertEqual(SoftLayer_Account.getNasNetworkStorage,
+                         result)
+
+        expected_filter = {
+            'nasNetworkStorage': {
+                'storageType': {
+                    'keyName': {'operation': '*= FILE_STORAGE'}
+                },
+                'serviceResource': {
+                    'type': {
+                        'type': {'operation': '!~ NAS'}
+                    }
+                },
+                'billingItem': {
+                    'orderItem': {
+                        'order': {
+                            'id': {'operation': 1234567}}}}
+            }
+        }
+
+        expected_mask = 'id,'\
+                        'username,'\
+                        'capacityGb,'\
+                        'bytesUsed,'\
+                        'serviceResource.datacenter[name],'\
+                        'serviceResourceBackendIpAddress,'\
+                        'activeTransactionCount,'\
+                        'fileNetworkMountAddress,'\
+                        'replicationPartnerCount'
+
+        self.assert_called_with(
+            'SoftLayer_Account',
+            'getNasNetworkStorage',
+            filter=expected_filter,
+            mask='mask[%s]' % expected_mask
+        )
+
     def test_list_file_volumes_with_additional_filters(self):
         result = self.file.list_file_volumes(datacenter="dal09",
                                              storage_type="Endurance",