Merge pull request #1437 from FernandoOjeda/ft/upgrade_hardware

allmightyspiff · web-flow · commit c8973821d670 · 2021-03-19T13:21:47.000-05:00
Add upgrade option to slcli hw.
diff --git a/SoftLayer/CLI/hardware/upgrade.py b/SoftLayer/CLI/hardware/upgrade.py
@@ -0,0 +1,47 @@
+"""Upgrade a hardware server."""
+# :license: MIT, see LICENSE for more details.
+
+import click
+
+import SoftLayer
+from SoftLayer.CLI import environment
+from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
+from SoftLayer.CLI import helpers
+
+
+@click.command()
+@click.argument('identifier')
+@click.option('--memory', type=click.INT, help="Memory Size in GB")
+@click.option('--network', help="Network port speed in Mbps",
+              default=None,
+              type=click.Choice(['100', '100 Redundant', '100 Dual',
+                                 '1000', '1000 Redundant', '1000 Dual',
+                                 '10000', '10000 Redundant', '10000 Dual'])
+              )
+@click.option('--drive-controller',
+              help="Drive Controller",
+              default=None,
+              type=click.Choice(['Non-RAID', 'RAID']))
+@click.option('--public-bandwidth', type=click.INT, help="Public Bandwidth in GB")
+@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):
+    """Upgrade a Hardware Server."""
+
+    mgr = SoftLayer.HardwareManager(env.client)
+
+    if not any([memory, network, drive_controller, public_bandwidth]):
+        raise exceptions.ArgumentError("Must provide "
+                                       " [--memory], [--network], [--drive-controller], or [--public-bandwidth]")
+
+    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')
+
+    if not mgr.upgrade(hw_id, memory=memory, nic_speed=network, drive_controller=drive_controller,
+                       public_bandwidth=public_bandwidth, test=test):
+        raise exceptions.CLIAbort('Hardware Server Upgrade Failed')
+    env.fout('Successfully Upgraded.')
diff --git a/SoftLayer/CLI/routes.py b/SoftLayer/CLI/routes.py
@@ -258,6 +258,7 @@
     ('hardware:toggle-ipmi', 'SoftLayer.CLI.hardware.toggle_ipmi:cli'),
     ('hardware:dns-sync', 'SoftLayer.CLI.hardware.dns:cli'),
     ('hardware:storage', 'SoftLayer.CLI.hardware.storage:cli'),
+    ('hardware:upgrade', 'SoftLayer.CLI.hardware.upgrade:cli'),
 
     ('securitygroup', 'SoftLayer.CLI.securitygroup'),
     ('securitygroup:list', 'SoftLayer.CLI.securitygroup.list:cli'),
diff --git a/SoftLayer/fixtures/SoftLayer_Hardware_Server.py b/SoftLayer/fixtures/SoftLayer_Hardware_Server.py
@@ -6,6 +6,9 @@
     'billingItem': {
         'id': 6327,
         'recurringFee': 1.54,
+        'package': {
+            'id': 911
+        },
         'nextInvoiceTotalRecurringAmount': 16.08,
         'children': [
             {'description': 'test', 'nextInvoiceTotalRecurringAmount': 1},
@@ -262,3 +265,76 @@
         }
     }
 }
