fixing testing issues related to new tables

Author: allmightyspiff

SoftLayer/CLI/call_api.py

@@ -172,7 +172,7 @@ def cli(env, service, method, parameters, _id, _filters, mask, limit, offset, or
     }
 
     if output_python:
-        env.out(_build_python_example(args, kwargs))
+        env.python_output(_build_python_example(args, kwargs))
     else:
         result = env.client.call(*args, **kwargs)
         env.fout(formatting.iter_to_table(result))

SoftLayer/CLI/environment.py

@@ -10,6 +10,7 @@
 import click
 import pkg_resources
 from rich.console import Console
+from rich.syntax import Syntax
 
 import SoftLayer
 from SoftLayer.CLI import formatting
@@ -33,6 +34,7 @@ def __init__(self):
         self.vars = {}
 
         self.client = None
+        self.console = Console()
         self.format = 'table'
         self.skip_confirmations = False
         self.config_file = None
@@ -41,16 +43,19 @@ def __init__(self):
 
     def out(self, output):
         """Outputs a string to the console (stdout)."""
-        console = Console()
-        if self.format in ('json', 'jsonraw'):
-            console.print_json(output)
+        if self.format == 'json':
+            self.console.print_json(output)
+        elif self.format == 'jsonraw':
+            #  Using Rich here is problematic because in the unit tests it thinks the terminal is 80 characters wide
+            #  and only prints out that many characters.
+            click.echo(output)
         else:
             # If we want to print a list of tables, Rich doens't handle that well.
             if isinstance(output, list):
                 for line in output:
-                    console.print(line)
+                    self.console.print(line)
             else:
-                console.print(output)
+                self.console.print(output)
 
     def err(self, output, newline=True):
         """Outputs an error string to the console (stderr)."""
@@ -75,6 +80,10 @@ def fout(self, output):
                 # If we hit an undecodeable entry, just try outputting as json.
                 self.out(self.fmt(output, 'json'))
 
+    def python_output(self, output):
+        """Prints out python code"""
+        self.console.print(Syntax(output, "python"))
+
     def input(self, prompt, default=None, show_default=True):
         """Provide a command prompt."""
         return click.prompt(prompt, default=default, show_default=show_default)

SoftLayer/CLI/formatting.py

@@ -25,8 +25,10 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
     :param data: One of: String, Table, FormattedItem, List, Tuple, SequentialOutput
     :param string fmt (optional): One of: table, raw, json, python
     """
-    if fmt in ('json', 'jsonraw'):
+    if fmt == 'json':
         return json.dumps(data, indent=4, cls=CLIJSONEncoder)
+    elif fmt == 'jsonraw':
+        return json.dumps(data, cls=CLIJSONEncoder)
 
     if isinstance(data, str) or isinstance(data, rTable):    
         return data
@@ -65,7 +67,7 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
         return output
 
     # fallback, convert this odd object to a string
-    print(f"Casting this to string {data}")
+    # print(f"Casting this to string {data}")
     return str(data)
 
 

tests/CLI/modules/account_tests.py

@@ -44,11 +44,14 @@ def test_event_jsonraw_output(self):
         command = '--format jsonraw account events'
         command_params = command.split()
         result = self.run_command(command_params)
+
         json_text_tables = result.stdout.split('\n')
+        print("RESULT: {}".format(result.output))
         # removing an extra item due to an additional Newline at the end of the output
         json_text_tables.pop()
         # each item in the json_text_tables should be a list
         for json_text_table in json_text_tables:
+            print("TESTING THIS: \n{}\n".format(json_text_table))
             json_table = json.loads(json_text_table)
             self.assertIsInstance(json_table, list)
 

tests/CLI/modules/block_tests.py

@@ -166,13 +166,11 @@ def test_volume_list_reduced_notes_format_output_table(self, list_mock):
         list_mock.return_value = [
             {'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', 'block', '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)
 
     def test_volume_list_order(self):
         result = self.run_command(['block', 'volume-list', '--order=1234567'])

tests/CLI/modules/call_api_tests.py

@@ -93,8 +93,9 @@ def test_python_output(self):
                                    '--id=100',
                                    '-f nested.property=5432',
                                    '--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()
@@ -162,14 +163,12 @@ def test_object_table(self):
 
         self.assert_no_fail(result)
         # NOTE(kmcdonald): Order is not guaranteed
-        self.assertIn(":........:........:", result.output)
-        self.assertIn(":   name : value  :", result.output)
-        self.assertIn(":    int : 10     :", result.output)
-        self.assertIn(":   None : None   :", result.output)
-        self.assertIn(":  float : 1.0    :", result.output)
-        self.assertIn(":   Bool : True   :", result.output)
-        self.assertIn(": string : string :", result.output)
-        self.assertIn(":........:........:", result.output)
+        self.assertIn("│   name │ value  │", result.output)
+        self.assertIn("│    int │ 10     │", result.output)
+        self.assertIn("│   None │ None   │", result.output)
+        self.assertIn("│  float │ 1.0    │", result.output)
+        self.assertIn("│   Bool │ True   │", result.output)
+        self.assertIn("│ string │ string │", result.output)
 
     def test_object_nested(self):
         mock = self.set_mock('SoftLayer_Service', 'method')
@@ -210,11 +209,11 @@ def test_list_table(self):
 
         self.assert_no_fail(result)
         self.assertEqual(result.output,
-                         """:......:......:.......:.....:........:
-: Bool : None : float : int : string :
-:......:......:.......:.....:........:
-: True : None :  1.0  :  10 : string :
-:......:......:.......:.....:........:
+                         """┌──────┬──────┬───────┬─────┬────────┐
+│ Bool │ None │ float │ int │ string │
+├──────┼──────┼───────┼─────┼────────┤
+│ True │ None │  1.0  │ 10  │ string │
+└──────┴──────┴───────┴─────┴────────┘
 """)
 
     def test_parameters(self):