Merge pull request #794 from LebedevRI/clang-tidy-sarif

LebedevRI · web-flow · commit e9ad258ac59c · 2025-04-04T22:33:09.000+03:00
Github: sarif-ify clang-tidy output
diff --git a/.github/workflows/CI-linux.yml b/.github/workflows/CI-linux.yml
@@ -146,12 +146,12 @@ jobs:
             eatmydata apt install clang-format-${{ inputs.compiler-version }} clang-tidy-${{ inputs.compiler-version }}
 
             eatmydata apt install curl gpg
-            echo 'deb https://ftp.gwdg.de//pub/opensuse/repositories/graphics%3A/darktable%3A/master/Debian_Unstable/ /' | tee /etc/apt/sources.list
+            echo 'deb https://ftp.gwdg.de//pub/opensuse/repositories/graphics%3A/darktable%3A/master/Debian_Unstable/ /' | tee /etc/apt/sources.list.d/rawspeed.list
             curl -fsSL https://download.opensuse.org/repositories/graphics:darktable:master/Debian_Unstable/Release.key | gpg --dearmor | tee /etc/apt/trusted.gpg.d/graphics_darktable_master.gpg > /dev/null
             apt update
             eatmydata apt install rawspeed-clang-tidy-module
           fi
-          if [ "$FLAVOR" = "ClangStaticAnalysis" ] || [ "$FLAVOR" = "ClangCTUStaticAnalysis" ]; then
+          if [ "$FLAVOR" = "ClangTidy" ] || [ "$FLAVOR" = "ClangStaticAnalysis" ] || [ "$FLAVOR" = "ClangCTUStaticAnalysis" ]; then
             eatmydata apt install clang-tools-${{ inputs.compiler-version }} \
                                       curl \
                                       libxml2-dev \
@@ -171,7 +171,7 @@ jobs:
           fi
           eatmydata apt clean
           dpkg-divert --add --rename --divert /usr/bin/ld.original /usr/bin/ld
-          if [ "$FLAVOR" = "ClangStaticAnalysis" ] || [ "$FLAVOR" = "ClangCTUStaticAnalysis" ]; then
+          if [ "$FLAVOR" = "ClangTidy" ] || [ "$FLAVOR" = "ClangStaticAnalysis" ] || [ "$FLAVOR" = "ClangCTUStaticAnalysis" ]; then
             ln -s /usr/bin/${{ inputs.compiler-CC  }} /usr/local/bin/clang
             ln -s /usr/bin/${{ inputs.compiler-CXX }} /usr/local/bin/clang++
             ln -s /usr/bin/${{ inputs.compiler-CC  }} /usr/local/bin/gcc
@@ -201,15 +201,15 @@ jobs:
           fail-on-cache-miss: true
       - name: Fetch/Checkout CodeChecker git repo (for clang static analysis)
         timeout-minutes: 1
-        if: inputs.flavor == 'ClangStaticAnalysis' || inputs.flavor == 'ClangCTUStaticAnalysis'
+        if: inputs.flavor == 'ClangTidy' || inputs.flavor == 'ClangStaticAnalysis' || inputs.flavor == 'ClangCTUStaticAnalysis'
         uses: actions/checkout@v4
         with:
           repository: 'Ericsson/codechecker'
           path: 'codechecker'
           fetch-depth: '1'
       - name: Install CodeChecker (for clang static analysis)
         timeout-minutes: 1
-        if: inputs.flavor == 'ClangStaticAnalysis' || inputs.flavor == 'ClangCTUStaticAnalysis'
+        if: inputs.flavor == 'ClangTidy' || inputs.flavor == 'ClangStaticAnalysis' || inputs.flavor == 'ClangCTUStaticAnalysis'
         env:
           CC: ${{ inputs.compiler-CC }}
           CXX: ${{ inputs.compiler-CXX }}
@@ -269,14 +269,18 @@ jobs:
           BUILD_DIR: ${{ github.workspace }}/rawspeed-build
           INSTALL_PREFIX: ${{ github.workspace }}/rawspeed-install
           RPUU_DST: ${{ env.RPUU_DST }}
-          ECO: ${{ inputs.ECO }} -DALLOW_DOWNLOADING_GOOGLETEST=ON -DALLOW_DOWNLOADING_GOOGLEBENCHMARK=ON -DUSE_CLANG_TIDY=${{ inputs.flavor == 'ClangTidy' }} -DRAWSPEED_ENABLE_SAMPLE_BASED_TESTING=${{ inputs.enable-sample-based-testing }}
+          ECO: ${{ inputs.ECO }} -DALLOW_DOWNLOADING_GOOGLETEST=ON -DALLOW_DOWNLOADING_GOOGLEBENCHMARK=ON -DUSE_CLANG_TIDY=${{ inputs.flavor == 'ClangTidy' }} -DRAWSPEED_ENABLE_CLANG_TIDY_WERROR=OFF -DRAWSPEED_ENABLE_SAMPLE_BASED_TESTING=${{ inputs.enable-sample-based-testing }}
           FLAVOR: ${{ inputs.flavor }}
           TARGET: configure
         run: |
           set -xe
           cmake -E make_directory "${BUILD_DIR}"
           cmake -E make_directory "${INSTALL_PREFIX}"
           export ECO="${ECO} -DRAWSPEED_REFERENCE_SAMPLE_ARCHIVE=${RPUU_DST}"
