Fixed #511 - Add option to perform license validation

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

Author: chinyeungli

CHANGELOG.rst

@@ -1,5 +1,11 @@
 ==============================
 Changelog
+2022-10-24
+    Release 7.2.0
+
+    * Add option to validate `license_expression` in the `check` command
+
+
 2022-10-24
     Release 7.1.1
 

about.ABOUT

@@ -1,6 +1,6 @@
 about_resource: .
 name: AboutCode-toolkit
-version: 7.1.1
+version: 7.2.0
 author: Jillian Daguil, Chin Yeung Li, Philippe Ombredanne, Thomas Druez
 copyright: Copyright (c) nexB Inc.
 description: |

docs/source/reference.rst

@@ -177,6 +177,7 @@ Options
 
         ..  code-block:: none
 
+                --license              Validate the license_expression value in the input.
                 --djc api_url api_key  Validate license_expression from a DejaCode License
                                        Library API URL using the API KEY.
                 --log FILE             Path to a file to save the error messages if any.
@@ -193,6 +194,14 @@ Details
 
         ..  code-block:: none
 
+                --license
+                    Validate the license_expression value in the input.
+
+                    If this option is not flagged, only the basic syntax is checked.
+                    No validation of the license_expression value.
+
+                 $ about check --license /home/project/about_files/
+
                 ---djc
 
                     Validate license_expression from a DejaCode License.
@@ -204,7 +213,7 @@ Details
                     In addition, the input needs to have the 'license_expression' field.
                     (Please contact nexB to get the api_* value for this feature)
 
-                $ about check --djc 'api_url' 'api_key' /home/project/about_files/
+                $ about check --license --djc 'api_url' 'api_key' /home/project/about_files/
 
                 --log
 

src/attributecode/__init__.py

@@ -20,7 +20,7 @@
 
 import saneyaml
 
-__version__ = '7.1.1'
+__version__ = '7.2.0'
 
 __about_spec_version__ = '3.2.3'
 

src/attributecode/cmd.py

@@ -675,6 +675,10 @@ def collect_redist_src(location, output, from_inventory, with_structures, zip, q
     type=click.Path(
         exists=True, file_okay=True, dir_okay=True, readable=True, resolve_path=True))
 
+@click.option('--license',
+    is_flag=True,
+    help='Validate the license_expression value in the input.')
+
 @click.option('--djc',
     nargs=2,
     type=str,
@@ -692,7 +696,7 @@ def collect_redist_src(location, output, from_inventory, with_structures, zip, q
     help='Show all error and warning messages.')
 
 @click.help_option('-h', '--help')
-def check(location, djc, log, verbose):
+def check(location, license, djc, log, verbose):
     """
 Check .ABOUT file(s) at LOCATION for validity and print error messages.
 
@@ -716,10 +720,11 @@ def check(location, djc, log, verbose):
     errors, abouts = collect_inventory(location)
 
     # Validate license_expression
-    from_check = True
-    _key_text_dict, errs = pre_process_and_fetch_license_dict(abouts, from_check, api_url, api_key)
-    for e in errs:
-        errors.append(e)
+    if license:
+        from_check = True
+        _key_text_dict, errs = pre_process_and_fetch_license_dict(abouts, from_check, api_url, api_key)
+        for e in errs:
+            errors.append(e)
 
     severe_errors_count = report_errors(errors, quiet=False, verbose=verbose, log_file_loc=log)
     sys.exit(severe_errors_count)

tests/testdata/test_cmd/help/about_check_help.txt

@@ -5,6 +5,7 @@ Usage: about check [OPTIONS] LOCATION
   LOCATION: Path to an ABOUT file or a directory with ABOUT files.
 
 Options:
+  --license              Validate the license_expression value in the input.
   --djc api_url api_key  Validate license_expression from a DejaCode License
                          Library API URL using the API KEY.
   --log FILE             Path to a file to save the error messages if any.