chore(cmake): overall improvements (#242)

Author: dmehala

.github/workflows/dev.yml

@@ -5,7 +5,7 @@ jobs:
   format:
     runs-on: ubuntu-22.04-arm
     container:
-      image: datadog/docker-library:dd-trace-cpp-ci-5f5c273-arm64
+      image: datadog/docker-library:dd-trace-cpp-ci-23768e9-arm64
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Check format
@@ -29,7 +29,7 @@ jobs:
     needs: format
     runs-on: ${{ matrix.runner }}
     container:
-      image: datadog/docker-library:dd-trace-cpp-ci-5f5c273-${{matrix.docker-arch}}
+      image: datadog/docker-library:dd-trace-cpp-ci-23768e9-${{matrix.docker-arch}}
     environment:
       name: dev
     permissions:
@@ -68,7 +68,7 @@ jobs:
             docker-arch: amd64
     runs-on: ${{ matrix.runner }}
     container:
-      image: datadog/docker-library:dd-trace-cpp-ci-5f5c273-${{matrix.docker-arch}}
+      image: datadog/docker-library:dd-trace-cpp-ci-23768e9-${{matrix.docker-arch}}
     steps:
       - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
       - name: Build
@@ -144,7 +144,7 @@ jobs:
     needs: build-linux-cmake 
     runs-on: ubuntu-22.04-arm
     container:
-      image: datadog/docker-library:dd-trace-cpp-ci-5f5c273-arm64
+      image: datadog/docker-library:dd-trace-cpp-ci-23768e9-arm64
     environment:
       name: dev
     permissions:

.github/workflows/main.yml

@@ -40,7 +40,7 @@ jobs:
     needs: call-dev-workflow
     runs-on: ubuntu-22.04-arm
     container:
-      image: datadog/docker-library:dd-trace-cpp-ci-5f5c273-arm64
+      image: datadog/docker-library:dd-trace-cpp-ci-23768e9-arm64
     env:
       DURATION_SEC: 300 # 5min
     steps:

.gitignore

@@ -1,5 +1,7 @@
 /bazel-*
 /.build/
+/build/
+/build-*/
 /.coverage/
 build/
 

CMakeLists.txt

@@ -1,15 +1,20 @@
 # Note: Make sure that this version is the same as that in
 # "./CheckRequiredCMakeVersion.cmake".
-cmake_minimum_required(VERSION 3.24)
+cmake_minimum_required(VERSION 3.28...4.0)
 cmake_policy(SET CMP0077 NEW)
 
-project(dd-trace-cpp)
+list(APPEND CMAKE_MODULE_PATH "${CMAKE_CURRENT_LIST_DIR}/cmake")
 
-set(CMAKE_CXX_STANDARD 17)
-set(CMAKE_CXX_STANDARD_REQUIRED ON)
-set(CMAKE_CXX_EXTENSIONS OFF)
-set(CMAKE_EXPORT_COMPILE_COMMANDS ON)
-set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+# Get the version of the lib
+file(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/src/datadog/version.cpp DD_TRACE_VERSION_CPP_CONTENTS REGEX "#define DD_TRACE_VERSION( |_NUM )")
+string(REGEX MATCH "#define DD_TRACE_VERSION \"[^\"]*" DD_TRACE_VERSION ${DD_TRACE_VERSION_CPP_CONTENTS})
+string(REGEX REPLACE "[^\"]+\"v" "" DD_TRACE_VERSION ${DD_TRACE_VERSION})
+
+project(
+  dd-trace-cpp
+    VERSION ${DD_TRACE_VERSION}
+    LANGUAGES CXX
+)
 
 option(BUILD_SHARED_LIBS "Build shared libraries" ON)
 option(BUILD_STATIC_LIBS "Build static libraries" ON)
@@ -26,7 +31,6 @@ set(DD_TRACE_TRANSPORT "curl" CACHE STRING "HTTP transport that dd-trace-cpp use
 
 if(DD_TRACE_TRANSPORT STREQUAL "curl")
   include(cmake/deps/curl.cmake)
-  message(STATUS "DD_TRACE_TRANSPORT is set to 'curl', including curl")
 elseif(DD_TRACE_TRANSPORT STREQUAL "none")
     message(STATUS "DD_TRACE_TRANSPORT is set to 'none', no default transport will be included")
 else()
@@ -44,18 +48,15 @@ if(CMAKE_CURRENT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
   option(DD_TRACE_ENABLE_SANITIZE "Build with address sanitizer and undefined behavior sanitizer" OFF)
 endif()
 
-if (NOT CMAKE_BUILD_TYPE)
-  set(CMAKE_BUILD_TYPE "RelWithDebInfo")
-endif ()
+# Include mandatory files
+include(GNUInstallDirs)
+include(CMakePackageConfigHelpers)
 
 # Linking this library requires threads.
 find_package(Threads REQUIRED)
 include(cmake/deps/json.cmake)
 include(cmake/utils.cmake)
 
-file(STRINGS ${CMAKE_CURRENT_SOURCE_DIR}/src/datadog/version.cpp DD_TRACE_VERSION_CPP_CONTENTS REGEX "#define DD_TRACE_VERSION( |_NUM )")
-string(REGEX MATCH "#define DD_TRACE_VERSION \"[^\"]*" DD_TRACE_VERSION ${DD_TRACE_VERSION_CPP_CONTENTS})
-string(REGEX REPLACE "[^\"]+\"" "" DD_TRACE_VERSION ${DD_TRACE_VERSION})
 message(STATUS "dd-trace-cpp version=[${DD_TRACE_VERSION}]")
 unset(DD_TRACE_VERSION_CPP_CONTENTS)
 
@@ -83,7 +84,10 @@ if (DD_TRACE_BUILD_FUZZERS)
 endif ()
 
 if (DD_TRACE_BUILD_TESTING)
+  include(Catch)
+  enable_testing()
   add_subdirectory(test)
+  add_subdirectory(test/system-tests)
 endif()
 
 if (DD_TRACE_BUILD_EXAMPLES)
@@ -94,17 +98,68 @@ if (DD_TRACE_BUILD_BENCHMARK)
   add_subdirectory(benchmark)
 endif ()
 
-add_library(dd_trace_cpp-objects OBJECT)
-add_library(dd_trace::obj ALIAS dd_trace_cpp-objects)
+add_library(dd-trace-cpp-objects OBJECT)
+add_library(dd-trace-cpp::obj ALIAS dd-trace-cpp-objects)
 
-file(GLOB_RECURSE public_header_files ${CMAKE_SOURCE_DIR}/include/*.h)
+target_compile_features(dd-trace-cpp-objects
+  PUBLIC
+    cxx_std_17
+)
 
-target_sources(dd_trace_cpp-objects
+# NOTE: Don't use glob:
+#  - <https://stackoverflow.com/questions/32411963/why-is-cmake-file-glob-evil>
+#  - <https://discourse.cmake.org/t/is-glob-still-considered-harmful-with-configure-depends/808>
+target_sources(dd-trace-cpp-objects
   PUBLIC
     FILE_SET public_headers
     TYPE HEADERS
     BASE_DIRS include
-    FILES ${public_header_files}
+    FILES 
+      include/datadog/remote_config/capability.h
+      include/datadog/remote_config/listener.h
+      include/datadog/remote_config/product.h
+      include/datadog/telemetry/configuration.h
+      include/datadog/telemetry/metrics.h
+      include/datadog/telemetry/product.h
+      include/datadog/telemetry/telemetry.h
+      include/datadog/baggage.h
+      include/datadog/cerr_logger.h
+      include/datadog/clock.h
+      include/datadog/collector.h
+      include/datadog/config.h
+      include/datadog/datadog_agent_config.h
+      include/datadog/dict_reader.h
+      include/datadog/dict_writer.h
+      include/datadog/environment.h
+      include/datadog/error.h
+      include/datadog/event_scheduler.h
+      include/datadog/expected.h
+      include/datadog/http_client.h
+      include/datadog/id_generator.h
+      include/datadog/injection_options.h
+      include/datadog/logger.h
+      include/datadog/null_collector.h
+      include/datadog/optional.h
+      include/datadog/propagation_style.h
+      include/datadog/rate.h
+      include/datadog/runtime_id.h
+      include/datadog/sampling_decision.h
+      include/datadog/sampling_mechanism.h
+      include/datadog/sampling_priority.h
+      include/datadog/span.h
+      include/datadog/span_config.h
+      include/datadog/span_defaults.h
+      include/datadog/span_matcher.h
+      include/datadog/span_sampler_config.h
+      include/datadog/string_view.h
+      include/datadog/trace_id.h
+      include/datadog/trace_sampler_config.h
+      include/datadog/trace_segment.h
+      include/datadog/trace_source.h
+      include/datadog/tracer.h
+      include/datadog/tracer_config.h
+      include/datadog/tracer_signature.h
+      include/datadog/version.h
   PRIVATE
     src/datadog/common/hash.cpp
     src/datadog/telemetry/configuration.cpp
@@ -156,102 +211,158 @@ target_sources(dd_trace_cpp-objects
     src/datadog/w3c_propagation.cpp
 )
 
-# Headers location are different depending of whether we are building 
-# or installing the library.
-target_include_directories(dd_trace_cpp-objects
-  PUBLIC
-    $<INSTALL_INTERFACE:include>
-    $<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/include>
+target_include_directories(dd-trace-cpp-objects
   PRIVATE
     ${CMAKE_CURRENT_SOURCE_DIR}/src/datadog
 )
 
-target_link_libraries(dd_trace_cpp-objects
+target_link_libraries(dd-trace-cpp-objects
   PUBLIC
     Threads::Threads
   PRIVATE
-    dd_trace::specs
+    dd-trace-cpp::specs
+)
+
+set_target_properties(dd-trace-cpp-objects
+  PROPERTIES
+    VERIFY_INTERFACE_HEADER_SETS ON
+    POSITION_INDEPENDENT_CODE ${BUILD_SHARED_LIBS}
+)
+
+install(
+  TARGETS dd-trace-cpp-objects dd-trace-cpp-specs
+  EXPORT dd-trace-cpp-targets
+  FILE_SET public_headers DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
 )
 
 # Produce both shared and static versions of the library.
 if (BUILD_SHARED_LIBS)
-  add_library(dd_trace_cpp-shared SHARED $<TARGET_OBJECTS:dd_trace_cpp-objects>)
-  add_library(dd_trace::shared ALIAS dd_trace_cpp-shared)
+  add_library(dd-trace-cpp-shared SHARED $<TARGET_OBJECTS:dd-trace-cpp-objects>)
+  add_library(dd-trace-cpp::shared ALIAS dd-trace-cpp-shared)
 
-  if (DD_TRACE_TRANSPORT STREQUAL "curl")
-    add_dependencies(dd_trace_cpp-shared CURL::libcurl_shared)
+  if(DD_TRACE_TRANSPORT STREQUAL "curl")
+    add_dependencies(dd-trace-cpp-shared CURL::libcurl_shared)
 
-    target_sources(dd_trace_cpp-shared
+    target_sources(dd-trace-cpp-shared
       PRIVATE
         src/datadog/curl.cpp
         src/datadog/default_http_client_curl.cpp
     )
 
-    target_link_libraries(dd_trace_cpp-shared
+    target_link_libraries(dd-trace-cpp-shared
       PRIVATE
         CURL::libcurl_shared
     )
+
+    install(
+      TARGETS libcurl_shared
+      EXPORT dd-trace-cpp-targets
+    )
   else()
-    target_sources(dd_trace_cpp-shared
+    target_sources(dd-trace-cpp-shared
       PRIVATE
         src/datadog/default_http_client_null.cpp
     )
-  endif ()
+  endif()
 
-  target_link_libraries(dd_trace_cpp-shared
+  target_link_libraries(dd-trace-cpp-shared
     PUBLIC
-      dd_trace::obj
+      dd-trace-cpp::obj
     PRIVATE
-      dd_trace::specs
+      dd-trace-cpp::specs
+  )
+
+  set_target_properties(dd-trace-cpp-shared
+    PROPERTIES 
+      OUTPUT_NAME "dd-trace-cpp"
   )
 
-  install(TARGETS dd_trace_cpp-objects dd_trace_cpp-shared
-    EXPORT dd_trace_cpp-export
-    FILE_SET public_headers DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  install(
+    TARGETS dd-trace-cpp-shared 
+    EXPORT dd-trace-cpp-targets
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_LIBDIR}
   )
 endif ()
 
 if (BUILD_STATIC_LIBS)
-  add_library(dd_trace_cpp-static STATIC $<TARGET_OBJECTS:dd_trace_cpp-objects>)
-  add_library(dd_trace::static ALIAS dd_trace_cpp-static)
+  add_library(dd-trace-cpp-static STATIC $<TARGET_OBJECTS:dd-trace-cpp-objects>)
+  add_library(dd-trace-cpp::static ALIAS dd-trace-cpp-static)
 
-  add_dependencies(dd_trace_cpp-static dd_trace_cpp-objects)
+  add_dependencies(dd-trace-cpp-static dd-trace-cpp-objects)
 
   if (DD_TRACE_TRANSPORT STREQUAL "curl")
-    add_dependencies(dd_trace_cpp-static CURL::libcurl_static)
+    add_dependencies(dd-trace-cpp-static CURL::libcurl_static)
 
-    target_sources(dd_trace_cpp-static
+    target_sources(dd-trace-cpp-static
       PRIVATE
         src/datadog/curl.cpp
         src/datadog/default_http_client_curl.cpp
     )
 
-    target_link_libraries(dd_trace_cpp-static 
+    target_link_libraries(dd-trace-cpp-static 
       PRIVATE
         CURL::libcurl_static
     )
+
+    install(
+      TARGETS libcurl_static
+      EXPORT dd-trace-cpp-targets
+    )
   else()
-    target_sources(dd_trace_cpp-static
+    target_sources(dd-trace-cpp-static
       PRIVATE
         src/datadog/default_http_client_null.cpp
     ) 
   endif ()
 
-  target_link_libraries(dd_trace_cpp-static 
+  target_link_libraries(dd-trace-cpp-static 
     PUBLIC
-      dd_trace::obj
+      dd-trace-cpp::obj
     PRIVATE
-      dd_trace::specs
+      dd-trace-cpp::specs
+  )
+
+  set_target_properties(dd-trace-cpp-static 
+    PROPERTIES 
+      OUTPUT_NAME "dd-trace-cpp"
   )
 
-  install(TARGETS dd_trace_cpp-objects dd_trace_cpp-static
-    EXPORT dd_trace_cpp-export
-    FILE_SET public_headers DESTINATION ${CMAKE_INSTALL_INCLUDEDIR}
+  install(
+    TARGETS dd-trace-cpp-static
+    EXPORT dd-trace-cpp-targets
     LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
     ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR}
     RUNTIME DESTINATION ${CMAKE_INSTALL_LIBDIR}
   )
 endif ()
+
+# install target
+write_basic_package_version_file(
+  "${PROJECT_NAME}-config-version.cmake"
+  VERSION ${PROJECT_VERSION}
+  COMPATIBILITY SameMajorVersion
+)
+
+configure_package_config_file(
+  "${CMAKE_CURRENT_SOURCE_DIR}/cmake/${PROJECT_NAME}-config.cmake.in"
+  ${PROJECT_NAME}-config.cmake
+  INSTALL_DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+  NO_CHECK_REQUIRED_COMPONENTS_MACRO
+  PATH_VARS CMAKE_INSTALL_INCLUDEDIR
+)
+
+install(
+  EXPORT dd-trace-cpp-targets
+  NAMESPACE dd-trace-cpp::
+  FILE ${PROJECT_NAME}-targets.cmake
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)
+
+install(
+  FILES 
+    "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config.cmake"
+    "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}-config-version.cmake"
+  DESTINATION "${CMAKE_INSTALL_LIBDIR}/cmake/${PROJECT_NAME}"
+)

CMakePresets.json

@@ -25,6 +25,7 @@
       "displayName": "Development",
       "cacheVariables": {
         "CMAKE_BUILD_TYPE": "Debug",
+        "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
         "DD_TRACE_ENABLE_SANITIZE": "OFF",
         "DD_TRACE_BUILD_TESTING": "ON",
         "DD_TRACE_BUILD_EXAMPLES": "ON",