feat: gazelle_test test rule (#1785)

* feat: gazelle_test test rule * remove no_sandbox attr and add symlink check * use readlink
bazelbuild · May 30, 2024 · b47ccd0 · b47ccd0
1 parent f738979
commit b47ccd0
Show file tree

Hide file tree

Showing 4 changed files with 126 additions and 47 deletions.
diff --git a/README.rst b/README.rst
@@ -258,6 +258,19 @@ You can also pass additional arguments to Gazelle after a ``--`` argument.
 After running ``update-repos``, you might want to run ``bazel run //:gazelle`` again, as the
 ``update-repos`` command can affect the output of a normal run of Gazelle.
 
+To verify that all BUILD files are update-to-date, you can use the ``gazelle_test`` rule.
+
+.. code:: bzl
+
+  load("@bazel_gazelle//:def.bzl", "gazelle_test")
+
+  gazelle_test(
+      name = "gazelle_test",
+      workspace = "//:BUILD.bazel", # a file in the workspace root, where the gazelle will be run
+  )
+
+However, please note that gazelle_test cannot be cached.
+
 Running Gazelle with Go
 ~~~~~~~~~~~~~~~~~~~~~~~
 

diff --git a/def.bzl b/def.bzl
@@ -69,7 +69,59 @@ def _rlocation_path(ctx, file):
     else:
         return ctx.workspace_name + "/" + file.short_path
 
-def _gazelle_runner_impl(ctx):
+def _gazelle_runner_attr_factory(test_runner = False):
+    attrs = {
+        "gazelle": attr.label(
+            allow_single_file = True,
+            default = "//cmd/gazelle",
+            executable = True,
+            cfg = "target",
+        ),
+        "command": attr.string(
+            values = [
+                "fix",
+                "update",
+                "update-repos",
+            ],
+            default = "update",
+        ),
+        "mode": attr.string(
+            values = ["", "print", "fix", "diff"],
+            default = "",
+        ),
+        "external": attr.string(
+            values = ["", "external", "static", "vendored"],
+            default = "",
+        ),
+        "build_tags": attr.string_list(),
+        "prefix": attr.string(),
+        "extra_args": attr.string_list(),
+        "data": attr.label_list(allow_files = True),
+        "env": attr.string_dict(),
+        "_repo_config": attr.label(
+            default = "@bazel_gazelle_go_repository_config//:WORKSPACE" if GAZELLE_IS_BAZEL_MODULE else None,
+            allow_single_file = True,
+        ),
+        "_template": attr.label(
+            default = "//internal:gazelle.bash.in",
+            allow_single_file = True,
+        ),
+    }
+    if test_runner:
+        attrs.update({
+            "workspace": attr.label(
+                allow_single_file = True,
+                doc = "Label of the WORKSPACE file",
+                mandatory = True,
+            ),
+            "mode": attr.string(
+                values = ["diff"],
+                default = "diff",
+            ),
+        })
+    return attrs
+
+def _gazelle_runner_impl_factory(ctx, test_runner = False):
     args = [ctx.attr.command]
     if ctx.attr.mode:
         args.extend(["-mode", ctx.attr.mode])
@@ -102,6 +154,7 @@ def _gazelle_runner_impl(ctx):
         "@@GOTOOL@@": shell.quote(_rlocation_path(ctx, go_tool)),
         "@@ENV@@": env,
         "@@REPO_CONFIG_PATH@@": shell.quote(_rlocation_path(ctx, repo_config)) if repo_config else "",
+        "@@WORKSPACE@@": ctx.file.workspace.path if test_runner else "",
     }
     ctx.actions.expand_template(
         template = ctx.file._template,
@@ -112,7 +165,7 @@ def _gazelle_runner_impl(ctx):
     runfiles = ctx.runfiles(files = [
         ctx.executable.gazelle,
         go_tool,
-    ] + ([repo_config] if repo_config else [])).merge(
+    ] + ([repo_config] if repo_config else []) + ([ctx.file.workspace] if test_runner else [])).merge(
         ctx.attr.gazelle[DefaultInfo].default_runfiles,
     )
     for d in ctx.attr.data:
@@ -123,50 +176,27 @@ def _gazelle_runner_impl(ctx):
         executable = out_file,
     )]
 
