Add cc_asan_test example

.github/workflows/ci.yaml

@@ -24,11 +24,11 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-20.04, macos-12, windows-2019]
+        os: [ubuntu-20.04, macos-12, windows-2022]
         bazelversion: [last_rc, last_green]
         folder: [".", examples]
         exclude:
-          - os: windows-2019
+          - os: windows-2022
             folder: "."
           - os: macos-12
             folder: "."
@@ -64,6 +64,16 @@ jobs:
         working-directory: ${{ matrix.folder }}
         run: echo "${{ matrix.bazelversion }}" > .bazelversion
 
+      - name: Add ASAN runtime DLL to PATH on Windows
+        if: matrix.os == 'windows-2022'
+        run: |
+          dir "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.16.27023"
+          dir "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.16.27023\bin"
+          dir "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.16.27023\bin\Hostx64"
+          dir "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.16.27023\bin\Hostx64\x64"
+          dir "C:\Program Files\Microsoft Visual Studio\Installer"
+          echo "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\VC\Tools\MSVC\14.16.27023\bin\Hostx64\x64" >> $GITHUB_PATH
+
       - name: bazel test //...
         env:
           # Bazelisk will download bazel to here.

examples/.bazelrc

@@ -1,3 +1,4 @@
+common --enable_platform_specific_config
 common --enable_bzlmod
 
 # Prevent Java compiler warnings such as:
@@ -16,5 +17,10 @@ common --check_bazel_compatibility=warning
 
 # Improve build caching by redacting environment variables.
 common --incompatible_strict_action_env
+# On Windows, PATH doubles as the dynamic library search path. We need its
+# unmodified value to find libraries in non-standard location, such as the
+# ASAN runtime for cc_asan_test.
+common:windows --noincompatible_strict_action_env
+common:windows --test_env=PATH
 # Allow build to start before all external deps have been fetched.
 common --experimental_merged_skyframe_analysis_execution

examples/cc_asan_test/BUILD.bazel

@@ -0,0 +1,20 @@
+load(":defs.bzl", "cc_asan_test")
+
+cc_asan_test(
+    name = "asan_test",
+    srcs = ["asan_test.cpp"],
+    env = {
+        # Effectively invert the exit code so that the test passes if and only
+        # if the expected ASAN error is detected.
+        "ASAN_OPTIONS": "exitcode=0:abort_on_error=0",
+    },
+    deps = [
+        ":lib",
+    ],
+)
+
+cc_library(
+    name = "lib",
+    srcs = ["lib.cpp"],
+    hdrs = ["lib.h"],
+)

examples/cc_asan_test/asan_test.cpp

@@ -0,0 +1,9 @@
+#include "cc_asan_test/lib.h"
+
+#include <iostream>
+
+int main() {
+  trigger_asan();
+  std::cerr << "Did not get expected AddressSanitizer error, is the test instrumented correctly?" << std::endl;
+  return 1;
+}

examples/cc_asan_test/defs.bzl

@@ -0,0 +1,17 @@
+load("@with_cfg.bzl", "with_cfg")
+
+cc_asan_test, _cc_asan_test_internal = with_cfg(
+    native.cc_test,
+).extend(
+    "copt",
+    select({
+        "@rules_cc//cc/compiler:msvc-cl": ["/fsanitize=address"],
+        "//conditions:default": ["-fsanitize=address"],
+    }),
+).extend(
+    "linkopt",
+    select({
+        "@rules_cc//cc/compiler:msvc-cl": [],
+        "//conditions:default": ["-fsanitize=address"],
+    }),
+).build()

examples/cc_asan_test/lib.cpp

@@ -0,0 +1,8 @@
+#include "cc_asan_test/lib.h"
+
+int trigger_asan() {
+  int* array = new int[100] {};
+  delete[] array;
+  // Triggers a heap-use-after-free error.
+  return array[0];
+}

examples/cc_asan_test/lib.h

@@ -0,0 +1,3 @@
+#pragma once
+
+int trigger_asan();