Refactor block and file volume list and volume order.

Author: Fernando Ojeda

SoftLayer/CLI/block/list.py

@@ -58,7 +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('--order', '-o', type=int, 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']))
@@ -74,8 +74,8 @@ def cli(env, sortby, columns, datacenter, username, storage_type, order):
     block_manager = SoftLayer.BlockStorageManager(env.client)
     block_volumes = block_manager.list_block_volumes(datacenter=datacenter,
                                                      username=username,
-                                                     order=order,
                                                      storage_type=storage_type,
+                                                     order=order,
                                                      mask=columns.mask())
 
     table = formatting.Table(columns.columns)

SoftLayer/CLI/block/order.py

@@ -6,7 +6,6 @@
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import exceptions
 
-
 CONTEXT_SETTINGS = {'token_normalize_func': lambda x: x.upper()}
 
 
@@ -128,5 +127,8 @@ def cli(env, storage_type, size, iops, tier, os_type,
             order['placedOrder']['id']))
         for item in order['placedOrder']['items']:
             click.echo(" > %s" % item['description'])
+        click.echo(
+            '\nYou may run "slcli block volume-list --order {0}" to find this block volume after it '
+            'is ready.'.format(order['placedOrder']['id']))
     else:
         click.echo("Order could not be placed! Please verify your options and try again.")

SoftLayer/CLI/file/list.py

@@ -56,7 +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('--order', '-o', type=int, 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']))
@@ -67,13 +67,13 @@
                   ', '.join(column.name for column in COLUMNS)),
               default=','.join(DEFAULT_COLUMNS))
 @environment.pass_env
-def cli(env, sortby, columns, datacenter, username, order, storage_type):
+def cli(env, sortby, columns, datacenter, username, storage_type, order):
     """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,
+                                                  order=order,
                                                   mask=columns.mask())
 
     table = formatting.Table(columns.columns)

SoftLayer/CLI/file/order.py

@@ -115,5 +115,8 @@ def cli(env, storage_type, size, iops, tier,
             order['placedOrder']['id']))
         for item in order['placedOrder']['items']:
             click.echo(" > %s" % item['description'])
+        click.echo(
+            '\nYou may run "slcli file volume-list --order {0}" to find this file volume after it '
+            'is ready.'.format(order['placedOrder']['id']))
     else:
         click.echo("Order could not be placed! Please verify your options and try again.")

SoftLayer/managers/block.py

@@ -25,13 +25,13 @@ def list_block_volume_limit(self):
         """
         return self.get_volume_count_limits()
 
