Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Minimal changes to enable a Go workspace #19423

Draft
wants to merge 6 commits into
base: main
Choose a base branch
from
Draft

Minimal changes to enable a Go workspace #19423

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
198bd69
Enable Go workspace
ivanvc Dec 11, 2024
8ffaff1
Add verify-go-workspace make target
ivanvc Dec 20, 2024
e7560fa
Migrate verify-dep to use a Go workspace
ivanvc Feb 14, 2025
4e842b0
Migrate verify-go-versions to use a Go workspace
ivanvc Feb 15, 2025
15fe747
Migrate bom command to use a Go workspace
ivanvc Feb 15, 2025
eb81e5b
Migrate release to use a Go workspace
ivanvc Feb 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 10 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
10 changes: 5 additions & 5 deletions api/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
8 changes: 4 additions & 4 deletions client/internal/v2/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
8 changes: 4 additions & 4 deletions client/v3/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
6 changes: 3 additions & 3 deletions etcdctl/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
6 changes: 3 additions & 3 deletions etcdutl/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 (
Expand Down
21 changes: 21 additions & 0 deletions go.work
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
)
993 changes: 993 additions & 0 deletions go.work.sum
View file
Open in desktop

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions pkg/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)
13 changes: 12 additions & 1 deletion scripts/test.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we merge it independent to migration to workspaces as a separate PR? Having less changes in the main PR will increase confidence during review.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great idea. Thanks, Marek 🙇. I'll break down this pull request even further, as most of the commits can coexist with the current codebase.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I opened #19463.

return 255
fi
run go mod edit -json | jq -r '.Require[] | .Path+","+.Version+","+if .Indirect then " (indirect)" else "" end+",'"${module}"'"'
Expand Down Expand Up @@ -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 {
Expand Down
42 changes: 42 additions & 0 deletions scripts/update_go_workspace.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
7 changes: 4 additions & 3 deletions server/go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
)