fixed #12017/#13723 - added command-line option --clang-tidy{=<exe>} and fixed output (danmar#7366)

Author: firewave

cli/cmdlineparser.cpp

@@ -603,6 +603,15 @@ CmdLineParser::Result CmdLineParser::parseFromArgs(int argc, const char* const a
             mSettings.clangExecutable = argv[i] + 8;
         }
 
+        else if (std::strcmp(argv[i], "--clang-tidy") == 0) {
+            mSettings.clangTidy = true;
+        }
+
+        else if (std::strncmp(argv[i], "--clang-tidy=", 13) == 0) {
+            mSettings.clangTidy = true;
+            mSettings.clangTidyExecutable = argv[i] + 13;
+        }
+
         else if (std::strncmp(argv[i], "--config-exclude=",17) ==0) {
             mSettings.configExcludePaths.insert(Path::fromNativeSeparators(argv[i] + 17));
         }

lib/cppcheck.cpp

@@ -1896,15 +1896,20 @@ void CppCheck::analyseClangTidy(const FileSettings &fileSettings)
 
     const std::string allDefines = getDefinesFlags(fileSettings.defines);
 
+    std::string exe = mSettings.clangTidyExecutable;
 #ifdef _WIN32
-    constexpr char exe[] = "clang-tidy.exe";
-#else
-    constexpr char exe[] = "clang-tidy";
+    // TODO: is this even necessary?
+    // append .exe if it is not a path
+    if (Path::fromNativeSeparators(mSettings.clangTidyExecutable).find('/') == std::string::npos) {
+        exe += ".exe";
+    }
 #endif
 
+    // TODO: log this call
+    // TODO: get rid of hard-coded checks
     const std::string args = "-quiet -checks=*,-clang-analyzer-*,-llvm* \"" + fileSettings.filename() + "\" -- " + allIncludes + allDefines;
     std::string output;
-    if (const int exitcode = mExecuteCommand(exe, split(args), "", output)) {
+    if (const int exitcode = mExecuteCommand(exe, split(args), "2>&1", output)) {
         std::cerr << "Failed to execute '" << exe << "' (exitcode: " << std::to_string(exitcode) << ")" << std::endl;
         return;
     }
@@ -1919,6 +1924,7 @@ void CppCheck::analyseClangTidy(const FileSettings &fileSettings)
         fcmd << istr.str();
     }
 
+    // TODO: log
     while (std::getline(istr, line)) {
         if (line.find("error") == std::string::npos && line.find("warning") == std::string::npos)
             continue;
@@ -1959,7 +1965,7 @@ void CppCheck::analyseClangTidy(const FileSettings &fileSettings)
             errmsg.severity = Severity::style;
 
         errmsg.file0 = std::move(fixedpath);
-        errmsg.setmsg(messageString);
+        errmsg.setmsg(trim(messageString));
         mErrorLogger.reportErr(errmsg);
     }
 }

lib/settings.h

