Fixed #486 - Add option to save error log in check command.

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

Author: chinyeungli

CHANGELOG.rst

@@ -15,6 +15,7 @@
     * Add ability to transform Excel formatted file 
     * Support Excel file format for `inventory`, `gen` and `attrib`
     * Add 'spdx_license_key' support
+    * Add option to save error log in `check` command
 
 2021-04-02
     Release 6.0.0

docs/source/conf.py

@@ -38,6 +38,7 @@
 # This pattern also affects html_static_path and html_extra_path.
 exclude_patterns = []
 
+master_doc = 'index'
 
 # -- Options for HTML output -------------------------------------------------
 

docs/source/reference.rst

@@ -141,9 +141,9 @@ Details
                     Users can use the following in the template to get the vartext:
                     {{ vartext['title'] }}
                     {{ vartext['header'] }}
-                
+
                 --verbose
-                
+
                     This option tells the tool to show all errors found.
                     The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
 
@@ -170,9 +170,10 @@ Options
         ..  code-block:: none
 
                 --djc api_url api_key  Validate license_expression from a DejaCode License
-                                         Library API URL using the API KEY.
-                --verbose                Show all the errors and warning
-                -h, --help               Show this message and exit.
+                                       Library API URL using the API KEY.
+                --log FILE             Path to a file to save the error messages if any.
+                --verbose              Show all error and warning messages.
+                -h, --help             Show this message and exit.
 
 Purpose
 -------
@@ -184,11 +185,17 @@ Details
 
         ..  code-block:: none
 
+                --log
+
+                    This option save the error log to the defined location
+
+                $ about check --log /home/project/error.log /home/project/about_files/
+
                 --verbose
-                
+
                     This option tells the tool to show all errors found.
                     The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
-                
+
                 $ about check --verbose /home/project/about_files/
 
 Special Notes

src/attributecode/cmd.py

@@ -592,18 +592,30 @@ def collect_redist_src(location, output, from_inventory, with_structures, zip, q
     help='Validate license_expression from a DejaCode License Library '
          'API URL using the API KEY.')
 
+@click.option('--log',
+    nargs=1,
+    metavar='FILE',
+    help='Path to a file to save the error messages if any.')
+
 @click.option('--verbose',
     is_flag=True,
     help='Show all error and warning messages.')
 
 @click.help_option('-h', '--help')
-def check(location, djc, verbose):
+def check(location, djc, log, verbose):
     """
 Check .ABOUT file(s) at LOCATION for validity and print error messages.
 
 LOCATION: Path to an ABOUT file or a directory with ABOUT files.
     """
     print_version()
+
+    if log:
+        # Check if the error log location exist and create the parent directory if not
+        parent = os.path.dirname(log)
+        if not parent:
+            os.makedirs(parent)
+
     api_url = ''
     api_key = ''
     if djc:
@@ -613,14 +625,13 @@ def check(location, djc, verbose):
     click.echo('Checking ABOUT files...')
     errors, abouts = collect_inventory(location)
 
-
     # Validate license_expression
-    key_text_dict, errs = pre_process_and_fetch_license_dict(abouts, api_url, api_key)
+    _key_text_dict, errs = pre_process_and_fetch_license_dict(abouts, api_url, api_key)
     for e in errs:
         errors.append(e)
 
     errors = unique(errors)
-    severe_errors_count = report_errors(errors, quiet=False, verbose=verbose)
+    severe_errors_count = report_errors(errors, quiet=False, verbose=verbose, log_file_loc=log)
     sys.exit(severe_errors_count)
 
 ######################################################################

src/attributecode/model.py

@@ -1607,7 +1607,6 @@ def pre_process_and_fetch_license_dict(abouts, api_url=None, api_key=None, scanc
                             license_data, errs = api.get_license_details_from_api(url, api_key, lic_key)
                             license_name = license_data.get('short_name', '')
                             license_text = license_data.get('full_text', '')
-                            license_key = license_data.get('key', '')
                             spdx_license_key = license_data.get('spdx_license_key', '')
                             for severity, message in errs: 
                                 msg = (about.about_file_path + ": " + message)

tests/testdata/test_cmd/help/about_check_help.txt

@@ -7,5 +7,6 @@ Usage: about check [OPTIONS] LOCATION
 Options:
   --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.
   --verbose              Show all error and warning messages.
   -h, --help             Show this message and exit.