Custom fields in mapping.config are ignored #299

 * The custom fields should now be adapted
 * Write tests for testing `--mapping`

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

Author: chinyeungli

src/attributecode/gen.py

@@ -164,7 +164,7 @@ def load_inventory(location, base_dir, license_notice_text_location=None,
         about = model.About(about_file_path=afp)
         about.location = loc
         running_inventory = False
-        ld_errors = about.load_dict(fields, base_dir, running_inventory, license_notice_text_location, with_empty=False)
+        ld_errors = about.load_dict(fields, base_dir, running_inventory, use_mapping, license_notice_text_location, with_empty=False)
         # 'about_resource' field will be generated during the process.
         # No error need to be raise for the missing 'about_resource'.
         for e in ld_errors:

src/attributecode/mapping.config

@@ -39,4 +39,5 @@ version: Confirmed Version
 copyright: Confirmed Copyright
 
 # Custom Fields
-license_expression: dje_license_key
+license_expression: dje_license_key
+resource: Resource

src/attributecode/model.py

@@ -1027,7 +1027,7 @@ def load_lines(self, lines, base_dir):
         self.errors = errors
         return errors
 
-    def load_dict(self, fields_dict, base_dir, running_inventory=False, 
+    def load_dict(self, fields_dict, base_dir, running_inventory=False, use_mapping=False,
                   license_notice_text_location=None, with_empty=True):
         """
         Load the ABOUT file from a fields name/value mapping.
@@ -1041,7 +1041,7 @@ def load_dict(self, fields_dict, base_dir, running_inventory=False,
             fields = [(n, v) for n, v in fields_dict.items() if v]
         errors = self.process(
             fields, about_file_path, running_inventory, base_dir, 
-            license_notice_text_location)
+            license_notice_text_location, use_mapping)
         self.errors = errors
         return errors
 

tests/test_gen.py

@@ -71,6 +71,33 @@ def test_load_inventory(self):
                         for a in abouts]
         assert expected == result
 
+    def test_load_inventory_with_mapping(self):
+        location = get_test_loc('gen/inv4.csv')
+        base_dir = get_test_loc('inv')
+        license_notice_text_location = None
+        use_mapping = True
+        errors, abouts = gen.load_inventory(location,
+                                            base_dir,
+                                            license_notice_text_location,
+                                            use_mapping)
+        expected_errors = [
+            Error(INFO, 'Field test is not a supported field and is not defined in the mapping file. This field is ignored.'),
+            Error(INFO, 'Field resource is a custom field')]
+        assert sorted(expected_errors) == sorted(errors)
+
+        expected = [u'about_resource: .\n'
+                    u'name: AboutCode\n'
+                    u'version: 0.11.0\n'
+                    u'description: |\n'
+                    u'    multi\n'
+                    u'    line\n'
+                    u'copyright: Copyright (c) nexB, Inc.\n'
+                    u'resource: this.ABOUT\n'
+                    ]
+        result = [a.dumps(with_absent=False, with_empty=False)
+                        for a in abouts]
+        assert expected == result
+
     def test_generation_dir_endswith_space(self):
         location = get_test_loc('inventory/complex/about_file_path_dir_endswith_space.csv')
         base_dir = get_temp_dir()

tests/test_util.py

@@ -30,6 +30,7 @@
 
 from attributecode import CRITICAL
 from attributecode import Error
+from attributecode import model
 from attributecode import util
 
 
@@ -324,3 +325,17 @@ def test_get_locations_with_very_long_path(self):
         test_loc = extract_test_loc('longpath.zip')
         result = list(util.get_locations(test_loc))
         assert any(longpath in r for r in result)
+
+    def test_apply_mapping(self):
+        input = [OrderedDict([('about_resource', '.'),
+                         ('name', 'test'),
+                         ('confirmed version', '1'),
+                         ('confirmed copyright', 'Copyright (c) 2013-2017 nexB Inc.')
+                         ])]
+        expected = [OrderedDict([('about_resource', '.'),
+                         ('name', 'test'),
+                         ('version', '1'),
+                         ('copyright', 'Copyright (c) 2013-2017 nexB Inc.')
+                         ])]
+        assert util.apply_mapping(input) == expected
+

tests/testdata/gen/inv4.csv

@@ -0,0 +1,3 @@
+about_file_path,about_resource,name,version,description,Confirmed Copyright,Resource,test
+inv/this.ABOUT,.,AboutCode,0.11.0,"multi
+line","Copyright (c) nexB, Inc.",this.ABOUT,This is a test