Skip to content

Commit 19a9535

Browse files
roychyingchenghan.ying
roychying
and
chenghan.ying
authored
(feat)build: Migrate Bazel target naming to go_default_library (#295)
Adopt go_default_library naming convention for Bazel targets ## Why? The internal go-code monorepo consumes this repo via Bazel with `build_file_generation = "off"` - it uses the checked-in `BUILD.bazel` files **directly** instead of regenerating them. go-code's gazelle enforces the`go_default_library` naming convention for all external repos globally (`# gazelle:go_naming_convention_external go_default_library`), so every dependency label it writes points at `:go_default_library`. For go-code to reference this repo's targets without per-import fixups, our targets must be reachable as `:go_default_library`. This complements the proto-disable change (#293): together they let go-code build this repo out of the box on Bazel 8.5.1 (which removed `native.java_proto_library`, breaking `proto_library`). ## What? - Add `# gazelle:go_naming_convention go_default_library` to the root `BUILD.bazel` and regenerate target names via gazelle: libraries/binaries ->`go_default_library`, tests -> `go_default_test`; external refs normalize to `:go_default_library`. - Manually migrate hand-authored, custom-named test targets that gazelle cannot rename across a convention change: - 9 integration/e2e `go_test` targets - `go_default_test` (`data`/`tags` preserved once the name matches the convention), - remove the redundant `platform/consumer:consumer_test` (gazelle now emits `go_default_test` for that package), - point the `Makefile` integration-test targets at `:go_default_test`. - Drop redundant `# keep`-pinned short-name `protopb` deps - under the new convention the `:go_default_library` equivalents are emitted beside them, so the short-name `:protopb` labels are dangling. ## Test Plan - `make gazelle` - clean and idempotent (no duplicate-rule errors). - `make build` - 223 targets built. - `make test` - 65/65 unit tests pass. - Verified downstream consumption from go-code with `build_file_generation="off"` by overriding the module at this branch: bazel test //src/.../submitqueue/{gateway,orchestrator,stovepipe}/... --override_repository=com_github_uber_submitqueue=/path/to/submitqueue - 71 targets build, 20/20 consumer tests pass. ## Issue <!-- Link the issue here. - Use 'Closes #123' if this is the final fix. - Use 'Part of #123' or just '#123' if the feature is still in progress. --> Co-authored-by: chenghan.ying <chenghan.ying@uber.com>
1 parent 3a6057c commit 19a9535

135 files changed

Lines changed: 1444 additions & 1439 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎BUILD.bazel‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,11 @@ load("@gazelle//:def.bzl", "gazelle")
22

33
# gazelle:prefix github.com/uber/submitqueue
44

5+
# Name every Go Bazel target go_default_library / go_default_test so labels
6+
# match go-code's (and other Bazel consumers') expected naming convention
7+
# without per-import fixups.
8+
# gazelle:go_naming_convention go_default_library
9+
510
# Exclude nested worktrees (created under .claude/worktrees) so gazelle does not
611
# index them as duplicate rule definitions and corrupt the canonical BUILD files.
712
# gazelle:exclude .claude

‎Makefile‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -144,19 +144,19 @@ integration-test: build-all-linux ## Run all integration tests (auto-builds bina
144144

145145
integration-test-submitqueue-consumer: ## Run Consumer integration tests
146146
@echo "Running Consumer integration tests..."
147-
@$(BAZEL) test //test/integration/submitqueue/core/consumer:consumer_test --test_output=streamed
147+
@$(BAZEL) test //test/integration/submitqueue/core/consumer:go_default_test --test_output=streamed
148148

149149
integration-test-extensions: ## Run extension integration tests (runs in parallel)
150150
@echo "Running extension integration tests (parallel)..."
151151
@$(BAZEL) test //test/integration/submitqueue/extension/... //test/integration/extension/... --test_output=errors
152152

153153
integration-test-submitqueue-gateway: build-submitqueue-gateway-linux ## Run Gateway integration tests (auto-builds binary)
154154
@echo "Running Gateway integration tests..."
155-
@$(BAZEL) test //test/integration/submitqueue/gateway:gateway_test --test_output=streamed
155+
@$(BAZEL) test //test/integration/submitqueue/gateway:go_default_test --test_output=streamed
156156

157157
integration-test-submitqueue-orchestrator: build-submitqueue-orchestrator-linux ## Run Orchestrator integration tests (auto-builds binary)
158158
@echo "Running Orchestrator integration tests..."
159-
@$(BAZEL) test //test/integration/submitqueue/orchestrator:orchestrator_test --test_output=streamed
159+
@$(BAZEL) test //test/integration/submitqueue/orchestrator:go_default_test --test_output=streamed
160160

161161
license-fix: ## Add missing license headers to source files
162162
@$(BAZEL) run //tool/linter/licenseheader -- --fix

‎api/base/change/protopb/BUILD.bazel‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = ["change.pb.go"],
66
importpath = "github.com/uber/submitqueue/api/base/change/protopb",
77
visibility = ["//visibility:public"],
88
deps = [
9-
"@org_golang_google_protobuf//reflect/protoreflect",
10-
"@org_golang_google_protobuf//runtime/protoimpl",
9+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
10+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
1111
],
1212
)