+
+getUpgradeItemPrices = [
+    {
+        "id": 21525,
+        "recurringFee": "0",
+        "categories": [
+            {
+                "categoryCode": "port_speed",
+                "id": 26,
+                "name": "Uplink Port Speeds",
+            }
+        ],
+        "item": {
+            "capacity": "10000",
+            "description": "10 Gbps Redundant Public & Private Network Uplinks",
+            "id": 4342,
+            "keyName": "10_GBPS_REDUNDANT_PUBLIC_PRIVATE_NETWORK_UPLINKS"
+        }
+    },
+    {
+        "hourlyRecurringFee": ".247",
+        "id": 209391,
+        "recurringFee": "164",
+        "categories": [
+            {
+                "categoryCode": "ram",
+                "id": 3,
+                "name": "RAM"
+            }
+        ],
+        "item": {
+            "capacity": "32",
+            "description": "32 GB RAM",
+            "id": 11291,
+            "keyName": "RAM_32_GB_DDR4_2133_ECC_NON_REG"
+        }
+    },
+    {
+        "hourlyRecurringFee": ".068",
+        "id": 22482,
+        "recurringFee": "50",
+        "categories": [
+            {
+                "categoryCode": "disk_controller",
+                "id": 11,
+                "name": "Disk Controller",
+            }
+        ],
+        "item": {
+            "capacity": "0",
+            "description": "RAID",
+            "id": 4478,
+            "keyName": "DISK_CONTROLLER_RAID",
+        }
+    },
+    {
+        "id": 50357,
+        "recurringFee": "0",
+        "categories": [
+            {
+                "categoryCode": "bandwidth",
+                "id": 10,
+                "name": "Public Bandwidth",
+            }
+        ],
+        "item": {
+            "capacity": "500",
+            "description": "500 GB Bandwidth Allotment",
+            "id": 6177,
+            "keyName": "BANDWIDTH_500_GB"
+        }
+    }
+]
diff --git a/SoftLayer/managers/hardware.py b/SoftLayer/managers/hardware.py
@@ -5,11 +5,13 @@
 
     :license: MIT, see LICENSE for more details.
 """
+import datetime
 import logging
 import socket
 import time
 
 from SoftLayer.decoration import retry
+from SoftLayer import exceptions
 from SoftLayer.exceptions import SoftLayerError
 from SoftLayer.managers import ordering
 from SoftLayer.managers.ticket import TicketManager
@@ -18,7 +20,7 @@
 LOGGER = logging.getLogger(__name__)
 
 # Invalid names are ignored due to long method names and short argument names
-# pylint: disable=invalid-name, no-self-use
+# pylint: disable=invalid-name, no-self-use, too-many-lines
 
 EXTRA_CATEGORIES = ['pri_ipv6_addresses',
                     'static_ipv6_addresses',
@@ -786,6 +788,146 @@ def get_hardware_item_prices(self, location):
         return self.client.call('SoftLayer_Product_Package', 'getItemPrices', mask=object_mask, filter=object_filter,
                                 id=package['id'])
 
+    def upgrade(self, instance_id, memory=None,
+                nic_speed=None, drive_controller=None,
+                public_bandwidth=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 bool test: Test option to verify the request.
+
+        :returns: bool
+        """
+        upgrade_prices = self._get_upgrade_prices(instance_id)
+        prices = []
+        data = {}
+
+        if memory:
+            data['memory'] = memory
+        if nic_speed:
+            data['nic_speed'] = nic_speed
+        if drive_controller:
+            data['disk_controller'] = drive_controller
+        if public_bandwidth:
+            data['bandwidth'] = public_bandwidth
+
+        server_response = self.get_instance(instance_id)
+        package_id = server_response['billingItem']['package']['id']
+
+        maintenance_window = datetime.datetime.now(utils.UTC())
+        order = {
+            'complexType': 'SoftLayer_Container_Product_Order_Hardware_Server_Upgrade',
+            'properties': [{
+                'name': 'MAINTENANCE_WINDOW',
+                'value': maintenance_window.strftime("%Y-%m-%d %H:%M:%S%z")
+            }],
+            'hardware': [{'id': int(instance_id)}],
+            'packageId': package_id
+        }
+
+        for option, value in data.items():
+            price_id = self._get_prices_for_upgrade_option(upgrade_prices, option, value)
+            if not price_id:
+                # Every option provided is expected to have a price
+                raise exceptions.SoftLayerError(
+                    "Unable to find %s option with value %s" % (option, value))
+
+            prices.append({'id': price_id})
+
+            order['prices'] = prices
+
+        if prices:
+            if test:
+                self.client['Product_Order'].verifyOrder(order)
+            else:
+                self.client['Product_Order'].placeOrder(order)
+            return True
+        return False
+
+    @retry(logger=LOGGER)
+    def get_instance(self, instance_id):
+        """Get details about a hardware server instance.
+
+        :param int instance_id: the instance ID
+        :returns: A dictionary containing a large amount of information about
+                  the specified instance.
+        """
+        mask = [
+            'billingItem[id,package[id,keyName]]'
+        ]
+        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):
+        """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.
+
+        :returns: list
+        """
+        mask = [
+            'id',
+            'locationGroupId',
+            'categories[name,id,categoryCode]',
+            'item[keyName,description,capacity,units]'
+        ]
+        mask = "mask[%s]" % ','.join(mask)
+        return self.hardware.getUpgradeItemPrices(include_downgrade_options, id=instance_id, mask=mask)
+
+    @staticmethod
+    def _get_prices_for_upgrade_option(upgrade_prices, option, value):
+        """Find the price id for the option and value to upgrade. This
+
+        :param list upgrade_prices: Contains all the prices related to a
+        hardware server upgrade.
+        :param string option: Describes type of parameter to be upgraded
+
+        :return: int.
+        """
+        price_id = None
+        option_category = {
+            'memory': 'ram',
+            'nic_speed': 'port_speed',
+            'disk_controller': 'disk_controller',
+            'bandwidth': 'bandwidth'
+        }
+        category_code = option_category.get(option)
+
+        for price in upgrade_prices:
+            if price.get('categories') is None or price.get('item') is None:
+                continue
+
+            product = price.get('item')
+            for category in price.get('categories'):
+                if not category.get('categoryCode') == category_code:
+                    continue
+
+                if option == 'disk_controller':
+                    if value == product.get('description'):
+                        price_id = price.get('id')
+                elif option == 'nic_speed':
+                    if value.isdigit():
+                        if str(product.get('capacity')) == str(value):
+                            price_id = price.get('id')
+                    else:
+                        split_nic_speed = value.split(" ")
+                        if str(product.get('capacity')) == str(split_nic_speed[0]) and \
+                                split_nic_speed[1] in product.get("description"):
+                            price_id = price.get('id')
+                elif option == 'bandwidth':
+                    if str(product.get('capacity')) == str(value):
+                        price_id = price.get('id')
+                else:
+                    if str(product.get('capacity')) == str(value):
+                        price_id = price.get('id')
+
+        return price_id
+
 
 def _get_bandwidth_key(items, hourly=True, no_public=False, location=None):
     """Picks a valid Bandwidth Item, returns the KeyName"""
