Skip to content

Make controller-gen/kustomize/golangci-lint/envtest tool-binary caching reliable #2367

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

Open
kaovilai wants to merge 5 commits into
base: oadp-dev
Choose a base branch
from
+47 −12
Open

Make controller-gen/kustomize/golangci-lint/envtest tool-binary caching reliable #2367

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
8802555
Make controller-gen/kustomize/golangci-lint version checks reliable
kaovilai Aug 10, 2026
a70d9a8
Remove setup-envtest if it cannot execute on this platform
kaovilai Aug 12, 2026
48c32f2
Extend arch-check to controller-gen/kustomize/golangci-lint too
kaovilai Aug 12, 2026
b86c89e
Fix a real crash: exit-126 arch check aborts under -e in modern Make
kaovilai Aug 12, 2026
a87381b
Rewrite comments to describe current design, not review history
kaovilai Aug 12, 2026
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
59 changes: 47 additions & 12 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,12 +214,7 @@ GOLANGCI_LINT = $(LOCALBIN)/$(BRANCH_VERSION)/golangci-lint
.PHONY: golangci-lint $(GOLANGCI_LINT)
golangci-lint: $(GOLANGCI_LINT) ## Download golangci-lint locally if necessary.
$(GOLANGCI_LINT): $(LOCALBIN)
@if [ -f $(GOLANGCI_LINT) ] && $(GOLANGCI_LINT) --version | grep -q $(GOLANGCI_LINT_VERSION); then \
echo "golangci-lint $(GOLANGCI_LINT_VERSION) is already installed"; \
else \
echo "Installing golangci-lint $(GOLANGCI_LINT_VERSION)"; \
$(call go-install-tool-branch,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION)); \
fi
$(call go-install-tool-versioned,$(GOLANGCI_LINT),github.com/golangci/golangci-lint/v2/cmd/golangci-lint@$(GOLANGCI_LINT_VERSION),$(GOLANGCI_LINT_VERSION))
@if [ -L "$(LOCALBIN)/golangci-lint" ]; then \
unlink "$(LOCALBIN)/golangci-lint"; \
fi
Expand Down Expand Up @@ -303,28 +298,30 @@ KUSTOMIZE ?= $(LOCALBIN)/$(BRANCH_VERSION)/kustomize
CONTROLLER_GEN ?= $(LOCALBIN)/$(BRANCH_VERSION)/controller-gen
ENVTEST ?= $(LOCALBIN)/setup-envtest

.PHONY: kustomize
.PHONY: kustomize $(KUSTOMIZE)
kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading.
$(KUSTOMIZE): $(LOCALBIN)
$(call go-install-tool-branch,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION))
$(call go-install-tool-versioned,$(KUSTOMIZE),sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION),$(KUSTOMIZE_VERSION))
@if [ -L "$(LOCALBIN)/kustomize" ]; then \
unlink "$(LOCALBIN)/kustomize"; \
fi
@ln -sf "$(LOCALBIN)/$(BRANCH_VERSION)/kustomize" "$(LOCALBIN)/kustomize"

.PHONY: controller-gen
.PHONY: controller-gen $(CONTROLLER_GEN)
controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten.
$(CONTROLLER_GEN): $(LOCALBIN)
$(call go-install-tool-branch,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION))
$(call go-install-tool-versioned,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION),$(CONTROLLER_TOOLS_VERSION))
@if [ -L "$(LOCALBIN)/controller-gen" ]; then \
unlink "$(LOCALBIN)/controller-gen"; \
fi
@ln -sf "$(LOCALBIN)/$(BRANCH_VERSION)/controller-gen" "$(LOCALBIN)/controller-gen"

.PHONY: envtest
# Uses go-install-tool-versioned (see its doc comment below) for both the version and
# architecture check, rather than a bespoke arch-only check here.
.PHONY: envtest $(ENVTEST)
envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST): $(LOCALBIN)
$(call go-install-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@v0.0.0-20250308055145-5fe7bb3edc86)
$(call go-install-tool-versioned,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@v0.0.0-20250308055145-5fe7bb3edc86,v0.0.0-20250308055145-5fe7bb3edc86)

.PHONY: operator-sdk
OPERATOR_SDK ?= $(LOCALBIN)/$(BRANCH_VERSION)/operator-sdk
Expand Down Expand Up @@ -532,6 +529,44 @@ rm -rf $$TMP_DIR ;\
}
endef

# go-install-tool-versioned installs $2 to branch-specific path $1, but only if $1 is missing,
# doesn't have the pinned module version $3 embedded in it, or was built for a different
# GOOS/GOARCH than this host. Uses `go version -m` to read a binary's embedded build info
# (module version, GOOS, GOARCH) instead of executing it or trusting a sidecar marker file:
# - A binary's own --version/--help output is not a reliable version or health signal. It
# can depend on ldflags a tool's own release process sets, which `go install` doesn't set
# (e.g. kustomize can report "(devel)" or an unexpanded `$$Format:%H$$` placeholder instead
# of its real version), and some tools exit nonzero on --version even when perfectly
# healthy (kustomize exits 1, setup-envtest's --help exits 2) — so "nonzero exit means
# broken" is the wrong signal. It's also dangerous under this Makefile's
# `.SHELLFLAGS = -ec` (enables `set -e`, honored by GNU Make 3.82+ but silently ignored by
# the Make 3.81 macOS ships): a bare probe command that exits nonzero aborts the whole
# recipe unless it's wrapped in an `if`/`||` guard.
# - Executing the binary to test compatibility can't detect a wrong-arch binary at all
# inside a container with qemu-user-static/binfmt_misc registered (common in multi-arch
# CI/build images): the foreign-arch binary runs under emulation and returns its own exit
# code rather than an exec-format-error.
# Reading embedded build info sidesteps both: no execution means no exit-code heuristic to
# get wrong and no qemu blind spot.
define go-install-tool-versioned
@BUILDINFO="$$(go version -m $(1) 2>/dev/null)" || BUILDINFO="" ;\
MOD_VERSION="$$(printf '%s\n' "$$BUILDINFO" | awk '$$1=="mod"{print $$3; exit}')" ;\
if [ -n "$$BUILDINFO" ] && [ "$$MOD_VERSION" = "$(3)" ] && printf '%s\n' "$$BUILDINFO" | grep -qF "GOOS=$$(go env GOOS)" && printf '%s\n' "$$BUILDINFO" | grep -qF "GOARCH=$$(go env GOARCH)"; then \
echo "$(notdir $(1)) $(3) is already installed" ;\
else \
set -e ;\
mkdir -p $(dir $(1)) ;\
rm -f $(1) ;\
TMP_DIR=$$(mktemp -d) ;\
cd $$TMP_DIR ;\
go mod init tmp ;\
echo "Installing $(notdir $(1)) $(3)" ;\
GOBIN=$(dir $(1)) go install -a -mod=mod $(2) ;\
cd - >/dev/null ;\
rm -rf $$TMP_DIR ;\
fi
endef

YQ = $(LOCALBIN)/yq
yq: ## Download yq locally if necessary.
# 4.28.1 is latest with go 1.17 go.mod
Expand Down