-    def list_block_volumes(self, datacenter=None, username=None, order=None, storage_type=None, **kwargs):
+    def list_block_volumes(self, datacenter=None, username=None, storage_type=None, order=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
+        :param order: Volume order id.
         :param kwargs:
         :return: Returns a list of block volumes.
         """

SoftLayer/managers/file.py

@@ -22,13 +22,13 @@ def list_file_volume_limit(self):
         """
         return self.get_volume_count_limits()
 
-    def list_file_volumes(self, datacenter=None, username=None, order=None, storage_type=None, **kwargs):
+    def list_file_volumes(self, datacenter=None, username=None, storage_type=None, order=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
+        :param order: Volume order id.
         :param kwargs:
         :return: Returns a list of file volumes.
         """

tests/CLI/modules/block_tests.py

@@ -145,22 +145,8 @@ 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))
+        json_result = json.loads(result.output)
+        self.assertEqual(json_result[0]['id'], 100)
 
     @mock.patch('SoftLayer.BlockStorageManager.list_block_volumes')
     def test_volume_count(self, list_mock):
@@ -220,7 +206,9 @@ def test_volume_order_performance(self, order_mock):
                          'Order #478 placed successfully!\n'
                          ' > Performance Storage\n > Block Storage\n'
                          ' > 0.25 IOPS per GB\n > 20 GB Storage Space\n'
-                         ' > 10 GB Storage Space (Snapshot Space)\n')
+                         ' > 10 GB Storage Space (Snapshot Space)\n'
+                         '\nYou may run "slcli block volume-list --order 478" to find this block volume '
+                         'after it is ready.\n')
 
     def test_volume_order_endurance_tier_not_given(self):
         result = self.run_command(['block', 'volume-order',
@@ -253,7 +241,9 @@ def test_volume_order_endurance(self, order_mock):
                          'Order #478 placed successfully!\n'
                          ' > Endurance Storage\n > Block Storage\n'
                          ' > 0.25 IOPS per GB\n > 20 GB Storage Space\n'
-                         ' > 10 GB Storage Space (Snapshot Space)\n')
+                         ' > 10 GB Storage Space (Snapshot Space)\n'
+                         '\nYou may run "slcli block volume-list --order 478" to find this block volume '
+                         'after it is ready.\n')
 
     @mock.patch('SoftLayer.BlockStorageManager.order_block_volume')
     def test_volume_order_order_not_placed(self, order_mock):
@@ -302,7 +292,9 @@ def test_volume_order_hourly_billing(self, order_mock):
                          ' > Storage as a Service\n'
                          ' > Block Storage\n'
                          ' > 20 GB Storage Space\n'
-                         ' > 200 IOPS\n')
+                         ' > 200 IOPS\n'
+                         '\nYou may run "slcli block volume-list --order 10983647" to find this block volume '
+                         'after it is ready.\n')
 
     @mock.patch('SoftLayer.BlockStorageManager.order_block_volume')
     def test_volume_order_performance_manager_error(self, order_mock):

tests/CLI/modules/file_tests.py

@@ -59,21 +59,8 @@ 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))
+        json_result = json.loads(result.output)
+        self.assertEqual(json_result[0]['id'], 1)
 
     @mock.patch('SoftLayer.FileStorageManager.list_file_volumes')
     def test_volume_count(self, list_mock):
@@ -243,7 +230,9 @@ def test_volume_order_performance(self, order_mock):
                          'Order #478 placed successfully!\n'
                          ' > Performance Storage\n > File Storage\n'
                          ' > 0.25 IOPS per GB\n > 20 GB Storage Space\n'
-                         ' > 10 GB Storage Space (Snapshot Space)\n')
+                         ' > 10 GB Storage Space (Snapshot Space)\n'
+                         '\nYou may run "slcli file volume-list --order 478" to find this file volume after it is '
+                         'ready.\n')
 
     def test_volume_order_endurance_tier_not_given(self):
         result = self.run_command(['file', 'volume-order',
@@ -276,7 +265,9 @@ def test_volume_order_endurance(self, order_mock):
                          'Order #478 placed successfully!\n'
                          ' > Endurance Storage\n > File Storage\n'
                          ' > 0.25 IOPS per GB\n > 20 GB Storage Space\n'
-                         ' > 10 GB Storage Space (Snapshot Space)\n')
+                         ' > 10 GB Storage Space (Snapshot Space)\n'
+                         '\nYou may run "slcli file volume-list --order 478" to find this file volume after it is '
+                         'ready.\n')
 
     @mock.patch('SoftLayer.FileStorageManager.order_file_volume')
     def test_volume_order_order_not_placed(self, order_mock):
@@ -327,7 +318,9 @@ def test_volume_order_hourly_billing(self, order_mock):
                          ' > File Storage\n'
                          ' > 20 GB Storage Space\n'
                          ' > 0.25 IOPS per GB\n'
-                         ' > 10 GB Storage Space (Snapshot Space)\n')
+                         ' > 10 GB Storage Space (Snapshot Space)\n'
+                         '\nYou may run "slcli file volume-list --order 479" to find this file volume after it is '
+                         'ready.\n')
 
     @mock.patch('SoftLayer.FileStorageManager.order_file_volume')
     def test_volume_order_performance_manager_error(self, order_mock):