fixing up unit tests and table edge cases

Author: allmightyspiff

SoftLayer/CLI/core.py

@@ -13,6 +13,7 @@
 
 import click
 import requests
+from rich.markup import escape
 
 import SoftLayer
 from SoftLayer.CLI.command import CommandLoader
@@ -143,9 +144,9 @@ def output_diagnostics(env, result, verbose=0, **kwargs):
         diagnostic_table = formatting.Table(['name', 'value'])
         diagnostic_table.add_row(['execution_time', '%fs' % (time.time() - START_TIME)])
 
-        api_call_value = []
+        api_call_value = formatting.Table(['API Calls'], title=None, align="left")
         for call in env.client.transport.get_last_calls():
-            api_call_value.append("%s::%s (%fs)" % (call.service, call.method, call.end_time - call.start_time))
+            api_call_value.add_row(["%s::%s (%fs)" % (call.service, call.method, call.end_time - call.start_time)])
 
         diagnostic_table.add_row(['api_calls', api_call_value])
         diagnostic_table.add_row(['version', consts.USER_AGENT])
@@ -156,13 +157,13 @@ def output_diagnostics(env, result, verbose=0, **kwargs):
 
     if verbose > 1:
         for call in env.client.transport.get_last_calls():
-            call_table = formatting.Table(['', '{}::{}'.format(call.service, call.method)])
+            call_table = formatting.Table(['', '{}::{}'.format(call.service, call.method)], align="left")
             nice_mask = ''
             if call.mask is not None:
                 nice_mask = call.mask
-
             call_table.add_row(['id', call.identifier])
-            call_table.add_row(['mask', nice_mask])
+            #  Need to escape this so Rich doesn't think the mask is a tag and hide it.
+            call_table.add_row(['mask', escape(nice_mask)])
             call_table.add_row(['filter', call.filter])
             call_table.add_row(['limit', call.limit])
             call_table.add_row(['offset', call.offset])

SoftLayer/CLI/dns/zone_import.py

@@ -5,8 +5,10 @@
 import click
 
 import SoftLayer
+from SoftLayer.CLI.command import SLCommand as SLCommand
 from SoftLayer.CLI import environment
 from SoftLayer.CLI import exceptions