+def _gazelle_runner_impl(ctx):
+    return _gazelle_runner_impl_factory(ctx)
+
+def _gazelle_test_runner_impl(ctx):
+    return _gazelle_runner_impl_factory(ctx, test_runner = True)
+
 _gazelle_runner = rule(
     implementation = _gazelle_runner_impl,
-    attrs = {
-        "gazelle": attr.label(
-            allow_single_file = True,
-            default = "//cmd/gazelle",
-            executable = True,
-            cfg = "target",
-        ),
-        "command": attr.string(
-            values = [
-                "fix",
-                "update",
-                "update-repos",
-            ],
-            default = "update",
-        ),
-        "mode": attr.string(
-            values = ["", "print", "fix", "diff"],
-            default = "",
-        ),
-        "external": attr.string(
-            values = ["", "external", "static", "vendored"],
-            default = "",
-        ),
-        "build_tags": attr.string_list(),
-        "prefix": attr.string(),
-        "extra_args": attr.string_list(),
-        "data": attr.label_list(allow_files = True),
-        "env": attr.string_dict(),
-        "_repo_config": attr.label(
-            default = "@bazel_gazelle_go_repository_config//:WORKSPACE" if GAZELLE_IS_BAZEL_MODULE else None,
-            allow_single_file = True,
-        ),
-        "_template": attr.label(
-            default = "//internal:gazelle.bash.in",
-            allow_single_file = True,
-        ),
-    },
+    attrs = _gazelle_runner_attr_factory(),
     executable = True,
     toolchains = ["@io_bazel_rules_go//go:toolchain"],
 )
 
-def gazelle(name, **kwargs):
+_gazelle_test_runner = rule(
+    implementation = _gazelle_test_runner_impl,
+    attrs = _gazelle_runner_attr_factory(test_runner = True),
+    executable = True,
+    toolchains = ["@io_bazel_rules_go//go:toolchain"],
+)
+
+def _gazelle_kwargs_prepare(name, kwargs):
     if "args" in kwargs:
         # The args attribute has special meaning for executable rules, but we
         # always want extra_args here instead.
@@ -176,21 +206,47 @@ def gazelle(name, **kwargs):
         kwargs.pop("args")
 
     visibility = kwargs.pop("visibility", default = None)
+    return name + "-runner", visibility
+
+def gazelle(name, **kwargs):
+    runner_name, visibility = _gazelle_kwargs_prepare(name, kwargs)
 
-    tags_set = {t: "" for t in kwargs.pop("tags", [])}
-    tags_set["manual"] = ""
-    tags = [k for k in tags_set.keys()]
-    runner_name = name + "-runner"
     _gazelle_runner(
         name = runner_name,
-        tags = tags,
         **kwargs
     )
+    tags_set = {t: "" for t in kwargs.pop("tags", [])}
+    tags_set["manual"] = ""
+    tags = tags_set.keys()
     native.sh_binary(
         name = name,
-        srcs = [runner_name],
         tags = tags,
+        srcs = [runner_name],
+        visibility = visibility,
+        deps = ["@bazel_tools//tools/bash/runfiles"],
+        data = kwargs["data"] if "data" in kwargs else [],
+    )
+
+def gazelle_test(name, **kwargs):
+    runner_name, visibility = _gazelle_kwargs_prepare(name, kwargs)
+
+    _gazelle_test_runner(
+        name = runner_name,
+        **kwargs
+    )
+
+    # Note: the "external" tag is a workaround for
+    # https://github.com/bazelbuild/bazel/issues/15516.
+    tags_set = {t: "" for t in kwargs.pop("tags", [])}
+    tags_set["no-sandbox"] = ""
+    tags_set["no-cache"] = ""
+    tags_set["external"] = ""
+    tags = tags_set.keys()
+    native.sh_test(
+        name = name,
+        srcs = [runner_name],
         visibility = visibility,
+        tags = tags,
         deps = ["@bazel_tools//tools/bash/runfiles"],
         data = kwargs["data"] if "data" in kwargs else [],
     )
diff --git a/internal/gazelle.bash.in b/internal/gazelle.bash.in
@@ -33,6 +33,7 @@ GAZELLE_PATH=@@GAZELLE_PATH@@
 ARGS=@@ARGS@@
 GOTOOL=@@GOTOOL@@
 REPO_CONFIG_PATH=@@REPO_CONFIG_PATH@@
+WORKSPACE="@@WORKSPACE@@"
 
 @@ENV@@
 
@@ -76,6 +77,10 @@ if [ -z "$gazelle_path" ]; then
   echo "error: could not locate gazelle binary" >&2
   exit 1
 fi
+if [[ -n "${TEST_WORKSPACE+x}" && -n "$WORKSPACE" ]]; then
+  BUILD_WORKSPACE_DIRECTORY="$(dirname "$(readlink ${WORKSPACE})")"
+  export BUILD_WORKSPACE_DIRECTORY
+fi
 if [ -z "${BUILD_WORKSPACE_DIRECTORY-}" ]; then
   echo "error: BUILD_WORKSPACE_DIRECTORY not set" >&2
   exit 1

diff --git a/tests/bcr/go_mod/BUILD.bazel b/tests/bcr/go_mod/BUILD.bazel
@@ -1,5 +1,10 @@
-load("@gazelle//:def.bzl", "gazelle")
+load("@gazelle//:def.bzl", "gazelle", "gazelle_test")
 
 # gazelle:go_naming_convention import
 # gazelle:go_naming_convention_external import
 gazelle(name = "gazelle")
+
+gazelle_test(
+    name = "gazelle_test",
+    workspace = "//:BUILD.bazel",
+)