Merge pull request stackb#323 from stackb/bazel-gazelle-031

Upgrade bazelbuild/bazel-gazelle to 0.31.0

Author: pcj

.bazelci/presubmit.yml

@@ -6,6 +6,8 @@ bazel: 5.1.1
 tasks:
   default_workspace_ubuntu1804:
     platform: ubuntu1804
+    build_targets:
+      - "@protoapis//..."
     test_targets:
       - //example/...
       - //language/...
@@ -19,6 +21,8 @@ tasks:
       - --deleted_packages=//plugin/grpc-ecosystem/grpc-gateway
   default_workspace_macos:
     platform: macos
+    build_targets:
+      - "@protoapis//..."
     test_targets:
       - //example/...
       - //language/...

.bazelrc

@@ -1,3 +1,16 @@
+common --enable_platform_specific_config
+
+build:windows --cxxopt='/std:c++14'
+build:windows --host_cxxopt='/std:c++14'
+build:linux   --cxxopt='-std=c++14'
+build:linux   --host_cxxopt='-std=c++14'
+build:macos   --cxxopt='-std=c++14'
+build:macos   --host_cxxopt='-std=c++14'
+build:freebsd   --cxxopt='-std=c++14'
+build:freebsd   --host_cxxopt='-std=c++14'
+
 build:bazelci --deleted_packages=docs
+
 # workaround for scala
 build --incompatible_java_common_parameters=false
+

BUILD.bazel

