Use clang-tidy through cmake (#341)

Author: andiwand

.github/workflows/build_test.yml

@@ -67,14 +67,9 @@ jobs:
         env:
           CC: ${{ matrix.config.cc }}
           CXX: ${{ matrix.config.cxx }}
-        run: |
-          mkdir -p build
-          cd build
-          cmake -DCMAKE_BUILD_TYPE=Release ..
-      - name: make
-        run: |
-          cd build
-          cmake --build . --config Release # `config Release` somehow necessary by windows
+        run: cmake -B build -S . -DCMAKE_BUILD_TYPE=Release
+      - name: build
+        run: cmake --build build --config Release # `config Release` somehow necessary by windows
 
       - name: upload binaries
         uses: actions/upload-artifact@v2

.github/workflows/format.yml

@@ -11,8 +11,6 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - run: sudo apt install clang-format-15
-
       - run: clang-format-15 --version
 
       - name: checkout

.github/workflows/tidy.yml

@@ -15,10 +15,7 @@ jobs:
     runs-on: ubuntu-22.04
 
     steps:
-      - name: ubuntu install clang-tidy
-        run: |
-          sudo apt install clang-tidy-12
-          clang-tidy-12 --version
+      - run: clang-tidy --version
 
       - name: set up python 3.8
         uses: actions/setup-python@v2
@@ -31,12 +28,7 @@ jobs:
         uses: actions/checkout@v2
 
       - name: cmake
-        run: |
-          mkdir -p build
-          cd build
-          cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_EXPORT_COMPILE_COMMANDS=ON ..
+        run: cmake -B build -S . -DCMAKE_BUILD_TYPE=Release -DODR_CLANG_TIDY=ON
 
       - name: clang-tidy
-        run: |
-          FILES=$( find . -path ./build -prune -false -o -type f \( -iname \*.cpp \) )
-          clang-tidy-12 -p build -header-filter '.*' $FILES
+        run: cmake --build build

CMakeLists.txt

@@ -6,6 +6,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 set(CMAKE_CXX_EXTENSIONS OFF)
 
 option(ODR_TEST "enable tests" ON)
+option(ODR_CLANG_TIDY "Run clang-tidy static analysis" OFF)
 
 # TODO defining global compiler flags seems to be bad practice with conan
 # TODO consider using conan profiles
@@ -163,15 +164,15 @@ add_library(odr
 
         "src/odr/internal/zip/zip_util.cpp"
         "src/odr/internal/zip/zip_archive.cpp"
-        )
+)
 set_target_properties(odr PROPERTIES OUTPUT_NAME odr)
 if (EXISTS "${PROJECT_SOURCE_DIR}/.git")
     add_dependencies(odr check_git)
 endif ()
 target_include_directories(odr
         PUBLIC
         src
-        )
+)
 target_link_libraries(odr
         PRIVATE
         pugixml::pugixml
@@ -180,14 +181,18 @@ target_link_libraries(odr
         nlohmann_json::nlohmann_json
         vincentlaucsb-csv-parser::vincentlaucsb-csv-parser
         uchardet::uchardet
-        )
+)
 
 add_subdirectory("cli")
 
 if (ODR_TEST)
     add_subdirectory("test")
 endif ()
 
+if (ODR_CLANG_TIDY)
+    add_subdirectory("static_analysis/clang-tidy")
+endif ()
+
 install(
         TARGETS
         odr

static_analysis/clang-tidy/CMakeLists.txt

@@ -0,0 +1,10 @@
+find_program(CLANG_TIDY_COMMAND NAMES clang-tidy)
+
+if (NOT CLANG_TIDY_COMMAND)
+    message(ERROR "ACTS_RUN_CLANG_TIDY is ON but clang-tidy is not found!")
+    set(CMAKE_CXX_CLANG_TIDY "" CACHE STRING "" FORCE)
+endif ()
+
+message(STATUS "Setting up clang-tidy run")
+
+set(CMAKE_CXX_CLANG_TIDY "${CLANG_TIDY_COMMAND}")