genattrib.py

- Add '--mapping' option for genattrib.py
- Use the about file's path as the sublist filter instead of the component name
about.py
- Change the 'about_resource_path' to 'about_resource' as it is not a path value

Author: chinyeungli

about_code_tool/about.py

@@ -445,7 +445,7 @@ class AboutFile(object):
     Represent an ABOUT file and functions to parse and validate a file.
     """
     def __init__(self, location=None):
-        self.about_resource_path = None
+        self.about_resource = None
         self.location = location
 
         self.parsed = None
@@ -684,14 +684,14 @@ def validate_about_resource_exist(self):
         # in validate_mandatory_fields_are_present(self)
         if about_resource in self.validated_fields \
                 and self.validated_fields[about_resource]:
-            self.about_resource_path = self.validated_fields[about_resource]
+            self.about_resource = self.validated_fields[about_resource]
 
-            if not self._exists(self.about_resource_path):
+            if not self._exists(self.about_resource):
                 self.errors.append(Error(FILE, about_resource,
-                                         self.about_resource_path,
+                                         self.about_resource,
                                          'File does not exist.'))
 
-        self._save_location(about_resource, self.about_resource_path)
+        self._save_location(about_resource, self.about_resource)
 
     def validate_file_field_exists(self, field_name, file_path):
         """
@@ -1098,7 +1098,8 @@ def generate_attribution(self, template_path='templates/default.html',
         license_text = []
         license_dict = {}
         for about_object in self:
-            if not limit_to or about_object.about_resource_path in limit_to:
+            about_relative_path = '/'+ about_object.location.partition(self.user_provided_path)[2]
+            if not limit_to or about_relative_path in limit_to:
                 validated_fields.append(about_object.validated_fields)
                 notice_text.append(about_object.notice_text())
                 dje_license_name = about_object.get_dje_license_name()
@@ -1110,7 +1111,7 @@ def generate_attribution(self, template_path='templates/default.html',
                         else:
                             msg = 'About resource: %s - license_text does not exist.'\
                                 ' License generation is skipped.'\
-                                % about_object.about_resource_path
+                                % about_object.about_resource
                             self.genattrib_errors.append(Error(GENATTRIB,\
                                                                'dje_license',\
                                                                dje_license_name, msg))
@@ -1121,14 +1122,14 @@ def generate_attribution(self, template_path='templates/default.html',
                         else:
                             msg = 'About resource: %s - license_text does not exist.'\
                                 ' License generation is skipped.'\
-                                % about_object.about_resource_path
+                                % about_object.about_resource
                             self.genattrib_errors.append(Error(GENATTRIB,\
                                                                'license_text',\
                                                                about_object.get_license_text_file_name(), msg))
                 else:
                     msg = 'No dje_license or license_text is found. License generation is skipped.'
                     self.genattrib_errors.append(Error(GENATTRIB, 'about_resource',\
-                                                        about_object.about_resource_path,\
+                                                        about_object.about_resource,\
                                                         msg))
 
         # We want the license generation in alphabetical order

about_code_tool/genattrib.py

@@ -10,6 +10,7 @@
 from __future__ import print_function
 from __future__ import with_statement
 from about import AboutCollector
+import genabout
 
 import codecs
 import csv
@@ -61,15 +62,20 @@
 limitations under the License.
 """
 
-def component_subset_to_sublist(input_path):
+def component_subset_to_sublist(input_list):
     sublist = []
-    with open(input_path, "rU") as f:
-        csv_dict = csv.DictReader(f)
-        sublist = [row["about_resource"] for row in csv_dict
-                   if "about_resource" in row.keys()]
-
+    sublist = [row["about_file"] for row in input_list
+                   if "about_file" in row.keys()]
     return sublist
 
+def update_path_to_about(input_list):
+    output_list = []
+    for row in input_list:
+        if row.endswith('/'):
+            row = row.rpartition('/')[0]
+        output_list.append(row + '.ABOUT')
+    return output_list
+
 USAGE_SYNTAX = """\
     Input can be a file or directory.
     Output of rendered template must be a file (e.g. .html).
@@ -83,10 +89,14 @@ def component_subset_to_sublist(input_path):
 2 - Print error and warning messages
 """
 
+MAPPING_HELP = """\
+Configure the mapping key from the MAPPING.CONFIG
+"""
 
 def main(parser, options, args):
     overwrite = options.overwrite
     verbosity = options.verbosity
+    mapping_config = options.mapping
 
     if options.version:
         print('ABOUT tool {0}\n{1}'.format(__version__, __copyright__))
@@ -97,6 +107,11 @@ def main(parser, options, args):
     elif verbosity >= 2:
         handler.setLevel(logging.WARNING)
 
+    if mapping_config:
+        if not exists('MAPPING.CONFIG'):
+            print("The file 'MAPPING.CONFIG' doesn't exist.")
+            sys.exit(errno.EINVAL)
+
     if not len(args) == 3:
         print('Path for input, output and component list are required.\n')
         parser.print_help()
@@ -136,8 +151,21 @@ def main(parser, options, args):
 
     if not exists(output_path) or (exists(output_path) and overwrite):
         collector = AboutCollector(input_path)
-        sublist = None if not component_subset_path else component_subset_to_sublist(component_subset_path)
-        attrib_str = collector.generate_attribution( limit_to = sublist )
+        input_list = []
+        if not component_subset_path:
+            sublist = None
+        else:
+            with open(component_subset_path, "rU") as f:
+                input_dict = csv.DictReader(f)
+                for row in input_dict:
+                    input_list.append(row)
+            if mapping_config:
+                mapping_list = genabout.GenAbout().get_mapping_list()
+                input_list = genabout.GenAbout().convert_input_list(input_list, mapping_list)
+            sublist = component_subset_to_sublist(input_list)
+            outlist = update_path_to_about(sublist)
+
+        attrib_str = collector.generate_attribution( limit_to = outlist )
         with open(output_path, "w") as f:
             f.write(attrib_str)
         errors = collector.get_genattrib_errors()
@@ -201,6 +229,7 @@ def format_option(self, option):
     parser.add_option('--overwrite', action='store_true',
                       help='Overwrites the output file if it exists')
     parser.add_option('--verbosity', type=int, help=VERBOSITY_HELP)
+    parser.add_option('--mapping', action='store_true', help=MAPPING_HELP)
     return parser
 
 

about_code_tool/tests/test_about.py

@@ -320,7 +320,7 @@ def test_normalize_lowercase(self):
 
     def test_validate_about_ref_testing_the_about_resource_field_is_present(self):
         about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/about_resource_field_present.ABOUT'))
-        self.assertEquals(about_file.about_resource_path, 'about_resource.c', 'the about_resource was not detected')
+        self.assertEquals(about_file.about_resource, 'about_resource.c', 'the about_resource was not detected')
 
     def test_validate_about_ref_no_about_ref_key(self):
         about_file = about.AboutFile(join(TESTDATA_PATH, 'parser_tests/.ABOUT'))