test(integration): Add tests focused on integration into workspaces

Our current test setup is biased towards bzlmod. The aspect integration tests
are using WORKSPACE for a single version and all others use bzlmod. The examples
integration tests are executed only for a single Bazel version. Due to this, we
overlooked until now that our WORKSPACE setup is no longer working for all Bazel
versions. These tests should help finding again a working setup. If we achieve
again a fully working setup, we will add these new tests to our CI.

Author: martis42

test/aspect/execute_tests.py

@@ -30,7 +30,7 @@
 
 VERSION_SPECIFIC_ARGS = {
     # We test Bazel 6 once with bzlmod and once with legacy WORKSPACE setup. Newer Bazel versions are only tested
-    # with bzlmod. bzlmod does not work for us before Bazel 6.2.
+    # with bzlmod. bzlmod does not work for with rules_python before Bazel 6.2.
     "--enable_bzlmod=false": CompatibleVersions(minimum="6.0.0", before="6.2.0"),
     "--enable_bzlmod=true": CompatibleVersions(minimum="6.2.0", before="7.0.0"),
     # Experimental changes we want to be compatible for

test/support/bazel.py

@@ -1,4 +1,6 @@
+import os
 import subprocess
+from copy import deepcopy
 from pathlib import Path
 from shutil import which
 
@@ -22,6 +24,24 @@ def get_bazel_binary() -> Path:
     raise RuntimeError("No bazelisk binary or bazel symlink towards bazelisk available on your system")
 
 
+def get_bazel_rolling_version(bazel_bin: Path) -> str:
+    process = subprocess.run(
+        [bazel_bin, "--version"],
+        env=make_bazel_version_env("rolling"),
+        shell=False,
+        check=True,
+        capture_output=True,
+        text=True,
+    )
+    return process.stdout.split("bazel")[1].strip()
+
+
+def make_bazel_version_env(version: str) -> os._Environ:
+    run_env = deepcopy(os.environ)
+    run_env["USE_BAZEL_VERSION"] = version
+    return run_env
+
+
 def get_current_workspace(bazel_bin: Path) -> Path:
     cmd = [
         str(bazel_bin),

test/workspace_integration/.bazelrc

@@ -0,0 +1,2 @@
+# The symlinks have no value for us, but clutter the project view in the IDE
+build --experimental_convenience_symlinks=clean

test/workspace_integration/.bazelversion

@@ -0,0 +1 @@
+7.4.1

test/workspace_integration/BUILD

@@ -0,0 +1,4 @@
+cc_library(
+    name = "valid_target",
+    hdrs = ["valid_target.h"],
+)

test/workspace_integration/MODULE.bazel

@@ -0,0 +1,7 @@
+module(name = "dwyu_workspace_integration_tests")
+
+bazel_dep(name = "depend_on_what_you_use", dev_dependency = True)
+local_path_override(
+    module_name = "depend_on_what_you_use",
+    path = "../../",
+)

test/workspace_integration/README.md

@@ -0,0 +1,3 @@
+These tests ensure that DWYU is integrable as advertised in the documentation for all supported Bazel versions.
+
+We explicitly do not add further dependencies to ensure no other modules and their transitive dependencies overwrite the dependencies defined by DWYU.

test/workspace_integration/WORKSPACE

@@ -0,0 +1,14 @@
+workspace(name = "dwyu_examples")
+
+local_repository(
+    name = "depend_on_what_you_use",
+    path = "../../",
+)
+
+load("@depend_on_what_you_use//:setup_step_1.bzl", "setup_step_1")
+
+setup_step_1()
+
+load("@depend_on_what_you_use//:setup_step_2.bzl", "setup_step_2")
+
+setup_step_2()

test/workspace_integration/WORKSPACE.bzlmod

@@ -0,0 +1,3 @@
+load("@depend_on_what_you_use//:defs.bzl", "dwyu_aspect_factory")
+
+dwyu_aspect = dwyu_aspect_factory()

test/workspace_integration/aspect.bzl

@@ -0,0 +1,74 @@
+#!/usr/bin/env python3
+from __future__ import annotations
+
+import logging
+import subprocess
+import sys
+from os import chdir
+from pathlib import Path
+from shlex import join as shlex_join
+
+# Allow importing test support code. Relative imports do not work in our case.
+# We do this centrally here, so all code we import while executing this knows the extended PYTHONPATH
+# ruff: noqa: E402
+WORKSPACE_ROOT = Path(__file__).resolve().parent.parent.parent
+sys.path.insert(0, str(WORKSPACE_ROOT))
+
+from test.support.bazel import get_bazel_binary, get_bazel_rolling_version, make_bazel_version_env
+
+logging.basicConfig(format="%(message)s", level=logging.INFO)
+
+BAZEL_VERSIONS_UNDER_TEST = [
+    "6.0.0",
+    "6.5.0",
+    "7.0.0",
+    "7.4.1",
+    "8.0.0",
+    "rolling",
+]
+
+ASPECT_TEST_CMD = ["--aspects=//:aspect.bzl%dwyu_aspect", "--output_groups=dwyu", "//:valid_target"]
+
+
+def run_tests(is_bzlmod: bool, bazel_versions: list[str]) -> list[str]:
+    bzlmod_arg = ["--enable_bzlmod=true"] if is_bzlmod else ["--enable_bzlmod=false"]
+    workspace_arg = [] if is_bzlmod else ["--enable_workspace=true"]
+    mode = "bzlmod" if is_bzlmod else "WORKSPACE"
+    failures = []
+
+    logging.info(f"\n##\n## Testing {mode} setup\n##")
+    for bazel_version in bazel_versions:
+        logging.info(f"\n## Testing {mode} with Bazel '{bazel_version}'")
+
+        env = make_bazel_version_env(bazel_version)
+        enable_workspace = workspace_arg if bazel_version >= "8.0.0" else []
+        cmd = ["bazel", "--max_idle_secs=10", "build", *bzlmod_arg, *enable_workspace, *ASPECT_TEST_CMD]
+        logging.info(f"## Executing: {shlex_join(cmd)}\n")
+        if subprocess.run(cmd, check=False, env=env).returncode != 0:
+            failures.append(f"WORKSPACE: {bazel_version}")
+
+    return failures
+
+
+def main() -> int:
+    bazel_bin = get_bazel_binary()
+    rolling_bazel = get_bazel_rolling_version(bazel_bin)
+    bazel_versions = [v if v != "rolling" else rolling_bazel for v in BAZEL_VERSIONS_UNDER_TEST]
+
+    failures = run_tests(is_bzlmod=True, bazel_versions=bazel_versions)
+    failures.extend(run_tests(is_bzlmod=False, bazel_versions=bazel_versions))
+
+    if failures:
+        logging.info("\nSome workspace integration tests FAILED")
+        logging.info("\n".join(f"- {fail}" for fail in sorted(failures)))
+        return 1
+
+    logging.info("\nAll workspace integration tests succeeded")
+    return 0
+
+
+if __name__ == "__main__":
+    # Ensure we can invoke the script from various places
+    chdir(Path(__file__).parent)
+
+    sys.exit(main())