Merge pull request #1455 from FernandoOjeda/ft/hw_upgrade_disk

Add the option to add and upgrade the hw disk.

Author: allmightyspiff

SoftLayer/CLI/hardware/upgrade.py

@@ -24,24 +24,40 @@
               default=None,
               type=click.Choice(['Non-RAID', 'RAID']))
 @click.option('--public-bandwidth', type=click.INT, help="Public Bandwidth in GB")
+@click.option('--add-disk', nargs=2, multiple=True, type=(int, int),
+              help="Add a Hard disk in GB to a specific channel, e.g 1000 GB in disk2, it will be "
+                   "--add-disk 1000 2")
+@click.option('--resize-disk', nargs=2, multiple=True, type=(int, int),
+              help="Upgrade a specific disk size in GB, e.g --resize-disk 2000 2")
 @click.option('--test', is_flag=True, default=False, help="Do not actually upgrade the hardware server")
 @environment.pass_env
-def cli(env, identifier, memory, network, drive_controller, public_bandwidth, test):
+def cli(env, identifier, memory, network, drive_controller, public_bandwidth, add_disk, resize_disk, test):
     """Upgrade a Hardware Server."""
 
     mgr = SoftLayer.HardwareManager(env.client)
 
-    if not any([memory, network, drive_controller, public_bandwidth]):
+    if not any([memory, network, drive_controller, public_bandwidth, add_disk, resize_disk]):
         raise exceptions.ArgumentError("Must provide "
-                                       " [--memory], [--network], [--drive-controller], or [--public-bandwidth]")
+                                       " [--memory], [--network], [--drive-controller], [--public-bandwidth],"
+                                       "[--add-disk] or [--resize-disk]")
 
     hw_id = helpers.resolve_id(mgr.resolve_ids, identifier, 'Hardware')
     if not test:
         if not (env.skip_confirmations or formatting.confirm(
                 "This action will incur charges on your account. Continue?")):
             raise exceptions.CLIAbort('Aborted')
 
+    disk_list = list()
+    if add_disk:
+        for guest_disk in add_disk:
+            disks = {'description': 'add_disk', 'capacity': guest_disk[0], 'number': guest_disk[1]}
+            disk_list.append(disks)
+    if resize_disk:
+        for guest_disk in resize_disk:
+            disks = {'description': 'resize_disk', 'capacity': guest_disk[0], 'number': guest_disk[1]}
+            disk_list.append(disks)
+
     if not mgr.upgrade(hw_id, memory=memory, nic_speed=network, drive_controller=drive_controller,
-                       public_bandwidth=public_bandwidth, test=test):
+                       public_bandwidth=public_bandwidth, disk=disk_list, test=test):
         raise exceptions.CLIAbort('Hardware Server Upgrade Failed')
     env.fout('Successfully Upgraded.')

SoftLayer/fixtures/SoftLayer_Hardware_Server.py

@@ -13,6 +13,10 @@
         'children': [
             {'description': 'test', 'nextInvoiceTotalRecurringAmount': 1},
         ],
+        'nextInvoiceChildren': [
+            {'description': 'test', 'nextInvoiceTotalRecurringAmount': 1, 'categoryCode': 'disk1'},
+            {'description': 'test2', 'nextInvoiceTotalRecurringAmount': 2, 'categoryCode': 'disk3'}
+        ],
         'orderItem': {
             'order': {
                 'userRecord': {
@@ -336,5 +340,40 @@
             "id": 6177,
             "keyName": "BANDWIDTH_500_GB"
         }
+    },
+    {
+        "hourlyRecurringFee": ".023",
+        "id": 49759,
+        "recurringFee": "15",
+        "categories": [
+            {
+                "categoryCode": "disk2",
+                "id": 6,
+                "name": "Third Hard Drive"
+            }
+        ],
+        "item": {
+            "capacity": "1000",
+            "description": "1.00 TB SATA",
+            "id": 6159,
+            "keyName": "HARD_DRIVE_1_00_TB_SATA_2",
+        }
+    },
+    {
+        "id": 49759,
+        "recurringFee": "0",
+        "categories": [
+            {
+                "categoryCode": "disk1",
+                "id": 5,
+                "name": "Second Hard Drive"
+            }
+        ],
+        "item": {
+            "capacity": "1000",
+            "description": "1.00 TB SATA",
+            "id": 6159,
+            "keyName": "HARD_DRIVE_1_00_TB_SATA_2"
+        }
     }
 ]

SoftLayer/managers/hardware.py

