Make license references a CLI option #3269

Moved license references to a CLI option and not default.

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

Author: AyanSinhaMahapatra

src/licensedcode/licenses_reference.py

@@ -14,6 +14,8 @@
 from licensedcode.models import Rule
 from plugincode.post_scan import PostScanPlugin
 from plugincode.post_scan import post_scan_impl
+from commoncode.cliutils import PluggableCommandLineOption
+from commoncode.cliutils import POST_SCAN_GROUP
 import attr
 
 TRACE = os.environ.get('SCANCODE_DEBUG_LICENSE_REFERENCE', False)
@@ -48,8 +50,18 @@ class LicenseReference(PostScanPlugin):
     # TODO: send to the tail of the scan, after files
     sort_order = 1000
 
-    def is_enabled(self, **kwargs):
-        return kwargs.get('license') or kwargs.get('package')
+    options = [
+        PluggableCommandLineOption(('--license-references',),
+            is_flag=True,
+            help='Return reference data for all licenses and license rules'
+                 'present in detections.',
+            help_group=POST_SCAN_GROUP,
+            sort_order=100,
+        )
+    ]
+
+    def is_enabled(self, license_references, **kwargs):
+        return license_references
 
     def process_codebase(self, codebase, **kwargs):
         """

tests/licensedcode/test_licenses_reference.py

@@ -24,7 +24,7 @@ def test_licenses_reference_works():
     test_dir = test_env.get_test_loc('licenses_reference_reporting/scan', copy=True)
     result_file = test_env.get_temp_file('json')
     args = [
-        '--license', '--package',
+        '--license', '--package', '--license-references',
         test_dir, '--json-pp', result_file, '--verbose'
     ]
     run_scan_click(args)
@@ -38,7 +38,7 @@ def test_licenses_reference_works_with_matched_text():
     result_file = test_env.get_temp_file('json')
     args = [
         '--license', '--package',  '--license-text', '--license-text-diagnostics',
-        test_dir, '--json-pp', result_file, '--verbose'
+        '--license-references', test_dir, '--json-pp', result_file, '--verbose'
     ]
     run_scan_click(args)
     check_json_scan(
@@ -51,7 +51,7 @@ def test_licenses_reference_works_with_license_clues():
     result_file = test_env.get_temp_file('json')
     args = [
         '--license',  '--license-text', '--license-text-diagnostics',
-        test_dir, '--json-pp', result_file, '--verbose'
+        '--license-references', test_dir, '--json-pp', result_file, '--verbose'
     ]
     run_scan_click(args)
     check_json_scan(