Fixed --mapping issue #304

 * Added `--mapping` option for `inventory`
 * Fixed the mapping issue
 * Added test code
 * Update USAGE doc

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

Author: chinyeungli

USAGE.rst

@@ -245,6 +245,7 @@ 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.
@@ -263,6 +264,10 @@ Options
  
         Set OUTPUT file format.  [default: csv]
 
+    --mapping
+
+        See mapping.config for details
+
     --show-all
 
         This option ask the tool to show all kind of errors found.

src/attributecode/cmd.py

@@ -112,6 +112,9 @@ def cli():
     type=click.Choice(['json', 'csv']),
     help='Set OUTPUT inventory file format.')
 
+@click.option('--mapping', is_flag=True,
+    help='Use file mapping.config to collect the defined not supported fields in ABOUT files.')
+
 @click.option('--show-all', is_flag=True, default=False,
     help='Show all errors and warnings. '
         'By default, the tool only prints these '
@@ -129,7 +132,7 @@ def cli():
 
 @click.help_option('-h', '--help')
 
-def inventory(location, output, quiet, format, show_all, validate_about_resource):
+def inventory(location, output, mapping, quiet, format, show_all, validate_about_resource):
     """
 Collect a JSON or CSV inventory of components from .ABOUT files.
 
@@ -152,7 +155,7 @@ def inventory(location, output, quiet, format, show_all, validate_about_resource
         # accept zipped ABOUT files as input
         location = extract_zip(location)
 
-    errors, abouts = model.collect_inventory(location)
+    errors, abouts = model.collect_inventory(location, use_mapping=mapping)
 
     write_errors = model.write_output(abouts, output, format)
     for err in write_errors:
@@ -317,7 +320,7 @@ def attrib(location, output, template, mapping, inventory, quiet, show_all,
     if location.lower().endswith('.zip'):
         location = extract_zip(location)
 
-    inv_errors, abouts = model.collect_inventory(location)
+    inv_errors, abouts = model.collect_inventory(location, use_mapping=mapping)
     no_match_errors = attrib_generate_and_save(
         abouts=abouts, output_location=output,
         use_mapping=mapping, template_loc=template,
@@ -327,7 +330,7 @@ def attrib(location, output, template, mapping, inventory, quiet, show_all,
         # Check for template error
         with open(output, 'r') as output_file:
             first_line = output_file.readline()
-            if first_line.startswith('Template processing error'):
+            if first_line.startswith('Template'):
                 click.echo(first_line)
                 sys.exit(errno.ENOEXEC)
 

src/attributecode/model.py

@@ -710,7 +710,7 @@ def create_fields(self):
             field.name = name
             setattr(self, name, field)
 
-    def __init__(self, location=None, about_file_path=None):
+    def __init__(self, location=None, about_file_path=None, use_mapping=False):
         self.create_fields()
         self.custom_fields = OrderedDict()
 
@@ -724,7 +724,7 @@ def __init__(self, location=None, about_file_path=None):
         self.base_dir = None
         if self.location:
             self.base_dir = os.path.dirname(location)
-            self.load(location)
+            self.load(location, use_mapping)
 
     def __repr__(self):
         return repr(self.all_fields())
@@ -965,7 +965,7 @@ def process(self, fields, about_file_path, running_inventory=False,
         # self.about_resource.resolve(self.about_file_path)
         return errors
 
-    def load(self, location):
+    def load(self, location, use_mapping=False):
         """
         Read, parse and process the ABOUT file at location.
         Return a list of errors and update self with errors.
@@ -988,7 +988,7 @@ def load(self, location):
             and then join with the 'about_resource_path'
             """
             running_inventory = True
-            errs = self.load_dict(saneyaml.load(input_text), base_dir, running_inventory)
+            errs = self.load_dict(saneyaml.load(input_text), base_dir, running_inventory, use_mapping)
             errors.extend(errs)
         except Exception as e:
             msg = 'Cannot load invalid ABOUT file: %(location)r: %(e)r\n' + str(e)
@@ -1190,7 +1190,7 @@ def parse(lines):
     return errors, fields
 
 
-def collect_inventory(location):
+def collect_inventory(location, use_mapping=False):
     """
     Collect ABOUT files at location and return a list of errors and a list of
     About objects.
@@ -1205,7 +1205,7 @@ def collect_inventory(location):
     abouts = []
     for about_loc in about_locations:
         about_file_path = util.get_relative_path(input_location, about_loc)
-        about = About(about_loc, about_file_path)
+        about = About(about_loc, about_file_path, use_mapping)
         # Insert about_file_path reference to the error
         for severity, message in about.errors:
             msg = (about_file_path + ": " + message)

tests/test_model.py

@@ -1160,6 +1160,23 @@ def test_collect_inventory_with_license_expression(self):
         returned_lic = abouts[0].license_expression.value
         assert expected_lic == returned_lic
 
+    def test_collect_inventory_with_mapping(self):
+        test_loc = get_test_loc('parse/name_mapping_test.ABOUT')
+        mapping = True
+        errors, abouts = model.collect_inventory(test_loc, mapping)
+        expected_msg = 'Field resource is a custom field'
+        assert len(errors) == 1
+        assert expected_msg in errors[0].message
+        # The not supported 'resource' value is collected
+        assert abouts[0].resource.value
+
+    def test_collect_inventory_without_mapping(self):
+        test_loc = get_test_loc('parse/name_mapping_test.ABOUT')
+        errors, abouts = model.collect_inventory(test_loc)
+        expected_msg = 'Field resource is not a supported field and is ignored.'
+        assert len(errors) == 1
+        assert expected_msg in errors[0].message
+
     def test_parse_license_expression(self):
         spec_char, returned_lic = model.parse_license_expression(u'mit or apache-2.0')
         expected_lic = [u'mit', u'apache-2.0']

tests/testdata/parse/name_mapping_test.ABOUT

@@ -0,0 +1,3 @@
+about_resource: .
+name: test
+resource: .