Merge branch 'softlayer:master' into ft/hw_upgrade_table

Author: FernandoOjeda

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+
+## [5.9.5] - 2021-05-25
+https://github.com/softlayer/softlayer-python/compare/v5.9.4...v5.9.5
+
+#### Improvements
+- Changed a testing domain to one that really doesnt exist #1492
+- Fix Incomplete notes field for file and block #1484
+- Show component versions on hw detail #1470
+- Add the firewall information on slcli firewall detail #1475
+- Add an --orderBy parameters to call-api #1459
+- Add image detail transaction data #1479
+
+
+
 ## [5.9.4] - 2021-04-27
 https://github.com/softlayer/softlayer-python/compare/v5.9.3...v5.9.4
 

README.rst

@@ -60,7 +60,12 @@ To install the slcli snap:
 
 .. code-block:: bash
 
-	$ sudo snap install slcli
+	$ sudo snap install slcli 
+	
+	(or to get the latest release)
+	
+	$ sudo snap install slcli --edge
+	
 	
 
 

SoftLayer/CLI/block/list.py

@@ -5,8 +5,7 @@
 import SoftLayer
 from SoftLayer.CLI import columns as column_helper
 from SoftLayer.CLI import environment
-from SoftLayer.CLI import formatting
-
+from SoftLayer.CLI import storage_utils
 
 COLUMNS = [
     column_helper.Column('id', ('id',), mask="id"),
@@ -18,7 +17,7 @@
         'storage_type',
         lambda b: b['storageType']['keyName'].split('_').pop(0)
         if 'storageType' in b and 'keyName' in b['storageType']
-        and isinstance(b['storageType']['keyName'], str)
+           and isinstance(b['storageType']['keyName'], str)
         else '-',
         mask="storageType.keyName"),
     column_helper.Column('capacity_gb', ('capacityGb',), mask="capacityGb"),
@@ -52,8 +51,6 @@
     'notes'
 ]
 
-DEFAULT_NOTES_SIZE = 20
-
 
 @click.command()
 @click.option('--username', '-u', help='Volume username')
@@ -78,24 +75,5 @@ def cli(env, sortby, columns, datacenter, username, storage_type, order):
                                                      order=order,
                                                      mask=columns.mask())
 
-    table = formatting.Table(columns.columns)
-    table.sortby = sortby
-
-    _reduce_notes(block_volumes)
-
-    for block_volume in block_volumes:
-        table.add_row([value or formatting.blank()
-                       for value in columns.row(block_volume)])
-
+    table = storage_utils.build_output_table(env, block_volumes, columns, sortby)
     env.fout(table)
-
-
-def _reduce_notes(block_volumes):
-    """Reduces the size of the notes in a volume list.
-
-    :param block_volumes: An list of block volumes
-    """
-    for block_volume in block_volumes:
-        if len(block_volume.get('notes', '')) > DEFAULT_NOTES_SIZE:
-            shortened_notes = block_volume['notes'][:DEFAULT_NOTES_SIZE]
-            block_volume['notes'] = shortened_notes

SoftLayer/CLI/environment.py

@@ -52,6 +52,10 @@ def fmt(self, output, fmt=None):
             fmt = self.format
         return formatting.format_output(output, fmt)
 
+    def format_output_is_json(self):
+        """Return True if format output is json or jsonraw"""
+        return 'json' in self.format
+
     def fout(self, output, newline=True):
         """Format the input and output to the console (stdout)."""
         if output is not None:

SoftLayer/CLI/file/list.py

@@ -5,7 +5,7 @@
 import SoftLayer
 from SoftLayer.CLI import columns as column_helper
 from SoftLayer.CLI import environment
-from SoftLayer.CLI import formatting
+from SoftLayer.CLI import storage_utils
 
 COLUMNS = [
     column_helper.Column('id', ('id',), mask="id"),
@@ -76,24 +76,5 @@ def cli(env, sortby, columns, datacenter, username, storage_type, order):
                                                   order=order,
                                                   mask=columns.mask())
 
-    table = formatting.Table(columns.columns)
-    table.sortby = sortby
-
-    _reduce_notes(file_volumes)
-
-    for file_volume in file_volumes:
-        table.add_row([value or formatting.blank()
-                       for value in columns.row(file_volume)])
-
+    table = storage_utils.build_output_table(env, file_volumes, columns, sortby)
     env.fout(table)
-
-
-def _reduce_notes(file_volumes):
-    """Reduces the size of the notes in a volume list.
-
-    :param file_volumes: An list of file volumes
-    """
-    for file_volume in file_volumes:
-        if len(file_volume.get('notes', '')) > DEFAULT_NOTES_SIZE:
-            shortened_notes = file_volume['notes'][:DEFAULT_NOTES_SIZE]
-            file_volume['notes'] = shortened_notes

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/CLI/storage_utils.py

@@ -2,6 +2,43 @@
 # :license: MIT, see LICENSE for more details.
 
 from SoftLayer.CLI import columns as column_helper
+from SoftLayer.CLI import formatting
+
+DEFAULT_NOTES_SIZE = 20
+
+
+def reduce_notes(volumes, env):
+    """Reduces all long notes found in the volumes list just if the format output is different from a JSON format.
+
+    :param list volumes: An list of storage volumes
+    :param env :A environment console.
+    """
+    if env.format_output_is_json():
+        return
+
+    for volume in volumes:
+        if len(volume.get('notes', '')) > DEFAULT_NOTES_SIZE:
+            shortened_notes = volume['notes'][:DEFAULT_NOTES_SIZE]
+            volume['notes'] = shortened_notes
+
+
+def build_output_table(env, volumes, columns, sortby):
+    """Builds a formatting table for a list of volumes.
+
+        :param env :A Environment console.
+        :param list volumes: An list of storage volumes
+        :param columns :A ColumnFormatter for column names
+        :param str sortby :A string to sort by.
+        """
+    table = formatting.Table(columns.columns)
+    if sortby in table.columns:
+        table.sortby = sortby
+
+    reduce_notes(volumes, env)
+    for volume in volumes:
+        table.add_row([value or formatting.blank()
+                       for value in columns.row(volume)])
+    return table
 
 
 def _format_name(obj):
@@ -96,7 +133,6 @@ def _format_name(obj):
 """),
 ]
 
-
 DEFAULT_COLUMNS = [
     'id',
     'name',

SoftLayer/CLI/virt/create.py

@@ -177,7 +177,7 @@ def _parse_create_args(client, args):
               help="Forces the VS to only have access the private network")
 @click.option('--like', is_eager=True, callback=_update_with_like_args,
               help="Use the configuration from an existing VS")
-@click.option('--network', '-n', help="Network port speed in Mbps")
+@click.option('--network', '-n', help="Network port speed in Mbps", type=click.INT)
 @helpers.multi_option('--tag', '-g', help="Tags to add to the instance")
 @click.option('--template', '-t', is_eager=True,
               callback=template.TemplateCallback(list_args=['disk', 'key', 'tag']),

SoftLayer/consts.py

@@ -5,7 +5,7 @@
 
     :license: MIT, see LICENSE for more details.
 """
-VERSION = 'v5.9.4'
+VERSION = 'v5.9.5'
 API_PUBLIC_ENDPOINT = 'https://api.softlayer.com/xmlrpc/v3.1/'
 API_PRIVATE_ENDPOINT = 'https://api.service.softlayer.com/xmlrpc/v3.1/'
 API_PUBLIC_ENDPOINT_REST = 'https://api.softlayer.com/rest/v3.1/'

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"
+            }]}}]