bazel: generate //go:generate stringer files within sandbox.

First part of #57787 work. As `gazelle` is not taking care by itself in any changes related to `//go:generate stringer` we are creating a `genrule` to handle it. From all the `//go:generate stringer` files, there are some that are having troubles during bazel build: ``` -pkg/util/encoding/encoding.go -pkg/util/encoding/BUILD.bazel "stringer: can't handle non-integer constant type Type" -pkg/workload/schemachange/schemachange.go -pkg/workload/schemachange/BUILD.bazel "stringer: can't happen: constant is not an integer TxStatusInFailure" ``` I already added some TODO task over there to keep them in track Release note: None
cockroachdb · Jan 25, 2021 · ef93819 · ef93819
1 parent 8efa63d
commit ef93819
Show file tree

Hide file tree

Showing 23 changed files with 341 additions and 0 deletions.
diff --git a/pkg/STRINGER.bzl b/pkg/STRINGER.bzl
@@ -0,0 +1,18 @@
+# Common function to create //go:generate stringer files within bazel sandbox
+
+def stringer(file, typ, name):
+   native.genrule(
+      name = name, 
+      srcs = [
+          file,
+      ],
+      outs = [typ.lower() + "_string.go"],
+      cmd = """
+         env PATH=`dirname $(location @go_sdk//:bin/go)` HOME=$(GENDIR) \
+         $(location @org_golang_x_tools//cmd/stringer:stringer) -output=$@ -type={} $<
+      """.format(typ),
+      tools = [
+         "@go_sdk//:bin/go",
+         "@org_golang_x_tools//cmd/stringer",
+       ],
+   )
diff --git a/pkg/base/BUILD.bazel b/pkg/base/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "base",
@@ -14,6 +15,7 @@ go_library(
         "testclusterreplicationmode_string.go",
         "testing_knobs.go",
         "zone.go",
+        ":gen-clusterreplication-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/base",
     visibility = ["//visibility:public"],
@@ -64,3 +66,9 @@ go_test(
         "@com_github_stretchr_testify//require",
     ],
 )
+
+stringer(
+    name = "gen-clusterreplication-stringer",
+    file = "test_server_args.go",
+    typ = "TestClusterReplicationMode",
+)
diff --git a/pkg/ccl/sqlproxyccl/BUILD.bazel b/pkg/ccl/sqlproxyccl/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "sqlproxyccl",
@@ -12,6 +13,7 @@ go_library(
         "metrics.go",
         "proxy.go",
         "server.go",
+        ":gen-errorcode-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/ccl/sqlproxyccl",
     visibility = ["//visibility:public"],
@@ -58,3 +60,9 @@ go_test(
         "@com_github_stretchr_testify//require",
     ],
 )
+
+stringer(
+    name = "gen-errorcode-stringer",
+    file = "error.go",
+    typ = "ErrorCode",
+)
diff --git a/pkg/cli/BUILD.bazel b/pkg/cli/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "cli",
@@ -51,6 +52,7 @@ go_library(
         "tsdump.go",
         "userfile.go",
         "zip.go",
+        ":gen-keytype-stringer",  # keep
     ],
     # keep
     cdeps = [
@@ -336,3 +338,9 @@ go_test(
         "@com_github_stretchr_testify//require",
     ],
 )
+
+stringer(
+    name = "gen-keytype-stringer",
+    file = "flags_util.go",
+    typ = "keyType",
+)
diff --git a/pkg/clusterversion/BUILD.bazel b/pkg/clusterversion/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@rules_proto//proto:defs.bzl", "proto_library")
 load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "clusterversion",
@@ -11,6 +12,7 @@ go_library(
         "keyed_versions.go",
         "setting.go",
         "testutils.go",
+        ":gen-key-stringer",  # keep
     ],
     embed = [":clusterversion_go_proto"],
     importpath = "github.com/cockroachdb/cockroach/pkg/clusterversion",
@@ -61,3 +63,9 @@ go_proto_library(
         "@com_github_gogo_protobuf//gogoproto",
     ],
 )
