Add new duration field to JSON output #1937

AUTHORS.rst

@@ -16,3 +16,4 @@ The following organizations or individuals have contributed to ScanCode:
 - Tushar Mittal @techytushar
 - Martin Petkov @MartinPetkov
 - Mrinal Paliwal @mriiinal
+- Mankaran Singh @MankaranSingh

CHANGELOG.rst

@@ -1,6 +1,10 @@
 Changelog
 =========
 
+Outputs:
+ - The "headers" attribute in JSON outputs now contains a 'duration' field. #1942
+
+
 v3.0.2 (2019-02-15)
 -------------------
 

src/scancode/cli.py

@@ -951,6 +951,7 @@ def echo_func(*_args, **_kwargs):
         codebase.counters['final:size_count'] = size_count
 
         cle.end_timestamp = time2tstamp()
+        cle.duration = time() - processing_start
         # collect these once as they are use in the headers and in the displayed summary
         errors = collect_errors(codebase, verbose)
         cle.errors = errors

src/scancode/cli_test_utils.py

@@ -227,6 +227,7 @@ def streamline_headers(headers):
         remove_windows_extra_timeout(hle.get('options', {}))
         hle.pop('start_timestamp', None)
         hle.pop('end_timestamp', None)
+        hle.pop('duration', None)
         streamline_errors(hle['errors'])
 
 

src/scancode/resource.py

@@ -133,6 +133,7 @@ class Header(object):
     notice = String(default='', help='Notice text for this tool.')
     start_timestamp = String(help='Start timestamp for this header.')
     end_timestamp = String(help='End timestamp for this header.')
+    duration = String(help='Scan duration in seconds.')
     message = String(help='Message text.')
     errors = List(help='List of error messages.')
     extra_data = Mapping(help='Mapping of extra key/values for this tool.')
@@ -153,6 +154,7 @@ def from_dict(cls, **kwargs):
             'notice',
             'start_timestamp',
             'end_timestamp',
+            'duration',
             'message',
             'errors',
             'extra_data',

tests/scancode/test_cli.py

@@ -722,6 +722,14 @@ def test_scan_errors_out_with_conflicting_verbosity_options():
             '--verbose option(s) and --verbose is used. You can set only one of '
             'these options at a time.') in result.output
 
+def test_scan_valid_duration_field_in_json_output_headers():
+    test_file = test_env.get_test_loc('license_text/test.txt')
+    result_file = test_env.get_temp_file('results.json')
+    args = ['--json', result_file, test_file]
+    run_scan_click(args)
+    with open(result_file) as result:
+        headers = json.loads(result.read())['headers']
+    assert headers[0]['duration'] >= 0
 
 @pytest.mark.scanslow
 @pytest.mark.skipif(on_windows and py3, reason='Somehow this test fails for now on Python 3')