‎api/base/mergestrategy/protopb/BUILD.bazel‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = ["mergestrategy.pb.go"],
66
importpath = "github.com/uber/submitqueue/api/base/mergestrategy/protopb",
77
visibility = ["//visibility:public"],
88
deps = [
9-
"@org_golang_google_protobuf//reflect/protoreflect",
10-
"@org_golang_google_protobuf//runtime/protoimpl",
9+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
10+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
1111
],
1212
)

‎api/base/messagequeue/protopb/BUILD.bazel‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = ["messagequeue.pb.go"],
66
importpath = "github.com/uber/submitqueue/api/base/messagequeue/protopb",
77
visibility = ["//visibility:public"],
88
deps = [
9-
"@org_golang_google_protobuf//reflect/protoreflect",
10-
"@org_golang_google_protobuf//runtime/protoimpl",
11-
"@org_golang_google_protobuf//types/descriptorpb",
9+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
10+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
11+
"@org_golang_google_protobuf//types/descriptorpb:go_default_library",
1212
],
1313
)

‎api/runway/messagequeue/BUILD.bazel‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,32 @@
11
load("@rules_go//go:def.bzl", "go_library", "go_test")
22

33
go_library(
4-
name = "messagequeue",
4+
name = "go_default_library",
55
srcs = [
66
"merge.go",
77
"topics.go",
88
],
99
importpath = "github.com/uber/submitqueue/api/runway/messagequeue",
1010
visibility = ["//visibility:public"],
1111
deps = [
12-
"//api/base/messagequeue/protopb", # keep
13-
"//api/runway/messagequeue/protopb", # keep
14-
"//platform/consumer",
15-
"@org_golang_google_protobuf//encoding/protojson",
16-
"@org_golang_google_protobuf//proto",
12+
"//api/base/messagequeue/protopb:go_default_library",
13+
"//api/runway/messagequeue/protopb:go_default_library",
14+
"//platform/consumer:go_default_library",
15+
"@org_golang_google_protobuf//encoding/protojson:go_default_library",
16+
"@org_golang_google_protobuf//proto:go_default_library",
1717
],
1818
)
1919

2020
go_test(
21-
name = "messagequeue_test",
21+
name = "go_default_test",
2222
srcs = ["merge_test.go"],
23-
embed = [":messagequeue"],
23+
embed = [":go_default_library"],
2424
deps = [
25-
"//api/base/change/protopb",
26-
"//api/base/mergestrategy/protopb",
27-
"//api/runway/messagequeue/protopb",
28-
"@com_github_stretchr_testify//assert",
29-
"@com_github_stretchr_testify//require",
30-
"@org_golang_google_protobuf//proto",
25+
"//api/base/change/protopb:go_default_library",
26+
"//api/base/mergestrategy/protopb:go_default_library",
27+
"//api/runway/messagequeue/protopb:go_default_library",
28+
"@com_github_stretchr_testify//assert:go_default_library",
29+
"@com_github_stretchr_testify//require:go_default_library",
30+
"@org_golang_google_protobuf//proto:go_default_library",
3131
],
3232
)

‎api/runway/messagequeue/protopb/BUILD.bazel‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = ["merge.pb.go"],
66
importpath = "github.com/uber/submitqueue/api/runway/messagequeue/protopb",
77
visibility = ["//visibility:public"],
88
deps = [
9-
"//api/base/change/protopb",
10-
"//api/base/mergestrategy/protopb",
11-
"//api/base/messagequeue/protopb", # keep
12-
"@org_golang_google_protobuf//reflect/protoreflect",
13-
"@org_golang_google_protobuf//runtime/protoimpl",
9+
"//api/base/change/protopb:go_default_library",
10+
"//api/base/mergestrategy/protopb:go_default_library",
11+
"//api/base/messagequeue/protopb:go_default_library",
12+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
13+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
1414
],
1515
)

