Adding a --filter post-processing step to analyze

The report filtering post processing step
was removed as part of the --skip SKIPFILE parameter
and was separated out to a --filter SKIPFILE parameter.
This way the reports are not skipped as a post processing
step by default.

Author: dkrupp

analyzer/codechecker_analyzer/analysis_manager.py

@@ -216,7 +216,7 @@ def prepare_check(action, analyzer_config, output_dir,
 
 
 def handle_success(
-    rh, result_file, result_base, skip_handlers,
+    rh, result_file, result_base, skip_handlers, filter_handlers,
     rs_handler: ReviewStatusHandler,
     capture_analysis_output, success_dir
 ):
@@ -230,7 +230,7 @@ def handle_success(
         save_output(os.path.join(success_dir, result_base),
                     rh.analyzer_stdout, rh.analyzer_stderr)
 
-    rh.postprocess_result(skip_handlers, rs_handler)
+    rh.postprocess_result(filter_handlers, rs_handler)
 
     # Generated reports will be handled separately at store.
 
@@ -487,7 +487,8 @@ def check(check_data):
     skiplist handler is None if no skip file was configured.
     """
     actions_map, action, analyzer_config, \
-        output_dir, skip_handlers, rs_handler, quiet_output_on_stdout, \
+        output_dir, skip_handlers, filter_handlers, \
+        rs_handler, quiet_output_on_stdout, \
         capture_analysis_output, generate_reproducer, analysis_timeout, \
         ctu_reanalyze_on_failure, \
         output_dirs, statistics_data = check_data
@@ -605,7 +606,7 @@ def handle_analysis_result(success, zip_file=zip_file):
 
             if success:
                 handle_success(rh, result_file, result_base,
-                               skip_handlers, rs_handler,
+                               skip_handlers, filter_handlers, rs_handler,
                                capture_analysis_output, success_dir)
             elif not generate_reproducer:
                 handle_failure(source_analyzer, rh,
@@ -719,7 +720,7 @@ def skip_cpp(compile_actions, skip_handlers):
 
 
 def start_workers(actions_map, actions, analyzer_config_map,
-                  jobs, output_path, skip_handlers,
+                  jobs, output_path, skip_handlers, filter_handlers,
                   rs_handler: ReviewStatusHandler, metadata_tool,
                   quiet_analyze, capture_analysis_output, generate_reproducer,
                   timeout, ctu_reanalyze_on_failure, statistics_data, manager,
@@ -785,6 +786,7 @@ def signal_handler(signum, _):
                          analyzer_config_map.get(build_action.analyzer_type),
                          output_path,
                          skip_handlers,
+                         filter_handlers,
                          rs_handler,
                          quiet_analyze,
                          capture_analysis_output,

analyzer/codechecker_analyzer/analyzer.py

@@ -130,7 +130,8 @@ def __has_enabled_checker(ch: AnalyzerConfigHandler):
                for _, (state, _) in ch.checks().items())
 
 
-def perform_analysis(args, skip_handlers, rs_handler: ReviewStatusHandler,
+def perform_analysis(args, skip_handlers, filter_handlers,
+                     rs_handler: ReviewStatusHandler,
                      actions, metadata_tool, compile_cmd_count):
     """
     Perform static analysis via the given (or if not, all) analyzers,
@@ -335,6 +336,7 @@ def perform_analysis(args, skip_handlers, rs_handler: ReviewStatusHandler,
                                        config_map, args.jobs,
                                        args.output_path,
                                        skip_handlers,
+                                       filter_handlers,
                                        rs_handler,
                                        metadata_tool,
                                        'quiet' in args,

analyzer/codechecker_analyzer/cmd/analyze.py

@@ -183,6 +183,16 @@ def add_arguments_to_parser(parser):
                                 "Please consult the User guide on how a "
                                 "Skipfile should be laid out.")
 
+    skip_mode.add_argument('--filter',
+                           dest="filterfile",
+                           required=False,
+                           default=argparse.SUPPRESS,
+                           help="Path to the Skipfile dictating which reports "
+                                "should be filtered out from the result set in a "
+                                "post processing step. "
+                                "Please consult the User guide on how a "
+                                "Skipfile should be laid out.")
+
     skip_mode.add_argument('--file',
                            nargs='+',
                            dest="files",
@@ -950,6 +960,21 @@ def __get_skip_handlers(args, compile_commands) -> SkipListHandlers:
     return skip_handlers
 
 
+def __get_filter_handlers(args, compile_commands) -> SkipListHandlers:
+    """
+    Initialize and return a list of skiplist handlers if
+    there is a filter list file in the arguments or files options is provided.
+    """
+    filter_handlers = SkipListHandlers()
+    if 'filterfile' in args:
+        with open(args.filterfile, encoding="utf-8", errors="ignore") as f:
+            content = f.read()
+            filter_handlers.append(SkipListHandler(content))
+            LOG.debug("Filter handler is created for the '--filter' option with "
+                      "the following filters:\n%s", content)
+
+    return filter_handlers
+
 def __update_skip_file(args):
     """
     Remove previous skip file if there was any.
@@ -1097,8 +1122,11 @@ def main(args):
         LOG.error(f"Found no compilation commands in '{args.input}'")
         sys.exit(1)
 
-    # Process the skip list if present.
+    # Process the skip list if present. This will filter out analysis actions.
     skip_handlers = __get_skip_handlers(args, compile_commands)
+    # Process the filter list if present. This will filter out successful reports.
+    filter_handlers = __get_filter_handlers(args, compile_commands)
+
     rs_handler = review_status_handler.ReviewStatusHandler(args.output_path)
 
     try:
@@ -1244,7 +1272,7 @@ def main(args):
     LOG.debug_analyzer("Compile commands forwarded for analysis: %d",
                        compile_cmd_count.analyze)
 
-    analyzer.perform_analysis(args, skip_handlers, rs_handler, actions,
+    analyzer.perform_analysis(args, skip_handlers,filter_handlers, rs_handler, actions,
                               metadata_tool, compile_cmd_count)
 
     __update_skip_file(args)

analyzer/codechecker_analyzer/cmd/check.py

@@ -275,7 +275,7 @@ def add_arguments_to_parser(parser):
                                     "more information.\n"
                                     "USE WISELY AND AT YOUR OWN RISK!")
 
-    skip_mode = analyzer_opts.add_mutually_exclusive_group()
+    skip_mode = parser.add_argument_group("file filter arguments")
     skip_mode.add_argument('-i', '--ignore', '--skip',
                            dest="skipfile",
                            required=False,
@@ -285,6 +285,16 @@ def add_arguments_to_parser(parser):
                                 "Please consult the User guide on how a "
                                 "Skipfile should be laid out.")
 
+    skip_mode.add_argument('--filter',
+                           dest="filterfile",
+                           required=False,
+                           default=argparse.SUPPRESS,
+                           help="Path to the Skipfile dictating which reports "
+                                "should be filtered out from the result set in a "
+                                "post processing step. "
+                                "Please consult the User guide on how a "
+                                "Skipfile should be laid out.")
+
     skip_mode.add_argument('--file',
                            nargs='+',
                            dest="files",
@@ -881,6 +891,7 @@ def __update_if_key_exists(source, target, key):
         # after the call.
         args_to_update = ['quiet',
                           'skipfile',
+                          'filterfile',
                           'files',
                           'analyzers',
                           'add_compiler_defaults',