only issue logChecker messages when necessary (#8535)

Author: firewave

cli/cppcheckexecutor.cpp

@@ -501,6 +501,7 @@ int CppCheckExecutor::check_internal(const Settings& settings, Suppressions& sup
 
 void StdLogger::writeCheckersReport(const Suppressions& supprs)
 {
+    // TODO: only necessary when we actually issue a checkers report?
     if (!mCheckersFile.empty())
     {
         std::ofstream fout(mCheckersFile);
@@ -510,15 +511,14 @@ void StdLogger::writeCheckersReport(const Suppressions& supprs)
         }
     }
 
-    const bool summary = mSettings.safety || mSettings.severity.isEnabled(Severity::information);
-    const bool xmlReport = mSettings.outputFormat == Settings::OutputFormat::xml && mSettings.xml_version == 3;
-    const bool textReport = !mSettings.checkersReportFilename.empty();
+    bool summary, xmlReport, textReport;
 
-    if (!summary && !xmlReport && !textReport)
+    if (!mSettings.collectLogCheckers(&summary, &xmlReport, &textReport))
         return;
 
     CheckersReport checkersReport(mSettings, mActiveCheckers);
 
+    // TODO: include in summary boolean
     const auto& suppressions = supprs.nomsg.getSuppressions();
     const bool summarySuppressed = std::any_of(suppressions.cbegin(), suppressions.cend(), [](const SuppressionList::Suppression& s) {
         return s.errorId == "checkersReport";

cli/processexecutor.cpp

@@ -154,7 +154,7 @@ namespace {
         void writeToPipe(PipeSignal type, const std::string &data) const
         {
             if (mDebug)
-                std::cout << "writeToPipe - " << static_cast<unsigned int>(type) << " - " << data << std::endl;
+                std::cout << "writeToPipe - " << static_cast<char>(type) << " - " << data << std::endl;
 
             {
                 const auto t = static_cast<char>(type);

lib/check.cpp

@@ -130,7 +130,7 @@ ErrorPath Check::getErrorPath(const Token* errtok, const ValueFlow::Value* value
 
 void Check::logChecker(const char id[])
 {
-    // TODO: only issue when we would actually use it later on
-    reportError(nullptr, Severity::internal, "logChecker", id);
+    if (!mSettings->buildDir.empty() || mSettings->collectLogCheckers())
+        reportError(nullptr, Severity::internal, "logChecker", id);
 }
 

lib/settings.cpp

@@ -770,3 +770,18 @@ bool Settings::unusedFunctionOnly()
     const char* unusedFunctionOnly = std::getenv("UNUSEDFUNCTION_ONLY");
     return unusedFunctionOnly && (std::strcmp(unusedFunctionOnly, "1") == 0);
 }
+
+bool Settings::collectLogCheckers(bool* summary, bool* xmlReport, bool* textReport) const
+{
+    const bool s = safety || severity.isEnabled(Severity::information);
+    if (summary)
+        *summary = s;
+    const bool x = outputFormat == Settings::OutputFormat::xml && xml_version == 3;
+    if (xmlReport)
+        *xmlReport = x;
+    const bool t = !checkersReportFilename.empty();
+    if (textReport)
+        *textReport = t;
+
+    return s || x || t;
+}

lib/settings.h

@@ -596,6 +596,8 @@ class CPPCHECKLIB WARN_UNUSED Settings {
 
     static bool unusedFunctionOnly();
 
+    bool collectLogCheckers(bool* summary = nullptr, bool* xmlReport = nullptr, bool* textReport = nullptr) const;
+
 private:
     static std::string parseEnabled(const std::string &str, std::tuple<SimpleEnableGroup<Severity>, SimpleEnableGroup<Checks>> &groups);
     std::string applyEnabled(const std::string &str, bool enable);

test/cli/other_test.py

@@ -4636,9 +4636,8 @@ def test_dui_include_absolute_missing(tmp_path):  # #14675
     ]
 
 
-@pytest.mark.xfail(strict=True)  # TODO: should not report logChecker when not required
 @pytest.mark.skipif(sys.platform == 'win32', reason="requires ProcessExecutor")
-def test_ipc_log_checker(tmp_path):
+def test_ipc(tmp_path):
     test_file = tmp_path / 'test.c'
     with open(test_file, "w") as f:
         f.write('void f() {}')
@@ -4648,6 +4647,7 @@ def test_ipc_log_checker(tmp_path):
         '--debug-ipc',
         '-j2',
         '--executor=process',
+        '--no-cppcheck-build-dir',
         str(test_file)
     ]