Add CMake OTELCPP_MAINTAINER_MODE

.github/workflows/ci.yml

@@ -23,6 +23,52 @@ jobs:
         sudo ./ci/setup_thrift.sh
         ./ci/do_ci.sh cmake.test
 
+  cmake_gcc_maintainer_test:
+    name: CMake gcc (maintainer mode)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+    - name: setup
+      run: |
+        sudo CC=/usr/bin/gcc CXX=/usr/bin/g++ ./ci/setup_cmake.sh
+        sudo CC=/usr/bin/gcc CXX=/usr/bin/g++ ./ci/setup_ci_environment.sh
+    - name: run cmake gcc (maintainer mode)
+      run: |
+        sudo CC=/usr/bin/gcc CXX=/usr/bin/g++ ./ci/setup_thrift.sh
+        CC=/usr/bin/gcc CXX=/usr/bin/g++ ./ci/do_ci.sh cmake.maintainer.test
+
+  cmake_clang_maintainer_test:
+    name: CMake clang (maintainer mode)
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+    - name: setup
+      run: |
+        sudo CC=/usr/bin/clang CXX=/usr/bin/clang++ ./ci/setup_cmake.sh
+        sudo CC=/usr/bin/clang CXX=/usr/bin/clang++ ./ci/setup_ci_environment.sh
+    - name: run cmake clang (maintainer mode)
+      run: |
+        sudo CC=/usr/bin/clang CXX=/usr/bin/clang++ ./ci/setup_thrift.sh
+        CC=/usr/bin/clang CXX=/usr/bin/clang++ ./ci/do_ci.sh cmake.maintainer.test
+
+  cmake_msvc_maintainer_test:
+    name: CMake msvc (maintainer mode)
+    runs-on: windows-2019
+    steps:
+    - uses: actions/checkout@v3
+      with:
+        submodules: 'recursive'
+    - name: setup
+      run: |
+        ./ci/setup_windows_cmake.ps1
+        ./ci/setup_windows_ci_environment.ps1
+    - name: run tests
+      run: ./ci/do_ci.ps1 cmake.maintainer.test
+
   cmake_deprecated_metrics_test:
     name: CMake test (without otlp-exporter and with deprecated metrics)
     runs-on: ubuntu-latest

CMakeLists.txt

@@ -163,6 +163,55 @@ option(BUILD_TESTING "Whether to enable tests" ON)
 
 option(BUILD_W3CTRACECONTEXT_TEST "Whether to build w3c trace context" OFF)
 
+option(MAINTAINER_MODE "Build in maintainer mode (-Wall -Werror)" OFF)
+
+if(MAINTAINER_MODE)
+  if(CMAKE_CXX_COMPILER_ID MATCHES "GNU")
+    add_compile_options(-Wall)
+    add_compile_options(-Werror)
+    add_compile_options(-Wextra)
+
+    # Tested with GCC 9.4 on github.
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 9.4)
+      # Relaxed warnings
+
+      # Enforced warnings
+    endif()
+
+  endif()
+
+  if(CMAKE_CXX_COMPILER_ID MATCHES "Clang")
+    add_compile_options(-Wall)
+    add_compile_options(-Werror)
+    add_compile_options(-Wextra)
+
+    # Tested with Clang 11.0 on github.
+    if(CMAKE_CXX_COMPILER_VERSION VERSION_GREATER_EQUAL 11.0)
+      # Relaxed warnings
+      add_compile_options(-Wno-error=unused-private-field)
+
+      # Relaxed warning, for GRPC generated code.
+      add_compile_options(-Wno-error=shadow-field)
+
+      # Enforced warnings
+      add_compile_options(-Wconditional-uninitialized)
+      add_compile_options(-Wextra-semi)
+      add_compile_options(-Wheader-hygiene)
+      add_compile_options(-Wnon-virtual-dtor)
+      add_compile_options(-Wundefined-reinterpret-cast)
+      add_compile_options(-Wrange-loop-analysis)
+      add_compile_options(-Winconsistent-missing-destructor-override)
+      add_compile_options(-Winconsistent-missing-override)
+      add_compile_options(-Wnewline-eof)
+    endif()
+  endif()
+
+  if(CMAKE_CXX_COMPILER_ID MATCHES "MSVC")
+    add_compile_options(/WX)
+    add_compile_options(/W4)
+  endif()
+endif(MAINTAINER_MODE)
+
 if(WIN32)
   if(BUILD_TESTING)
     if(MSVC)

ci/README.md

@@ -4,6 +4,7 @@ CI tests can be run on docker by invoking the script `./ci/run_docker.sh
 ./ci/do_ci.sh {TARGET}` where the targets are:
 
 * `cmake.test`: build cmake targets and run tests.
+* `cmake.maintainer.test`: build with cmake and test, in maintainer mode.
 * `cmake.legacy.test`: build cmake targets with gcc 4.8 and run tests.
 * `cmake.c++20.test`: build cmake targets with the C++20 standard and run tests.
 * `cmake.test_example_plugin`: build and test an example OpenTelemetry plugin.

ci/do_ci.ps1

@@ -48,6 +48,27 @@ switch ($action) {
       exit $exit
     }
   }
+  "cmake.maintainer.test" {
+    cd "$BUILD_DIR"
+    cmake $SRC_DIR `
+      -DMAINTAINER_MODE=ON `
+      -DVCPKG_TARGET_TRIPLET=x64-windows `
+      "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR/scripts/buildsystems/vcpkg.cmake"
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+    cmake --build .
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+    ctest -C Debug
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+  }
   "cmake.with_async_export.test" {
     cd "$BUILD_DIR"
     cmake $SRC_DIR `

ci/do_ci.sh

@@ -89,6 +89,22 @@ if [[ "$1" == "cmake.test" ]]; then
   make
   make test
   exit 0
+elif [[ "$1" == "cmake.maintainer.test" ]]; then
+  cd "${BUILD_DIR}"
+  rm -rf *
+  cmake -DCMAKE_BUILD_TYPE=Debug  \
+        -DWITH_PROMETHEUS=ON \
+        -DWITH_ZIPKIN=ON \
+        -DWITH_JAEGER=ON \
+        -DWITH_ELASTICSEARCH=ON \
+        -DWITH_LOGS_PREVIEW=ON \
+        -DWITH_METRICS_PREVIEW=OFF \
+        -DWITH_ASYNC_EXPORT_PREVIEW=ON \
+        -DMAINTAINER_MODE=ON \
+        "${SRC_DIR}"
+  make
+  make test
+  exit 0
 elif [[ "$1" == "cmake.with_async_export.test" ]]; then
   cd "${BUILD_DIR}"
   rm -rf *