Merge pull request #1681 from caberos/issue1673

add the block volume-options command

Author: allmightyspiff

SoftLayer/CLI/block/options.py

@@ -0,0 +1,49 @@
+"""List all options for ordering a block storage."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI.command import SLCommand
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import formatting
+
+PACKAGE_STORAGE = 759
+
+
+@click.command(cls=SLCommand)
+@environment.pass_env
+def cli(env):
+    """List all options for ordering a block storage"""
+
+    order_manager = SoftLayer.OrderingManager(env.client)
+    items = order_manager.get_items(PACKAGE_STORAGE)
+    datacenters = order_manager.get_regions(PACKAGE_STORAGE)
+
+    iops_table = formatting.Table(['Id', 'Description', 'KeyName'], title='IOPS')
+    snapshot_table = formatting.Table(['Id', 'Description', 'KeyName'], title='Snapshot')
+    storage_table = formatting.Table(['Id', 'Description', 'KeyName'], title='Storage')
+    datacenter_table = formatting.Table(['Id', 'Description', 'KeyName'], title='Datacenter')
+
+    for datacenter in datacenters:
+        datacenter_table.add_row([datacenter['location']['locationId'],
+                                  datacenter.get('description'),
+                                  datacenter['keyname']])
+
+    for item in items:
+        if item['itemCategory']['categoryCode'] == 'performance_storage_space':
+            storage_table.add_row([item.get('id'), item.get('description'),
+                                   item.get('keyName')])
+
+        if item['itemCategory']['categoryCode'] == 'storage_tier_level':
+            iops_table.add_row([item.get('id'), item.get('description'),
+                                item.get('keyName')])
+
+        if item['itemCategory']['categoryCode'] == 'storage_snapshot_space':
+            snapshot_table.add_row([item.get('id'), item.get('description'),
+                                    item.get('keyName')])
+
+    env.fout(datacenter_table)
+    env.fout(iops_table)
+    env.fout(storage_table)
+    env.fout(snapshot_table)

SoftLayer/CLI/routes.py

@@ -125,6 +125,7 @@
     ('block:volume-limits', 'SoftLayer.CLI.block.limit:cli'),
     ('block:volume-refresh', 'SoftLayer.CLI.block.refresh:cli'),
     ('block:volume-convert', 'SoftLayer.CLI.block.convert:cli'),
+    ('block:volume-options', 'SoftLayer.CLI.block.options:cli'),
     ('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'),

SoftLayer/fixtures/SoftLayer_Location.py

@@ -9,4 +9,4 @@
         "longName": "San Jose 1",
         "name": "sjc01"
     }]
-getDatacenters = [{'id': 1854895, 'name': 'dal13', 'regions': [{'keyname': 'DALLAS13'}]}]
+getDatacenters = [{'id': 1854895, 'longName': 'dallas 13', 'name': 'dal13', 'regions': [{'keyname': 'DALLAS13'}]}]

SoftLayer/managers/ordering.py

@@ -6,7 +6,6 @@
     :license: MIT, see LICENSE for more details.
 """
 
-
 from re import match
 
 from SoftLayer import exceptions
@@ -717,3 +716,21 @@ def resolve_location_name(self, location_key):
             if location.get('regions', default_regions)[index_first].get('keyname') == location_key:
                 return location_name
         raise exceptions.SoftLayerError("Location {} does not exist".format(location_key))
+
+    def get_items(self, package_id, storage_filter=None):
+        """"Returns the items .
+
+
+        :param int package_id: The package for which to get the items.
+        :param dict storage_filter: object filter.
+        """
+
+        return self.client.call('SoftLayer_Product_Package', 'getItems', filter=storage_filter,
+                                id=package_id)
+
+    def get_regions(self, package_id):
+        """returns the all regions.
+
+        :param int package_id: The package for which to get the items.
+        """
+        return self.client.call('SoftLayer_Product_Package', 'getRegions', id=package_id)

docs/cli/block.rst

@@ -83,6 +83,10 @@ Block Commands
     :prog: block volume-count
     :show-nested:
 
+.. click:: SoftLayer.CLI.block.options:cli
+    :prog: block volume-options
+    :show-nested:
+
 .. click:: SoftLayer.CLI.block.detail:cli
     :prog: block volume-detail
     :show-nested:

tests/CLI/modules/block_tests.py

@@ -792,6 +792,11 @@ def test_dep_dupe_convert(self):
 
         self.assert_no_fail(result)
 
+    def test_volume_options(self):
+        result = self.run_command(['block', 'volume-options'])
+
+        self.assert_no_fail(result)
+
     @mock.patch('SoftLayer.BlockStorageManager.volume_set_note')
     def test_volume_set_note(self, set_note):
         set_note.return_value = True

tests/managers/ordering_tests.py

@@ -893,3 +893,11 @@ def test_issues1425_nonzeroterm(self):
         # Test None-existing price for term
         price_id = self.ordering.get_item_price_id("8", [price2, price1], 37)
         self.assertEqual(None, price_id)
+
+    def test_get_items(self):
+        self.ordering.get_items(123)
+        self.assert_called_with('SoftLayer_Product_Package', 'getItems')
+
+    def test_get_regions(self):
+        self.ordering.get_regions(123)
+        self.assert_called_with('SoftLayer_Product_Package', 'getRegions')