#318 Support different JSON format

 * Add test code

Signed-off-by: Chin Yeung Li <[email protected]>

Author: chinyeungli

src/attributecode/util.py

@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # -*- coding: utf8 -*-
 # ============================================================================
-#  Copyright (c) 2013-2017 nexB Inc. http://www.nexb.com/ - All rights reserved.
+#  Copyright (c) 2013-2018 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #  Licensed under the Apache License, Version 2.0 (the "License");
 #  you may not use this file except in compliance with the License.
 #  You may obtain a copy of the License at
@@ -427,10 +427,13 @@ def load_json(location, use_mapping=False, mapping_file=None):
         else:
             updated_results = [results]
     else:
-        updated_results = results
-    if use_mapping:
-        results = apply_mapping(updated_results, mapping_file)
-    return results
+        updated_results = sorted(results)
+
+    if use_mapping or mapping_file:
+        about_ordered_list = apply_mapping(updated_results, mapping_file)
+    else:
+        about_ordered_list = updated_results
+    return about_ordered_list
 
 
 def have_network_connection():

tests/test_util.py

@@ -301,6 +301,33 @@ def test_load_json_with_mapping(self):
         result = util.load_json(test_file, use_mapping=True)
         assert expected == result
 
+    def test_load_non_list_json_with_mapping(self):
+        test_file = get_test_loc('load/not_a_list_need_mapping.json')
+        mapping_file = get_test_loc('custom-mapping-file/mapping.config')
+        expected = [OrderedDict(
+                    [('about_file_path', '/load/this.ABOUT'),
+                     ('version', '0.11.0'),
+                     ('about_resource', '.'),
+                     ('name', 'AboutCode'),
+                     ('about_resource_path', '.'),
+                     ])
+                    ]
+        result = util.load_json(test_file, use_mapping=False, mapping_file=mapping_file)
+        assert expected == result
+
+    def test_load_non_list_json(self):
+        test_file = get_test_loc('load/not_a_list.json')
+        expected = [OrderedDict(
+                    [('about_file_path', '/load/this.ABOUT'),
+                     ('version', '0.11.0'),
+                     ('about_resource', '.'),
+                     ('name', 'AboutCode'),
+                     ('about_resource_path', '.'),
+                     ])
+                    ]
+        result = util.load_json(test_file)
+        assert expected == result
+
     def test_get_about_file_path_from_csv_using_mapping(self):
         test_file = get_test_loc('util/about.csv')
         expected = ['about.ABOUT']

tests/testdata/custom-mapping-file/mapping.config

@@ -31,7 +31,7 @@
 #
 
 # Essential Fields
-about_file_path: about_file
+about_file_path: path
 name: Component
 
 # Optional Fields

tests/testdata/load/not_a_list.json

@@ -1,5 +1,5 @@
 {
-    "path": "/load/this.ABOUT", 
+    "about_file_path": "/load/this.ABOUT", 
     "about_resource_path": ".", 
     "about_resource": ".", 
     "name": "AboutCode", 

tests/testdata/load/not_a_list_need_mapping.json

@@ -0,0 +1,7 @@
+{
+    "path": "/load/this.ABOUT", 
+    "about_resource_path": ".", 
+    "about_resource": ".", 
+    "name": "AboutCode", 
+    "version": "0.11.0"
+}

tests/testdata/load/scancode_result.json

@@ -8,68 +8,12 @@
       "type": "directory",
       "name": "test",
       "base_name": "test",
-      "extension": "",
-      "size": 0,
-      "date": null,
-      "sha1": null,
-      "md5": null,
-      "mime_type": null,
-      "file_type": null,
-      "programming_language": null,
-      "is_binary": false,
-      "is_text": false,
-      "is_archive": false,
-      "is_media": false,
-      "is_source": false,
-      "is_script": false,
-      "licenses": [],
-      "copyrights": [],
-      "emails": [],
-      "urls": [],
-      "files_count": 1,
-      "dirs_count": 0,
-      "size_count": 173,
-      "scan_errors": []
     },
     {
       "path": "test/ScanCode.ABOUT",
       "type": "file",
       "name": "ScanCode.ABOUT",
       "base_name": "ScanCode",
-      "extension": ".ABOUT",
-      "size": 173,
-      "date": "2018-03-14",
-      "sha1": "96f9a9baa6d9114a190a68f4364341d5b16a62cd",
-      "md5": "ef3544d674fa0fe93daf435dacdf6857",
-      "mime_type": "text/plain",
-      "file_type": "ASCII text",
-      "programming_language": "ActionScript 3",
-      "is_binary": false,
-      "is_text": true,
-      "is_archive": false,
-      "is_media": false,
-      "is_source": true,
-      "is_script": false,
-      "licenses": [],
-      "copyrights": [
-        {
-          "statements": [
-            "Copyright (c) 2017 nexB Inc. owner nexB Inc."
-          ],
-          "holders": [
-            "nexB Inc. owner nexB Inc."
-          ],
-          "authors": [],
-          "start_line": 5,
-          "end_line": 7
-        }
-      ],
-      "emails": [],
-      "urls": [],
-      "files_count": 0,
-      "dirs_count": 0,
-      "size_count": 0,
-      "scan_errors": []
     }
   ]
 }