‎api/runway/protopb/BUILD.bazel‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = [
66
"runway.pb.go",
77
"runway.pb.yarpc.go",
@@ -10,17 +10,17 @@ go_library(
1010
importpath = "github.com/uber/submitqueue/api/runway/protopb",
1111
visibility = ["//visibility:public"],
1212
deps = [
13-
"@org_golang_google_grpc//:grpc",
14-
"@org_golang_google_grpc//codes",
15-
"@org_golang_google_grpc//status",
16-
"@org_golang_google_protobuf//proto",
17-
"@org_golang_google_protobuf//reflect/protoreflect",
18-
"@org_golang_google_protobuf//runtime/protoimpl",
19-
"@org_uber_go_fx//:fx",
20-
"@org_uber_go_yarpc//:yarpc",
21-
"@org_uber_go_yarpc//api/transport",
22-
"@org_uber_go_yarpc//api/x/restriction",
23-
"@org_uber_go_yarpc//encoding/protobuf/reflection",
24-
"@org_uber_go_yarpc//encoding/protobuf/v2:protobuf",
13+
"@org_golang_google_grpc//:go_default_library",
14+
"@org_golang_google_grpc//codes:go_default_library",
15+
"@org_golang_google_grpc//status:go_default_library",
16+
"@org_golang_google_protobuf//proto:go_default_library",
17+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
18+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
19+
"@org_uber_go_fx//:go_default_library",
20+
"@org_uber_go_yarpc//:go_default_library",
21+
"@org_uber_go_yarpc//api/transport:go_default_library",
22+
"@org_uber_go_yarpc//api/x/restriction:go_default_library",
23+
"@org_uber_go_yarpc//encoding/protobuf/reflection:go_default_library",
24+
"@org_uber_go_yarpc//encoding/protobuf/v2:go_default_library",
2525
],
2626
)

‎api/stovepipe/protopb/BUILD.bazel‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = [
66
"stovepipe.pb.go",
77
"stovepipe.pb.yarpc.go",
@@ -10,17 +10,17 @@ go_library(
1010
importpath = "github.com/uber/submitqueue/api/stovepipe/protopb",
1111
visibility = ["//visibility:public"],
1212
deps = [
13-
"@org_golang_google_grpc//:grpc",
14-
"@org_golang_google_grpc//codes",
15-
"@org_golang_google_grpc//status",
16-
"@org_golang_google_protobuf//proto",
17-
"@org_golang_google_protobuf//reflect/protoreflect",
18-
"@org_golang_google_protobuf//runtime/protoimpl",
19-
"@org_uber_go_fx//:fx",
20-
"@org_uber_go_yarpc//:yarpc",
21-
"@org_uber_go_yarpc//api/transport",
22-
"@org_uber_go_yarpc//api/x/restriction",
23-
"@org_uber_go_yarpc//encoding/protobuf/reflection",
24-
"@org_uber_go_yarpc//encoding/protobuf/v2:protobuf",
13+
"@org_golang_google_grpc//:go_default_library",
14+
"@org_golang_google_grpc//codes:go_default_library",
15+
"@org_golang_google_grpc//status:go_default_library",
16+
"@org_golang_google_protobuf//proto:go_default_library",
17+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
18+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
19+
"@org_uber_go_fx//:go_default_library",
20+
"@org_uber_go_yarpc//:go_default_library",
21+
"@org_uber_go_yarpc//api/transport:go_default_library",
22+
"@org_uber_go_yarpc//api/x/restriction:go_default_library",
23+
"@org_uber_go_yarpc//encoding/protobuf/reflection:go_default_library",
24+
"@org_uber_go_yarpc//encoding/protobuf/v2:go_default_library",
2525
],
2626
)

‎api/submitqueue/gateway/protopb/BUILD.bazel‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
load("@rules_go//go:def.bzl", "go_library")
22

33
go_library(
4-
name = "protopb",
4+
name = "go_default_library",
55
srcs = [
66
"gateway.pb.go",
77
"gateway.pb.yarpc.go",
@@ -10,19 +10,19 @@ go_library(
1010
importpath = "github.com/uber/submitqueue/api/submitqueue/gateway/protopb",
1111
visibility = ["//visibility:public"],
1212
deps = [
13-
"//api/base/change/protopb",
14-
"//api/base/mergestrategy/protopb",
15-
"@org_golang_google_grpc//:grpc",
16-
"@org_golang_google_grpc//codes",
17-
"@org_golang_google_grpc//status",
18-
"@org_golang_google_protobuf//proto",
19-
"@org_golang_google_protobuf//reflect/protoreflect",
20-
"@org_golang_google_protobuf//runtime/protoimpl",
21-
"@org_uber_go_fx//:fx",
22-
"@org_uber_go_yarpc//:yarpc",
23-
"@org_uber_go_yarpc//api/transport",
24-
"@org_uber_go_yarpc//api/x/restriction",
25-
"@org_uber_go_yarpc//encoding/protobuf/reflection",
26-
"@org_uber_go_yarpc//encoding/protobuf/v2:protobuf",
13+
"//api/base/change/protopb:go_default_library",
14+
"//api/base/mergestrategy/protopb:go_default_library",
15+
"@org_golang_google_grpc//:go_default_library",
16+
"@org_golang_google_grpc//codes:go_default_library",
17+
"@org_golang_google_grpc//status:go_default_library",
18+
"@org_golang_google_protobuf//proto:go_default_library",
19+
"@org_golang_google_protobuf//reflect/protoreflect:go_default_library",
20+
"@org_golang_google_protobuf//runtime/protoimpl:go_default_library",
21+
"@org_uber_go_fx//:go_default_library",
22+
"@org_uber_go_yarpc//:go_default_library",
23+
"@org_uber_go_yarpc//api/transport:go_default_library",
24+
"@org_uber_go_yarpc//api/x/restriction:go_default_library",
25+
"@org_uber_go_yarpc//encoding/protobuf/reflection:go_default_library",
26+
"@org_uber_go_yarpc//encoding/protobuf/v2:go_default_library",
2727
],
2828
)

0 commit comments

Comments
 (0)