Fixed #495 - Enhance the usability of attrib

 * Remove restriction of requiring `about_resource` field in the input
if `attrib` from an inventory

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

Author: chinyeungli

CHANGELOG.rst

@@ -1,4 +1,4 @@
-2022-xx-xx
+2022-03-01
     Release 7.0.0
 
     * Add '@' as a supported character for filename #451
@@ -12,7 +12,7 @@
     * Use readthedocs for documentation
     * Add Dockerfile to run aboutcode with docker
     * Add new option to choose extract license from ScanCode LicenseDB or DJC License Library
-    * Add ability to transform Excel formatted file 
+    * Add ability to transform XLSX file 
     * Support XLSX file format for `inventory`, `gen` and `attrib`
     * Add 'spdx_license_key' support
     * Add option to save error log in `check` command
@@ -21,6 +21,8 @@
     * Add '%" as a supported character
     * Update default template
     * All errors are logged if and only if the `verbose` option is set. Otherwise, ony 'Critical' and 'Warning' errors will be showed/logged
+    * Ability to generate attribution notice directly from an input inventory
+    * Remove the restriction of requiring 'about_resource' field in the input if performing `attrib` from an inventory
 
 2021-04-02
     Release 6.0.0

src/attributecode/attrib.py

@@ -182,7 +182,7 @@ def generate(abouts, is_about_input, license_dict, scancode, min_license_score,
     licenses_list = sorted(licenses_list, key=lambda x: x.key)
 
     rendered = template.render(
-        abouts=abouts, 
+        abouts=abouts,
         common_licenses=COMMON_LICENSES,
         licenses_list=licenses_list,
         utcnow=utcnow,

src/attributecode/gen.py

@@ -116,7 +116,6 @@ def check_about_resource_filename(arp):
     return ''
 
 
-# TODO: this should be either the CSV or the ABOUT files but not both???
 def load_inventory(location, from_attrib=False, base_dir=None, scancode=False, reference_dir=None):
     """
     Load the inventory file at `location` for ABOUT and LICENSE files stored in
@@ -152,24 +151,24 @@ def load_inventory(location, from_attrib=False, base_dir=None, scancode=False, r
         arp_list = []
         errors = []
         for component in inventory:
-            arp = component['about_resource']
-            dup_err = check_duplicated_about_resource(arp, arp_list)
-            if dup_err:
-                if not dup_err in errors:
-                    errors.append(dup_err)
-            else:
-                arp_list.append(arp)
+            if not from_attrib:
+                arp = component['about_resource']
+                dup_err = check_duplicated_about_resource(arp, arp_list)
+                if dup_err:
+                    if not dup_err in errors:
+                        errors.append(dup_err)
+                else:
+                    arp_list.append(arp)
+
+                invalid_about_filename = check_about_resource_filename(arp)
+                if invalid_about_filename and not invalid_about_filename in errors:
+                    errors.append(invalid_about_filename)
 
             newline_in_file_err = check_newline_in_file_field(component)
             if newline_in_file_err:
                 errors.extend(newline_in_file_err)
-
-            invalid_about_filename = check_about_resource_filename(arp)
-            if invalid_about_filename and not invalid_about_filename in errors:
-                errors.append(invalid_about_filename)
         if errors:
             return errors, abouts
-
     except Exception as e:
         # TODO: why catch ALL Exception
         msg = "The essential field 'about_resource' is not found in the <input>"
@@ -183,22 +182,32 @@ def load_inventory(location, from_attrib=False, base_dir=None, scancode=False, r
 
         for f in required_fields:
             if f not in fields:
-                msg = "Required field: %(f)r not found in the <input>" % locals()
-                errors.append(Error(CRITICAL, msg))
-                return errors, abouts
-        afp = fields.get(model.About.ABOUT_RESOURCE_ATTR)
+                if from_attrib and f == 'about_resource':
+                    continue
+                else:
+                    msg = "Required field: %(f)r not found in the <input>" % locals()
+                    errors.append(Error(CRITICAL, msg))
+                    return errors, abouts
+        # Set about file path to '' if no 'about_resource' is provided from
+        # the input for `attrib`
+        if not 'about_resource' in fields:
+            afp = ''
+        else:
+            afp = fields.get(model.About.ABOUT_RESOURCE_ATTR)
 
+        """
         # FIXME: this should not be a failure condition
         if not afp or not afp.strip():
             msg = 'Empty column: %(afp)r. Cannot generate .ABOUT file.' % locals()
             errors.append(Error(ERROR, msg))
             continue
         else:
-            afp = util.to_posix(afp)
-            if base_dir:
-                loc = join(base_dir, afp)
-            else:
-                loc = afp
+        """
+        afp = util.to_posix(afp)
+        if base_dir:
+            loc = join(base_dir, afp)
+        else:
+            loc = afp
         about = model.About(about_file_path=afp)
         about.location = loc
 
@@ -213,6 +222,11 @@ def load_inventory(location, from_attrib=False, base_dir=None, scancode=False, r
                 updated_resource_value = basename(resource_path)
             fields['about_resource'] = updated_resource_value
 
+        # Set 'about_resource' to '.' if no 'about_resource' is provided from
+        # the input for `attrib`
+        elif not 'about_resource' in fields and from_attrib:
+            fields['about_resource'] = u'.'
+
         ld_errors = about.load_dict(
             fields,
             base_dir,

tests/test_gen.py

@@ -93,6 +93,35 @@ def test_load_inventory(self):
 custom1: |
   multi
   line
+'''
+        )
+        result = [a.dumps() for a in abouts]
+        assert expected == result[0]
+
+    def test_load_inventory_without_about_resource(self):
+        location = get_test_loc('test_gen/inv_no_about_resource.csv')
+        base_dir = get_temp_dir()
+        from_attrib = False
+        errors, abouts = gen.load_inventory(location, base_dir=base_dir, from_attrib=from_attrib)
+        expected_error = [Error(CRITICAL,  "The essential field 'about_resource' is not found in the <input>")]
+
+        assert errors == expected_error
+        assert abouts == [] 
+
+    def test_load_inventory_without_about_resource_from_attrib(self):
+        location = get_test_loc('test_gen/inv_no_about_resource.csv')
+        base_dir = get_temp_dir()
+        from_attrib = True
+        errors, abouts = gen.load_inventory(location, base_dir=base_dir, from_attrib=from_attrib)
+
+        expected_num_errors = 0
+        assert len(errors) == expected_num_errors 
+
+        expected = (
+'''about_resource: .
+name: AboutCode
+version: 0.11.0
+license_expression: apache-2.0
 '''
         )
         result = [a.dumps() for a in abouts]

tests/testdata/test_gen/inv_no_about_resource.csv

@@ -0,0 +1,2 @@
+name,version,license_expression
+AboutCode,0.11.0,apache-2.0