+from SoftLayer.CLI import formatting
 from SoftLayer.CLI import helpers
 
 RECORD_REGEX = re.compile(r"""^((?P<domain>(([\w-]+|\*)(\.)?)*|\@)?\s+
@@ -17,9 +19,8 @@
 RECORD_FMT = "type={type}, record={record}, data={data}, ttl={ttl}"
 
 
-@click.command(cls=SoftLayer.CLI.command.SLCommand, )
-@click.argument('zonefile',
-                type=click.Path(exists=True, readable=True, resolve_path=True))
+@click.command(cls=SLCommand)
+@click.argument('zonefile', type=click.Path(exists=True, readable=True, resolve_path=True))
 @click.option('--dry-run', is_flag=True, help="Don't actually create records")
 @environment.pass_env
 def cli(env, zonefile, dry_run):
@@ -31,12 +32,12 @@ def cli(env, zonefile, dry_run):
 
     zone, records, bad_lines = parse_zone_details(zone_contents)
 
-    env.out("Parsed: zone=%s" % zone)
+    click.secho("Parsed: zone=%s" % zone)
     for record in records:
-        env.out("Parsed: %s" % RECORD_FMT.format(**record))
+        click.secho("Parsed: %s" % RECORD_FMT.format(**record), fg="green")
 
     for line in bad_lines:
-        env.out("Unparsed: %s" % line)
+        click.secho("Unparsed: %s" % line, fg="yellow")
 
     if dry_run:
         return
@@ -47,25 +48,19 @@ def cli(env, zonefile, dry_run):
                                      name='zone')
     except exceptions.CLIAbort:
         zone_id = manager.create_zone(zone)['id']
-        env.out(click.style("Created: %s" % zone, fg='green'))
+        click.secho(click.style("Created: %s" % zone, fg='green'))
 
     # Attempt to create each record
     for record in records:
         try:
-            manager.create_record(zone_id,
-                                  record['record'],
-                                  record['type'],
-                                  record['data'],
-                                  record['ttl'])
-
-            env.out(click.style("Created: %s" % RECORD_FMT.format(**record),
-                                fg='green'))
+            manager.create_record(zone_id, record['record'], record['type'], record['data'], record['ttl'])
+
+            click.secho(click.style("Created: %s" % RECORD_FMT.format(**record), fg='green'))
         except SoftLayer.SoftLayerAPIError as ex:
-            env.out(click.style("Failed: %s" % RECORD_FMT.format(**record),
-                                fg='red'))
-            env.out(click.style(str(ex), fg='red'))
+            click.secho(click.style("Failed: %s" % RECORD_FMT.format(**record), fg='red'))
+            click.secho(click.style(str(ex), fg='red'))
 
-    env.out(click.style("Finished", fg='green'))
+    click.secho(click.style("Finished", fg='green'))
 
 
 def parse_zone_details(zone_contents):
@@ -75,7 +70,10 @@ def parse_zone_details(zone_contents):
     zone_lines = [line.strip() for line in zone_contents.split('\n')]
 
     zone_search = re.search(r'^\$ORIGIN (?P<zone>.*)\.', zone_lines[0])
-    zone = zone_search.group('zone')
+    if zone_search:
+        zone = zone_search.group('zone')
+    else:
+        raise exceptions.ArgumentError("Invalid Zone File")
 
     for line in zone_lines[1:]:
         record_search = re.search(RECORD_REGEX, line)

SoftLayer/CLI/environment.py

@@ -53,13 +53,14 @@ def out(self, output):
             # If we want to print a list of tables, Rich doens't handle that well.
             if isinstance(output, list):
                 for line in output:
-                    self.console.print(line)
+                    self.console.print(line, overflow='ignore')
             else:
-                self.console.print(output)
+                self.console.print(output,  overflow='ignore')
 
     def err(self, output, newline=True):
         """Outputs an error string to the console (stderr)."""
-        click.echo(output, nl=newline, err=True)
+        error_console = Console(stderr=True)
+        error_console.print(output)
 
     def fmt(self, output, fmt=None):
         """Format output based on current the environment format."""

SoftLayer/CLI/formatting.py

@@ -93,17 +93,15 @@ def b_to_gb(_bytes):
 
     :param int _bytes: number of bytes
     """
-    return FormattedItem(_bytes,
-                         "%.2fG" % (float(_bytes) / 1024 / 1024 / 1024))
+    return FormattedItem(_bytes, "%.2fG" % (float(_bytes) / 1024 / 1024 / 1024))
 
 
 def gb(gigabytes):  # pylint: disable=C0103
     """Converts number of gigabytes to a FormattedItem in gigabytes.
 
     :param int gigabytes: number of gigabytes
     """
-    return FormattedItem(int(float(gigabytes)) * 1024,
-                         "%dG" % int(float(gigabytes)))
+    return FormattedItem(int(float(gigabytes)) * 1024, "%dG" % int(float(gigabytes)))
 
 
 def blank():
@@ -233,7 +231,7 @@ class Table(object):
     :param list columns: a list of column names
     """
 
-    def __init__(self, columns, title=None):
+    def __init__(self, columns, title=None, align={}):
         duplicated_cols = [col for col, count
                            in collections.Counter(columns).items()
                            if count > 1]
@@ -243,7 +241,7 @@ def __init__(self, columns, title=None):
 
         self.columns = columns
         self.rows = []
-        self.align = {}
+        self.align = align
         self.sortby = None
         self.title = title
 

SoftLayer/transports.py

@@ -430,7 +430,7 @@ def print_reproduceable(self, request):
 
         :param request request: Request object
         """
-        command = "curl -u $SL_USER:$SL_APIKEY -X {method} -H {headers} {data} '{uri}'"
+        command = "curl -u $SL_USER:$SL_APIKEY -X {method} -H {headers} [red]{data}[/red] [yellow]'{uri}'[/yellow]"
 
         method = REST_SPECIAL_METHODS.get(request.method)
 

tests/CLI/modules/call_api_tests.py

@@ -95,7 +95,7 @@ def test_python_output(self):
                                    '--output-python'])
         print("OUTPUT: \n{}".format(result.exception))
         self.assert_no_fail(result)
-        
+
         self.assertIsNotNone(result.output, """import SoftLayer
 
 client = SoftLayer.create_client_from_env()
@@ -293,7 +293,6 @@ def test_filter_with_filter(self):
         self.assertIsInstance(result.exception, exceptions.CLIAbort)
 
     def test_json_filter(self):
-        pass
         result = self.run_command(['call-api', 'Account', 'getObject', '--json-filter={"test":"something"}'])
         self.assert_no_fail(result)
         self.assert_called_with('SoftLayer_Account', 'getObject', filter={"test": "something"})
@@ -315,3 +314,9 @@ def test_call_api_orderBy(self):
                                                     'value': ['DESC']}]},
                                             'typeId': {'operation': 1}}
                                 })
+    def test_very_verbose(self):
+        result = self.run_command(['call-api', '-vvv', 'Account', 'getObject'])
+        self.assert_no_fail(result)
+        self.assert_called_with('SoftLayer_Account', 'getObject')
+        print(result.output)
+        self.assertEqual(result.output, "soething")

tests/CLI/modules/file_tests.py

@@ -88,12 +88,11 @@ def test_volume_list_reduced_notes_format_output_table(self, list_mock):
             {'notes': note_mock}
         ]
         expected_table = formatting.Table(['notes'])
-        expected_table.add_row([expected_reduced_note])
-        expected_output = formatting.format_output(expected_table) + '\n'
         result = self.run_command(['--format', 'table', 'file', 'volume-list', '--columns', 'notes'])
 
         self.assert_no_fail(result)
-        self.assertEqual(expected_output, result.output)
+        self.assertIn(expected_reduced_note, result.output)
+        self.assertNotIn(note_mock, result.output)
 
     @mock.patch('SoftLayer.FileStorageManager.list_file_volumes')
     def test_volume_count(self, list_mock):