Introduce gcc warnings as checkers

Gcc has its own checkers that can be enabled as warnings:
-Wanalyzer-<checker_name>. However, all other warnings can be
considered as checkers.

Until this patch the -Wanalyzer-<checker_name> checkers could have
been enabled in CodeChecker as --enable gcc-<checker_name>. This
patch makes it possible to enable all other warnings as checkers:
--enable gcc-<warnings_name>.

The problem is that both gcc static analyzers and gcc warning names
have the following transformation in CodeChecker:

-Wanalyzer-<name>  ->  gcc-<name>
-W<name>           ->  gcc-<name>

Theoretically it's possible to generate the inverse transformation,
because static analyzer names and warning names are disjoint. But
we decided to preserve all original names for the checkers:

-Wanalyzer-<name>  ->  gcc-analyzer-<name>
-W<name>           ->  gcc-<name>

This is a backward incompatible change.

Author: FDniel97

analyzer/codechecker_analyzer/analyzers/gcc/analyzer.py

@@ -22,7 +22,8 @@
 
 from .config_handler import GccConfigHandler
 from .result_handler import GccResultHandler, \
-    actual_name_to_codechecker_name, codechecker_name_to_actual_name_disabled
+    actual_name_to_codechecker_name, \
+    codechecker_name_to_actual_name, codechecker_name_to_actual_name_disabled
 
 LOG = get_logger('analyzer.gcc')
 
@@ -77,6 +78,9 @@ def construct_analyzer_cmd(self, result_handler):
                 # than startswith and a hardcoded slicing
                 analyzer_cmd.append(
                     codechecker_name_to_actual_name_disabled(checker_name))
+            else:
+                analyzer_cmd.append(
+                    codechecker_name_to_actual_name(checker_name))
 
         compile_lang = self.buildaction.lang
         if not has_flag('-x', analyzer_cmd):
@@ -106,17 +110,27 @@ def get_analyzer_checkers(cls):
         try:
             output = subprocess.check_output(command, env=environ)
 
+            context = analyzer_context.get_context()
+
+            blacklisted_checkers = context.checker_labels.checkers_by_labels(
+                ["blacklist:true"], cls.ANALYZER_NAME)
+
             # Still contains the help message we need to remove.
             for entry in output.decode().split('\n'):
                 warning_name, _, description = entry.strip().partition(' ')
-                # GCC Static Analyzer names start with -Wanalyzer.
-                if warning_name.startswith('-Wanalyzer'):
-                    # Rename the checkers interally (similarly to how we
-                    # support cppcheck)
-                    renamed_checker_name = \
-                        actual_name_to_codechecker_name(warning_name)
-                    checker_list.append(
-                        (renamed_checker_name, description.strip()))
+                # We filter out the unwanted checkers
+                if not warning_name.startswith('-W') or '=' in warning_name \
+                        or warning_name == '-W' \
+                        or actual_name_to_codechecker_name(warning_name) \
+                        in blacklisted_checkers:
+                    continue
+                # GCC Static Analyzer names and warning names start with -W.
+                # Rename the checkers interally
+                # (similarly to how we support cppcheck)
+                renamed_checker_name = \
+                    actual_name_to_codechecker_name(warning_name)
+                checker_list.append(
+                    (renamed_checker_name, description.strip()))
             return checker_list
         except (subprocess.CalledProcessError) as e:
             LOG.error(e.stderr)

analyzer/codechecker_analyzer/analyzers/gcc/result_handler.py

@@ -29,18 +29,18 @@
 
 
 def actual_name_to_codechecker_name(actual_name: str):
-    assert actual_name.startswith('-Wanalyzer')
-    return actual_name.replace("-Wanalyzer", "gcc")
+    assert actual_name.startswith('-W')
+    return actual_name.replace("-W", "gcc-")
 
 
 def codechecker_name_to_actual_name(codechecker_name: str):
     assert codechecker_name.startswith('gcc')