+
+stringer(
+    name = "gen-key-stringer",
+    file = "cockroach_versions.go",
+    typ = "Key",
+)
diff --git a/pkg/kv/kvclient/kvcoord/BUILD.bazel b/pkg/kv/kvclient/kvcoord/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "kvcoord",
@@ -28,6 +29,7 @@ go_library(
         "txn_lock_gatekeeper.go",
         "txn_metrics.go",
         "txnstate_string.go",
+        ":gen-txnstate-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/kv/kvclient/kvcoord",
     visibility = ["//visibility:public"],
@@ -149,3 +151,9 @@ go_test(
         "@org_golang_x_sync//errgroup",
     ],
 )
+
+stringer(
+    name = "gen-txnstate-stringer",
+    file = "txn_coord_sender.go",
+    typ = "txnState",
+)
diff --git a/pkg/kv/kvserver/BUILD.bazel b/pkg/kv/kvserver/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@rules_proto//proto:defs.bzl", "proto_library")
 load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "kvserver",
@@ -91,6 +92,7 @@ go_library(
         "testing_knobs.go",
         "track_raft_protos.go",
         "ts_maintenance_queue.go",
+        ":gen-refreshraftreason-stringer",  # keep
     ],
     embed = [":kvserver_go_proto"],
     importpath = "github.com/cockroachdb/cockroach/pkg/kv/kvserver",
@@ -427,3 +429,9 @@ go_proto_library(
         "@io_etcd_go_etcd_raft_v3//raftpb",
     ],
 )
+
+stringer(
+    name = "gen-refreshraftreason-stringer",
+    file = "replica_raft.go",
+    typ = "refreshRaftReason",
+)
diff --git a/pkg/roachpb/BUILD.bazel b/pkg/roachpb/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@rules_proto//proto:defs.bzl", "proto_library")
 load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "roachpb",
@@ -21,6 +22,8 @@ go_library(
         "span_group.go",
         "tenant.go",
         "version.go",
+        ":gen-errordetailtype-stringer",  # keep
+        ":gen-method-stringer",  # keep
     ],
     embed = [":roachpb_go_proto"],
     importpath = "github.com/cockroachdb/cockroach/pkg/roachpb",
@@ -146,3 +149,17 @@ go_proto_library(
         "@com_github_gogo_protobuf//gogoproto",
     ],
 )
+
+# Using common function for stringer to create method_string.go
+stringer(
+    name = "gen-method-stringer",
+    file = "method.go",
+    typ = "Method",
+)
+
+# Using common function for stringer to create errordetailtype_string.go
+stringer(
+    name = "gen-errordetailtype-stringer",
+    file = "errors.go",
+    typ = "ErrorDetailType",
+)
diff --git a/pkg/sql/BUILD.bazel b/pkg/sql/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "sql",
@@ -218,6 +219,10 @@ go_library(
         "zero.go",
         "zigzag_join.go",
         "zone_config.go",
+        ":gen-advancecode-stringer",  # keep
+        ":gen-nodestatus-stringer",  # keep
+        ":gen-txnevent-stringer",  # keep
+        ":gen-txntype-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql",
     visibility = ["//visibility:public"],
@@ -588,3 +593,27 @@ go_test(
         "@org_golang_x_sync//errgroup",
     ],
 )
+
+stringer(
+    name = "gen-txnevent-stringer",
+    file = "txn_state.go",
+    typ = "txnEvent",
+)
+
+stringer(
+    name = "gen-txntype-stringer",
+    file = "txn_state.go",
+    typ = "txnType",
+)
+
+stringer(
+    name = "gen-advancecode-stringer",
+    file = "txn_state.go",
+    typ = "advanceCode",
+)
+
+stringer(
+    name = "gen-nodestatus-stringer",
+    file = "distsql_physical_planner.go",
+    typ = "NodeStatus",
+)
diff --git a/pkg/sql/catalog/catalogkv/BUILD.bazel b/pkg/sql/catalog/catalogkv/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "catalogkv",
@@ -7,6 +8,7 @@ go_library(
         "descriptorkind_string.go",
         "namespace.go",
         "test_utils.go",
+        ":gen-descriptorkind-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/catalog/catalogkv",
     visibility = ["//visibility:public"],
@@ -49,3 +51,9 @@ go_test(
         "@com_github_stretchr_testify//require",
     ],
 )