diff --git a/docs/cli/hardware.rst b/docs/cli/hardware.rst
@@ -119,3 +119,7 @@ This function updates the firmware of a server. If already at the latest version
 .. click:: SoftLayer.CLI.hardware.guests:cli
    :prog: hardware guests
    :show-nested:
+
+.. click:: SoftLayer.CLI.hardware.upgrade:cli
+   :prog: hardware upgrade
+   :show-nested:
diff --git a/tests/CLI/modules/server_tests.py b/tests/CLI/modules/server_tests.py
@@ -903,3 +903,29 @@ def test_hardware_guests_empty(self):
         result = self.run_command(['hw', 'guests', '123456'])
         self.assertEqual(result.exit_code, 2)
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
+    def test_upgrade_no_options(self, ):
+        result = self.run_command(['hw', 'upgrade', '100'])
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.ArgumentError)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_aborted(self, confirm_mock):
+        confirm_mock.return_value = False
+        result = self.run_command(['hw', 'upgrade', '100', '--memory=1'])
+        self.assertEqual(result.exit_code, 2)
+        self.assertIsInstance(result.exception, exceptions.CLIAbort)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade_test(self, confirm_mock):
+        confirm_mock.return_value = True
+        result = self.run_command(['hw', 'upgrade', '100', '--test', '--memory=32', '--public-bandwidth=500',
+                                   '--drive-controller=RAID', '--network=10000 Redundant'])
+        self.assert_no_fail(result)
+
+    @mock.patch('SoftLayer.CLI.formatting.confirm')
+    def test_upgrade(self, confirm_mock):
+        confirm_mock.return_value = True
+        result = self.run_command(['hw', 'upgrade', '100', '--memory=32', '--public-bandwidth=500',
+                                   '--drive-controller=RAID', '--network=10000 Redundant'])
+        self.assert_no_fail(result)
diff --git a/tests/managers/hardware_tests.py b/tests/managers/hardware_tests.py
