Merge branch 'main' into fix_clang_tidy_warnings_part_6

Author: lalitb

.github/workflows/cmake_install.yml

@@ -215,7 +215,7 @@ jobs:
         run: ./ci/do_ci.sh cmake.opentracing_shim.install.test
 
   ubuntu_2404_conan_latest:
-    name: Ubuntu 24.04 conan latest versions cxx17 (static libs)
+    name: Ubuntu 24.04 conan latest versions cxx17 (static libs - opentracing shim)
     runs-on: ubuntu-24.04
     env:
       INSTALL_TEST_DIR: '/home/runner/install_test'
@@ -248,6 +248,8 @@ jobs:
         run: |
           export PKG_CONFIG_PATH=$INSTALL_TEST_DIR/lib/pkgconfig:$PKG_CONFIG_PATH
           ./ci/verify_packages.sh
+      - name: Run OpenTracing Shim Test
+        run: ./ci/do_ci.sh cmake.opentracing_shim.install.test
 
   macos_14_conan_stable:
     name: macOS 14 conan stable versions cxx17 (static libs)

CMakeLists.txt

@@ -36,11 +36,6 @@ project(opentelemetry-cpp)
 # Mark variables as used so cmake doesn't complain about them
 mark_as_advanced(CMAKE_TOOLCHAIN_FILE)
 
-# Note: CMAKE_FIND_PACKAGE_PREFER_CONFIG requires cmake 3.15. Prefer cmake
-# CONFIG search mode to find dependencies. This is important to properly find
-# protobuf versions 3.22.0 and above due to the abseil-cpp dependency.
-set(CMAKE_FIND_PACKAGE_PREFER_CONFIG TRUE)
-
 # Don't use customized cmake modules if vcpkg is used to resolve dependence.
 if(NOT DEFINED CMAKE_TOOLCHAIN_FILE)
   list(APPEND CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake/modules/")
@@ -79,10 +74,6 @@ if(DEFINED ENV{VCPKG_ROOT} AND NOT DEFINED CMAKE_TOOLCHAIN_FILE)
       CACHE STRING "")
 endif()
 
-if(VCPKG_CHAINLOAD_TOOLCHAIN_FILE)
-  include("${VCPKG_CHAINLOAD_TOOLCHAIN_FILE}")
-endif()
-
 option(WITH_ABI_VERSION_1 "ABI version 1" ON)
 option(WITH_ABI_VERSION_2 "EXPERIMENTAL: ABI version 2 preview" OFF)
 
@@ -310,49 +301,7 @@ endif()
 include(GNUInstallDirs)
 
 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(SAVED_CMAKE_CXX_CLANG_TIDY ${CMAKE_CXX_CLANG_TIDY})
