Merge pull request #434 from nexB/425-json-output-change

#425: JSON outputs no longer pretty-printed by default; added format …

Author: pombredanne

etc/release/release.sh

@@ -50,6 +50,8 @@ function test_scan {
             # minimal test: update when new scans are available
             ./scancode --quiet -lcip apache-2.0.LICENSE test_scan.json
             echo "TEST JSON passed: ./scancode --quiet -lcip apache-2.0.LICENSE test_scan.json"
+            ./scancode --quiet -lcip --format json-pp apache-2.0.LICENSE test_scan.json
+            echo "TEST JSON-PP passed: ./scancode --quiet -lcip --format json-pp apache-2.0.LICENSE test_scan.json"
             ./scancode --quiet -lcip --format html apache-2.0.LICENSE test_scan.html
             echo "TEST HTML passed: ./scancode --quiet -lcip --format html apache-2.0.LICENSE test_scan.html"
             ./scancode --quiet -lcip --format html-app apache-2.0.LICENSE test_scan_app.html

src/scancode/cli.py

@@ -245,7 +245,7 @@ class ScanCommand(utils.BaseCommand):
 Try 'scancode --help' for help on options and arguments.'''
 
 
-formats = ('json', 'html', 'html-app', 'spdx-tv', 'spdx-rdf')
+formats = ('json', 'json-pp', 'html', 'html-app', 'spdx-tv', 'spdx-rdf')
 
 def validate_formats(ctx, param, value):
     value_lower = value.lower()
@@ -659,7 +659,7 @@ def save_results(files_count, scanned_files, format, input, output_file):
         except HtmlAppAssetCopyError:
             echo_stderr('\nFailed to create HTML app.', fg='red')
 
-    elif format == 'json':
+    elif format == 'json' or format == 'json-pp':
         import simplejson as json
 
         meta = OrderedDict()
@@ -668,7 +668,10 @@ def save_results(files_count, scanned_files, format, input, output_file):
         meta['files_count'] = files_count
         # TODO: add scanning options to meta
         meta['files'] = scanned_files
-        output_file.write(unicode(json.dumps(meta, indent=2 * ' ', iterable_as_array=True, encoding='utf-8')))
+        if format == 'json-pp':
+            output_file.write(unicode(json.dumps(meta, indent=2 * ' ', iterable_as_array=True, encoding='utf-8')))
+        else:
+            output_file.write(unicode(json.dumps(meta, separators=(',', ':'), iterable_as_array=True, encoding='utf-8')))
         output_file.write('\n')
 
     elif format == 'spdx-tv' or format == 'spdx-rdf':

tests/scancode/data/json-option/copyright_acme_c-c.c

@@ -0,0 +1 @@
+/* Copyright © 2000 ACME, Inc., All Rights Reserved */

tests/scancode/test_cli.py

@@ -85,6 +85,34 @@ def _load_json_result(result_file):
     return scan_result
 
 
+def test_json_pretty_print_option(monkeypatch):
+    monkeypatch.setattr(click._termui_impl, 'isatty', lambda _: True)
+    test_dir = test_env.get_test_loc('json-option', copy=True)
+    runner = CliRunner()
+    result_file = test_env.get_temp_file('json')
+    result = runner.invoke(cli.scancode, ['--copyright', '--format', 'json-pp', test_dir, result_file], catch_exceptions=True)
+    assert result.exit_code == 0
+    assert 'Scanning done' in result.output
+    assert 'copyright_acme_c-c.c' in result.output
+    assert os.path.exists(result_file)
+    assert len(open(result_file).read()) > 10
+    assert len(open(result_file).readlines()) > 1
+
+
+def test_json_output_option_is_minified(monkeypatch):
+    monkeypatch.setattr(click._termui_impl, 'isatty', lambda _: True)
+    test_dir = test_env.get_test_loc('json-option', copy=True)
+    runner = CliRunner()
+    result_file = test_env.get_temp_file('json')
+    result = runner.invoke(cli.scancode, ['--copyright', '--format', 'json', test_dir, result_file], catch_exceptions=True)
+    assert result.exit_code == 0
+    assert 'Scanning done' in result.output
+    assert 'copyright_acme_c-c.c' in result.output
+    assert os.path.exists(result_file)
+    assert len(open(result_file).read()) > 10
+    assert len(open(result_file).readlines()) == 1
+    
+
 def test_package_option_detects_packages(monkeypatch):
     monkeypatch.setattr(click._termui_impl, 'isatty', lambda _: True)
     test_dir = test_env.get_test_loc('package', copy=True)