add options to control how dependencies are found. Add support for fetching zlib and building in tree

Author: dbarker

.github/workflows/cmake_install.yml

@@ -19,7 +19,7 @@ jobs:
       CMAKE_VERSION: '3.31.6'
       # cxx17 is the default for windows-2022
       CXX_STANDARD: '17'
-      CMAKE_ARGS: "-DWITH_STL=CXX17"
+      CMAKE_ARGS: "-DWITH_STL=CXX17 -DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
     steps:
       - name: Harden the runner (Audit all outbound calls)
         uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
@@ -46,7 +46,7 @@ jobs:
       CMAKE_VERSION: '3.15.0'
       # cxx14 is the default for windows-2019
       CXX_STANDARD: '14'
-      CMAKE_ARGS: "-DWITH_GSL=ON"
+      CMAKE_ARGS: "-DWITH_GSL=ON -DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
     steps:
       - name: Harden the runner (Audit all outbound calls)
         uses: step-security/harden-runner@0634a2670c59f64b4a01f0f96f84700a4088b9f0 # v2.12.0
@@ -72,6 +72,7 @@ jobs:
       CMAKE_VERSION: '3.28.3'
       # cxx17 is the default for Ubuntu 24.04
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
       BUILD_TYPE: 'Debug'
     steps:
     - name: Harden the runner (Audit all outbound calls)
@@ -108,6 +109,7 @@ jobs:
       CMAKE_VERSION: '3.28.3'
       # The default cxx standard for Ubuntu 24.04
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_FORCE_FETCH_DEPENDENCIES=ON"
       BUILD_TYPE: 'Debug'
     steps:
     - name: Harden the runner (Audit all outbound calls)
@@ -273,6 +275,7 @@ jobs:
        # CMake 3.28 is apt package version for Ubuntu 24.04
       CMAKE_VERSION: '3.28.3'
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
       CMAKE_TOOLCHAIN_FILE: /home/runner/conan/build/Debug/generators/conan_toolchain.cmake
       BUILD_TYPE: 'Debug'
     steps:
@@ -284,6 +287,9 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           submodules: false
+      - name: Get required submodules
+        run: |
+          git submodule update --init --depth 1 third_party/opentelemetry-proto
       - name: Install Conan
         run: |
           python3 -m pip install pip==25.0.1
@@ -316,6 +322,7 @@ jobs:
       # Set to the latest version of cmake 3.x
       CMAKE_VERSION: '3.31.6'
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
       CMAKE_TOOLCHAIN_FILE: /home/runner/conan/build/Debug/generators/conan_toolchain.cmake
       BUILD_TYPE: 'Debug'
     steps:
@@ -327,6 +334,9 @@ jobs:
       - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
           submodules: false
+      - name: Get required submodules
+        run: |
+          git submodule update --init --depth 1 third_party/opentelemetry-proto
       - name: Install Conan
         run: |
           python3 -m pip install pip==25.0.1
@@ -354,6 +364,7 @@ jobs:
       INSTALL_TEST_DIR: '/Users/runner/install_test'
       CMAKE_VERSION: '3.28.3'
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
       CMAKE_TOOLCHAIN_FILE: '/Users/runner/conan/build/Debug/generators/conan_toolchain.cmake'
       BUILD_TYPE: 'Debug'
     steps:
@@ -365,6 +376,9 @@ jobs:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         submodules: false
+    - name: Get required submodules
+      run: |
+        git submodule update --init --depth 1 third_party/opentelemetry-proto
     - name: Install Conan and tools
       run: |
         brew install conan autoconf automake libtool coreutils
@@ -385,6 +399,7 @@ jobs:
       # Set to the latest version of cmake 3.x
       CMAKE_VERSION: '3.31.6'
       CXX_STANDARD: '17'
+      CMAKE_ARGS: "-DOPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES=ON"
       BUILD_TYPE: 'Debug'
     steps:
     - name: Harden the runner (Audit all outbound calls)
@@ -395,6 +410,9 @@ jobs:
     - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
       with:
         submodules: false