-    return codechecker_name.replace("gcc", "-Wanalyzer")
+    return codechecker_name.replace("gcc-", "-W")
 
 
 def codechecker_name_to_actual_name_disabled(codechecker_name: str):
     assert codechecker_name.startswith('gcc')
-    return codechecker_name.replace("gcc", "-Wno-analyzer")
+    return codechecker_name.replace("gcc-", "-Wno-")
 
 
 class GccResultHandler(ResultHandler):

analyzer/tests/functional/analyze/test_analyze.py

@@ -1342,6 +1342,105 @@ def test_disable_all_checkers(self):
         # Checkers of all 3 analyzers are disabled.
         self.assertEqual(out.count("No checkers enabled for"), 5)
 
+    def test_analyzer_gcc_warnings(self):
+        build_json = os.path.join(self.test_workspace, "build.json")
+        source_file = os.path.join(self.test_dir, "compiler_warning.c")
+
+        build_log = [{"directory": self.test_workspace,
+                      "command": "gcc -c " + source_file, "file": source_file}]
+
+        with open(build_json, 'w',
+                  encoding="utf-8", errors="ignore") as outfile:
+            json.dump(build_log, outfile)
+
+        analyze_cmd = [self._codechecker_cmd, "analyze", build_json,
+                       "--analyzers", "gcc",
+                       "-o", self.report_dir,
+                       "--disable-all",
+                       "--verbose", "debug_analyzer"]
+
+        process = subprocess.Popen(
+            analyze_cmd,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.test_dir,
+            encoding="utf-8",
+            errors="ignore")
+        out, _ = process.communicate()
+        self.assertEqual(out.count("No checkers enabled for gcc"), 1)
+
+        analyze_cmd = [self._codechecker_cmd, "analyze", build_json,
+                       "--analyzers", "gcc",
+                       "-o", self.report_dir,
+                       "--enable", "gcc-div-by-zero",
+                       "--verbose", "debug_analyzer"]
+
+        process = subprocess.Popen(
+            analyze_cmd,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.test_dir,
+            encoding="utf-8",
+            errors="ignore")
+        out, _ = process.communicate()
+        self.assertEqual(out.count("gcc: 1"), 1)
+        self.assertEqual(out.count("Wdiv-by-zero"), 2)
+
+        analyze_cmd = [self._codechecker_cmd, "analyze", build_json,
+                       "--analyzers", "gcc",
+                       "-o", self.report_dir,
+                       "--enable", "gcc-analyzer-out-of-bounds",
+                       "--verbose", "debug_analyzer"]
+
+        process = subprocess.Popen(
+            analyze_cmd,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.test_dir,
+            encoding="utf-8",
+            errors="ignore")
+        out, _ = process.communicate()
+        self.assertEqual(out.count("gcc: 1"), 1)
+        self.assertEqual(out.count("Wanalyzer-out-of-bounds"), 2)
+
+        analyze_cmd = [self._codechecker_cmd, "analyze", build_json,
+                       "--analyzers", "gcc",
+                       "-o", self.report_dir,
+                       "--enable", "gcc-comment",
+                       "--verbose", "debug_analyzer"]
+
+        process = subprocess.Popen(
+            analyze_cmd,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.test_dir,
+            encoding="utf-8",
+            errors="ignore")
+        out, _ = process.communicate()
+        self.assertEqual(out.count("gcc: 1"), 1)
+        self.assertEqual(out.count("Wcomment"), 2)
+
+        analyze_cmd = [self._codechecker_cmd, "analyze", build_json,
+                       "--analyzers", "gcc",
+                       "-o", self.report_dir,
+                       "--enable-all",
+                       "--disable", "gcc-div-by-zero",
+                       "--disable", "gcc-analyzer-out-of-bounds",
+                       "--disable", "gcc-comment",
+                       "--verbose", "debug_analyzer"]
+
+        process = subprocess.Popen(
+            analyze_cmd,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            cwd=self.test_dir,
+            encoding="utf-8",
+            errors="ignore")
+        out, _ = process.communicate()
+        self.assertEqual(out.count("Wno-div-by-zero"), 2)
+        self.assertEqual(out.count("Wno-analyzer-out-of-bounds"), 2)
+        self.assertEqual(out.count("Wno-comment"), 2)
+
     def test_analyzer_and_checker_config(self):
         """Test analyzer configuration through command line flags."""
         build_json = os.path.join(self.test_workspace, "build_success.json")

