[CI] Add a clang-tidy build

[msiddhu]

Fixes #2051

Changes

• Added clang-tidy-18 checks to GitHub Workflow.
• Using the existing .clang-tidy file for checks which is added in [Code Health] clang-tidy cleanup, part 1  #2990
• The opentracing_shim (build WITH_OPENTRACING_SHIM fails as it's taking the .clang-tidy file and has the warningsAsErrors flag enabled) and the etw exporter [Move ETW exporter from opentelelemetry-cpp to opentelemetry-cpp-contrib #1423] are currently excluded from the build.
• The workflow does not auto-fix any code. It simply writes the warnings to an output file (clang-tidy-output.log) and prints the number of warnings present.

Problems

Currently installing gRPC is eating up a lot of time. Open for suggestions to optimize this.

Note

The build contains features which are in currently in preview. Should modify the workflow file when the feature is released as stable.

Remaining Work:

• Add more checks and resolve the warnings via multiple cleanups.
• Compare the warnings count of main branch and the current PR.

For significant contributions please make sure you have completed the following items:

• CHANGELOG.md updated for non-trivial changes
• Unit tests have been added
• Changes in public API reviewed

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.66%. Comparing base (497eaf4) to head (ba3a6d8).
Report is 103 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #3001      +/-   ##
==========================================
+ Coverage   87.12%   87.66%   +0.55%     
==========================================
  Files         200      190      -10     
  Lines        6109     5858     -251     
==========================================
- Hits         5322     5135     -187     
+ Misses        787      723      -64     

see 121 files with indirect coverage changes

[marcalff]

Thanks for adding clang-tidy to the CI.

See some comments.

[marcalff]

This is taking shape.

Somehow the CI log do not show clang-tidy warnings, this needs some troubleshooting.

Make sure it works properly locally first, to validate CMAKE_CXX_CLANG_TIDY works.

[msiddhu]

A still have a problem. I'm not able to suppress the third_party. Please help me with this if you know anyway. Or could revert back to original approach without using the -DCMAKE_CXX_CLANG_TIDY .

I have tried different combinations of regex but the clang-tidy is still not suppressing the warnings.

Even, this is taking longer to run in CI

[marcalff]

A still have a problem. I'm not able to suppress the third_party. Please help me with this if you know anyway. Or could revert back to original approach without using the -DCMAKE_CXX_CLANG_TIDY .

I have tried different combinations of regex but the clang-tidy is still not suppressing the warnings.

Even, this is taking longer to run in CI

See this code in the top level CMakeList.txt:

if(WITH_PROMETHEUS)
  find_package(prometheus-cpp CONFIG QUIET)
  if(NOT prometheus-cpp_FOUND)
    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(ENABLE_TESTING OFF)
      add_subdirectory(third_party/prometheus-cpp)
      set(ENABLE_TESTING ${SAVED_ENABLE_TESTING})
    else()

The same way the prometheus-cpp sub directory is build with ENABLE_TESTING = OFF, there should be a way to build that sub directory without clang-tidy, as in:

      set(CMAKE_CXX_CLANG_TIDY "")

Save and restore the setting, same as SAVED_ENABLE_TESTING.

[msiddhu]

Thanks alot for the help. @marcalff

• Added the set(CMAKE_CXX_CLANG_TIDY "") in required third_parties.
• Enabled some more checks. Currently the warnings are 542. and takes 18 min to run the check.
• In the next cleanups we could adjust the configuration file to get our correct requirements.

Thanks.

[marcalff]

LGTM, thanks for the CI

[lalitb]

Currently installing gRPC is eating up a lot of time. Open for suggestions to optimize this.

The bazel-windows build, which take ~ 30mins, provide enough buffer for CI tasks that are slower but still relatively fast. It's also worth considering using Alpine Linux, as it includes the gRPC package, and the opentelemetry-demo is already utilizing it.

[msiddhu]

Thanks @lalitb. I'll check this and include the OTLP_GRPC in the next clean up.