Adds a new 'jsonraw' format that will print JSON without indention (softlayer#766)

sudorandom · web-flow · commit 7aca9ce012fb · 2016-10-05T15:38:21.000-05:00
* Adds a new 'jsonraw' format that will print JSON without indention

This makes it easier to parse the JSON, especially for commands that output
multiple things.

* Fixes trivial style issue
diff --git a/SoftLayer/CLI/core.py b/SoftLayer/CLI/core.py
@@ -31,7 +31,7 @@
     3: logging.DEBUG
 }
 
-VALID_FORMATS = ['table', 'raw', 'json']
+VALID_FORMATS = ['table', 'raw', 'json', 'jsonraw']
 DEFAULT_FORMAT = 'raw'
 if sys.stdout.isatty():
     DEFAULT_FORMAT = 'table'
diff --git a/SoftLayer/CLI/formatting.py b/SoftLayer/CLI/formatting.py
@@ -28,7 +28,7 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
     :param string fmt (optional): One of: table, raw, json, python
     """
     if isinstance(data, utils.string_types):
-        if fmt == 'json':
+        if fmt in ('json', 'jsonraw'):
             return json.dumps(data)
         return data
 
@@ -46,6 +46,9 @@ def format_output(data, fmt='table'):  # pylint: disable=R0911,R0912
                 format_output(data, fmt='python'),
                 indent=4,
                 cls=CLIJSONEncoder)
+        elif fmt == 'jsonraw':
+            return json.dumps(format_output(data, fmt='python'),
+                              CLIJSONEncoder)
         elif fmt == 'python':
             return data.to_python()
 
diff --git a/tests/CLI/helper_tests.py b/tests/CLI/helper_tests.py
@@ -305,6 +305,21 @@ def test_format_output_json(self):
         ret = formatting.format_output('test', 'json')
         self.assertEqual('"test"', ret)
 
+    def test_format_output_jsonraw(self):
+        t = formatting.Table(['nothing'])
+        t.align['nothing'] = 'c'
+        t.add_row(['testdata'])
+        t.add_row([formatting.blank()])
+        t.sortby = 'nothing'
+        ret = formatting.format_output(t, 'jsonraw')
+        # This uses json.dumps due to slight changes in the output between
+        # py3.3 and py3.4
+        expected = json.dumps([{'nothing': 'testdata'}, {'nothing': None}])
+        self.assertEqual(expected, ret)
+
+        ret = formatting.format_output('test', 'json')
+        self.assertEqual('"test"', ret)
+
     def test_format_output_json_keyvaluetable(self):
         t = formatting.KeyValueTable(['key', 'value'])
         t.add_row(['nothing', formatting.blank()])
@@ -314,6 +329,21 @@ def test_format_output_json_keyvaluetable(self):
     "nothing": null
 }''', ret)
 
+    def test_format_output_jsonraw_keyvaluetable(self):
+        t = formatting.KeyValueTable(['key', 'value'])
+        t.add_row(['nothing', formatting.blank()])
+        t.sortby = 'nothing'
+        ret = formatting.format_output(t, 'jsonraw')
+        self.assertEqual('''{"nothing": null}''', ret)
+
+    def test_format_output_json_string(self):
+        ret = formatting.format_output("test", 'json')
+        self.assertEqual('"test"', ret)
+
+    def test_format_output_jsonraw_string(self):
+        ret = formatting.format_output("test", 'jsonraw')
+        self.assertEqual('"test"', ret)
+
     def test_format_output_formatted_item(self):
         item = formatting.FormattedItem('test', 'test_formatted')
         ret = formatting.format_output(item, 'table')
@@ -379,6 +409,16 @@ def test_format_output_unicode(self):
         t = formatting.format_output(item, 'raw')
         self.assertEqual('raw ☃', t)
 
+    def test_format_output_table_invalid_sort(self):
+        t = formatting.Table(['nothing'])
+        t.align['nothing'] = 'c'
+        t.add_row(['testdata'])
+        t.sortby = 'DOES NOT EXIST'
+        self.assertRaises(
+            exceptions.CLIHalt,
+            formatting.format_output, t, 'table',
+        )
+
 
 class TestTemplateArgs(testing.TestCase):
 

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@`
`31`	`31`	`3: logging.DEBUG`
`32`	`32`	`}`
`33`	`33`
`34`		`-VALID_FORMATS = ['table', 'raw', 'json']`
	`34`	`+VALID_FORMATS = ['table', 'raw', 'json', 'jsonraw']`
`35`	`35`	`DEFAULT_FORMAT = 'raw'`
`36`	`36`	`if sys.stdout.isatty():`
`37`	`37`	`DEFAULT_FORMAT = 'table'`