Merge pull request #1470 from caberos/issue1465

Show component versions on hw detail

Author: allmightyspiff

SoftLayer/CLI/hardware/detail.py

@@ -9,13 +9,16 @@
 from SoftLayer.CLI import helpers
 from SoftLayer import utils
 
+# pylint: disable=R0915
+
 
 @click.command()
 @click.argument('identifier')
 @click.option('--passwords', is_flag=True, help='Show passwords (check over your shoulder!)')
 @click.option('--price', is_flag=True, help='Show associated prices')
+@click.option('--components', is_flag=True, default=False, help='Show associated hardware components')
 @environment.pass_env
-def cli(env, identifier, passwords, price):
+def cli(env, identifier, passwords, price, components):
     """Get details for a hardware device."""
 
     hardware = SoftLayer.HardwareManager(env.client)
@@ -66,7 +69,7 @@ def cli(env, identifier, passwords, price):
                                         utils.clean_time(utils.lookup(result, 'lastTransaction', 'modifyDate')))
 
     table.add_row(['last_transaction', last_transaction])
-    table.add_row(['billing', 'Hourly' if result['hourlyBillingFlag'] else'Monthly'])
+    table.add_row(['billing', 'Hourly' if result['hourlyBillingFlag'] else 'Monthly'])
 
     vlan_table = formatting.Table(['type', 'number', 'id'])
     for vlan in result['networkVlans']:
@@ -107,6 +110,24 @@ def cli(env, identifier, passwords, price):
             pass_table.add_row([item['username'], item['password']])
         table.add_row(['remote users', pass_table])
 
+    if components:
+        components = hardware.get_components(identifier)
+        components_table = formatting.Table(['name', 'Firmware version', 'Firmware build date', 'Type'])
+        components_table.align['date'] = 'l'
+        component_ids = []
+        for hw_component in components:
+            if hw_component['id'] not in component_ids:
+                firmware = hw_component['hardwareComponentModel']['firmwares'][0]
+                components_table.add_row([utils.lookup(hw_component, 'hardwareComponentModel', 'longDescription'),
+                                          utils.lookup(firmware, 'version'),
+                                          utils.clean_time(utils.lookup(firmware, 'createDate')),
+                                          utils.lookup(hw_component, 'hardwareComponentModel',
+                                                       'hardwareGenericComponentModel', 'hardwareComponentType',
+                                                       'keyName')])
+                component_ids.append(hw_component['id'])
+
+        table.add_row(['components', components_table])
+
     table.add_row(['tags', formatting.tags(result['tagReferences'])])
 
     env.fout(table)

SoftLayer/fixtures/SoftLayer_Hardware_Server.py

@@ -377,3 +377,21 @@
         }
     }
 ]
+
+getComponents = [{
+    "hardwareComponentModelId": 147,
+    "hardwareId": 1234,
+    "id": 369,
+    "modifyDate": "2017-11-10T16:59:38-06:00",
+    "serviceProviderId": 1,
+    "hardwareComponentModel": {
+        "name": "IMM2 - Onboard",
+        "firmwares": [
+            {
+                "createDate": "2020-09-24T13:46:29-06:00",
+                "version": "5.60"
+            },
+            {
+                "createDate": "2019-10-14T16:51:12-06:00",
+                "version": "5.10"
+            }]}}]

SoftLayer/managers/hardware.py

@@ -1030,6 +1030,41 @@ def _get_disk_price_detail(self, disk_data, upgrade_prices, disk_channel, disk_t
 
         return disk_price
 
+    def get_components(self, hardware_id, mask=None, filter_component=None):
+        """Get details about a hardware components.
+
+        :param int hardware_id: the instance ID
+        :returns: A dictionary containing a large amount of information about
+                  the specified components.
+        """
+        if not mask:
+            mask = 'id,hardwareComponentModel[longDescription,' \
+                   'hardwareGenericComponentModel[description,hardwareComponentType[keyName]],' \
+                   'firmwares[createDate,version]]'
+
+        if not filter_component:
+            filter_component = {"components": {
+                "hardwareComponentModel": {
+                    "firmwares": {
+                        "createDate": {
+                            "operation": "orderBy",
+                            "options": [
+                                {
+                                    "name": "sort",
+                                    "value": [
+                                        "DESC"
+                                    ]
+                                },
+                                {
+                                    "name": "sortOrder",
+                                    "value": [
+                                        1
+                                    ]}]}
+                    }}}}
+
+        return self.client.call('Hardware_Server', 'getComponents',
+                                mask=mask, filter=filter_component, id=hardware_id)
+
 
 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

@@ -985,3 +985,7 @@ def test_upgrade(self, confirm_mock):
                                    '--drive-controller=RAID', '--network=10000 Redundant'])
 
         self.assert_no_fail(result)
+
+    def test_components(self):
+        result = self.run_command(['hardware', 'detail', '100', '--components'])
+        self.assert_no_fail(result)

tests/managers/hardware_tests.py

@@ -928,6 +928,26 @@ def test_upgrade_full(self):
         self.assertIn({'id': 22482}, order_container['prices'])
         self.assertIn({'id': 50357}, order_container['prices'])
 
+    def test_get_components(self):
+        result = self.hardware.get_components(1234)
+        components = [{'hardwareComponentModelId': 147,
+                       'hardwareId': 1234,
+                       'id': 369,
+                       'modifyDate': '2017-11-10T16:59:38-06:00',
+                       'serviceProviderId': 1,
+                       'hardwareComponentModel':
+                           {'name': 'IMM2 - Onboard',
+                            'firmwares':
+                                [{'createDate': '2020-09-24T13:46:29-06:00',
+                                  'version': '5.60'},
+                                 {'createDate': '2019-10-14T16:51:12-06:00',
+                                  'version': '5.10'}]}}]
+        self.assert_called_with('SoftLayer_Hardware_Server', 'getComponents')
+        self.assertEqual(result, components)
+        self.assertEqual(result[0]['hardwareId'], 1234)
+        self.assertEqual(result[0]['hardwareComponentModel']['name'], 'IMM2 - Onboard')
+        self.assertEqual(result[0]['hardwareComponentModel']['firmwares'][0]['version'], '5.60')
+
 
 class HardwareHelperTests(testing.TestCase):