move cmake install tests to a top level install dir. Clean up comments and cmake messages. Run the ci install test on the more modern grpc version and with abseil

Author: dbarker

.github/workflows/ci.yml

@@ -537,6 +537,9 @@ jobs:
   cmake_install_test:
     name: CMake install test
     runs-on: ubuntu-24.04
+    env:
+      INSTALL_TEST_DIR: '/home/runner/install_test'
+      CXX_STANDARD: '17'
     steps:
     - uses: actions/checkout@v4
       with:
@@ -545,21 +548,21 @@ jobs:
       run: |
         sudo -E ./ci/setup_googletest.sh
         sudo -E ./ci/setup_ci_environment.sh
-    - name: run cmake install
+    - name: install dependencies
       env:
-        CXX_STANDARD: '14'
-        PROTOBUF_VERSION: '21.3'
-        GRPC_VERSION: 'v1.49.2'
+        ABSEIL_CPP_VERSION: '20230125.3'
+        PROTOBUF_VERSION: '23.3'
+        GRPC_VERSION: 'v1.55.0'
       run: |
+        sudo ./ci/install_abseil.sh
         sudo ./ci/install_protobuf.sh
-        sudo ./ci/setup_grpc.sh -r $GRPC_VERSION -s $CXX_STANDARD -p protobuf
-    - name: build and run tests
+        sudo ./ci/setup_grpc.sh -r $GRPC_VERSION -s $CXX_STANDARD -p protobuf -p abseil
+    - name: build and test
       run: |
-        export OTEL_CPP_TEST_INSTALL_DIR=$HOME/test-install
         ./ci/do_ci.sh cmake.install.test
     - name: verify packages
       run: |
-        export PKG_CONFIG_PATH=$HOME/test-install/lib/pkgconfig:$PKG_CONFIG_PATH
+        export PKG_CONFIG_PATH=$INSTALL_TEST_DIR/lib/pkgconfig:$PKG_CONFIG_PATH
         ./ci/verify_packages.sh
 
   plugin_test:

CMakeLists.txt

@@ -394,6 +394,8 @@ if(WITH_PROMETHEUS)
   endif()
 endif()
 
+message(STATUS "Building WITH_ABSEIL=${WITH_ABSEIL}")
+
 if(WITH_ABSEIL)
   if(NOT TARGET absl::strings)
     find_package(absl CONFIG REQUIRED)
@@ -796,9 +798,9 @@ if(OPENTELEMETRY_INSTALL)
       "${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}/${PROJECT_NAME}-config.cmake"
       "${CMAKE_CURRENT_BINARY_DIR}/cmake/${PROJECT_NAME}/${PROJECT_NAME}-config-version.cmake"
       "${CMAKE_CURRENT_BINARY_DIR}/thirdparty-built-with-flags.cmake"
-      "${CMAKE_CURRENT_LIST_DIR}/cmake/install/component-definitions.cmake"
-      "${CMAKE_CURRENT_LIST_DIR}/cmake/install/thirdparty-dependency-definitions.cmake"
-      "${CMAKE_CURRENT_LIST_DIR}/cmake/install/find-package-support-functions.cmake"
+      "${CMAKE_CURRENT_LIST_DIR}/cmake/component-definitions.cmake"
+      "${CMAKE_CURRENT_LIST_DIR}/cmake/thirdparty-dependency-definitions.cmake"
+      "${CMAKE_CURRENT_LIST_DIR}/cmake/find-package-support-functions.cmake"
     DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
     COMPONENT cmake-config)
 

ci/do_ci.sh

@@ -62,8 +62,8 @@ function run_benchmarks
 mkdir -p "${BUILD_DIR}"
 [ -z "${PLUGIN_DIR}" ] && export PLUGIN_DIR=$HOME/plugin
 mkdir -p "${PLUGIN_DIR}"
-[ -z "${OTEL_CPP_TEST_INSTALL_DIR}" ] && export OTEL_CPP_TEST_INSTALL_DIR=$HOME/otel_cpp_test_install
-mkdir -p "${OTEL_CPP_TEST_INSTALL_DIR}"
+[ -z "${INSTALL_TEST_DIR}" ] && export INSTALL_TEST_DIR=$HOME/install_test
+mkdir -p "${INSTALL_TEST_DIR}"
 
 MAKE_COMMAND="make -k -j \$(nproc)"
 
@@ -232,19 +232,19 @@ elif [[ "$1" == "cmake.abseil.test" ]]; then
 elif [[ "$1" == "cmake.opentracing_shim.test" ]]; then
   cd "${BUILD_DIR}"
   rm -rf *
