[CI] Add a clang-tidy build (#3001)

Author: msiddhu

.clang-tidy

@@ -3,6 +3,8 @@
 
 Checks: >
   -*,
+  performance-*,
+  portability-*,
   abseil-*,
   -abseil-string-find-str-contains,
   bugprone-*,
@@ -13,7 +15,6 @@ Checks: >
   -bugprone-unchecked-optional-access,
   -bugprone-unhandled-exception-at-new,
   -bugprone-unused-local-non-trivial-variable,
-  -bugprone-unused-return-value,
   google-*,
   -google-build-using-namespace,
   -google-default-arguments,
@@ -29,41 +30,10 @@ Checks: >
   -misc-non-private-member-variables-in-classes,
   -misc-unused-alias-decls,
   -misc-use-anonymous-namespace,
-  performance-*,
-  -performance-move-const-arg,
-  portability-*
-#  readability-*,
-#  -readability-convert-member-functions-to-static,
-#  -readability-else-after-return,
-#  -readability-function-cognitive-complexity,
-#  -readability-identifier-length,
-#  -readability-implicit-bool-conversion,
-#  -readability-isolate-declaration,
-#  -readability-magic-numbers,
-#  -readability-named-parameter,
-#  -readability-redundant-*,
-#  -readability-string-compare,
-#  cppcoreguidelines-*,
-#  -cppcoreguidelines-avoid-c-arrays,
-#  -cppcoreguidelines-avoid-magic-numbers,
-#  -cppcoreguidelines-init-variables,
-#  -cppcoreguidelines-macro-usage,
-#  -cppcoreguidelines-non-private-member-variables-in-classes,
-#  -cppcoreguidelines-pro-*,
-#  modernize-*,
-#  -modernize-use-default-member-init,
-#  -modernize-use-nodiscard,
-#  -modernize-use-trailing-return-type,
-#  -modernize-avoid-c-arrays,
-#  -modernize-use-using
-
-# Use existing clang-format for formatting the code
-# FormatStyle: 'file'
-
-# TODO: include checks: readability, cppcoreguidelines, modernize , google-readability-namespace-comments, google-readability-avoid-underscore-in-googletest-name, performance-move-const-arg
-
-
-
-
-
-
+  cppcoreguidelines-*,
+  -cppcoreguidelines-avoid-c-arrays,
+  -cppcoreguidelines-avoid-magic-numbers,
+  -cppcoreguidelines-init-variables,
+  -cppcoreguidelines-macro-usage,
+  -cppcoreguidelines-non-private-member-variables-in-classes,
+  -cppcoreguidelines-pro-*

.github/workflows/clang-tidy.yaml

@@ -0,0 +1,84 @@
+name: clang-tidy
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  clang-tidy:
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Setup Environment
+        env:
+          PROTOBUF_VERSION: '23.3'
+          ABSEIL_CPP_VERSION: '20230125.3'
+          CXX_STANDARD: '14'
+        run: |
+          sudo apt update -y
+          sudo apt install -y --no-install-recommends --no-install-suggests \
+          build-essential \
+          iwyu \
+          cmake \
+          libssl-dev \
+          libcurl4-openssl-dev \
+          libprotobuf-dev \
+          protobuf-compiler \
+          libgmock-dev \
+          libgtest-dev \
+          libbenchmark-dev
+
+          if ! command -v clang-tidy &> /dev/null; then
+            echo "clang-tidy could not be found"
+            exit 1
+          fi
+          echo "Using clang-tidy version: $(clang-tidy --version)"
+          echo "clang-tidy installed at: $(which clang-tidy)"
+
+
+      - name: Prepare CMake
+        env:
+          CC: clang
+          CXX: clang++
+        run: |
+          mkdir -p build && cd build
+          echo "Running cmake..."
+          cmake .. \
+            -DCMAKE_CXX_STANDARD=14 \
+            -DWITH_STL=CXX14 \
+            -DWITH_OTLP_HTTP=ON \
+            -DWITH_OTLP_FILE=ON \
+            -DWITH_PROMETHEUS=ON \
+            -DWITH_ZIPKIN=ON \
+            -DWITH_ELASTICSEARCH=ON \
+            -DWITH_OTLP_HTTP_COMPRESSION=ON \
+            -DWITH_EXAMPLES=ON \
+            -DWITH_EXAMPLES_HTTP=ON \
+            -DBUILD_W3CTRACECONTEXT_TEST=ON \
+            -DWITH_METRICS_EXEMPLAR_PREVIEW=ON \
+            -DWITH_ASYNC_EXPORT_PREVIEW=ON \
+            -DCMAKE_EXPORT_COMPILE_COMMANDS=ON \
+            -DCMAKE_CXX_CLANG_TIDY="clang-tidy"
+
+      - name: Run clang-tidy
+        run: |
+          cd build
+          make -j$(nproc) 2>&1 | tee -a clang-tidy.log || exit 1
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: Logs (clang-tidy)
+          path: ./build/clang-tidy.log
+
+      - name: Count warnings
+        run: |
+          cd build
+          COUNT=$(grep -c "warning:" clang-tidy.log)
+          echo "clang-tidy reported ${COUNT} warning(s)"
+
+# TODO: include WITH_OTLP_GRPC and WITH_ABSEIL flags.

CHANGELOG.md

@@ -15,6 +15,9 @@ Increment the:
 
 ## [Unreleased]
 
+* [CI] Add a clang-tidy build
+  [#3001](https://github.com/open-telemetry/opentelemetry-cpp/pull/3001)
+
 ## [1.16.1 2024-07-17]
 
 * [BUILD] Add bazel missing BUILD file

CMakeLists.txt

@@ -364,9 +364,12 @@ if(WITH_PROMETHEUS)
     message(STATUS "Trying to use local prometheus-cpp from submodule")
     if(EXISTS ${PROJECT_SOURCE_DIR}/third_party/prometheus-cpp/.git)
       set(SAVED_ENABLE_TESTING ${ENABLE_TESTING})
+      set(SAVED_CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY})
       set(ENABLE_TESTING OFF)
+      set(CMAKE_CXX_CLANG_TIDY "")
       add_subdirectory(third_party/prometheus-cpp)
       set(ENABLE_TESTING ${SAVED_ENABLE_TESTING})
+      set(CMAKE_CXX_CLANG_TIDY ${SAVED_CMAKE_CXX_CLANG_TIDY})
     else()
       message(
         FATAL_ERROR
@@ -444,7 +447,10 @@ if(WITH_OTLP_GRPC
   include(CMakeDependentOption)
 
   message(STATUS "PROTOBUF_PROTOC_EXECUTABLE=${PROTOBUF_PROTOC_EXECUTABLE}")
+  set(SAVED_CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY})
+  set(CMAKE_CXX_CLANG_TIDY "")
   include(cmake/opentelemetry-proto.cmake)
+  set(CMAKE_CXX_CLANG_TIDY ${SAVED_CMAKE_CXX_CLANG_TIDY})
 endif()
 
 #