Make --todo output more prominent in results

Signed-off-by: Ayan Sinha Mahapatra <[email protected]>

Author: AyanSinhaMahapatra

src/licensedcode/plugin_license.py

@@ -78,7 +78,7 @@ class LicenseScanner(ScanPlugin):
     )
 
     run_order = 4
-    sort_order = 4
+    sort_order = 5
 
     options = [
         PluggableCommandLineOption(('-l', '--license'),

src/packagedcode/plugin_package.py

@@ -146,7 +146,7 @@ class PackageScanner(ScanPlugin):
     required_plugins = ['scan:licenses']
 
     run_order = 3
-    sort_order = 3
+    sort_order = 4
 
     options = [
         PluggableCommandLineOption(

src/summarycode/todo.py

@@ -70,7 +70,7 @@ class AmbiguousDetectionsToDoPlugin(PostScanPlugin):
     """
     Summarize a scan by compiling review items of ambiguous detections.
     """
-    sort_order = 10
+    sort_order = 3
 
     resource_attributes = dict(for_todo=attr.ib(default=attr.Factory(list)))
     codebase_attributes = dict(todo=attr.ib(default=attr.Factory(list)))

tests/summarycode/data/todo/no_todo/base64-arraybuffer.expected.json

@@ -1,4 +1,32 @@
 {
+  "summary": {
+    "declared_license_expression": "mit",
+    "license_clarity_score": {
+      "score": 100,
+      "declared_license": true,
+      "identification_precision": true,
+      "has_license_text": true,
+      "declared_copyrights": true,
+      "conflicting_license_categories": false,
+      "ambiguous_compound_licensing": false
+    },
+    "declared_holder": "Niklas von Hertzen",
+    "primary_language": "JavaScript",
+    "other_license_expressions": [
+      {
+        "value": null,
+        "count": 1
+      }
+    ],
+    "other_holders": [
+      {
+        "value": null,
+        "count": 2
+      }
+    ],
+    "other_languages": []
+  },
+  "todo": [],
   "packages": [
     {
       "type": "npm",
@@ -309,7 +337,6 @@
       ]
     }
   ],
-  "todo": [],
   "files": [
     {
       "path": "base64-arraybuffer-0.1.4",
@@ -330,6 +357,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": true,
+      "is_key_file": false,
       "package_data": [],
       "for_packages": [],
       "detected_license_expression": null,
@@ -340,7 +373,6 @@
       "copyrights": [],
       "holders": [],
       "authors": [],
-      "for_todo": [],
       "files_count": 5,
       "dirs_count": 1,
       "size_count": 4564,
@@ -365,6 +397,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": true,
+      "is_key_file": false,
       "package_data": [],
       "for_packages": [
         "pkg:npm/[email protected]?uuid=fixed-uid-done-for-testing-5642512d1758"
@@ -377,7 +415,6 @@
       "copyrights": [],
       "holders": [],
       "authors": [],
-      "for_todo": [],
       "files_count": 0,
       "dirs_count": 0,
       "size_count": 0,
@@ -402,6 +439,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": true,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": true,
+      "is_key_file": true,
       "package_data": [],
       "for_packages": [
         "pkg:npm/[email protected]?uuid=fixed-uid-done-for-testing-5642512d1758"
@@ -448,7 +491,6 @@
         }
       ],
       "authors": [],
-      "for_todo": [],
       "files_count": 0,
       "dirs_count": 0,
       "size_count": 0,
@@ -473,6 +515,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": true,
+      "is_top_level": true,
+      "is_key_file": true,
       "package_data": [],
       "for_packages": [
         "pkg:npm/[email protected]?uuid=fixed-uid-done-for-testing-5642512d1758"
@@ -519,7 +567,6 @@
         }
       ],
       "authors": [],
-      "for_todo": [],
       "files_count": 0,
       "dirs_count": 0,
       "size_count": 0,
@@ -544,6 +591,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": true,
+      "is_key_file": false,
       "package_data": [],
       "for_packages": [
         "pkg:npm/[email protected]?uuid=fixed-uid-done-for-testing-5642512d1758"
@@ -556,7 +609,6 @@
       "copyrights": [],
       "holders": [],
       "authors": [],
-      "for_todo": [],
       "files_count": 1,
       "dirs_count": 0,
       "size_count": 1704,
@@ -581,6 +633,12 @@
       "is_media": false,
       "is_source": true,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": false,
+      "is_key_file": false,
       "package_data": [],
       "for_packages": [
         "pkg:npm/[email protected]?uuid=fixed-uid-done-for-testing-5642512d1758"
@@ -627,7 +685,6 @@
         }
       ],
       "authors": [],
-      "for_todo": [],
       "files_count": 0,
       "dirs_count": 0,
       "size_count": 0,
@@ -652,6 +709,12 @@
       "is_media": false,
       "is_source": false,
       "is_script": false,
+      "for_todo": [],
+      "is_legal": false,
+      "is_manifest": false,
+      "is_readme": false,
+      "is_top_level": false,
+      "is_key_file": false,
       "package_data": [
         {
           "type": "npm",
@@ -864,7 +927,6 @@
           "end_line": 7
         }
       ],
-      "for_todo": [],
       "files_count": 0,
       "dirs_count": 0,
       "size_count": 0,

tests/summarycode/data/todo/todo_present/README.multi-orig-tarball-package-expected-diag.json

@@ -1,5 +1,4 @@
 {
-  "license_detections": [],
   "todo": [
     {
       "detection_id": "borceux-d99f172d-bc25-b4f7-b6bf-cccec1995ce5",
@@ -39,10 +38,14 @@
       }
     }
   ],
+  "license_detections": [],
   "files": [
     {
       "path": "README.multi-orig-tarball-package",
       "type": "file",
+      "for_todo": [
+        "borceux-d99f172d-bc25-b4f7-b6bf-cccec1995ce5"
+      ],
       "detected_license_expression": null,
       "detected_license_expression_spdx": null,
       "license_detections": [],
@@ -65,9 +68,6 @@
         }
       ],
       "percentage_of_license_text": 10.53,
-      "for_todo": [
-        "borceux-d99f172d-bc25-b4f7-b6bf-cccec1995ce5"
-      ],
       "scan_errors": []
     }
   ]

tests/summarycode/data/todo/todo_present/incomplete-setup-cfg-expected.json

@@ -1,6 +1,4 @@
 {
-  "packages": [],
-  "dependencies": [],
   "todo": [
     {
       "detection_id": "pkg:pypi/scancode-toolkit-e7ce965e-449d-5c31-b5e4-5ad0dfd29f5c",
@@ -53,10 +51,15 @@
       }
     }
   ],
+  "packages": [],
+  "dependencies": [],
   "files": [
     {
       "path": "incomplete-setup.cfg",
       "type": "file",
+      "for_todo": [
+        "pkg:pypi/scancode-toolkit-e7ce965e-449d-5c31-b5e4-5ad0dfd29f5c"
+      ],
       "package_data": [
         {
           "type": "pypi",
@@ -104,9 +107,6 @@
         }
       ],
       "for_packages": [],
-      "for_todo": [
-        "pkg:pypi/scancode-toolkit-e7ce965e-449d-5c31-b5e4-5ad0dfd29f5c"
-      ],
       "scan_errors": []
     }
   ]

tests/summarycode/data/todo/todo_present/unknown-license-expected.json

@@ -1,29 +1,4 @@
 {
-  "license_detections": [
-    {
-      "identifier": "unknown-b0897d47-1c91-9898-2364-2e4d1a34b6fd",
-      "license_expression": "unknown",
-      "license_expression_spdx": "LicenseRef-scancode-unknown",
-      "detection_count": 1,
-      "reference_matches": [
-        {
-          "license_expression": "unknown",
-          "license_expression_spdx": "LicenseRef-scancode-unknown",
-          "from_file": "unknown-license.txt",
-          "start_line": 1,
-          "end_line": 10,
-          "matcher": "6-unknown",
-          "score": 86.89,
-          "matched_length": 53,
-          "match_coverage": 100.0,
-          "rule_relevance": 100,
-          "rule_identifier": "license-detection-unknown-51bcd994ad60981fff8c5f1b1b9af6e3d4f5ba67",
-          "rule_url": null,
-          "matched_text": "form shall mean the preferred form for making\nthe purposes of this definition control\nsoftware is modified by someone else\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof."
-        }
-      ]
-    }
-  ],
   "todo": [
     {
       "detection_id": "unknown-b0897d47-1c91-9898-2364-2e4d1a34b6fd",
@@ -60,10 +35,38 @@
       }
     }
   ],
+  "license_detections": [
+    {
+      "identifier": "unknown-b0897d47-1c91-9898-2364-2e4d1a34b6fd",
+      "license_expression": "unknown",
+      "license_expression_spdx": "LicenseRef-scancode-unknown",
+      "detection_count": 1,
+      "reference_matches": [
+        {
+          "license_expression": "unknown",
+          "license_expression_spdx": "LicenseRef-scancode-unknown",
+          "from_file": "unknown-license.txt",
+          "start_line": 1,
+          "end_line": 10,
+          "matcher": "6-unknown",
+          "score": 86.89,
+          "matched_length": 53,
+          "match_coverage": 100.0,
+          "rule_relevance": 100,
+          "rule_identifier": "license-detection-unknown-51bcd994ad60981fff8c5f1b1b9af6e3d4f5ba67",
+          "rule_url": null,
+          "matched_text": "form shall mean the preferred form for making\nthe purposes of this definition control\nsoftware is modified by someone else\n\n\n\nrepresent, as a whole, an original work of authorship. For the purposes\n      of this License, Derivative Works shall not include works that remain\n      separable from, or merely link (or bind by name) to the interfaces of,\n      the Work and Derivative Works thereof."
+        }
+      ]
+    }
+  ],
   "files": [
     {
       "path": "unknown-license.txt",
       "type": "file",
+      "for_todo": [
+        "unknown-b0897d47-1c91-9898-2364-2e4d1a34b6fd"
+      ],
       "detected_license_expression": "unknown",
       "detected_license_expression_spdx": "LicenseRef-scancode-unknown",
       "license_detections": [
@@ -92,9 +95,6 @@
       ],
       "license_clues": [],
       "percentage_of_license_text": 86.89,
-      "for_todo": [
-        "unknown-b0897d47-1c91-9898-2364-2e4d1a34b6fd"
-      ],
       "scan_errors": []
     }
   ]

tests/summarycode/test_todo.py

@@ -30,6 +30,8 @@ def test_end2end_todo_works_on_codebase_without_ambiguous_detections(self):
         run_scan_click([
             '-clip',
             '--todo',
+            '--classify',
+            '--summary',
             '--json-pp', result_file, test_dir
         ])
         check_json_scan(expected_file, result_file, remove_uuid=True, remove_file_date=True, regen=REGEN_TEST_FIXTURES)