+    - name: Get required submodules
+      run: |
+        git submodule update --init --depth 1 third_party/opentelemetry-proto
     - name: Install Dependencies with Homebrew
       run: |
         ./ci/setup_cmake_macos.sh

CMakeLists.txt

@@ -246,10 +246,22 @@ option(OPENTELEMETRY_SKIP_DYNAMIC_LOADING_TESTS
        "Whether to build test libraries that are always linked as shared libs"
        OFF)
 
+option(OPENTELEMETRY_FORCE_FETCH_DEPENDENCIES
+       "Whether to force fetching dependencies from submodules or git repositories"
+       OFF)
+
+option(OPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES
+       "Whether to require finding dependencies as a locally installed package or submodules"
+       OFF)
+
 #
 # Verify options dependencies
 #
-
+if(OPENTELEMETRY_FORCE_FETCH_DEPENDENCIES AND OPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES)
+  message(FATAL_ERROR "OPENTELEMETRY_FORCE_FETCH_DEPENDENCIES and "
+                      "OPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES are mutually "
+                      "exclusive options. Both can be OFF but only one can be ON.")
+endif()
 if(WITH_EXAMPLES_HTTP AND NOT WITH_EXAMPLES)
   message(FATAL_ERROR "WITH_EXAMPLES_HTTP=ON requires WITH_EXAMPLES=ON")
 endif()

ci/do_ci.ps1

@@ -359,6 +359,13 @@ switch ($action) {
         $CXX_STANDARD = 14
     }
     Write-Host "Using CXX_STANDARD: $CXX_STANDARD"
