Minimal changes to enable a Go workspace

Makefile

@@ -75,10 +75,10 @@ fuzz:
 verify: verify-gofmt verify-bom verify-lint verify-dep verify-shellcheck verify-goword \
 	verify-govet verify-license-header verify-mod-tidy \
 	verify-shellws verify-proto-annotations verify-genproto verify-yamllint \
-	verify-govet-shadow verify-markdown-marker verify-go-versions
+	verify-govet-shadow verify-markdown-marker verify-go-versions verify-go-workspace
 
 .PHONY: fix
-fix: fix-bom fix-lint fix-yamllint sync-toolchain-directive
+fix: fix-bom fix-lint fix-yamllint sync-toolchain-directive update-go-workspace
 	./scripts/fix.sh
 
 .PHONY: verify-gofmt
@@ -215,6 +215,14 @@ clean:
 verify-go-versions:
 	./scripts/verify_go_versions.sh
 
+.PHONY: verify-go-workspace
+verify-go-workspace:
+	PASSES="go_workspace" ./scripts/test.sh
+
 .PHONY: sync-toolchain-directive
 sync-toolchain-directive:
 	./scripts/sync_go_toolchain_directive.sh
+
+.PHONY: update-go-workspace
+update-go-workspace:
+	./scripts/update_go_workspace.sh

api/go.mod

@@ -31,9 +31,9 @@ require (
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/api/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/pkg/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/tests/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/api/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/pkg/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/tests/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
 )

client/internal/v2/go.mod

@@ -27,8 +27,8 @@ replace (
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/pkg/v3 => ./FORBIDDED_DEPENDENCY
-	go.etcd.io/etcd/tests/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/pkg/v3 v3.999.999 => ../../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/tests/v3 v3.999.999 => ../../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../../../FORBIDDEN_DEPENDENCY
 )

client/v3/go.mod

@@ -52,8 +52,8 @@ replace (
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/pkg/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/tests/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/pkg/v3 v3.999.999 => ../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../../FORBIDDEN_DEPENDENCY
+	go.etcd.io/tests/v3 v3.999.999 => ../../FORBIDDEN_DEPENDENCY
 )

etcdctl/go.mod

@@ -57,7 +57,7 @@ replace (
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/tests/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/tests/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
 )

etcdutl/go.mod