@@ -821,14 +821,15 @@ def authorize_storage(self, hardware_id, username_storage):
 
     def upgrade(self, instance_id, memory=None,
                 nic_speed=None, drive_controller=None,
-                public_bandwidth=None, test=False):
+                public_bandwidth=None, disk=None, test=False):
         """Upgrades a hardware server instance.
 
         :param int instance_id: Instance id of the hardware server to be upgraded.
         :param int memory: Memory size.
         :param string nic_speed: Network Port Speed data.
         :param string drive_controller: Drive Controller data.
         :param int public_bandwidth: Public keyName data.
+        :param list disk: List of disks to add or upgrade Hardware Server.
         :param bool test: Test option to verify the request.
 
         :returns: bool
@@ -860,6 +861,10 @@ def upgrade(self, instance_id, memory=None,
             'packageId': package_id
         }
 
+        if disk:
+            prices = self._get_disk_price_list(instance_id, disk)
+            order['prices'] = prices
+
         for option, value in data.items():
             price_id = self._get_prices_for_upgrade_option(upgrade_prices, option, value)
             if not price_id:
@@ -888,13 +893,13 @@ def get_instance(self, instance_id):
                   the specified instance.
         """
         mask = [
-            'billingItem[id,package[id,keyName]]'
+            'billingItem[id,package[id,keyName],nextInvoiceChildren]'
         ]
         mask = "mask[%s]" % ','.join(mask)
 
         return self.hardware.getObject(id=instance_id, mask=mask)
 