@@ -49,6 +49,7 @@ gazelle(
 
 filegroup(
     name = "all_files",
+    testonly = True,
     srcs = [
         "BUILD.bazel",
         "WORKSPACE",

Makefile

@@ -28,6 +28,6 @@ test:
 
 .PHONY: get
 get:
-	$(BAZEL) run @go_sdk//:bin/go -- get github.com/bazelbuild/bazel-gazelle@v0.27.0
+	$(BAZEL) run @go_sdk//:bin/go -- get github.com/bazelbuild/bazel-gazelle@v0.31.0
 	$(BAZEL) run @go_sdk//:bin/go -- mod download github.com/bazelbuild/buildtools
 	$(BAZEL) run @go_sdk//:bin/go -- mod vendor

WORKSPACE

@@ -1,12 +1,16 @@
 workspace(name = "build_stack_rules_proto")
 
+load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+
 # gazelle:repo bazel_gazelle
 
 # ----------------------------------------------------
 # Toolchain-Related
 # ----------------------------------------------------
 
 register_toolchains("//toolchain:standard")
+# alternatively:
+# register_toolchains("//toolchain:prebuilt")
 
 # ----------------------------------------------------
 # Top-Level Dependency Trees
@@ -95,6 +99,18 @@ go_deps()
 # Core gRPC
 # ----------------------------------------------------
 
+http_archive(
+    name = "com_google_absl",
+    generator_function = "grpc_deps",
+    generator_name = "com_google_absl",
+    sha256 = "9a2b5752d7bfade0bdeee2701de17c9480620f8b237e1964c1b9967c75374906",
+    strip_prefix = "abseil-cpp-20230125.2",
+    urls = [
+        "https://storage.googleapis.com/grpc-bazel-mirror/github.com/abseil/abseil-cpp/archive/20230125.2.tar.gz",
+        "https://github.com/abseil/abseil-cpp/archive/20230125.2.tar.gz",
+    ],
+)
+
 load(
     "@com_github_grpc_grpc//bazel:grpc_deps.bzl",
     "grpc_deps",
@@ -120,6 +136,7 @@ load(
 maven_install(
     artifacts = IO_GRPC_GRPC_JAVA_ARTIFACTS,
     generate_compat_repositories = True,
+    maven_install_json = "//:maven_install.json",
     override_targets = IO_GRPC_GRPC_JAVA_OVERRIDE_TARGETS,
     repositories = [
         "https://repo.maven.apache.org/maven2/",
@@ -225,3 +242,11 @@ load("@build_bazel_rules_nodejs//:index.bzl", "node_repositories")
 node_repositories()
 
 register_toolchains("//toolchain:nodejs")
+
+# ----------------------------------------------------
+# proto_repositories
+# ----------------------------------------------------
+
+load("//:proto_repositories.bzl", "proto_repositories")
+
+proto_repositories()

cmd/gazelle/BUILD.bazel

@@ -17,6 +17,8 @@ go_library(
     tags = ["manual"],
     visibility = ["//visibility:public"],
     deps = [
+        "//cmd/gazelle/internal/module",
+        "//cmd/gazelle/internal/wspace",
         "//language/protobuf",
         "@bazel_gazelle//config:go_default_library",
         "@bazel_gazelle//flag:go_default_library",
@@ -58,6 +60,11 @@ go_test(
 
 filegroup(
     name = "all_files",
-    srcs = ["BUILD.bazel"] + glob(["*.go"]),
+    testonly = True,
+    srcs = glob(["*.go"]) + [
+        "BUILD.bazel",
+        "//cmd/gazelle/internal/module:all_files",
+        "//cmd/gazelle/internal/wspace:all_files",
+    ],
     visibility = ["//:__pkg__"],
 )

cmd/gazelle/README.md

@@ -0,0 +1,38 @@
+# cmd/gazelle
+
+This is essentially a copy of the files in bazelbuild/bazel-gazelle/cmd/gazelle.
+
+To upgrade gazelle, one must:
+
+- `go get` the correct version and update `go.mod` file
+- `make tidy` to propagate changes to `go.sum` and `go_repositories.bzl`.
+- update the version of @bazel_gazelle in `deps/BUILD.bazel`, then run `make
+   deps` to regenerate the actual deps tree.
+- Compare changes in the source repo to the files here.  It's easiest to just
+   copy over each file and see where the diffs are.  Make sure `langs.go`
+   includes the `github.com/stackb/rules_proto/language/protobuf`.  Internal
+   packages referenced must also be copied over (ugh).  There's probably a more elegant solution to keeping a modified copy of gazelle binary here.
+- Since the `proto_gazelle.bzl` rule uses
+  `@bazel_gazelle//internal:gazelle.bash.in`, changes there must remain
+  compatible with proto_gazelle.  Look at the diff there and make sure the proto_gazelle_impl is satifying the needs of that template.
+- Remember that this `cmd/gazelle` must be buildable via the standard go
+  toolchain (see proto_repository_tools.bzl):
+
+```py
+    args = [
+        go_tool,
+        "install",
+        "-ldflags",
+        "-w -s",
+        "-gcflags",
+        "all=-trimpath=" + env["GOPATH"],
+        "-asmflags",
+        "all=-trimpath=" + env["GOPATH"],
+        "github.com/stackb/rules_proto/cmd/gazelle",
+    ]
+    result = env_execute(ctx, args, environment = env)
+    if result.return_code:
+        fail("failed to build tools: " + result.stderr)
+```
+
+So any and all deps must be in the vendor tree.

cmd/gazelle/diff.go

@@ -27,7 +27,7 @@ import (
 	"github.com/pmezard/go-difflib/difflib"
 )
 
-var exitError = fmt.Errorf("encountered changes while running diff")
+var errExit = fmt.Errorf("encountered changes while running diff")
 
 func diffFile(c *config.Config, f *rule.File) error {
 	rel, err := filepath.Rel(c.RepoRoot, f.Path)
@@ -36,7 +36,11 @@ func diffFile(c *config.Config, f *rule.File) error {
 	}
 	rel = filepath.ToSlash(rel)
 
-	date := "1970-01-01 00:00:00.000000000 +0000"
+	// The epoch timestamp is assumed to represent file creation/deletion events
+	// by some tools, so use a dummy timestamp that is one ns past the epoch.
+	// See https://github.com/bazelbuild/bazel-gazelle/issues/1528.
+	date := "1970-01-01 00:00:00.000000001 +0000"
+
 	diff := difflib.UnifiedDiff{
 		Context:  3,
 		FromDate: date,
@@ -60,7 +64,7 @@ func diffFile(c *config.Config, f *rule.File) error {
 	}
 
 	if len(f.Content) != 0 {
-    		diff.A = difflib.SplitLines(string(f.Content))
+		diff.A = difflib.SplitLines(string(f.Content))
 	}
 
 	diff.B = difflib.SplitLines(string(newContent))
@@ -80,7 +84,7 @@ func diffFile(c *config.Config, f *rule.File) error {
 		return fmt.Errorf("error diffing %s: %v", f.Path, err)
 	}
 	if ds, _ := difflib.GetUnifiedDiffString(diff); ds != "" {
-		return exitError
+		return errExit
 	}
 
 	return nil