Remove the --validate-about-resource option #306

 * Remove the `--validate-about-resource` option
 * Update USAGE doc
 * Rename `ignore_about_resource_path_error` to
`ignore_about_resource_path_not_exist_error`

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

Author: chinyeungli

USAGE.rst

@@ -45,7 +45,6 @@ attrib
                                 names - mapping.config
     --show-all                  Show all the errors and warning
     --template PATH             Path to a custom attribution template.
-    --validate-about-resource   Validate the existence of the about resource.
     -q, --quiet                 Do not print any error/warning.
     --help                      Show this message and exit.
 
@@ -94,10 +93,6 @@ Options
         For instance, if user has a custom template located at:
         /home/custom_template/template.html
 
-    --validate-about-resource
-
-        The option ask the tool to validate the existence of the referencing file.
-
     $ about attrib --template /home/custom_template/template.html LOCATION OUTPUT
 
 
@@ -178,7 +173,6 @@ gen
     --mapping                           Use for mapping between the input keys and
                                         the ABOUT field names - mapping.config
     --show-all                          Show all the errors and warning
-    --validate-about-resource           Validate the existence of the about resource.
     -q, --quiet                         Do not print any error/warning.
     --help                              Show this message and exit.
 
@@ -224,9 +218,6 @@ Options
         This option ask the tool to show all kind of errors found.
         The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
 
-    --validate-about-resource
-
-        The option ask the tool to validate the existence of the referencing file.
 
 inventory
 =========
@@ -247,7 +238,6 @@ inventory
     -f, --format [json|csv]     Set OUTPUT file format.  [default: csv]
     --mapping                   Use file mapping.config to collect the defined not supported fields in ABOUT files.
     --show-all                  Show all the errors and warning
-    --validate-about-resource   Validate the existence of the about resource.
     -q, --quiet                 Do not print any error/warning.
     --help                      Show this message and exit.
 
@@ -273,8 +263,4 @@ Options
         This option ask the tool to show all kind of errors found.
         The default behavior will only show 'CRITICAL', 'ERROR', and 'WARNING'
 
-    --validate-about-resource
-
-        The option ask the tool to validate the existence of the referencing file.
-
     $ about inventory -f json [OPTIONS] LOCATION OUTPUT

src/attributecode/cmd.py

@@ -35,7 +35,7 @@
 from attributecode import model
 from attributecode import severities
 from attributecode.util import extract_zip
-from attributecode.util import ignore_about_resource_path_error
+from attributecode.util import ignore_about_resource_path_not_exist_error
 from attributecode.util import to_posix
 
 
@@ -123,16 +123,12 @@ def cli():
         'for any level.'
 )
 
-@click.option('--validate-about-resource', is_flag=True, default=False,
-    help='Validate the existence of the about resource.'
-)
-
 @click.option('-q', '--quiet', is_flag=True,
     help='Do not print error or warning messages.')
 
 @click.help_option('-h', '--help')
 
-def inventory(location, output, mapping, quiet, format, show_all, validate_about_resource):
+def inventory(location, output, mapping, quiet, format, show_all):
     """
 Collect a JSON or CSV inventory of components from .ABOUT files.
 
@@ -161,13 +157,8 @@ def inventory(location, output, mapping, quiet, format, show_all, validate_about
     for err in write_errors:
         errors.append(err)
 
-    finalized_errors = []
+    finalized_errors = ignore_about_resource_path_not_exist_error(errors)
 
-    if not validate_about_resource:
-        finalized_errors = ignore_about_resource_path_error(errors)
-    else:
-        finalized_errors = errors
-    
     log_errors(finalized_errors, quiet, show_all, os.path.dirname(output))
     sys.exit(0)
 
@@ -212,17 +203,13 @@ def inventory(location, output, mapping, quiet, format, show_all, validate_about
         'for any level.'
 )
 
-@click.option('--validate-about-resource', is_flag=True, default=False,
-    help='Validate the existence of the about resource.'
-)
-
 @click.option('-q', '--quiet', is_flag=True,
     help='Do not print error or warning messages.')
 
 @click.help_option('-h', '--help')
 
 def gen(location, output, mapping, license_notice_text_location, fetch_license,
-        quiet, show_all, validate_about_resource):
+        quiet, show_all):
     """
 Generate .ABOUT files in OUTPUT directory from a JSON or CSV inventory of .ABOUT files at LOCATION.
 
@@ -244,12 +231,7 @@ def gen(location, output, mapping, license_notice_text_location, fetch_license,
 
     about_count = len(abouts)
     error_count = 0
-    finalized_errors = []
-
-    if not validate_about_resource:
-        finalized_errors = ignore_about_resource_path_error(errors)
-    else:
-        finalized_errors = errors
+    finalized_errors = ignore_about_resource_path_not_exist_error(errors)
 
     for e in finalized_errors:
         # Only count as warning/error if CRITICAL, ERROR and WARNING
@@ -295,17 +277,12 @@ def gen(location, output, mapping, license_notice_text_location, fetch_license,
 @click.option('--template', type=click.Path(exists=True), nargs=1,
     help='Path to an optional custom attribution template used for generation.')
 
-@click.option('--validate-about-resource', is_flag=True, default=False,
-    help='Validate the existence of the about resource.'
-)
-
 @click.option('-q', '--quiet', is_flag=True,
     help='Do not print error or warning messages.')
 
 @click.help_option('-h', '--help')
 
-def attrib(location, output, template, mapping, inventory, quiet, show_all,
-           validate_about_resource):
+def attrib(location, output, template, mapping, inventory, quiet, show_all):
     """
 Generate an attribution document at OUTPUT using .ABOUT files at LOCATION.
 
@@ -337,12 +314,7 @@ def attrib(location, output, template, mapping, inventory, quiet, show_all,
     for no_match_error in no_match_errors:
         inv_errors.append(no_match_error)
 
-    finalized_errors = []
-
-    if not validate_about_resource:
-        finalized_errors = ignore_about_resource_path_error(inv_errors)
-    else:
-        finalized_errors = inv_errors
+    finalized_errors = ignore_about_resource_path_not_exist_error(inv_errors)
 
     log_errors(finalized_errors, quiet, show_all, os.path.dirname(output))
     click.echo('Finished.')

src/attributecode/util.py

@@ -473,7 +473,7 @@ def copy_license_notice_files(fields, base_dir, license_notice_text_location, af
             shutil.copy2(from_lic_path, to_lic_path)
 
 
-def ignore_about_resource_path_error(errors):
+def ignore_about_resource_path_not_exist_error(errors):
     ignore_resource_path_check_message = u'Field about_resource_path:'
     updated_errors = []
     for err in errors:

tests/test_util.py

@@ -339,8 +339,8 @@ def test_apply_mapping(self):
                          ])]
         assert util.apply_mapping(input) == expected
 
-    def test_ignore_about_resource_path_error(self):
+    def test_ignore_about_resource_path_not_exist_error(self):
         input_err = [Error(ERROR, 'Field about_resource_path: test.tar.gz does not exist'),
                      Error(ERROR, 'Field about_resource_path: test.tar.gz does not exist')]
         expected_err = []
-        assert util.ignore_about_resource_path_error(input_err) == expected_err
+        assert util.ignore_about_resource_path_not_exist_error(input_err) == expected_err