+
+    if (Test-Path Env:\CMAKE_ARGS) {
+        $CMAKE_ARGS = (Get-Item Env:\CMAKE_ARGS).Value
+    } else {
+        $CMAKE_ARGS = ""
+    }
+    Write-Host "Using CMAKE_ARGS: $CMAKE_ARGS"
 
     $CMAKE_OPTIONS = @(
     "-DCMAKE_CXX_STANDARD=$CXX_STANDARD",
@@ -370,6 +377,7 @@ switch ($action) {
 
     cmake $SRC_DIR `
       $CMAKE_OPTIONS `
+      $CMAKE_ARGS `
       "-DCMAKE_INSTALL_PREFIX=$INSTALL_TEST_DIR" `
       -DWITH_ABI_VERSION_1=OFF `
       -DWITH_ABI_VERSION_2=ON `

cmake/curl.cmake

@@ -2,11 +2,13 @@
 # SPDX-License-Identifier: Apache-2.0
 
 if(OPENTELEMETRY_INSTALL)
-  set(CURL_DISABLE_INSTALL OFF CACHE BOOL "" FORCE)
+  set(_CURL_DISABLE_INSTALL OFF)
 else()
-  set(CURL_DISABLE_INSTALL ON  CACHE BOOL "" FORCE)
+  set(_CURL_DISABLE_INSTALL ON)
 endif()
 
+set(_OTEL_BUILD_SHARED_LIBS ${BUILD_SHARED_LIBS})
+
 add_thirdparty_package(
   PACKAGE_NAME CURL
   FETCH_NAME curl
@@ -16,22 +18,26 @@ add_thirdparty_package(
   VERSION_REGEX "#define[ \t]+LIBCURL_VERSION[ \t]+\"([0-9]+\\.[0-9]+\\.[0-9]+(-[A-Za-z0-9]+)?)\""
   VERSION_FILE "\${curl_SOURCE_DIR}/include/curl/curlver.h"
   CMAKE_ARGS
+    CURL_DISABLE_INSTALL=${_CURL_DISABLE_INSTALL}
     CURL_USE_LIBPSL=OFF
     BUILD_CURL_EXE=OFF
     BUILD_LIBCURL_DOCS=OFF
     BUILD_MISC_DOCS=OFF
     ENABLE_CURL_MANUAL=OFF
+    BUILD_SHARED_LIBS=ON
 )
 
-unset(CURL_DISABLE_INSTALL)
+set(BUILD_SHARED_LIBS ${_OTEL_BUILD_SHARED_LIBS} CACHE BOOL "" FORCE)
+unset(_OTEL_BUILD_SHARED_LIBS)
+unset(_CURL_DISABLE_INSTALL)
 
-foreach(FIND_CURL_IMPORTED_TARGET CURL::libcurl CURL::libcurl_shared
-                                  CURL::libcurl_static)
-  if(TARGET ${FIND_CURL_IMPORTED_TARGET})
-    set(CURL_IMPORTED_TARGET_NAME ${FIND_CURL_IMPORTED_TARGET})
-    break()
-  endif()
-endforeach()
+if(TARGET CURL::libcurl)
+  set(CURL_IMPORTED_TARGET_NAME CURL::libcurl)
+elseif(TARGET CURL::libcurl_shared)
+  set(CURL_IMPORTED_TARGET_NAME CURL::libcurl_shared)
+elseif(TARGET CURL::libcurl_static)
+  set(CURL_IMPORTED_TARGET_NAME CURL::libcurl_static)
+endif()
 
 if(NOT TARGET ${CURL_IMPORTED_TARGET_NAME})
   message(FATAL_ERROR "CURL imported target not found.")

cmake/grpc.cmake

@@ -24,6 +24,8 @@ add_thirdparty_package(
     gRPC_BUILD_GRPC_RUBY_PLUGIN=OFF
     gRPC_BUILD_GRPCPP_OTEL_PLUGIN=OFF
     RE2_BUILD_TESTING=OFF
+    gRPC_ZLIB_PROVIDER=module
+    gRPC_PROTOBUF_PROVIDER=module
 )
 
 if(TARGET grpc++)

cmake/opentracing-cpp.cmake

@@ -1,7 +1,7 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
-set(OTEL_BUILD_TESTING ${BUILD_TESTING})
+set(_OTEL_BUILD_TESTING ${BUILD_TESTING})
 
 add_thirdparty_package(
   PACKAGE_NAME OpenTracing
@@ -16,7 +16,8 @@ add_thirdparty_package(
     BUILD_TESTING=OFF
 )
 
-set(BUILD_TESTING ${OTEL_BUILD_TESTING} CACHE BOOL "" FORCE)
+set(BUILD_TESTING ${_OTEL_BUILD_TESTING} CACHE BOOL "" FORCE)
+unset(_OTEL_BUILD_TESTING)
 
 if(NOT ${OpenTracing_PROVIDER} STREQUAL "package")
   if(TARGET opentracing AND NOT TARGET OpenTracing::opentracing)

cmake/protobuf.cmake

@@ -3,13 +3,12 @@
 
 if(DEFINED gRPC_PROVIDER AND NOT gRPC_PROVIDER STREQUAL "package" AND TARGET libprotobuf)
   # gRPC was fetched and built protobuf as a submodule
+  set(Protobuf_PROVIDER "grpc_submodule")
   add_thirdparty_package(
     PACKAGE_NAME Protobuf
     VERSION_REGEX "\"cpp\"[ \t]*:[ \t]*\"([0-9]+\\.[0-9]+(\\.[0-9]+)?)\""
     VERSION_FILE "\${grpc_SOURCE_DIR}/third_party/protobuf/version.json"
   )
-  message(STATUS "Using Protobuf from gRPC submodule. version file is ${grpc_SOURCE_DIR}/third_party/protobuf/version.json")
-  set(Protobuf_PROVIDER "grpc_submodule")
 else()
   # Protobuf 3.22+ depends on abseil-cpp and must be found using the cmake
   # find_package CONFIG search mode. The following attempts to find Protobuf
@@ -29,6 +28,7 @@ else()
       protobuf_INSTALL=${OPENTELEMETRY_INSTALL}
       protobuf_BUILD_TESTS=OFF
       protobuf_BUILD_EXAMPLES=OFF
+      protobuf_WITH_ZLIB=OFF
   )
 endif()
 

cmake/tools.cmake

@@ -286,32 +286,35 @@ function(add_thirdparty_package)
   message(DEBUG "  Version file: ${_THIRDPARTY_VERSION_FILE}")
   message(DEBUG "  CMake args: ${_THIRDPARTY_CMAKE_ARGS}")
 
-  foreach(_search_mode IN LISTS _THIRDPARTY_SEARCH_MODES)
-    message(STATUS "  Searching for ${_THIRDPARTY_PACKAGE_NAME} with search mode ${_search_mode}")
-    find_package(${_THIRDPARTY_PACKAGE_NAME} ${_search_mode} QUIET)
-    if(${_THIRDPARTY_PACKAGE_NAME}_FOUND)
-      if(DEFINED ${_THIRDPARTY_PACKAGE_NAME}_VERSION_STRING AND NOT DEFINED ${_THIRDPARTY_PACKAGE_NAME}_VERSION)
-        set(${_THIRDPARTY_PACKAGE_NAME}_VERSION ${${_THIRDPARTY_PACKAGE_NAME}_VERSION_STRING})
+  if(NOT OPENTELEMETRY_FORCE_FETCH_DEPENDENCIES)
+    foreach(_search_mode IN LISTS _THIRDPARTY_SEARCH_MODES)
+      message(STATUS "  Searching for ${_THIRDPARTY_PACKAGE_NAME} with search mode ${_search_mode}")
+      find_package(${_THIRDPARTY_PACKAGE_NAME} ${_search_mode} QUIET)
+      if(${_THIRDPARTY_PACKAGE_NAME}_FOUND)
+        if(DEFINED ${_THIRDPARTY_PACKAGE_NAME}_VERSION_STRING AND NOT DEFINED ${_THIRDPARTY_PACKAGE_NAME}_VERSION)
+          set(${_THIRDPARTY_PACKAGE_NAME}_VERSION ${${_THIRDPARTY_PACKAGE_NAME}_VERSION_STRING})
+        endif()
+        message(STATUS "  Found ${_THIRDPARTY_PACKAGE_NAME} with search mode ${_search_mode}")
+        break()
       endif()
-      message(STATUS "  Found ${_THIRDPARTY_PACKAGE_NAME} with search mode ${_search_mode}")
-      break()
-    endif()
-  endforeach()
+    endforeach()
+  endif()
 
   if(${_THIRDPARTY_PACKAGE_NAME}_FOUND)
     set("${_THIRDPARTY_PACKAGE_NAME}_PROVIDER" "package")
   elseif(DEFINED _THIRDPARTY_SOURCE_DIR OR DEFINED _THIRDPARTY_GIT_REPOSITORY)
-    message(STATUS "  Fetching ${_THIRDPARTY_PACKAGE_NAME}")
     # Use FetchContent to fetch the package if not found
     include(FetchContent)
 
     if(DEFINED _THIRDPARTY_SOURCE_DIR AND EXISTS "${_THIRDPARTY_SOURCE_DIR}/.git")
+      message(STATUS "  Fetching ${_THIRDPARTY_PACKAGE_NAME} from local source at ${_THIRDPARTY_SOURCE_DIR}")
       FetchContent_Declare(
           ${_THIRDPARTY_FETCH_NAME}
           SOURCE_DIR ${_THIRDPARTY_SOURCE_DIR}
       )
       set("${_THIRDPARTY_PACKAGE_NAME}_PROVIDER" "fetch_source")
-    elseif(DEFINED _THIRDPARTY_GIT_REPOSITORY AND DEFINED _THIRDPARTY_GIT_TAG)
+    elseif( NOT OPENTELEMETRY_REQUIRE_LOCAL_DEPENDENCIES AND DEFINED _THIRDPARTY_GIT_REPOSITORY AND DEFINED _THIRDPARTY_GIT_TAG)
+      message(STATUS "  Fetching ${_THIRDPARTY_PACKAGE_NAME} from ${_THIRDPARTY_GIT_REPOSITORY} at tag ${_THIRDPARTY_GIT_TAG}")
       FetchContent_Declare(
           ${_THIRDPARTY_FETCH_NAME}
           GIT_REPOSITORY

cmake/zlib.cmake

@@ -1,21 +1,76 @@
 # Copyright The OpenTelemetry Authors
 # SPDX-License-Identifier: Apache-2.0
 
-if(NOT OPENTELEMETRY_INSTALL)
-  set(SKIP_INSTALL_ALL ON)
+if(TARGET zlib)
+  if(DEFINED gRPC_PROVIDER AND NOT gRPC_PROVIDER STREQUAL "package")
+     set(ZLIB_PROVIDER "grpc")
+  elseif(DEFIND Protobuf_PROVIDER AND NOT Protobuf_PROVIDER STREQUAL "package")
+     set(ZLIB_PROVIDER "protobuf")
+  endif()
 endif()
 
-add_thirdparty_package(
-  PACKAGE_NAME ZLIB
-  FETCH_NAME zlib
-  SEARCH_MODES "MODULE" "CONFIG"
-  GIT_REPOSITORY "https://github.com/madler/zlib.git"
-  GIT_TAG ${ZLIB_GIT_TAG}
-  REQUIRED_TARGETS "ZLIB::ZLIB"
-  VERSION_REGEX "set\\([ \t]*VERSION[ \t]+\"([0-9]+\\.[0-9]+\\.[0-9]+)\"\\)"
-  VERSION_FILE "\${zlib_SOURCE_DIR}/CMakeLists.txt"
-  CMAKE_ARGS
-    ZLIB_BUILD_EXAMPLES=OFF
+if( DEFINED ZLIB_PROVIDER)
+  # zlib was built as a submodule of gRPC or Protobuf
+  add_thirdparty_package(
+    PACKAGE_NAME ZLIB
+    VERSION_REGEX "set\\([ \t]*VERSION[ \t]+\"([0-9]+\\.[0-9]+\\.[0-9]+)\"\\)"
+    VERSION_FILE "\${${ZLIB_PROVIDER}_SOURCE_DIR}/third_party/zlib/CMakeLists.txt"
+  )
+else()
+  if(${OPENTELEMETRY_INSTALL})
+    set(_SKIP_ZLIB_INSTALL OFF)
+  else()
+    set(_SKIP_ZLIB_INSTALL ON)
+  endif()
+
+  add_thirdparty_package(
+    PACKAGE_NAME ZLIB
+    FETCH_NAME zlib
+    SEARCH_MODES "MODULE" "CONFIG"
+    GIT_REPOSITORY "https://github.com/madler/zlib.git"
+    GIT_TAG ${ZLIB_GIT_TAG}
+    VERSION_REGEX "set\\([ \t]*VERSION[ \t]+\"([0-9]+\\.[0-9]+\\.[0-9]+)\"\\)"
+    VERSION_FILE "\${zlib_SOURCE_DIR}/CMakeLists.txt"
+    CMAKE_ARGS
+      ZLIB_BUILD_EXAMPLES=OFF
+      ZLIB_INSTALL=${OPENTELEMETRY_INSTALL}
+      SKIP_INSTALL_ALL=${_SKIP_ZLIB_INSTALL}
+      SKIP_INSTALL_LIBRARIES=${_SKIP_ZLIB_INSTALL}
+  )
+  unset(_SKIP_ZLIB_INSTALL)
+endif()
+
+if(TARGET zlib AND NOT TARGET ZLIB::ZLIB)
+   set_target_properties(zlib
+  PROPERTIES
+    INTERFACE_INCLUDE_DIRECTORIES ""
 )
+  set_target_properties(zlib PROPERTIES EXPORT_NAME ZLIB)
+  target_include_directories(zlib
+  INTERFACE
+    $<BUILD_INTERFACE:${zlib_SOURCE_DIR}>
+    $<BUILD_INTERFACE:${zlib_BINARY_DIR}>
+    $<INSTALL_INTERFACE:include>
+  )
+  add_library(ZLIB::ZLIB ALIAS zlib)
+endif()
 
-unset(SKIP_INSTALL_ALL)
+if(NOT TARGET ZLIB::ZLIB)
+  message(FATAL_ERROR "A required zlib target (ZLIB::ZLIB) was not found")
+endif()
+
+if(OPENTELEMETRY_INSTALL)
+  install(
+    TARGETS zlib
+    EXPORT "zlib-target"
+    RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+    ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR} COMPONENT "zlib")
+
+  install(
+    EXPORT "zlib-target"
+    FILE "zlib-target.cmake"
+    NAMESPACE "ZLIB::"
+    DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/ZLIB"
+    COMPONENT "zlib")
+endif()