feat: add bazel support

GuillaumeLagrange · GuillaumeLagrange · commit 93ab1abc9d31 · 2025-05-06T15:26:13.000+02:00
diff --git a/.bazelrc b/.bazelrc
@@ -0,0 +1 @@
+build --//core:codspeed_mode=instrumentation
diff --git a/.bazelversion b/.bazelversion
@@ -0,0 +1 @@
+7.6.1
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -39,6 +39,28 @@ jobs:
       with:
         name: test_results
         path: ${{runner.workspace}}/core/build-tests/test/test-results/**/*.json
+
+  cmake-integration-tests:
+    strategy:
+      matrix:
+        codspeed-mode:
+          - "instrumentation"
+          - "off"
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v3
+
+    - name: Cache build
+      uses: actions/cache@v3
+      with:
+        path: examples/google_benchmark_cmake/build
+        key: ${{ runner.os }}-build-${{ matrix.codspeed-mode }}-${{ hashFiles('**/CMakeLists.txt', '**/examples/google_benchmark_cmake/**') }}
+
+      - name: Build and run benchmarks
+        run: |
+          bazel run //examples/google_benchmark:my_benchmark
   
   instrumentation:
     runs-on: ubuntu-latest
diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,6 @@ build/
 
 # Clangd cache
 .cache/
+
+# Bazel output
+/bazel-*
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -0,0 +1 @@
+bazel_dep(name = "rules_cc", version = "0.0.17")
diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock
diff --git a/README.md b/README.md
@@ -11,3 +11,7 @@ This mono-repo contains the integration libraries for using CodSpeed in C++:
 
 - [`codspeed-google-benchmark`](./google_benchmark/): Google Benchmark compatibility layer for CodSpeed
 - [`codspeed-core`](./core/): The CodSpeed core library used to integrate with Codspeed runners
+
+## Usage
+
+The library can be used with both [CMake](https://docs.codspeed.io/benchmarks/cpp#cmake) and [Bazel](https://docs.codspeed.io/benchmarks/cpp#bazel). If you need further information to integrate CodSpeed to your project, please feel free to open an issue or ask for help on our discord server.
diff --git a/core/BUILD b/core/BUILD
@@ -0,0 +1,41 @@
+load("@bazel_skylib//rules:common_settings.bzl", "string_flag")
+load("@rules_cc//cc:defs.bzl", "cc_library")
+
+CODSPEED_VERSION = "1.0.0"
+
+# Define the codspeed library
+cc_library(
+    name = "codspeed",
+    srcs = glob(["src/**/*.cpp"] + ["src/**/*.h"] + ["src/**/*.hpp"]),
+    hdrs = ["include/codspeed.h"],
+    includes = ["include"],
+    defines = [
+        "CODSPEED_VERSION=\\\"{}\\\"".format(CODSPEED_VERSION),
+    ] + select({
+        ":instrumentation_mode": ["CODSPEED_ENABLED", "CODSPEED_INSTRUMENTATION"],
+        ":walltime_mode": ["CODSPEED_ENABLED", "CODSPEED_WALLTIME"],
+        "//conditions:default": [],
+    }),
+    visibility = ["//visibility:public"],
+)
+
+# Codspeed mode
+string_flag(
+    name = "codspeed_mode",
+    build_setting_default = "off",
+    values = [
+        "off",
+        "instrumentation",
+        "walltime",
+    ],
+)
+
+config_setting(
+    name = "instrumentation_mode",
+    flag_values = {":codspeed_mode": "instrumentation"},
+)
+
+config_setting(
+    name = "walltime_mode",
+    flag_values = {":codspeed_mode": "walltime"},
+)
diff --git a/core/CMakeLists.txt b/core/CMakeLists.txt
@@ -12,7 +12,13 @@ set(CMAKE_CXX_STANDARD_REQUIRED True)
 include_directories(include)
 
 # Add the library
-add_library(codspeed src/codspeed.cpp src/walltime.cpp src/uri.cpp)
+add_library(
+    codspeed
+    src/codspeed.cpp
+    src/walltime.cpp
+    src/uri.cpp
+    src/workspace.cpp
+)
 
 # Version
 add_compile_definitions(CODSPEED_VERSION="${CODSPEED_VERSION}")
@@ -31,7 +37,7 @@ endif()
 
 execute_process(
     COMMAND git rev-parse --show-toplevel
-    OUTPUT_VARIABLE GIT_ROOT_DIR
+    OUTPUT_VARIABLE CODSPEED_ROOT_DIR
     OUTPUT_STRIP_TRAILING_WHITESPACE
     RESULT_VARIABLE GIT_COMMAND_RESULT
 )
@@ -44,13 +50,14 @@ if(NOT GIT_COMMAND_RESULT EQUAL 0)
         Continuing, but codspeed features will not be useable"
     )
     # Default to user's cmake source directory