+
+stringer(
+    name = "gen-descriptorkind-stringer",
+    file = "catalogkv.go",
+    typ = "DescriptorKind",
+)
diff --git a/pkg/sql/catalog/descpb/BUILD.bazel b/pkg/sql/catalog/descpb/BUILD.bazel
@@ -1,6 +1,7 @@
 load("@rules_proto//proto:defs.bzl", "proto_library")
 load("@io_bazel_rules_go//proto:def.bzl", "go_proto_library")
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "descpb",
@@ -16,6 +17,8 @@ go_library(
         "privilegedescversion_string.go",
         "region_name.go",
         "structured.go",
+        ":gen-formatversion-stringer",  # keep
+        ":gen-privilegedescversion-stringer",  # keep
     ],
     embed = [":descpb_go_proto"],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb",
@@ -83,3 +86,15 @@ go_proto_library(
         "@com_github_gogo_protobuf//gogoproto",
     ],
 )
+
+stringer(
+    name = "gen-privilegedescversion-stringer",
+    file = "privilege.go",
+    typ = "PrivilegeDescVersion",
+)
+
+stringer(
+    name = "gen-formatversion-stringer",
+    file = "structured.go",
+    typ = "FormatVersion",
+)
diff --git a/pkg/sql/colfetcher/BUILD.bazel b/pkg/sql/colfetcher/BUILD.bazel
@@ -1,11 +1,13 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "colfetcher",
     srcs = [
         "cfetcher.go",
         "colbatch_scan.go",
         "fetcherstate_string.go",
+        ":gen-fetcherstate-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/colfetcher",
     visibility = ["//visibility:public"],
@@ -38,3 +40,9 @@ go_library(
         "@com_github_cockroachdb_errors//:errors",
     ],
 )
+
+stringer(
+    name = "gen-fetcherstate-stringer",
+    file = "cfetcher.go",
+    typ = "fetcherState",
+)
diff --git a/pkg/sql/execinfra/BUILD.bazel b/pkg/sql/execinfra/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "execinfra",
@@ -18,6 +19,8 @@ go_library(
         "server_config.go",
         "testutils.go",
         "version.go",
+        ":gen-consumerstatus-stringer",  # keep
+        ":gen-procstate-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/execinfra",
     visibility = ["//visibility:public"],
@@ -88,3 +91,15 @@ go_test(
         "//pkg/util/randutil",
     ],
 )
+
+stringer(
+    name = "gen-procstate-stringer",
+    file = "processorsbase.go",
+    typ = "procState",
+)
+
+stringer(
+    name = "gen-consumerstatus-stringer",
+    file = "base.go",
+    typ = "ConsumerStatus",
+)
diff --git a/pkg/sql/opt/optgen/lang/BUILD.bazel b/pkg/sql/opt/optgen/lang/BUILD.bazel
@@ -1,4 +1,5 @@
 load("@io_bazel_rules_go//go:def.bzl", "go_library", "go_test")
+load("//pkg:STRINGER.bzl", "stringer")
 
 go_library(
     name = "lang",
@@ -13,6 +14,8 @@ go_library(
         "token_string.go",
         ":gen-expr",  # keep
         ":gen-operator",  # keep
+        ":gen-operator-stringer",  # keep
+        ":gen-token-stringer",  # keep
     ],
     importpath = "github.com/cockroachdb/cockroach/pkg/sql/opt/optgen/lang",
     visibility = ["//visibility:public"],
@@ -78,3 +81,15 @@ genrule(
     """,
     tools = ["//pkg/sql/opt/optgen/cmd/langgen"],
 )
+
+stringer(
+    name = "gen-token-stringer",
+    file = "scanner.go",
+    typ = "Token",
+)
+
+stringer(
+    name = "gen-operator-stringer",
+    file = "operator.og.go",
+    typ = "Operator",
+)