-      set(SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE
-          ${CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
-      set(ENABLE_TESTING OFF)
-      set(CMAKE_CXX_CLANG_TIDY "")
-      set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "")
-      add_subdirectory(third_party/prometheus-cpp)
-      set(ENABLE_TESTING ${SAVED_ENABLE_TESTING})
-      set(CMAKE_CXX_CLANG_TIDY ${SAVED_CMAKE_CXX_CLANG_TIDY})
-      set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE
-          ${SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
-
-      # Get the version of the prometheus-cpp submodule
-      find_package(Git QUIET)
-      if(Git_FOUND)
-        execute_process(
-          COMMAND ${GIT_EXECUTABLE} describe --tags --always
-          WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}/third_party/prometheus-cpp
-          OUTPUT_VARIABLE prometheus-cpp_VERSION
-          OUTPUT_STRIP_TRAILING_WHITESPACE)
-        string(REGEX REPLACE "^v" "" prometheus-cpp_VERSION
-                             "${prometheus-cpp_VERSION}")
-      endif()
-
-      message(
-        STATUS
-          "Using local prometheus-cpp from submodule. Version = ${prometheus-cpp_VERSION}"
-      )
-    else()
-      message(
-        FATAL_ERROR
-          "\nprometheus-cpp package was not found. Please either provide it manually or clone with submodules. "
-          "To initialize, fetch and checkout any nested submodules, you can use the following command:\n"
-          "git submodule update --init --recursive")
-    endif()
-  else()
-    message(STATUS "Using external prometheus-cpp")
-  endif()
+  include("${opentelemetry-cpp_SOURCE_DIR}/cmake/prometheus-cpp.cmake")
 endif()
 
 if(WITH_OTLP_GRPC
@@ -497,6 +446,14 @@ if((NOT WITH_API_ONLY) AND USE_NLOHMANN_JSON)
   include("${opentelemetry-cpp_SOURCE_DIR}/cmake/nlohmann-json.cmake")
 endif()
 
+#
+# Do we need OpenTracing ?
+#
+
+if(WITH_OPENTRACING)
+  include("${opentelemetry-cpp_SOURCE_DIR}/cmake/opentracing-cpp.cmake")
+endif()
+
 if(OTELCPP_MAINTAINER_MODE)
   if(CMAKE_CXX_COMPILER_ID STREQUAL "GNU")
     message(STATUS "Building with gcc in maintainer mode.")
@@ -696,10 +653,18 @@ if(ZLIB_FOUND)
   message(STATUS "ZLIB: ${ZLIB_VERSION}")
 endif()
 if(USE_NLOHMANN_JSON)
-  message(STATUS "nlohmann-json: ${nlohmann_json_VERSION}")
+  message(
+    STATUS "nlohmann-json: ${nlohmann_json_VERSION} (${nlohmann_json_PROVIDER})"
+  )
+endif()
+if(WITH_PROMETHEUS)
+  message(
+    STATUS
+      "prometheus-cpp: ${prometheus-cpp_VERSION} (${prometheus-cpp_PROVIDER})")
 endif()
-if(prometheus-cpp_FOUND)
-  message(STATUS "prometheus-cpp: ${prometheus-cpp_VERSION}")
+if(WITH_OPENTRACING)
+  message(
+    STATUS "opentracing-cpp: ${OpenTracing_VERSION} (${OpenTracing_PROVIDER})")
 endif()
 message(STATUS "---------------------------------------------")
 
@@ -724,30 +689,6 @@ endif()
 add_subdirectory(api)
 
 if(WITH_OPENTRACING)
-  find_package(OpenTracing CONFIG QUIET)
-  if(NOT OpenTracing_FOUND)
-    set(OPENTRACING_DIR "third_party/opentracing-cpp")
-    message(STATUS "Trying to use local ${OPENTRACING_DIR} from submodule")
-    if(EXISTS "${PROJECT_SOURCE_DIR}/${OPENTRACING_DIR}/.git")
-      set(SAVED_BUILD_TESTING ${BUILD_TESTING})
-      set(BUILD_TESTING OFF)
-      set(SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE
-          ${CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
-      set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE "")
-      add_subdirectory(${OPENTRACING_DIR})
-      set(BUILD_TESTING ${SAVED_BUILD_TESTING})
-      set(CMAKE_CXX_INCLUDE_WHAT_YOU_USE
-          ${SAVED_CMAKE_CXX_INCLUDE_WHAT_YOU_USE})
-    else()
-      message(
-        FATAL_ERROR
-          "\nopentracing-cpp package was not found. Please either provide it manually or clone with submodules. "
-          "To initialize, fetch and checkout any nested submodules, you can use the following command:\n"
-          "git submodule update --init --recursive")
-    endif()
-  else()
-    message(STATUS "Using external opentracing-cpp")
-  endif()
   add_subdirectory(opentracing-shim)
 endif()
 

cmake/nlohmann-json.cmake

@@ -1,94 +1,48 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
-#
-# The dependency on nlohmann_json can be provided different ways. By order of
-# decreasing priority, options are:
-#
-# 1 - Search for a nlohmann_json package
-#
-# Packages installed on the local machine are used if found.
-#
-# The nlohmann_json dependency is not installed, as it already is.
-#
-# 2 - Search for a nlohmann_json git submodule
-#
-# When git submodule is used, the nlohmann_json code is located in:
-# third_party/nlohmann-json
-#
-# The nlohmann_json dependency is installed, by building the sub directory with
-# JSON_Install=ON
-#
-# 3 - Download nlohmann_json from github
-#
-# Code from the development branch is used, unless a specific release tag is
-# provided in variable ${nlohmann-json}
-#
-# The nlohmann_json dependency is installed, by building the downloaded code
-# with JSON_Install=ON
-#
+# Import nlohmann_json target (nlohmann_json::nlohmann_json).
+# 1. Find an installed nlohmann-json package
+# 2. Use FetchContent to build nlohmann-json from a git submodule
+# 3. Use FetchContent to fetch and build nlohmann-json from GitHub
 
-# nlohmann_json package is required for most SDK build configurations
-find_package(nlohmann_json QUIET)
-set(nlohmann_json_clone FALSE)
-if(nlohmann_json_FOUND)
-  message(STATUS "nlohmann::json dependency satisfied by: package")
-elseif(TARGET nlohmann_json)
-  message(STATUS "nlohmann::json is already added as a CMake target!")
-elseif(EXISTS ${PROJECT_SOURCE_DIR}/.git
-       AND EXISTS
-           ${PROJECT_SOURCE_DIR}/third_party/nlohmann-json/CMakeLists.txt)
-  message(STATUS "nlohmann::json dependency satisfied by: git submodule")
-  set(JSON_BuildTests
-      OFF
-      CACHE INTERNAL "")
-  set(JSON_Install
-      ON
-      CACHE INTERNAL "")
-  # This option allows to link nlohmann_json::nlohmann_json target
-  add_subdirectory(${PROJECT_SOURCE_DIR}/third_party/nlohmann-json)
-  # This option allows to add header to include directories
-  include_directories(
-    ${PROJECT_SOURCE_DIR}/third_party/nlohmann-json/single_include)
-else()
-  if("${nlohmann-json}" STREQUAL "")
-    set(nlohmann-json "develop")
+find_package(nlohmann_json CONFIG QUIET)
+set(nlohmann_json_PROVIDER "find_package")
+
+if(NOT nlohmann_json_FOUND)
+  set(_NLOHMANN_JSON_SUBMODULE_DIR "${opentelemetry-cpp_SOURCE_DIR}/third_party/nlohmann-json")
+  if(EXISTS "${_NLOHMANN_JSON_SUBMODULE_DIR}/.git")
+    FetchContent_Declare(
+       "nlohmann_json"
+       SOURCE_DIR "${_NLOHMANN_JSON_SUBMODULE_DIR}"
+       )
+    set(nlohmann_json_PROVIDER "fetch_source")
+  else()
+    FetchContent_Declare(
+      "nlohmann_json"
+      GIT_REPOSITORY  "https://github.com/nlohmann/json.git"
+      GIT_TAG "${nlohmann-json_GIT_TAG}"
+      )
+    set(nlohmann_json_PROVIDER "fetch_repository")
   endif()
-  message(STATUS "nlohmann::json dependency satisfied by: github download")
-  set(nlohmann_json_clone TRUE)
-  include(ExternalProject)
-  ExternalProject_Add(
-    nlohmann_json_download
-    PREFIX third_party
-    GIT_REPOSITORY https://github.com/nlohmann/json.git
-    GIT_TAG "${nlohmann-json_GIT_TAG}"
-    UPDATE_COMMAND ""
-    CMAKE_ARGS -DCMAKE_INSTALL_PREFIX=${CMAKE_INSTALL_PREFIX}
-               -DJSON_BuildTests=OFF -DJSON_Install=ON
-               -DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}
-    TEST_AFTER_INSTALL 0
-    DOWNLOAD_NO_PROGRESS 1
-    LOG_CONFIGURE 1
-    LOG_BUILD 1
-    LOG_INSTALL 1)
 
-  ExternalProject_Get_Property(nlohmann_json_download INSTALL_DIR)
-  set(NLOHMANN_JSON_INCLUDE_DIR
-      ${INSTALL_DIR}/src/nlohmann_json_download/single_include)
-  add_library(nlohmann_json_ INTERFACE)
-  target_include_directories(
-    nlohmann_json_ INTERFACE "$<BUILD_INTERFACE:${NLOHMANN_JSON_INCLUDE_DIR}>"
-                             "$<INSTALL_INTERFACE:include>")
-  add_dependencies(nlohmann_json_ nlohmann_json_download)
-  add_library(nlohmann_json::nlohmann_json ALIAS nlohmann_json_)
+  set(JSON_BuildTests OFF CACHE BOOL "" FORCE)
+  set(JSON_Install ${OPENTELEMETRY_INSTALL} CACHE BOOL "" FORCE)
+  set(JSON_MultipleHeaders OFF CACHE BOOL "" FORCE)
+
+  FetchContent_MakeAvailable(nlohmann_json)
+
+  # Set the nlohmann_json_VERSION variable from the git tag.
+  string(REGEX REPLACE "^v([0-9]+\\.[0-9]+\\.[0-9]+)$" "\\1" nlohmann_json_VERSION "${nlohmann-json_GIT_TAG}")
 
-  if(OPENTELEMETRY_INSTALL)
-    install(
-      TARGETS nlohmann_json_
-      EXPORT "${PROJECT_NAME}-third_party_nlohmann_json_target"
-      RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
-      LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
-      COMPONENT third_party_nlohmann_json)
+  #Disable iwyu and clang-tidy
+  if(TARGET nlohmann_json)
+    set_target_properties(nlohmann_json PROPERTIES CXX_INCLUDE_WHAT_YOU_USE ""
+                                                     CXX_CLANG_TIDY "")
   endif()
 endif()
+
+if(NOT TARGET nlohmann_json::nlohmann_json)
+  message(FATAL_ERROR "A required nlohmann_json target (nlohmann_json::nlohmann_json) was not imported")
+endif()
+

cmake/opentracing-cpp.cmake

@@ -0,0 +1,68 @@
+# Copyright The OpenTelemetry Authors
+# SPDX-License-Identifier: Apache-2.0
+
+find_package(OpenTracing CONFIG QUIET)
+set(OpenTracing_PROVIDER "find_package")
+
+if(NOT OpenTracing_FOUND)
+  set(_OPENTRACING_SUBMODULE_DIR "${opentelemetry-cpp_SOURCE_DIR}/third_party/opentracing-cpp")
+  if(EXISTS "${_OPENTRACING_SUBMODULE_DIR}/.git")
+    FetchContent_Declare(
+       "opentracing"
+       SOURCE_DIR "${_OPENTRACING_SUBMODULE_DIR}"
+       )
+    set(OpenTracing_PROVIDER "fetch_source")
+  else()
+    FetchContent_Declare(
+      "opentracing"
+      GIT_REPOSITORY  "https://github.com/opentracing/opentracing-cpp.git"
+      GIT_TAG "${opentracing-cpp_GIT_TAG}"
+      )
+    set(OpenTracing_PROVIDER "fetch_repository")
+  endif()
+
+  # OpenTracing uses the BUILD_TESTING variable directly and we must force the cached value to OFF.
+  # save the current state of BUILD_TESTING
+  if(DEFINED BUILD_TESTING)
+    set(_SAVED_BUILD_TESTING ${BUILD_TESTING})
+  endif()
+
+  # Set the cache variables for the opentracing build
+  set(BUILD_TESTING OFF CACHE BOOL "" FORCE)
+  set(BUILD_MOCKTRACER OFF CACHE BOOL "" FORCE)
+
+  FetchContent_MakeAvailable(opentracing)
+
+  # Restore the saved state of BUILD_TESTING
+  if(DEFINED _SAVED_BUILD_TESTING)
+    set(BUILD_TESTING ${_SAVED_BUILD_TESTING} CACHE BOOL "" FORCE)
+  else()
+    unset(BUILD_TESTING CACHE)
+  endif()
+
+  # Patch the opentracing targets to set missing includes, add namespaced alias targets, disable iwyu and clang-tidy.
+  foreach(_target opentracing opentracing-static)
+    if(TARGET ${_target})
+      # Add missing include directories
+      target_include_directories(${_target} PUBLIC
+        "$<BUILD_INTERFACE:${opentracing_SOURCE_DIR}/include>"
+        "$<BUILD_INTERFACE:${opentracing_SOURCE_DIR}/3rd_party/include>"
+        "$<BUILD_INTERFACE:${opentracing_BINARY_DIR}/include>"
+        )
+      # Disable CXX_INCLUDE_WHAT_YOU_USE and CXX_CLANG_TIDY
+      set_target_properties(${_target}
+                          PROPERTIES CXX_INCLUDE_WHAT_YOU_USE "" CXX_CLANG_TIDY "")
+      # Create alias targets
+      if(NOT TARGET OpenTracing::${_target})
+        add_library(OpenTracing::${_target} ALIAS ${_target})
+      endif()
+    endif()
+  endforeach()
+
+  # Set the OpenTracing_VERSION variable from the git tag.
+  string(REGEX REPLACE "^v([0-9]+\\.[0-9]+\\.[0-9]+)$" "\\1" OpenTracing_VERSION "${opentracing-cpp_GIT_TAG}")
+endif(NOT OpenTracing_FOUND)
+
+if(NOT TARGET OpenTracing::opentracing AND NOT TARGET OpenTracing::opentracing-static)
+  message(FATAL_ERROR "No OpenTracing targets (OpenTracing::opentracing or OpenTracing::opentracing-static) were imported")
+endif()