-    def _get_upgrade_prices(self, instance_id, include_downgrade_options=True):
+    def _get_upgrade_prices(self, instance_id):
         """Following Method gets all the price ids related to upgrading a Hardware Server.
 
         :param int instance_id: Instance id of the Hardware Server to be upgraded.
@@ -908,7 +913,7 @@ def _get_upgrade_prices(self, instance_id, include_downgrade_options=True):
             'item[keyName,description,capacity,units]'
         ]
         mask = "mask[%s]" % ','.join(mask)
-        return self.hardware.getUpgradeItemPrices(include_downgrade_options, id=instance_id, mask=mask)
+        return self.hardware.getUpgradeItemPrices(id=instance_id, mask=mask)
 
     @staticmethod
     def _get_prices_for_upgrade_option(upgrade_prices, option, value):
@@ -927,7 +932,10 @@ def _get_prices_for_upgrade_option(upgrade_prices, option, value):
             'disk_controller': 'disk_controller',
             'bandwidth': 'bandwidth'
         }
-        category_code = option_category.get(option)
+        if 'disk' in option:
+            category_code = option
+        else:
+            category_code = option_category.get(option)
 
         for price in upgrade_prices:
             if price.get('categories') is None or price.get('item') is None:
@@ -953,12 +961,75 @@ def _get_prices_for_upgrade_option(upgrade_prices, option, value):
                 elif option == 'bandwidth':
                     if str(product.get('capacity')) == str(value):
                         price_id = price.get('id')
+                elif 'disk' in option:
+                    if str(product.get('capacity')) == str(value):
+                        price_id = price
                 else:
                     if str(product.get('capacity')) == str(value):
                         price_id = price.get('id')
 
         return price_id
 
+    def _get_disk_price_list(self, instance_id, disk):
+        """Get the disks prices to be added or upgraded.
+
+        :param int instance_id: Hardware Server instance id.
+        :param list disk: List of disks to be added o upgraded to the HW.
+
+        :return list.
+        """
+        prices = []
+        disk_exist = False
+        upgrade_prices = self._get_upgrade_prices(instance_id)
+        server_response = self.get_instance(instance_id)
+        for disk_data in disk:
+            disk_channel = 'disk' + str(disk_data.get('number'))
+            for item in utils.lookup(server_response, 'billingItem', 'nextInvoiceChildren'):
+                if disk_channel == item['categoryCode']:
+                    disk_exist = True
+                    break
+            if disk_exist:
+                disk_price_detail = self._get_disk_price_detail(disk_data, upgrade_prices, disk_channel, 'add_disk')
+                prices.append(disk_price_detail)
+            else:
+                disk_price_detail = self._get_disk_price_detail(disk_data, upgrade_prices, disk_channel, 'resize_disk')
+                prices.append(disk_price_detail)
+
+        return prices
+
+    def _get_disk_price_detail(self, disk_data, upgrade_prices, disk_channel, disk_type):
+        """Get the disk price detail.
+
+        :param disk_data: List of disks to be added or upgraded.
+        :param list upgrade_prices: List of item prices.
+        :param String disk_channel: Disk position.
+        :param String disk_type: Disk type.
+
+        """
+        if disk_data.get('description') == disk_type:
+            if "add" in disk_type:
+                raise SoftLayerError("Unable to add the disk because this already exists.")
+            if "resize" in disk_type:
+                raise SoftLayerError("Unable to resize the disk because this does not exists.")
+        else:
+            price_id = self._get_prices_for_upgrade_option(upgrade_prices, disk_channel,
+                                                           disk_data.get('capacity'))
+            if not price_id:
+                raise SoftLayerError("The item price was not found for %s with 'capacity:' %i" %
+                                     (disk_channel, disk_data.get('capacity')))
+
+            disk_price = {
+                "id": price_id.get('id'),
+                "categories": [
+                    {
+                        "categoryCode": price_id['categories'][0]['categoryCode'],
+                        "id": price_id['categories'][0]['id']
+                    }
+                ]
+            }
+
+        return disk_price
+
 
 def _get_bandwidth_key(items, hourly=True, no_public=False, location=None):
     """Picks a valid Bandwidth Item, returns the KeyName"""

tests/CLI/modules/server_tests.py

@@ -944,6 +944,41 @@ def test_upgrade_test(self, confirm_mock):
                                    '--drive-controller=RAID', '--network=10000 Redundant'])
         self.assert_no_fail(result)
 
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_add_disk(self, confirm_mock):
+        confirm_mock.return_value = True
+        result = self.run_command(['hw', 'upgrade', '100', '--add-disk=1000', '2'])
+
+        self.assert_no_fail(result)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_resize_disk(self, confirm_mock):
+        confirm_mock.return_value = True
+        result = self.run_command(['hw', 'upgrade', '100', '--resize-disk=1000', '1'])
+
+        self.assert_no_fail(result)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_disk_not_price_found(self, confirm_mock):
+        confirm_mock.return_value = False
+        result = self.run_command(['hw', 'upgrade', '100', '--add-disk=1000', '3'])
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_disk_already_exist(self, confirm_mock):
+        confirm_mock.return_value = False
+        result = self.run_command(['hw', 'upgrade', '100', '--add-disk=1000', '1'])
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_disk_does_not_exist(self, confirm_mock):
+        confirm_mock.return_value = False
+        result = self.run_command(['hw', 'upgrade', '100', '--resize-disk=1000', '3'])
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
     @mock.patch('SoftLayer.CLI.formatting.confirm')
     def test_upgrade(self, confirm_mock):
         confirm_mock.return_value = True

tests/managers/hardware_tests.py

@@ -869,6 +869,13 @@ def test_get_price_id_mismatch_capacity(self):
         result = self.hardware._get_prices_for_upgrade_option(upgrade_prices, 'memory', 1)
         self.assertEqual(92, result)
 
+    def test_get_price_id_disk_capacity(self):
+        upgrade_prices = [
+            {'categories': [{'categoryCode': 'disk1'}], 'item': {'capacity': 1}, 'id': 99}
+        ]
+        result = self.hardware._get_prices_for_upgrade_option(upgrade_prices, 'disk1', 1)
+        self.assertEqual(99, result['id'])
+
     def test_upgrade(self):
         result = self.hardware.upgrade(1, memory=32)
 
@@ -878,6 +885,30 @@ def test_upgrade(self):
         order_container = call.args[0]
         self.assertEqual(order_container['prices'], [{'id': 209391}])
 
+    def test_upgrade_add_disk(self):
+        disk_list = list()
+        disks = {'description': 'add_disk', 'capacity': 1000, 'number': 2}
+        disk_list.append(disks)
+        result = self.hardware.upgrade(1, disk=disk_list)
+
+        self.assertEqual(result, True)
+        self.assert_called_with('SoftLayer_Product_Order', 'placeOrder')
+        call = self.calls('SoftLayer_Product_Order', 'placeOrder')[0]
+        order_container = call.args[0]
+        self.assertEqual(order_container['prices'][0]['id'], 49759)
+
+    def test_upgrade_resize_disk(self):
+        disk_list = list()
+        disks = {'description': 'resize_disk', 'capacity': 1000, 'number': 1}
+        disk_list.append(disks)
+        result = self.hardware.upgrade(1, disk=disk_list)
+
+        self.assertEqual(result, True)
+        self.assert_called_with('SoftLayer_Product_Order', 'placeOrder')
+        call = self.calls('SoftLayer_Product_Order', 'placeOrder')[0]
+        order_container = call.args[0]
+        self.assertEqual(order_container['prices'][0]['id'], 49759)
+
     def test_upgrade_blank(self):
         result = self.hardware.upgrade(1)