Fixed #204

 * The current error.log will log the path that have problem, and I
believe this is sufficient
 * Display the error count in the error.log and stdout.

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

Author: chinyeungli

docs/CHANGELOG.rst

@@ -5,6 +5,7 @@
     * Multiple licenses support
     * No support for referenceing multuiple resources
     * Fix the incorrect boolean field behavior
+    * Display number of errors/warnings in the error log
 
 2018-09-19
 

src/attributecode/cmd.py

@@ -198,9 +198,16 @@ def inventory(location, output, mapping, mapping_file, mapping_output, filter, q
                         'Please correct and re-run.'
         print(msg)
 
+    error_count = 0
     finalized_errors = update_severity_level_about_resource_path_not_exist_error(errors)
 
-    log_errors(finalized_errors, quiet, verbose, os.path.dirname(output))
+    for e in finalized_errors:
+        # Only count as warning/error if CRITICAL, ERROR and WARNING
+        if e.severity > 20:
+            error_count = error_count + 1
+
+    log_errors(finalized_errors, error_count, quiet, verbose, os.path.dirname(output))
+    click.echo(' %(error_count)d errors or warnings detected.' % locals())
     sys.exit(0)
 
 
@@ -282,9 +289,8 @@ def gen(location, output, mapping, mapping_file, license_notice_text_location, f
         # Only count as warning/error if CRITICAL, ERROR and WARNING
         if e.severity > 20:
             error_count = error_count + 1
-    click.echo(
-        'Generated %(about_count)d .ABOUT files with %(error_count)d errors or warnings' % locals())
-    log_errors(finalized_errors, quiet, verbose, output)
+    log_errors(finalized_errors, error_count, quiet, verbose, output)
+    click.echo('Generated %(about_count)d .ABOUT files with %(error_count)d errors or warnings' % locals())
     sys.exit(0)
 
 
@@ -365,9 +371,16 @@ def attrib(location, output, template, mapping, mapping_file, inventory, vartext
     for no_match_error in no_match_errors:
         inv_errors.append(no_match_error)
 
+    error_count = 0
     finalized_errors = update_severity_level_about_resource_path_not_exist_error(inv_errors)
 
-    log_errors(finalized_errors, quiet, verbose, os.path.dirname(output))
+    for e in finalized_errors:
+        # Only count as warning/error if CRITICAL, ERROR and WARNING
+        if e.severity > 20:
+            error_count = error_count + 1
+
+    log_errors(finalized_errors, error_count, quiet, verbose, os.path.dirname(output))
+    click.echo(' %(error_count)d errors or warnings detected.' % locals())
     click.echo('Finished.')
     sys.exit(0)
 
@@ -429,7 +442,7 @@ def check(location, verbose):
     sys.exit(0)
 
 
-def log_errors(errors, quiet, verbose, base_dir=False):
+def log_errors(errors, err_count, quiet, verbose, base_dir=False):
     """
     Iterate of sequence of Error objects and print and log errors with
     a severity superior or equal to level.
@@ -450,7 +463,9 @@ def log_errors(errors, quiet, verbose, base_dir=False):
         log_path = join(bdir, LOG_FILENAME)
         if exists(log_path):
             os.remove(log_path)
-
+        f = open(log_path, "a")
+        error_msg = str(err_count) + u" errors or warnings detected."
+        f.write(error_msg)
         file_handler = logging.FileHandler(log_path)
         file_logger.addHandler(file_handler)
 

src/attributecode/model.py

@@ -555,12 +555,14 @@ def _validate(self, *args, **kwargs):
         False. Return a list of errors.
         """
         errors = super(BooleanField, self)._validate(*args, ** kwargs)
+        self.about_file_path = kwargs.get('about_file_path')
         flag = self.get_flag(self.original_value)
         if flag is False:
             name = self.name
             val = self.original_value
+            about_file_path = self.about_file_path
             flag_values = self.flag_values
-            msg = (u'Field %(name)s: Invalid flag value: %(val)r is not '
+            msg = (u'Path: %(about_file_path)s - Field %(name)s: Invalid flag value: %(val)r is not '
                    u'one of: %(flag_values)s' % locals())
             errors.append(Error(ERROR, msg))
             self.value = None

tests/test_cmd.py

@@ -39,7 +39,8 @@ def test_log_errors(capsys):
               Error(DEBUG, 'msg4'),
               Error(NOTSET, 'msg4'),
               ]
-    cmd.log_errors(errors, quiet, show_all, base_dir='')
+    error_count = len(errors)
+    cmd.log_errors(errors, error_count, quiet, show_all, base_dir='')
     out, err = capsys.readouterr()
     expected_out = '''CRITICAL: msg1
 ERROR: msg2
@@ -62,7 +63,8 @@ def test_log_errors_without_show_all(capsys):
               Error(DEBUG, 'msg4'),
               Error(NOTSET, 'msg4'),
               ]
-    cmd.log_errors(errors, quiet, show_all, base_dir='')
+    error_count = len(errors)
+    cmd.log_errors(errors, error_count, quiet, show_all, base_dir='')
     out, err = capsys.readouterr()
     expected_out = '''CRITICAL: msg1
 ERROR: msg2
@@ -82,7 +84,8 @@ def test_log_errors_with_quiet(capsys):
               Error(DEBUG, 'msg4'),
               Error(NOTSET, 'msg4'),
               ]
-    cmd.log_errors(errors, quiet, show_all, base_dir='')
+    error_count = len(errors)
+    cmd.log_errors(errors, error_count, quiet, show_all, base_dir='')
     out, err = capsys.readouterr()
     assert '' == out
     assert '' == err