-  rm -rf ${OTEL_CPP_TEST_INSTALL_DIR}/*
+  rm -rf ${INSTALL_TEST_DIR}/*
   cmake "${CMAKE_OPTIONS[@]}" \
         -DCMAKE_CXX_FLAGS="-Werror -Wno-error=redundant-move $CXXFLAGS" \
         -DWITH_OPENTRACING=ON \
-        -DCMAKE_INSTALL_PREFIX=${OTEL_CPP_TEST_INSTALL_DIR} \
+        -DCMAKE_INSTALL_PREFIX=${INSTALL_TEST_DIR} \
         "${SRC_DIR}"
   make -j $(nproc)
   make test
   make install
-  export LD_LIBRARY_PATH="${OTEL_CPP_TEST_INSTALL_DIR}/lib:$LD_LIBRARY_PATH"
-  cmake -S "${SRC_DIR}/cmake/install/test" \
+  export LD_LIBRARY_PATH="${INSTALL_TEST_DIR}/lib:$LD_LIBRARY_PATH"
+  cmake -S "${SRC_DIR}/install/test/cmake" \
         -B "${BUILD_DIR}/install_test" \
-        "-DCMAKE_PREFIX_PATH=${OTEL_CPP_TEST_INSTALL_DIR}" \
+        "-DCMAKE_PREFIX_PATH=${INSTALL_TEST_DIR}" \
         "-DCOMPONENTS_TO_TEST=shims_opentracing"
   ctest --test-dir "${BUILD_DIR}/install_test" --output-on-failure
   exit 0
@@ -425,9 +425,10 @@ elif [[ "$1" == "cmake.do_not_install.test" ]]; then
 elif [[ "$1" == "cmake.install.test" ]]; then
   cd "${BUILD_DIR}"
   rm -rf *
-  rm -rf ${OTEL_CPP_TEST_INSTALL_DIR}/*
+  rm -rf ${INSTALL_TEST_DIR}/*
   cmake "${CMAKE_OPTIONS[@]}"  \
-        -DCMAKE_INSTALL_PREFIX=${OTEL_CPP_TEST_INSTALL_DIR} \
+        -DCMAKE_INSTALL_PREFIX=${INSTALL_TEST_DIR} \
+        -DWITH_ABSEIL=ON \
         -DWITH_METRICS_EXEMPLAR_PREVIEW=ON \
         -DWITH_ASYNC_EXPORT_PREVIEW=ON \
         -DWITH_OTLP_GRPC=ON \
@@ -442,10 +443,10 @@ elif [[ "$1" == "cmake.install.test" ]]; then
         "${SRC_DIR}"
   make -j $(nproc)
   make install
-  export LD_LIBRARY_PATH="${OTEL_CPP_TEST_INSTALL_DIR}/lib:$LD_LIBRARY_PATH"
-  cmake -S "${SRC_DIR}/cmake/install/test" \
+  export LD_LIBRARY_PATH="${INSTALL_TEST_DIR}/lib:$LD_LIBRARY_PATH"
+  cmake -S "${SRC_DIR}/install/test/cmake" \
         -B "${BUILD_DIR}/install_test" \
-         "-DCMAKE_PREFIX_PATH=${OTEL_CPP_TEST_INSTALL_DIR}" \
+         "-DCMAKE_PREFIX_PATH=${INSTALL_TEST_DIR}" \
          "-DCOMPONENTS_TO_TEST=api;sdk;ext_common;ext_http_curl;exporters_in_memory;exporters_ostream;exporters_otlp_common;exporters_otlp_file;exporters_otlp_grpc;exporters_otlp_http;exporters_prometheus;exporters_elasticsearch;exporters_zipkin"
   ctest --test-dir "${BUILD_DIR}/install_test" --output-on-failure
   exit 0

cmake/install/component-definitions.cmake renamed to cmake/component-definitions.cmake

@@ -7,10 +7,10 @@
 # Finding opentelemetry-cpp in CMake projects
 # ========================================
 #
-#  - find_package(opentelemetry-cpp CONFIG) to import all installed targets and dependencies
+#  - find_package(opentelemetry-cpp CONFIG REQUIRED) to import all installed targets and dependencies
 #  - find_package(opentelemetry-cpp CONFIG COMPONENTS ...) to import specific components' targets and dependencies
 #
-# Supported use cases
+# Example usage
 # -------------------
 #
 # 1. **No Components Specified**
@@ -22,28 +22,18 @@
 #       find_package(opentelemetry-cpp CONFIG REQUIRED)
 #
 #
-# 2. **Subset of Required Components Specified**
+# 2. **Components Specified**
 #
-#    If you request only a subset (e.g. one component), the package will import the
-#    requested component and resolve additional dependencies as needed.
+#    When a component is specified, its third-party dependencies are found;
+#    then, targets from that component, along with the components on which it depends, are imported.
 #
 #    .. code-block:: cmake
 #
 #       find_package(opentelemetry-cpp CONFIG REQUIRED COMPONENTS exporters_otlp_grpc)
 #
-# 3. **Components Specified Out-of-Order**
-#
-#    The package automatically sorts components based on their inter-dependencies.
-#    For instance, even if the components are listed out-of-order:
-#
-#    .. code-block:: cmake
-#
-#       find_package(opentelemetry-cpp CONFIG REQUIRED COMPONENTS exporters_ostream sdk api)
-#
-#    the correct dependency order is applied internally.
 #
 #.. note::
-#   To troubleshoot issues with ``find_package(opentelemetry-cpp)``, run CMake with debug logging enabled:
+#   To troubleshoot issues with ``find_package(opentelemetry-cpp CONFIG REQUIRED)``, run CMake with debug logging enabled:
 #
 #   .. code-block:: bash
 #
@@ -74,7 +64,10 @@
 #   opentelemetry-cpp_<component>_FOUND - True if the requested component is found.
 # ::
 #
-# This module includes the following components for use with `find_package(opentelemetry-cpp COMPONENTS ...)`
+#
+# CMake Components and Targets Supported
+# --------------------
+# opentelemetry-cpp supports the following components and targets. This install may include a subset.
 #
 # COMPONENTS
 #   api
@@ -158,8 +151,7 @@
 #
 # - **component-definitions.cmake**
 #   This file defines the available opentelemetry-cpp components, the targets associated with each
-#   component, and the inter-component dependency relationships. It ensures that, regardless of the
-#   order in which components are specified, all necessary dependencies and targets are imported correctly.
+#   component, and the inter-component dependencies.
 #
 
 
@@ -205,7 +197,7 @@ set(_OPENTELEMETRY_CPP_TARGETS "")
 get_targets(_REQUESTED_COMPONENTS _OPENTELEMETRY_CPP_TARGETS)
 check_targets_imported(_OPENTELEMETRY_CPP_TARGETS)
 
-# Set OPENTELEMETRY_CPP_* variables to preserve legacy CMake style
+# Set OPENTELEMETRY_CPP_* variables
 set(OPENTELEMETRY_CPP_LIBRARIES)
 
 foreach(_TARGET IN LISTS _OPENTELEMETRY_CPP_TARGETS)

cmake/install/find-package-support-functions.cmake renamed to cmake/find-package-support-functions.cmake

@@ -5,7 +5,7 @@
 # CMAKE flags to capture the build configuration for the insalled package
 #    BUILT_WITH_<dependency> is set to true if the installed package requires that dependency
 # See the thirdparty-dependency-deinfitions.cmake for the supported dependency list and
-# mapping to opentelemetry-cpp components that may require them.
+# mapping to opentelemetry-cpp components.
 #-------------------------------------------------------------------------
 
 # Initialize dependency expected flags
@@ -20,10 +20,6 @@ set(BUILT_WITH_prometheus-cpp FALSE)
 set(BUILT_WITH_OpenTracing FALSE)
 
 # absl:
-# Expected TRUE if either:
-#   - WITH_ABSEIL is enabled, OR
-#   - WITH_OTLP_GRPC is enabled, OR
-#   - WITH_OTLP_HTTP or WITH_OTLP_FILE is enabled and Protobuf version is at least 3.22.0.
 if(@WITH_ABSEIL@)
   set(BUILT_WITH_absl TRUE)
 elseif(@WITH_OTLP_HTTP@ OR @WITH_OTLP_FILE@ OR @WITH_OTLP_GRPC@)
@@ -35,7 +31,6 @@ elseif(@WITH_OTLP_HTTP@ OR @WITH_OTLP_FILE@ OR @WITH_OTLP_GRPC@)
 endif()
 
 # CURL and ZLIB:
-# Expected TRUE if WITH_HTTP_CLIENT_CURL is enabled and we're building static libraries.
 if(@WITH_HTTP_CLIENT_CURL@ AND NOT "@BUILD_SHARED_LIBS@")
   if("@CURL_FOUND@")
     set(BUILT_WITH_CURL TRUE)
@@ -46,7 +41,6 @@ if(@WITH_HTTP_CLIENT_CURL@ AND NOT "@BUILD_SHARED_LIBS@")
 endif()
 
 # nlohmann_json:
-# Expected TRUE if both USE_NLOHMANN_JSON is true and the package was found during build.
 if("@USE_NLOHMANN_JSON@" AND "@nlohmann_json_FOUND@")
   set(BUILT_WITH_nlohmann_json TRUE)
 endif()

cmake/templates/opentelemetry-cpp-config.cmake.in

@@ -18,7 +18,7 @@ set(THIRD_PARTY_DEPENDENCIES_SUPPORTED
 )
 
 #-----------------------------------------------------------------------
-# Flags to determine if find_dependency(dep) or find_dependency(dep CONFIG) should be used
+# Flags to determine if CONFIG search mode should be used in find_dependency(...)
 #-----------------------------------------------------------------------
 
 # absl

cmake/templates/thirdparty-built-with-flags.cmake.in

@@ -13,11 +13,11 @@ else()
     STATUS "CMAKE_CXX_STANDARD is set to default of ${CMAKE_CXX_STANDARD}")
 endif()
 
-include(${CMAKE_SOURCE_DIR}/../../install/component-definitions.cmake)
+include(${CMAKE_SOURCE_DIR}/../../../cmake/component-definitions.cmake)
 
-# If COMPONENTS_TO_TEST is not set, then test all components
+# Check that COMPONENTS_TO_TEST is set and contains valid components
 if(NOT COMPONENTS_TO_TEST)
-  set(COMPONENTS_TO_TEST ${opentelemetry-cpp_COMPONENTS})
+  message(FATAL_ERROR "COMPONENTS_TO_TEST is not set")
 else()
   set(COMPONENTS_ARE_VALID TRUE)
   foreach(component ${COMPONENTS_TO_TEST})
@@ -33,11 +33,10 @@ else()
   endif()
 endif()
 
-set(INSTALL_TEST_SRC_DIR "${CMAKE_SOURCE_DIR}/src")
+set(INSTALL_TEST_SRC_DIR "${CMAKE_SOURCE_DIR}/../src")
 
 enable_testing()
 
-message(STATUS "Testing cmake usage for find_package(opentelemetry ...)")
 # -----------------------------------------------------------
 # CMake Usage tests for find_package(opentelemetry-cpp ...)
 #
@@ -52,45 +51,44 @@ add_test(
   NAME cmake-usage-no-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
-    ${CMAKE_SOURCE_DIR}/projects/cmake_usage_tests/no_components -B
+    ${CMAKE_SOURCE_DIR}/usage_tests/no_components -B
     build-cmake-usage-no-components-test
     -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
 
 add_test(
   NAME cmake-usage-unsorted-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
-    ${CMAKE_SOURCE_DIR}/projects/cmake_usage_tests/unsorted_components -B
+    ${CMAKE_SOURCE_DIR}/usage_tests/unsorted_components -B
     build-cmake-usage-unsorted-components-test
     -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
 
 add_test(
   NAME cmake-usage-missing-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
-    ${CMAKE_SOURCE_DIR}/projects/cmake_usage_tests/missing_components -B
+    ${CMAKE_SOURCE_DIR}/usage_tests/missing_components -B
     build-cmake-usage-missing-components-test
     -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
 
 add_test(
   NAME cmake-usage-unsupported-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
-    ${CMAKE_SOURCE_DIR}/projects/cmake_usage_tests/unsupported_components -B
+    ${CMAKE_SOURCE_DIR}/usage_tests/unsupported_components -B
     build-cmake-usage-unsupported-components-test
     -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
 
 # -----------------------------------------------------------
 # Test the full package install using legacy cmake build instructions
 # find_package(opentelemetry-cpp CONFIG REQUIRED)
-message(STATUS "Testing the full package install")
+
 # Test cmake configuration
 add_test(
   NAME full-package-cmake-config-test
   COMMAND
-    ${CMAKE_COMMAND} --log-level=DEBUG -S
-    ${CMAKE_SOURCE_DIR}/projects/package_test -B build-full-package-test
-    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
+    ${CMAKE_COMMAND} --log-level=DEBUG -S ${CMAKE_SOURCE_DIR}/package_test -B
+    build-full-package-test -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
     -DINSTALL_TEST_SRC_DIR=${INSTALL_TEST_SRC_DIR})
 
 # Build the full package test executable
@@ -106,13 +104,12 @@ add_test(NAME full-package-run-test
 # -----------------------------------------------------------
 # Loop over all the components to test
 foreach(component ${COMPONENTS_TO_TEST})
-  message(STATUS "Testing the ${component} component install")
   # Test cmake configuration
   add_test(
     NAME component-${component}-cmake-config-test
     COMMAND
       ${CMAKE_COMMAND} --log-level=DEBUG -S
-      ${CMAKE_SOURCE_DIR}/projects/component_tests/${component} -B
+      ${CMAKE_SOURCE_DIR}/component_tests/${component} -B
       build-${component}-test -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
       -DINSTALL_TEST_SRC_DIR=${INSTALL_TEST_SRC_DIR})