+          export ECO="${ECO} -DCMAKE_CXX_CLANG_TIDY_EXPORT_FIXES_DIR=${BUILD_DIR}/clang-tidy/"
+          if [ "$FLAVOR" = "ClangTidy" ] || [ "$FLAVOR" = "ClangStaticAnalysis" ] || [ "$FLAVOR" = "ClangCTUStaticAnalysis" ] || [ "$FLAVOR" = "CodeQLAnalysis" ]; then
+            export ECO="${ECO} -DRAWSPEED_ENABLE_WERROR=OFF"
+          fi
           "${SRC_DIR}/.ci/ci-script.sh"
       - name: Build
         timeout-minutes: ${{ inputs.flavor != 'ClangTidy' && (inputs.flavor != 'CodeQLAnalysis' && 7 || 12) || 25 }}
@@ -388,6 +392,54 @@ jobs:
         run: |
           set -xe
           "${SRC_DIR}/.ci/ci-script.sh"
+      - name: Perform clang-tidy static analysis
+        timeout-minutes: 1
+        if: inputs.flavor == 'ClangTidy' && !cancelled()
+        env:
+          SRC_DIR: ${{ github.workspace }}/rawspeed
+          BUILD_DIR: ${{ github.workspace }}/rawspeed-build
+          CC: ${{ inputs.compiler-CC }}
+          CXX: ${{ inputs.compiler-CXX }}
+        id: CC-CTSA
+        run: |
+          set -xe
+          . "$PWD/codechecker/venv/bin/activate"
+          export PATH="$PWD/codechecker/build/CodeChecker/bin:$PATH"
+          set +e
+          report-converter -t clang-tidy-yaml -o "${BUILD_DIR}/codechecker_clangtidy_results" "${BUILD_DIR}/clang-tidy/"
+          CodeChecker parse -e sarif "${BUILD_DIR}/codechecker_clangtidy_results" -o "${GITHUB_WORKSPACE}/codechecker_clangtidy_report.json"
+          CodeChecker parse -e html "${BUILD_DIR}/codechecker_clangtidy_results" -o "${GITHUB_WORKSPACE}/codechecker_clangtidy_report"
+          bugs=$?
+          set -xe
+          [ $bugs -eq 0 ] || exit 1
+      - name: Upload results of clang-tidy static analysis [YAML]
+        timeout-minutes: 1
+        if: inputs.flavor == 'ClangTidy' && failure() && steps.CC-CTSA.conclusion == 'failure'
+        uses: actions/upload-artifact@v4
+        with:
+          name: clangtidy_report
+          path: ${{ github.workspace }}/rawspeed-build/clang-tidy/
+          if-no-files-found: error
+          compression-level: 9
+          overwrite: true
+      - name: Upload results of clang-tidy static analysis [SARIF]
+        timeout-minutes: 1
+        if: inputs.flavor == 'ClangTidy' && failure() && steps.CC-CTSA.conclusion == 'failure'
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: "${{ github.workspace }}/codechecker_clangtidy_report.json"
+          checkout_path: "${{ github.workspace }}/rawspeed"
+          category: CodeChecker-CTSA
+      - name: Upload results of clang-tidy static analysis [HTML]
+        timeout-minutes: 1
+        if: inputs.flavor == 'ClangTidy' && failure() && steps.CC-CTSA.conclusion == 'failure'
+        uses: actions/upload-artifact@v4
+        with:
+          name: codechecker_clangtidy_report
+          path: ${{ github.workspace }}/codechecker_clangtidy_report/
+          if-no-files-found: error
+          compression-level: 9
+          overwrite: true
       - name: Perform clang static analysis (plain mode)
         timeout-minutes: 25
         if: inputs.flavor == 'ClangStaticAnalysis'
@@ -466,7 +518,7 @@ jobs:
           overwrite: true
       - name: Perform CodeQL static analysis
         timeout-minutes: 11
-        if: inputs.flavor == 'CodeQLAnalysis'
+        if: inputs.flavor == 'CodeQLAnalysis' && !cancelled()
         uses: github/codeql-action/analyze@v3
       - name: Perform SonarCloud static analysis
         timeout-minutes: 6
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -53,6 +53,7 @@ endif()
 option(RAWSPEED_ENABLE_DEBUG_INFO "Whether to generate debug info or not." ON)
 
 option(RAWSPEED_ENABLE_WERROR "Stop and fail the build, if a compiler warning is triggered." ON)
+option(RAWSPEED_ENABLE_CLANG_TIDY_WERROR "Stop and fail the build, if a clang-tidy warning is triggered." ON)
 
 option(WITH_OPENMP "Enable OpenMP support." ON)
 if(WITH_OPENMP)
diff --git a/cmake/clang-tidy.cmake b/cmake/clang-tidy.cmake
@@ -1,6 +1,6 @@
 find_package(LLVMClangTidy REQUIRED)
 
-set(plugin "")
+unset(plugin)
 
 if(USE_RAWSPEED_CLANG_TIDY_MODULE)
   math(EXPR CLANG_TIDY_VERSION_MAJOR_NEXT "1 + ${CLANG_TIDY_VERSION_MAJOR}")
@@ -16,4 +16,15 @@ if(USE_RAWSPEED_CLANG_TIDY_MODULE)
   set(plugin "--load=$<TARGET_PROPERTY:RawSpeedClangTidyModule::clangTidyRawSpeedModule,LOCATION>")
 endif()
 
-set(CMAKE_CXX_CLANG_TIDY "${CLANGTIDY_PATH}" ${plugin} -extra-arg=-Wno-unknown-warning-option -extra-arg=-Wno-unknown-pragmas)
+set(CMAKE_CXX_CLANG_TIDY "${CLANGTIDY_PATH}")
+
+if(DEFINED plugin)
+  set(CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY} ${plugin})
+endif()
+
+if(NOT RAWSPEED_ENABLE_CLANG_TIDY_WERROR)
+  set(CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY} -warnings-as-errors=-*)
+endif()
+
+set(CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY} -extra-arg=-Wno-unknown-warning-option)
+set(CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY} -extra-arg=-Wno-unknown-pragmas)