@@ -16,9 +16,9 @@ replace (
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/tests/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/tests/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
 )
 
 require (

go.work

@@ -0,0 +1,21 @@
+// This is a generated file. Do not edit directly.
+
+go 1.23
+
+toolchain go1.23.6
+
+use (
+	.
+	./api
+	./client/internal/v2
+	./client/pkg
+	./client/v3
+	./etcdctl
+	./etcdutl
+	./pkg
+	./server
+	./tests
+	./tools/mod
+	./tools/rw-heatmaps
+	./tools/testgrid-analysis
+)

pkg/go.mod

@@ -38,8 +38,8 @@ replace go.etcd.io/etcd/client/pkg/v3 => ../client/pkg
 // Etcd contains lots of packages and dependency relationship.
 // Shouldn't import unnecessary dependencies
 replace (
-	go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/api/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/tests/v3 => ./FORBIDDEN_DEPENDENCY
-	go.etcd.io/etcd/v3 => ./FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/api/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/tests/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/etcd/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
 )

scripts/sync_go_toolchain_directive.sh

@@ -12,3 +12,4 @@ source ./scripts/test_lib.sh
 
 TARGET_GO_VERSION="${TARGET_GO_VERSION:-"$(cat "${ETCD_ROOT_DIR}/.go-version")"}"
 find . -name 'go.mod' -exec go mod edit -toolchain=go"${TARGET_GO_VERSION}" {} \;
+go work edit -toolchain=go"${TARGET_GO_VERSION}"

scripts/test.sh

@@ -483,7 +483,7 @@ function bom_pass {
   run cp go.sum go.sum.tmp || return 2
   run cp go.mod go.mod.tmp || return 2
 
-  output=$(GOFLAGS=-mod=mod run_go_tool github.com/appscodelabs/license-bill-of-materials \
+  output=$(run_go_tool github.com/appscodelabs/license-bill-of-materials \
     --override-file ./bill-of-materials.override.json \
     "${modules[@]}")
   code="$?"
@@ -508,7 +508,7 @@ function bom_pass {
 
 function dump_deps_of_module() {
   local module
-  if ! module=$(run go list -m); then
+  if ! module=$(run go mod edit -json | jq -r .Module.Path); then
     return 255
   fi
   run go mod edit -json | jq -r '.Require[] | .Path+","+.Version+","+if .Indirect then " (indirect)" else "" end+",'"${module}"'"'
@@ -617,6 +617,17 @@ function genproto_pass {
   "${ETCD_ROOT_DIR}/scripts/verify_genproto.sh"
 }
 
+function go_workspace_pass {
+  log_callout "Ensuring go workspace is in sync."
+
+  run go mod download
+  if [ -n "$(git status --porcelain go.work.sum)" ]; then
+    log_error "Go workspace not in sync."
+    log_warning "Suggestion: run \"make fix\" to address the issue."
+    return 255
+  fi
+}
+
 ########### MAIN ###############################################################
 
 function run_pass {

scripts/update_go_workspace.sh

@@ -0,0 +1,42 @@
+#!/usr/bin/env bash
+#
+# Copyright 2024 The etcd Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+# Based on k/k scripts/update-go-workspace.sh:
+# https://github.com/kubernetes/kubernetes/blob/e2b96b25661849775dedf441b2f5c555392caa84/hack/update-go-workspace.sh
+
+# This script generates go.work so that it includes all Go packages
+# in this repo, with a few exceptions.
+
+set -euo pipefail
+
+source ./scripts/test_lib.sh
+
+# Avoid issues and remove the workspace files.
+rm -f go.work go.work.sum
+
+# Generate the workspace.
+go work init
+sed -i -e '1i\// This is a generated file. Do not edit directly.\n' go.work
+
+git ls-files -z ':(glob)**/go.mod' \
+    | xargs -0 -n1 dirname -z \
+    | xargs -0 -n1 go work edit -use
+
+go work edit -toolchain "go$(cat .go-version)"
+go work edit -go "$(go mod edit -json | jq -r .Go)"
+
+# generate go.work.sum
+go mod download

scripts/updatebom.sh

@@ -14,7 +14,7 @@ function bom_fixlet {
   # shellcheck disable=SC2207
   modules=($(modules_for_bom))
 
-  if GOFLAGS=-mod=mod run_go_tool "github.com/appscodelabs/license-bill-of-materials" \
+  if run_go_tool "github.com/appscodelabs/license-bill-of-materials" \
       --override-file ./bill-of-materials.override.json \
       "${modules[@]}" > ./bill-of-materials.json.tmp; then
     cp ./bill-of-materials.json.tmp ./bill-of-materials.json

scripts/verify_go_versions.sh

@@ -34,6 +34,20 @@ function verify_go_versions() {
     fi
 }
 
+# Workaround to get go.work's toolchain, as go work edit -json doesn't return
+# the toolchain as of Go 1.24. When this is fixed, we can replace these two
+# checks with verify_go_versions go.work
+toolchain_version="$(grep toolchain go.work | cut -d' ' -f2)"
+if [[ "go${target_go_version}" != "${toolchain_version}" ]]; then
+    log_error "go toolchain directive out of sync for go.work, got: ${toolchain_version}"
+    toolchain_out_of_sync="true"
+fi
+go_line_version="$(go work edit -json | jq -r .Go)"
+if ! printf '%s\n' "${go_line_version}" "${target_go_version}" | sort --check=silent --version-sort; then
+    log_error "go directive in go.work is greater than maximum allowed: go${target_go_version}"
+    go_line_violation="true"
+fi
+
 while read -r mod; do
     verify_go_versions "${mod}";
 done < <(find . -name 'go.mod')
@@ -51,3 +65,5 @@ fi
 if [[ "${go_line_violation}" == "true" ]] || [[ "${toolchain_out_of_sync}" == "true" ]]; then
     exit 1
 fi
+
+log_success "SUCCESS: Go toolchain directive in sync"

server/go.mod

@@ -89,6 +89,7 @@ replace (
 
 // Bad imports are sometimes causing attempts to pull that code.
 // This makes the error more explicit.
-replace go.etcd.io/etcd => ./FORBIDDEN_DEPENDENCY
-
-replace go.etcd.io/tests/v3 => ./FORBIDDEN_DEPENDENCY
+replace (
+	go.etcd.io/etcd => ../FORBIDDEN_DEPENDENCY
+	go.etcd.io/tests/v3 v3.999.999 => ../FORBIDDEN_DEPENDENCY
+)