Add 'about_file_path' reference in the error #284

The 'about_file_path' reference is now added along with the error
message. In addition, the previous code dedup all the same error for all
ABOUT files, such as missing essential field, which is incorrect. If 3
ABOUT files are missing the essential field, such as 'name', we should
log this 3 times with reference of which ABOUT files have the issue.

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

Author: chinyeungli

src/attributecode/model.py

@@ -1113,6 +1113,7 @@ def collect_inventory(location):
     About objects.
     """
     errors = []
+    dedup_errors = []
     input_location = util.get_absolute(location)
     about_locations = list(util.get_about_locations(input_location))
 
@@ -1122,12 +1123,18 @@ def collect_inventory(location):
     for about_loc in about_locations:
         about_file_path = util.get_relative_path(input_location, about_loc)
         about = About(about_loc, about_file_path)
-        # Avoid logging duplicated/same errors multiple times
-        for about_error in about.errors:
-            if not about_error in errors:
-                errors.append(about_error)
+        # Insert about_file_path reference to the error
+        for severity, message in about.errors:
+            msg = (about_file_path + ": " + message)
+            errors.append(Error(severity, msg))
         abouts.append(about)
-    return errors, abouts
+
+    # Avoid logging duplicated/same errors multiple times
+    for about_error in errors:
+        if not about_error in dedup_errors:
+            dedup_errors.append(about_error)
+
+    return dedup_errors, abouts
 
 
 def field_names(abouts, with_paths=True, with_absent=True, with_empty=True):

tests/test_model.py

@@ -1098,10 +1098,11 @@ def test_collect_inventory_return_errors(self):
         file_path1 = posixpath.join(test_loc, 'distribute_setup.py')
         file_path2 = posixpath.join(test_loc, 'date_test.py')
 
-        err_msg1 = u'Field about_resource: Path %s not found' % file_path1
-        err_msg2 = u'Field about_resource: Path %s not found' % file_path2
+        err_msg1 = u'non-supported_date_format.ABOUT: Field about_resource: Path %s not found' % file_path1
+        err_msg2 = u'supported_date_format.ABOUT: Field about_resource: Path %s not found' % file_path2
         expected_errors = [
-            Error(INFO, u'Field date is not a supported field and is ignored.'),
+            Error(INFO, u'non-supported_date_format.ABOUT: Field date is not a supported field and is ignored.'),
+            Error(INFO, u'supported_date_format.ABOUT: Field date is not a supported field and is ignored.'),
             Error(CRITICAL, err_msg1),
             Error(CRITICAL, err_msg2)]
         assert sorted(expected_errors) == sorted(errors)