windows install test support

Author: dbarker

.github/workflows/ci.yml

@@ -907,6 +907,18 @@ jobs:
     - name: run tests
       run: ./ci/do_ci.ps1 cmake.test_example_plugin
 
+  windows_cmake_install_test:
+    name: Windows CMake install test
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: 'recursive'
+      - name: Setup Windows CI Environment
+        run: ./ci/setup_windows_ci_environment.ps1
+      - name: Run Tests
+        run: ./ci/do_ci.ps1 cmake.install.test
+
   code_coverage:
     name: Code coverage
     runs-on: ubuntu-22.04

ci/do_ci.ps1

@@ -20,6 +20,11 @@ if (!(test-path build)) {
 }
 $BUILD_DIR = Join-Path "$SRC_DIR" "build"
 
+if (!(test-path install_test)) {
+  mkdir install_test
+}
+$INSTALL_TEST_DIR = Join-Path "$SRC_DIR" "install_test"
+
 if (!(test-path plugin)) {
   mkdir plugin
 }
@@ -58,11 +63,22 @@ switch ($action) {
     }
   }
   "cmake.dll.test" {
+
+    $CMAKE_OPTIONS = @(
+      "-DCMAKE_CXX_STANDARD=17",
+      "-DCMAKE_BUILD_TYPE=Debug",
+      "-DVCPKG_TARGET_TRIPLET=x64-windows",
+      "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
+      )
+    
+    rm -Recurse -Force "$INSTALL_TEST_DIR\*"
     cd "$BUILD_DIR"
     cmake $SRC_DIR `
-      -DVCPKG_TARGET_TRIPLET=x64-windows `
+      $CMAKE_OPTIONS `
+      "-DCMAKE_INSTALL_PREFIX=$INSTALL_TEST_DIR" `
       -DOPENTELEMETRY_BUILD_DLL=1 `
-     "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
+      -DOPENTELEMETRY_INSTALL=ON 
+
     $exit = $LASTEXITCODE
     if ($exit -ne 0) {
       exit $exit
@@ -77,7 +93,35 @@ switch ($action) {
     if ($exit -ne 0) {
       exit $exit
     }
-    $env:PATH = "$BUILD_DIR\ext\src\dll\Debug;$env:PATH"
+    
+    cmake --build . --target install
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    $env:PATH = "$INSTALL_TEST_DIR\bin;$env:PATH"
+
+    $CMAKE_OPTIONS_STRING = $CMAKE_OPTIONS -join " "
+    
+    cmake -S "$SRC_DIR\install\test\cmake" `
+          -B "$BUILD_DIR\install_test" `
+          $CMAKE_OPTIONS `
+          "-DINSTALL_TEST_CMAKE_OPTIONS=$CMAKE_OPTIONS_STRING" `
+          "-DCMAKE_PREFIX_PATH=$INSTALL_TEST_DIR" `
+          "-DINSTALL_TEST_COMPONENTS=ext_dll" 
+
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    ctest -C Debug --test-dir "$BUILD_DIR\install_test" --output-on-failure
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
     examples\simple\Debug\example_simple.exe
     $exit = $LASTEXITCODE
     if ($exit -ne 0) {
@@ -340,6 +384,81 @@ switch ($action) {
       exit $exit
     }
   }
+  "cmake.install.test" {
+    cd "$BUILD_DIR"
+    rm -Recurse -Force "$INSTALL_TEST_DIR\*"
+
+    $CMAKE_OPTIONS = @(
+    "-DCMAKE_CXX_STANDARD=17",
+    "-DCMAKE_BUILD_TYPE=Debug",
+    "-DVCPKG_TARGET_TRIPLET=x64-windows",
+    "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
+    )
+
+    cmake $SRC_DIR `
+      $CMAKE_OPTIONS `
+      "-DCMAKE_INSTALL_PREFIX=$INSTALL_TEST_DIR" `
+      -DWITH_ABSEIL=OFF `
+      -DWITH_METRICS_EXEMPLAR_PREVIEW=ON `
+      -DWITH_ASYNC_EXPORT_PREVIEW=ON `
+      -DWITH_OTLP_GRPC=ON `
+      -DWITH_OTLP_HTTP=ON `
+      -DWITH_OTLP_FILE=ON `
+      -DWITH_OTLP_HTTP_COMPRESSION=ON `
+      -DWITH_HTTP_CLIENT_CURL=ON `
+      -DWITH_PROMETHEUS=ON `
+      -DWITH_ZIPKIN=ON `
+      -DWITH_ELASTICSEARCH=ON `
+      -DWITH_ETW=ON `
+      -DOPENTELEMETRY_INSTALL=ON `
+
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    cmake --build . -j $nproc
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    ctest -C Debug
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    cmake --build . --target install
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    $env:PATH = "$INSTALL_TEST_DIR\bin;$env:PATH"
+
+    $CMAKE_OPTIONS_STRING = $CMAKE_OPTIONS -join " "
+   
+    cmake -S "$SRC_DIR\install\test\cmake" `
+          -B "$BUILD_DIR\install_test" `
+          $CMAKE_OPTIONS `
+          "-DCMAKE_PREFIX_PATH=$INSTALL_TEST_DIR" `
+          "-DINSTALL_TEST_CMAKE_OPTIONS=$CMAKE_OPTIONS_STRING" `
+          "-DINSTALL_TEST_COMPONENTS=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;exporters_etw"
+          
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    ctest -C Debug --test-dir "$BUILD_DIR\install_test" --output-on-failure
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+
+    exit 0
+  }
   default {
     echo "unknown action: $action"
     exit 1

ci/do_ci.sh

@@ -242,10 +242,13 @@ elif [[ "$1" == "cmake.opentracing_shim.test" ]]; then
   make test
   make install
   export LD_LIBRARY_PATH="${INSTALL_TEST_DIR}/lib:$LD_LIBRARY_PATH"
+  CMAKE_OPTIONS_STRING=$(IFS=" "; echo "${CMAKE_OPTIONS[*]}")
   cmake -S "${SRC_DIR}/install/test/cmake" \
         -B "${BUILD_DIR}/install_test" \
+        "${CMAKE_OPTIONS[@]}" \
         "-DCMAKE_PREFIX_PATH=${INSTALL_TEST_DIR}" \
-        "-DCOMPONENTS_TO_TEST=shims_opentracing"
+        "-DINSTALL_TEST_CMAKE_OPTIONS=${CMAKE_OPTIONS_STRING}" \
+        "-DINSTALL_TEST_COMPONENTS=api;sdk;exporters_in_memory;exporters_ostream;shims_opentracing"
   ctest --test-dir "${BUILD_DIR}/install_test" --output-on-failure
   exit 0
 elif [[ "$1" == "cmake.c++20.test" ]]; then
@@ -442,12 +445,18 @@ elif [[ "$1" == "cmake.install.test" ]]; then
         -DOPENTELEMETRY_INSTALL=ON \
         "${SRC_DIR}"
   make -j $(nproc)
+  make test
   make install
   export LD_LIBRARY_PATH="${INSTALL_TEST_DIR}/lib:$LD_LIBRARY_PATH"
+
+  CMAKE_OPTIONS_STRING=$(IFS=" "; echo "${CMAKE_OPTIONS[*]}")
+
   cmake -S "${SRC_DIR}/install/test/cmake" \
         -B "${BUILD_DIR}/install_test" \
+         "${CMAKE_OPTIONS[@]}" \
          "-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"
+         "-DINSTALL_TEST_CMAKE_OPTIONS=${CMAKE_OPTIONS_STRING}" \
+         "-DINSTALL_TEST_COMPONENTS=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
 elif [[ "$1" == "cmake.test_example_plugin" ]]; then

ci/setup_windows_ci_environment.ps1

@@ -25,4 +25,7 @@ $VCPKG_DIR = (Get-Item -Path ".\").FullName
 # curl
 ./vcpkg "--vcpkg-root=$VCPKG_DIR" install curl:x64-windows
 
+# prometheus-cpp
+./vcpkg "--vcpkg-root=$VCPKG_DIR" install prometheus-cpp:x64-windows
+
 Pop-Location

cmake/component-definitions.cmake

@@ -152,18 +152,8 @@ set(COMPONENT_ext_dll_COMPONENT_DEPENDS
     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_etw
-    exporters_zipkin
-    shims_opentracing
 )
 
 set(COMPONENT_exporters_in_memory_COMPONENT_DEPENDS

cmake/find-package-support-functions.cmake

@@ -161,7 +161,6 @@ function (is_dependency_required dependency_in components_in is_required_out)
     message(FATAL_ERROR " is_dependency_required: The BUILT_WITH_${dependency_in} flag is required but not defined in the 'thirdparty-built-with-flags.cmake' file")
   elseif(NOT BUILT_WITH_${dependency_in})
     set(${is_required_out} FALSE PARENT_SCOPE)
-    message(DEBUG "is_dependency_required: ${dependency_in} is not required because that package was not built with it.")
   else()
     foreach(component IN LISTS ${components_in})
       set(is_required_by_component FALSE)

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

@@ -41,7 +41,7 @@ if(@WITH_HTTP_CLIENT_CURL@ AND NOT "@BUILD_SHARED_LIBS@")
 endif()
 
 # nlohmann_json:
-if("@USE_NLOHMANN_JSON@" AND "@nlohmann_json_FOUND@")
+if("@USE_NLOHMANN_JSON@")
   set(BUILT_WITH_nlohmann_json TRUE)
 endif()
 

install/test/cmake/CMakeLists.txt

@@ -4,35 +4,48 @@
 cmake_minimum_required(VERSION 3.10)
 project(opentelemetry-cpp-component-install-tests LANGUAGES CXX)
 
-if(CXX_STANDARD)
-  message(STATUS "CMAKE_CXX_STANDARD is set from CXX_STANDARD=${CXX_STANDARD}")
-  set(CMAKE_CXX_STANDARD $CXX_STANDARD)
-else()
-  set(CMAKE_CXX_STANDARD 14)
-  message(
-    STATUS "CMAKE_CXX_STANDARD is set to default of ${CMAKE_CXX_STANDARD}")
+if(NOT INSTALL_TEST_CMAKE_OPTIONS)
+  set(INSTALL_TEST_CMAKE_OPTIONS
+      "-DCMAKE_CXX_STANDARD=14 -DCMAKE_BUILD_TYPE=Debug")
 endif()
 
-include(${CMAKE_SOURCE_DIR}/../../../cmake/component-definitions.cmake)
+separate_arguments(INSTALL_TEST_CMAKE_OPTIONS)
+
+message(
+  STATUS "INSTALL_TEST_CMAKE_OPTIONS is set to ${INSTALL_TEST_CMAKE_OPTIONS}")
+
+find_package(opentelemetry-cpp CONFIG REQUIRED)
 
-# Check that COMPONENTS_TO_TEST is set and contains valid components
-if(NOT COMPONENTS_TO_TEST)
-  message(FATAL_ERROR "COMPONENTS_TO_TEST is not set")
+message(
+  STATUS
+    "OPENTELEMETRY_CPP_COMPONENTS_INSTALLED = ${OPENTELEMETRY_CPP_COMPONENTS_INSTALLED}"
+)
+
+# Check that INSTALL_TEST_COMPONENTS is set and contains installed components
+if(NOT INSTALL_TEST_COMPONENTS)
+  message(
+    STATUS
+      "INSTALL_TEST_COMPONENTS is not set. Setting to OPENTELEMETRY_CPP_COMPONENTS_INSTALLED"
+  )
+  set(INSTALL_TEST_COMPONENTS ${OPENTELEMETRY_CPP_COMPONENTS_INSTALLED})
 else()
   set(COMPONENTS_ARE_VALID TRUE)
-  foreach(component ${COMPONENTS_TO_TEST})
-    if(NOT component IN_LIST opentelemetry-cpp_COMPONENTS)
+  foreach(component ${INSTALL_TEST_COMPONENTS})
+    if(NOT component IN_LIST OPENTELEMETRY_CPP_COMPONENTS_INSTALLED)
       message(
         ERROR
-        " Component ${component} is not a valid opentelemetry-cpp component")
+        " Component ${component} is not an installed opentelemetry-cpp component"
+      )
       set(COMPONENTS_ARE_VALID FALSE)
     endif()
   endforeach()
   if(NOT COMPONENTS_ARE_VALID)
-    message(FATAL_ERROR "COMPONENTS_TO_TEST contains invalid components")
+    message(FATAL_ERROR "INSTALL_TEST_COMPONENTS contains invalid components")
   endif()
 endif()
 
+message(STATUS "INSTALL_TEST_COMPONENTS = ${INSTALL_TEST_COMPONENTS}")
+
 set(INSTALL_TEST_SRC_DIR "${CMAKE_SOURCE_DIR}/../src")
 
 enable_testing()
@@ -53,31 +66,31 @@ add_test(
     ${CMAKE_COMMAND} --log-level=DEBUG -S
     ${CMAKE_SOURCE_DIR}/usage_tests/no_components -B
     build-cmake-usage-no-components-test
-    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
+    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} ${INSTALL_TEST_CMAKE_OPTIONS})
 
 add_test(
   NAME cmake-usage-unsorted-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
     ${CMAKE_SOURCE_DIR}/usage_tests/unsorted_components -B
     build-cmake-usage-unsorted-components-test
-    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
+    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} ${INSTALL_TEST_CMAKE_OPTIONS})
 
 add_test(
   NAME cmake-usage-missing-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
     ${CMAKE_SOURCE_DIR}/usage_tests/missing_components -B
     build-cmake-usage-missing-components-test
-    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
+    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} ${INSTALL_TEST_CMAKE_OPTIONS})
 
 add_test(
   NAME cmake-usage-unsupported-components-test
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S
     ${CMAKE_SOURCE_DIR}/usage_tests/unsupported_components -B
     build-cmake-usage-unsupported-components-test
-    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH})
+    -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH} ${INSTALL_TEST_CMAKE_OPTIONS})
 
 # -----------------------------------------------------------
 # Test the full package install using legacy cmake build instructions
@@ -89,6 +102,8 @@ add_test(
   COMMAND
     ${CMAKE_COMMAND} --log-level=DEBUG -S ${CMAKE_SOURCE_DIR}/package_test -B
     build-full-package-test -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
+    ${INSTALL_TEST_CMAKE_OPTIONS}
+    -DINSTALL_TEST_COMPONENTS=${INSTALL_TEST_COMPONENTS}
     -DINSTALL_TEST_SRC_DIR=${INSTALL_TEST_SRC_DIR})
 
 # Build the full package test executable
@@ -103,14 +118,15 @@ add_test(NAME full-package-run-test
 
 # -----------------------------------------------------------
 # Loop over all the components to test
-foreach(component ${COMPONENTS_TO_TEST})
+foreach(component ${INSTALL_TEST_COMPONENTS})
   # Test cmake configuration
   add_test(
     NAME component-${component}-cmake-config-test
     COMMAND
       ${CMAKE_COMMAND} --log-level=DEBUG -S
       ${CMAKE_SOURCE_DIR}/component_tests/${component} -B
       build-${component}-test -DCMAKE_PREFIX_PATH=${CMAKE_PREFIX_PATH}
+      ${INSTALL_TEST_CMAKE_OPTIONS}
       -DINSTALL_TEST_SRC_DIR=${INSTALL_TEST_SRC_DIR})
 
   # Build the component test executable