renamed --debug-clang-ast to -debug-clang-output as it might cont…

…ain compiler warnings/errors - also log it earlier
danmar · Jan 13, 2025 · 7ad1ab4 · 7ad1ab4
1 parent c1ab84c
commit 7ad1ab4
Show file tree

Hide file tree

Showing 5 changed files with 48 additions and 14 deletions.
diff --git a/cli/cmdlineparser.cpp b/cli/cmdlineparser.cpp
@@ -615,8 +615,8 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
             }
 
             // Show debug warnings for lookup for configuration files
-            else if (std::strcmp(argv[i], "--debug-clang-ast") == 0)
-                mSettings.debugClangAst = true;
+            else if (std::strcmp(argv[i], "--debug-clang-output") == 0)
+                mSettings.debugClangOutput = true;
 
             // Show --debug output after the first simplifications
             else if (std::strcmp(argv[i], "--debug") == 0 ||

diff --git a/lib/cppcheck.cpp b/lib/cppcheck.cpp
@@ -680,16 +680,15 @@ unsigned int CppCheck::checkClang(const FileWithDetails &file)
 
     std::string output2;
     const int exitcode = mExecuteCommand(exe,split(args2),redirect2,output2);
+    if (mSettings.debugClangOutput) {
+        std::cout << output2 << std::endl;
+    }
     if (exitcode != EXIT_SUCCESS) {
         // TODO: report as proper error
         std::cerr << "Failed to execute '" << exe << " " << args2 << " " << redirect2 << "' - (exitcode: " << exitcode << " / output: " << output2 << ")" << std::endl;
         return 0; // TODO: report as failure?
     }
 
-    if (mSettings.debugClangAst) {
-        std::cout << output2 << std::endl;
-    }
-
     if (output2.find("TranslationUnitDecl") == std::string::npos) {
         // TODO: report as proper error
         std::cerr << "Failed to execute '" << exe << " " << args2 << " " << redirect2 << "' - (no TranslationUnitDecl in output)" << std::endl;

diff --git a/lib/settings.h b/lib/settings.h
@@ -178,8 +178,8 @@ class CPPCHECKLIB WARN_UNUSED Settings {
     /** @brief Are we running from DACA script? */
     bool daca{};
 
-    /** @brief Is --debug-clang-ast given? */
-    bool debugClangAst{};
+    /** @brief Is --debug-clang-output given? */
+    bool debugClangOutput{};
 
     /** @brief Internal: Is --debug-lookup or --debug-lookup=all given? */
     bool debuglookup{};

diff --git a/test/cli/clang-import_test.py b/test/cli/clang-import_test.py
@@ -241,7 +241,7 @@ def test_cmd_std_cpp_enforce_alias(tmp_path):  # #13128/#13129/#13130
     __test_cmd(tmp_path, 'test.c',['--language=c++', '--std=gnu99', '--std=gnu++11'], '-x c++ -std=gnu++11')
 
 
-def test_debug_ast(tmp_path):
+def test_debug_clang_output(tmp_path):
     test_file = tmp_path / 'test.c'
     with open(test_file, 'wt') as f:
         f.write(
@@ -252,12 +252,47 @@ def test_debug_ast(tmp_path):
     args = [
         '-q',
         '--clang',
-        '--debug-clang-ast',
+        '--debug-clang-output',
         str(test_file)
     ]
 
     exitcode, stdout, stderr = cppcheck(args)
     assert exitcode == 0, stderr if not stdout else stdout
     assert stderr == ''
     assert stdout.startswith('TranslationUnitDecl'), stdout
+    assert stdout.find(str(test_file)) != -1, stdout
+
+
+def test_debug_clang_output_failure_exitcode(tmp_path):
+    # the given code will cause clang to fail with an exitcode
+    #
+    # Failed to execute 'clang -fsyntax-only -Xclang -ast-dump -fno-color-diagnostics -x c++ a.cpp 2>&1' - (exitcode: 1 / output: a.cpp:3:12: error: indirection requires pointer operand ('int' invalid)
+    # 3 |     (void)(*0);
+    # |            ^~
+    # 1 error generated.
+    # TranslationUnitDecl 0x6127d5d9d4e8 <<invalid sloc>> <invalid sloc>
+    # ...
+    test_file = tmp_path / 'test.c'
+    with open(test_file, 'wt') as f:
+        f.write(
+"""void f()
+{
+    (void)(*0);
+}
+""")
+
+    args = [
+        '-q',
+        '--clang',
+        '--debug-clang-output',
+        str(test_file)
+    ]
+
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stderr if not stdout else stdout
+    stderr_lines = stderr.splitlines()
+    assert len(stderr_lines) > 5, stderr_lines
+    assert (stderr_lines[0] ==
+            "Failed to execute 'clang -fsyntax-only -Xclang -ast-dump -fno-color-diagnostics -x c {} 2>&1' - (exitcode: 1 / output: {}:3:12: error: indirection requires pointer operand ('int' invalid)".format(test_file, test_file))
+    assert stdout.find('TranslationUnitDecl') != -1, stdout
     assert stdout.find(str(test_file)) != -1, stdout
diff --git a/test/testcmdlineparser.cpp b/test/testcmdlineparser.cpp
@@ -422,7 +422,7 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(maxTemplateRecursion);
         TEST_CASE(maxTemplateRecursionMissingCount);
         TEST_CASE(emitDuplicates);
-        TEST_CASE(debugClangAst);
+        TEST_CASE(debugClangOutput);
 
         TEST_CASE(ignorepaths1);
         TEST_CASE(ignorepaths2);
@@ -2908,11 +2908,11 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS(true, settings->emitDuplicates);
     }
 
-    void debugClangAst() {
+    void debugClangOutput() {
         REDIRECT;
-        const char * const argv[] = {"cppcheck", "--debug-clang-ast", "file.cpp"};
+        const char * const argv[] = {"cppcheck", "--debug-clang-output", "file.cpp"};
         ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parser->parseFromArgs(3, argv));
-        ASSERT_EQUALS(true, settings->debugClangAst);
+        ASSERT_EQUALS(true, settings->debugClangOutput);
     }
 
     void ignorepaths1() {