@@ -162,7 +162,10 @@ class CPPCHECKLIB WARN_UNUSED Settings {
     std::string clangExecutable = "clang";
 
     /** Use clang-tidy */
-    bool clangTidy{}; // TODO: CLI
+    bool clangTidy{};
+
+    /** Custom clang-tidy executable */
+    std::string clangTidyExecutable = "clang-tidy";
 
     /** Internal: Clear the simplecpp non-existing include cache */
     bool clearIncludeCache{}; // internal

test/cli/other_test.py

@@ -5,6 +5,7 @@
 import sys
 import pytest
 import json
+import subprocess
 
 from testutils import cppcheck, assert_cppcheck, cppcheck_ex
 from xml.etree import ElementTree
@@ -3369,4 +3370,51 @@ def test_check_unused_templates_func(tmp_path):  # #13714
     exitcode, stdout, stderr = cppcheck(args)
     assert exitcode == 0, stdout
     assert stdout.splitlines() == []
-    assert stderr.splitlines() == []  # no error since the unused templates are not being checked
+    assert stderr.splitlines() == []  # no error since the unused templates are not being checked
+
+try:
+    # TODO: handle exitcode?
+    subprocess.call(['clang-tidy', '--version'])
+    has_clang_tidy = True
+except OSError:
+    has_clang_tidy = False
+
+def __test_clang_tidy(tmpdir, use_compdb):
+    test_file = os.path.join(tmpdir, 'test.cpp')
+    with open(test_file, 'wt') as f:
+        f.write(
+"""static void foo() // NOLINT(misc-use-anonymous-namespace)
+{
+    (void)(*((int*)nullptr));
+}""")
+
+    project_file = __write_compdb(tmpdir, test_file) if use_compdb else None
+
+    args = [
+        '-q',
+        '--template=simple',
+        '--clang-tidy'
+    ]
+    if project_file:
+        args += ['--project={}'.format(project_file)]
+    else:
+        args += [str(test_file)]
+    exitcode, stdout, stderr = cppcheck(args)
+    assert exitcode == 0, stdout
+    assert stdout.splitlines() == [
+    ]
+    assert stderr.splitlines() == [
+        '{}:3:14: error: Null pointer dereference: (int*)nullptr [nullPointer]'.format(test_file),
+        '{}:3:14: style: C-style casts are discouraged; use static_cast/const_cast/reinterpret_cast [clang-tidy-google-readability-casting]'.format(test_file)
+    ]
+
+
+@pytest.mark.skipif(not has_clang_tidy, reason='clang-tidy is not available')
+@pytest.mark.xfail(strict=True)  # TODO: clang-tidy is only invoked with FileSettings - see #12053
+def test_clang_tidy(tmpdir):  # #12053
+    __test_clang_tidy(tmpdir, False)
+
+
+@pytest.mark.skipif(not has_clang_tidy, reason='clang-tidy is not available')
+def test_clang_tidy_project(tmpdir):
+    __test_clang_tidy(tmpdir, True)

test/testcmdlineparser.cpp

@@ -324,7 +324,7 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(exceptionhandlingNotSupported2);
 #endif
         TEST_CASE(clang);
-        TEST_CASE(clang2);
+        TEST_CASE(clangCustom);
         TEST_CASE(clangInvalid);
         TEST_CASE(valueFlowMaxIterations);
         TEST_CASE(valueFlowMaxIterations2);
@@ -448,6 +448,8 @@ class TestCmdlineParser : public TestFixture {
         TEST_CASE(checkUnusedTemplates);
         TEST_CASE(noCheckUnusedTemplates);
         TEST_CASE(noCheckUnusedTemplates);
+        TEST_CASE(clangTidy);
+        TEST_CASE(clangTidyCustom);
 
         TEST_CASE(ignorepaths1);
         TEST_CASE(ignorepaths2);
@@ -2111,7 +2113,7 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS("clang", settings->clangExecutable);
     }
 
-    void clang2() {
+    void clangCustom() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "--clang=clang-14", "file.cpp"};
         ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parseFromArgs(argv));
@@ -3048,6 +3050,22 @@ class TestCmdlineParser : public TestFixture {
         ASSERT_EQUALS(false, settings->checkUnusedTemplates);
     }
 
+    void clangTidy() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--clang-tidy", "file.cpp"};
+        ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parser->parseFromArgs(3, argv));
+        ASSERT(settings->clangTidy);
+        ASSERT_EQUALS("clang-tidy", settings->clangTidyExecutable);
+    }
+
+    void clangTidyCustom() {
+        REDIRECT;
+        const char * const argv[] = {"cppcheck", "--clang-tidy=clang-tidy-14", "file.cpp"};
+        ASSERT_EQUALS_ENUM(CmdLineParser::Result::Success, parser->parseFromArgs(3, argv));
+        ASSERT(settings->clangTidy);
+        ASSERT_EQUALS("clang-tidy-14", settings->clangTidyExecutable);
+    }
+
     void ignorepaths1() {
         REDIRECT;
         const char * const argv[] = {"cppcheck", "-isrc", "file.cpp"};