-    set(GIT_ROOT_DIR ${CMAKE_SOURCE_DIR})
+    set(CODSPEED_ROOT_DIR ${CMAKE_SOURCE_DIR})
 endif()
 
 target_compile_definitions(
     codspeed
-    INTERFACE -DCODSPEED_GIT_ROOT_DIR="${GIT_ROOT_DIR}"
+    PRIVATE -DCODSPEED_ROOT_DIR="${CODSPEED_ROOT_DIR}"
 )
+message(STATUS "Using codspeed root directory: ${CODSPEED_ROOT_DIR}")
 
 set(CODSPEED_MODE_ALLOWED_VALUES "off" "instrumentation" "walltime")
 set(CODSPEED_MODE "off" CACHE STRING "Build mode for Codspeed")
diff --git a/core/include/codspeed.h b/core/include/codspeed.h
@@ -46,6 +46,10 @@ void generate_codspeed_walltime_report(
 std::string extract_lambda_namespace(const std::string &pretty_func);
 std::string sanitize_bench_args(std::string &text);
 
+// Gets path relative to workspace root, expected to be called with __FILE__ as
+// an argument
+std::string get_path_relative_to_workspace(const std::string &path);
+
 } // namespace codspeed
 
 #endif // CODSPEED_H
diff --git a/core/src/workspace.cpp b/core/src/workspace.cpp
@@ -0,0 +1,25 @@
+// Implementation
+#include "codspeed.h"
+#include <cstdlib>
+#include <filesystem>
+
+namespace codspeed {
+
+std::string get_path_relative_to_workspace(const std::string &path) {
+  // 1. Check for bazel usage, through the BUILD_WORKSPACE_DIRECTORY env var
+  // If so, __FILE__ will already be relative to the bazel workspace root
+  if (std::getenv("BUILD_WORKSPACE_DIRECTORY") != NULL) {
+    return path;
+  }
+
+  // 2. If defined, use the specificed value directly
+#ifdef CODSPEED_ROOT_DIR
+  return std::filesystem::relative(path, CODSPEED_ROOT_DIR).string();
+#endif
+
+  // 3. Fallback to bath relative to PWD
+  return std::filesystem::relative(path, std::filesystem::current_path())
+      .string();
+}
+
+} // namespace codspeed
diff --git a/examples/google_benchmark/BUILD.bazel b/examples/google_benchmark/BUILD.bazel
@@ -0,0 +1,7 @@
+cc_binary(
+    name = "my_benchmark",
+    srcs = glob(["*.cpp", "*.hpp"]),
+    deps = [
+        "//google_benchmark:benchmark",
+    ],
+)
diff --git a/flake.nix b/flake.nix
@@ -20,8 +20,11 @@
         # Common build inputs for both shells
         commonBuildInputs = with pkgs; [
           gcc
-          cmake
           pkg-config
+
+          # Build systems
+          cmake
+          bazelisk
         ];
 
       in
diff --git a/google_benchmark/BUILD.bazel b/google_benchmark/BUILD.bazel
@@ -77,7 +77,7 @@ cc_library(
         "_LARGEFILE_SOURCE",
     ],
     visibility = ["//visibility:public"],
-    deps = select({
+    deps = ["//core:codspeed"] + select({
         ":perfcounters": ["@libpfm"],
         "//conditions:default": [],
     }),
diff --git a/google_benchmark/include/benchmark/benchmark.h b/google_benchmark/include/benchmark/benchmark.h
@@ -1444,7 +1444,7 @@ class Fixture : public internal::Benchmark {
 #include <filesystem>
 
 #define CUR_FILE \
-  std::filesystem::relative(__FILE__, CODSPEED_GIT_ROOT_DIR).string() + "::"
+  codspeed::get_path_relative_to_workspace(__FILE__) + "::"
 #define NAMESPACE \
   (([]() { return codspeed::extract_lambda_namespace(__PRETTY_FUNCTION__); })())
 #define STATIC_NAMESPACE_STRING(name) static std::string name = NAMESPACE;

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+build --//core:codspeed_mode=instrumentation`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+bazel_dep(name = "rules_cc", version = "0.0.17")`