analyzer/tests/functional/analyze_and_parse/test_files/gcc_simple.output

@@ -18,7 +18,7 @@ CHECK#CodeChecker check --build "make gcc_simple" --output $OUTPUT$ --quiet --an
 [] - To store results use the "CodeChecker store" command.
 [] - See --help and the user guide for further options about parsing and storing the reports.
 [] - ----=================----
-[HIGH] gcc_simple.cpp:5:3: double-‘free’ of ‘i’ [gcc-double-free]
+[HIGH] gcc_simple.cpp:5:3: double-‘free’ of ‘i’ [gcc-analyzer-double-free]
   free(i);
   ^
 
@@ -34,11 +34,11 @@ Found 1 defect(s) in gcc_simple.cpp
 ----=================----
 
 ----==== Checker Statistics ====----
-┌─────────────────┬──────────┬───────────────────┐
-│ Checker name    │ Severity │ Number of reports │
-├─────────────────┼──────────┼───────────────────┤
-│ gcc-double-free │ HIGH     │ 1                 │
-└─────────────────┴──────────┴───────────────────┘
+┌──────────────────────────┬──────────┬───────────────────┐
+│ Checker name             │ Severity │ Number of reports │
+├──────────────────────────┼──────────┼───────────────────┤
+│ gcc-analyzer-double-free │ HIGH     │ 1                 │
+└──────────────────────────┴──────────┴───────────────────┘
 ----=================----
 
 ----==== File Statistics ====----

analyzer/tests/functional/analyze_and_parse/test_files/gcc_simple_checker_disable.output

@@ -1,7 +1,7 @@
 NORMAL#CodeChecker log --output $LOGFILE$ --build "make gcc_simple" --quiet
-NORMAL#CodeChecker analyze $LOGFILE$ --output $OUTPUT$ --analyzers gcc --enable=extreme -d gcc-double-free
+NORMAL#CodeChecker analyze $LOGFILE$ --output $OUTPUT$ --analyzers gcc --enable=extreme -d gcc-analyzer-double-free
 NORMAL#CodeChecker parse $OUTPUT$
-CHECK#CodeChecker check --build "make gcc_simple" --output $OUTPUT$ --quiet --analyzers gcc --enable=extreme -d gcc-double-free
+CHECK#CodeChecker check --build "make gcc_simple" --output $OUTPUT$ --quiet --analyzers gcc --enable=extreme -d gcc-analyzer-double-free
 -----------------------------------------------
 [] - Starting build...
 [] - Using CodeChecker ld-logger.

analyzer/tests/functional/cmdline/test_cmdline.py

@@ -212,8 +212,8 @@ def test_checkers_guideline(self):
                                       'MallocSizeof',
                                       'clang-diagnostic-format-overflow',
                                       'overflow-non-kprintf',
-                                      'gcc-allocation-size',
-                                      'gcc-out-of-bounds']))
+                                      'gcc-analyzer-allocation-size',
+                                      'gcc-analyzer-out-of-bounds']))
 
         checkers_cmd = [env.codechecker_cmd(), 'checkers', '--guideline']
         _, out, _ = run_cmd(checkers_cmd)

analyzer/tests/unit/test_checker_handling.py

@@ -796,7 +796,7 @@ def create_analyzer_cppcheck(args, workspace):
 
 
 class MockCppcheckCheckerLabels:
-    def checkers_by_labels(self, labels):
+    def checkers_by_labels(self, labels, _=None):
         if labels[0] == 'profile:default':
             return [
                 'cppcheck-argumentSize',