Install setup-envtest module version which matching with the controller-runtime version instead of latest #2480

camilamacedo86 · 2022-01-14T10:35:16Z

What do you want to happen?

Motivation

The concern/motivation to raise this one is that in Kubebuilder, we are: (here)

ENVTEST = $(shell pwd)/bin/setup-envtest
.PHONY: envtest
envtest: ## Download envtest-setup locally if necessary.
	$(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@latest)

Then, a KB user scaffolds the project today. The scaffold is done with controller-runtime version X.
Afterwards, we are still producing new releases and versions. Thus, this target can begin to download a version of this module that is no longer compatible.

Proposed solution

Scaffold the package tools with the module import:

//go:build tools
// +build tools

/*
YOUR_COPYRIGHT
*/

// This package imports things required by build scripts, to force `go mod` to see them as dependencies
package tools

import (
	_ "sigs.k8s.io/controller-runtime/tools/setup-envtest"
)

Change the makefile target to go install the setup-envtest mod version which matches with the controller-runtime version in the go.mod, e.g.:

ENVTEST = $(shell pwd)/bin/setup-envtest
.PHONY: envtest
envtest: ## Download envtest-setup locally if necessary.
	$(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest)

Then, the command go install sigs.k8s.io/controller-runtime/tools/setup-envtest ought to install its version which
corresponding with the C+R version used into the project. More info: kubernetes-sigs/controller-runtime#1670

Extra Labels

No response

The text was updated successfully, but these errors were encountered:

jmrodri · 2022-01-27T17:08:40Z

/label triage/accepted

k8s-ci-robot · 2022-01-27T17:08:42Z

@jmrodri: The label(s) /label triage/accepted cannot be applied. These labels are supported: api-review, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, team/katacoda, refactor

In response to this:

/label triage/accepted

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

NikhilSharmaWe · 2022-04-01T05:11:59Z

@camilamacedo86 I would like to work on this.
/assign

camilamacedo86 · 2022-04-01T09:24:36Z

Adding here what was discussed in #2486 for :

From @joelanford :

This setup is going to result in the project's CI dependencies being added to the main project's go.mod file, which has implications on:
how underlying dependencies get resolved when a build tool and the main project share a transitive dependency (e.g. the build tool might unnecessarily hold back the transitive dependency on a lower version due to Go's MVS algorithm)
how other projects consume this project as a dependency (external projects will end up with this project's build tool dependencies in their go.mod files and might impact their transitive dependency selection also due to MVS)
TL;DR: At a minimum, I think we need to put the tools dependencies in a separate go module. However see also this issue for background about why even that might not be a great idea: kubernetes-sigs/cluster-api#5569

From @camilamacedo86 :

Note that the main reason/motivation for them do not add the dep as an import in the issue shared is Also this helps to make the version of our dependencies visible top-level (in the Makefile instead of hack/tools/go.mod) which does not seems our case; we are only trying to use this approach with the env-test to ensure that its version is compatible with the controller-runtime one scaffold in the project and not all scenarios. The approach was the solution provided by the controller-runtime maintainers, see: #2480

However, what would be your suggestion for us do not to scaffold to use env-test from the latest by default in this case?

@from @joelanford :

we are only trying to use this approach with the env-test

That may be, but many users will see this tools pattern and start adding other build dependencies, thus further polluting their main go.mod file. One of the main goals of kubebuilder is to help reinforce best practices, and I'd consider it a bad practice to include build deps alongside library deps in the same go.mod/go.sum.

One way to solve this problem is something like:

CR_VERSION=$(shell go list -m sigs.k8s.io/controller-runtime | cut -d" " -f2)
ENVTEST = $(shell pwd)/bin/setup-envtest
.PHONY: envtest
envtest: ## Download envtest-setup locally if necessary.
	$(call go-get-tool,$(ENVTEST),sigs.k8s.io/controller-runtime/tools/setup-envtest@$(CR_VERSION))

From @camilamacedo86 :

That does not work, see (we cannot use the tag to download the envtest, see: kubernetes-sigs/controller-runtime#1670 ) :

 go get sigs.k8s.io/controller-runtime/tools/[email protected]
go: downloading sigs.k8s.io/controller-runtime v0.11.1
go get: module sigs.k8s.io/[email protected] found, but does not contain package sigs.k8s.io/controller-runtime/tools/setup-envtest

k8s-triage-robot · 2022-06-30T10:18:59Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

camilamacedo86 · 2022-06-30T11:12:22Z

/remove-lifecycle stale

rumstead · 2022-08-10T15:02:12Z

Is there a recommendation on how to get the dependencies?

sigs.k8s.io/controller-runtime/tools/setup-envtest: module sigs.k8s.io/controller-runtime@latest found (v0.12.3), but does not contain package sigs.k8s.io/controller-runtime/tools/setup-envtest

EDIT: Don't love it but it works..

.PHONY: envtest
envtest: $(ENVTEST) ## Download envtest-setup locally if necessary.
$(ENVTEST): $(LOCALBIN)
	# https://github.com/kubernetes-sigs/kubebuilder/issues/2480
	test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/[email protected]

k8s-triage-robot · 2022-11-08T16:20:30Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

k8s-triage-robot · 2022-12-08T16:48:18Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle rotten

k8s-triage-robot · 2023-01-07T17:39:20Z

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue with /reopen
Mark this issue as fresh with /remove-lifecycle rotten
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

k8s-ci-robot · 2023-01-07T17:39:24Z

@k8s-triage-robot: Closing this issue, marking it as "Not Planned".

In response to this:

The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs.

This bot triages issues according to the following rules:

After 90d of inactivity, lifecycle/stale is applied

After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied

After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Reopen this issue with /reopen

Mark this issue as fresh with /remove-lifecycle rotten

Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/close not-planned

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

jroper · 2023-10-09T06:09:27Z

The dependency on latest has just caused our build to suddenly fail without us changing anything:

22:45:19 > Downloading sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
go: downloading sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20231008020014-968daa8964f9
go: downloading go.uber.org/zap v1.26.0
go: downloading github.com/go-logr/zapr v1.2.4
go: downloading github.com/go-logr/logr v1.2.4
go: downloading golang.org/x/text v0.12.0
go: downloading go.uber.org/multierr v1.10.0
# go.uber.org/multierr
/home/circleci/go/pkg/mod/go.uber.org/[email protected]/error.go:224:20: undefined: atomic.Bool
note: module requires Go 1.19
make[1]: *** [Makefile:171: envtest] Error 2
make: *** [Makefile:114: test] Error 2

This violates the principle of repeatable builds. We shouldn't be forced to upgrade to Go 1.19 before we are ready. There needs to be a better way.

yangsoon · 2023-10-09T06:31:00Z

The dependency on latest has just caused our build to suddenly fail without us changing anything:

22:45:19 > Downloading sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
go: downloading sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20231008020014-968daa8964f9
go: downloading go.uber.org/zap v1.26.0
go: downloading github.com/go-logr/zapr v1.2.4
go: downloading github.com/go-logr/logr v1.2.4
go: downloading golang.org/x/text v0.12.0
go: downloading go.uber.org/multierr v1.10.0
# go.uber.org/multierr
/home/circleci/go/pkg/mod/go.uber.org/[email protected]/error.go:224:20: undefined: atomic.Bool
note: module requires Go 1.19
make[1]: *** [Makefile:171: envtest] Error 2
make: *** [Makefile:114: test] Error 2

This violates the principle of repeatable builds. We shouldn't be forced to upgrade to Go 1.19 before we are ready. There needs to be a better way.

I also encountered this issue just now. You can temporarily fix it by using the command

go install sigs.k8s.io/controller-runtime/tools/[email protected]

Huang-Wei · 2023-10-19T18:12:52Z

Use @latest leads to downloading deps that may need higher version of Go, which breaks my CI:

     go: downloading go.uber.org/multierr v1.10.0
     # go.uber.org/multierr
     /go/pkg/mod/go.uber.org/[email protected]/error.go:224:20: undefined: atomic.Bool
     note: module requires Go 1.19

As @jroper mentioned above, it violates the principle of repeatable builds.

zeeke · 2023-11-24T11:21:41Z

The dependency on latest has just caused our build to suddenly fail without us changing anything:
22:45:19 > Downloading sigs.k8s.io/controller-runtime/tools/setup-envtest@latest
go: downloading sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20231008020014-968daa8964f9
go: downloading go.uber.org/zap v1.26.0
go: downloading github.com/go-logr/zapr v1.2.4
go: downloading github.com/go-logr/logr v1.2.4
go: downloading golang.org/x/text v0.12.0
go: downloading go.uber.org/multierr v1.10.0
# go.uber.org/multierr
/home/circleci/go/pkg/mod/go.uber.org/[email protected]/error.go:224:20: undefined: atomic.Bool
note: module requires Go 1.19
make[1]: *** [Makefile:171: envtest] Error 2
make: *** [Makefile:114: test] Error 2
This violates the principle of repeatable builds. We shouldn't be forced to upgrade to Go 1.19 before we are ready. There needs to be a better way.
I also encountered this issue just now. You can temporarily fix it by using the command
go install sigs.k8s.io/controller-runtime/tools/[email protected]

As an alternative, not sure if it's better than referencing a specific commit, you can target a branch:

 go install sigs.k8s.io/controller-runtime/tools/[email protected]
go: downloading sigs.k8s.io/controller-runtime/tools/setup-envtest v0.0.0-20231026160510-6ffcf19a340d
go: downloading sigs.k8s.io/controller-runtime v0.13.2
go: downloading golang.org/x/text v0.3.6

Using `@latest` for tools dependecies produces unrepeatable builds which might break at any point in time. This is particularly important when maintaining released versions which need a backport fix. Note: At the moment is not possible to reference the package `sigs.k8s.io/controller-runtime/tools/setup-envtest` with a specific version: ``` go: sigs.k8s.io/controller-runtime/tools/[email protected]: module sigs.k8s.io/[email protected] found, but does not contain package sigs.k8s.io/controller-runtime/tools/setup-envtest ``` See kubernetes-sigs/kubebuilder#2480 Ref: openshift/sriov-network-operator#849 Signed-off-by: Andrea Panattoni <[email protected]>

Using `@latest` for tools dependecies produces unrepeatable builds which might break at any point in time. This is particularly important when maintaining released versions which need a backport fix. Note: At the moment is not possible to reference the package `sigs.k8s.io/controller-runtime/tools/setup-envtest` with a specific version: ``` go: sigs.k8s.io/controller-runtime/tools/[email protected]: module sigs.k8s.io/[email protected] found, but does not contain package sigs.k8s.io/controller-runtime/tools/setup-envtest ``` See kubernetes-sigs/kubebuilder#2480 Ref: openshift#849 Signed-off-by: Andrea Panattoni <[email protected]>

setup-envtest is installed in the automatically generated makefile target. Pinning its version to avoid updates to its repo like the minimum golang version in the go.mod can break compatibility and CI. See kubernetes-sigs/kubebuilder#2480

Using `@latest` for tools dependecies produces unrepeatable builds which might break at any point in time. This is particularly important when maintaining released versions which need a backport fix. Note: At the moment is not possible to reference the package `sigs.k8s.io/controller-runtime/tools/setup-envtest` with a specific version: ``` go: sigs.k8s.io/controller-runtime/tools/[email protected]: module sigs.k8s.io/[email protected] found, but does not contain package sigs.k8s.io/controller-runtime/tools/setup-envtest ``` See kubernetes-sigs/kubebuilder#2480 Ref: openshift#849 Signed-off-by: Andrea Panattoni <[email protected]>

camilamacedo86 added the kind/feature Categorizes issue or PR as related to a new feature. label Jan 14, 2022

camilamacedo86 mentioned this issue Jan 19, 2022

✨ Remove deprecated go get from Makefile templates #2486

Merged

camilamacedo86 mentioned this issue Jan 30, 2022

Update/fix EnvTest config doc #2499

Closed

camilamacedo86 added the triage/accepted Indicates an issue or PR is ready to be actively worked on. label Feb 10, 2022

k8s-ci-robot assigned NikhilSharmaWe Apr 1, 2022

NikhilSharmaWe mentioned this issue Apr 1, 2022

✨ Made changes so that setup-envtest module version matches with the controller-runtime version instead of latest #2585

Closed

NikhilSharmaWe mentioned this issue Apr 1, 2022

✨(go/v3) : Made changes so that setup-envtest module version matches with the controller-runtime version instead of latest #2587

Closed

camilamacedo86 mentioned this issue Apr 12, 2022

Released version of setup-envtest kubernetes-sigs/controller-runtime#1659

Closed

TerryHowe mentioned this issue Jun 7, 2022

Update setup env tests aws/eks-anywhere-packages#239

Merged

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 30, 2022

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jun 30, 2022

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Nov 8, 2022

k8s-ci-robot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Dec 8, 2022

k8s-ci-robot closed this as not planned Won't fix, can't repro, duplicate, stale Jan 7, 2023

zeeke mentioned this issue Nov 24, 2023

envtest: Stick to a specific setup-envtest version k8snetworkplumbingwg/sriov-network-operator#551

Merged

zeeke mentioned this issue Jan 2, 2024

OCPBUGS-25924: envtest: Stick to a specific setup-envtest version openshift/sriov-network-operator#878

Merged

ngraham20 mentioned this issue Mar 26, 2024

Controller runtime tool versioning fix stolostron/multiclusterhub-operator#1404

Merged

aleskandro mentioned this issue Apr 2, 2024

Pin setup-envtest openshift/multiarch-tuning-operator#69

Merged

Huang-Wei mentioned this issue Apr 10, 2024

Add scheduling op to helm chart kubernetes-sigs/scheduler-plugins#697

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Install setup-envtest module version which matching with the controller-runtime version instead of latest #2480

Install setup-envtest module version which matching with the controller-runtime version instead of latest #2480

camilamacedo86 commented Jan 14, 2022 •

edited

Loading

jmrodri commented Jan 27, 2022

k8s-ci-robot commented Jan 27, 2022

NikhilSharmaWe commented Apr 1, 2022

camilamacedo86 commented Apr 1, 2022 •

edited

Loading

k8s-triage-robot commented Jun 30, 2022

camilamacedo86 commented Jun 30, 2022

rumstead commented Aug 10, 2022 •

edited

Loading

k8s-triage-robot commented Nov 8, 2022

k8s-triage-robot commented Dec 8, 2022

k8s-triage-robot commented Jan 7, 2023

k8s-ci-robot commented Jan 7, 2023

jroper commented Oct 9, 2023

yangsoon commented Oct 9, 2023

Huang-Wei commented Oct 19, 2023

zeeke commented Nov 24, 2023

Install setup-envtest module version which matching with the controller-runtime version instead of latest #2480

Install setup-envtest module version which matching with the controller-runtime version instead of latest #2480

Comments

camilamacedo86 commented Jan 14, 2022 • edited Loading

What do you want to happen?

Extra Labels

jmrodri commented Jan 27, 2022

k8s-ci-robot commented Jan 27, 2022

NikhilSharmaWe commented Apr 1, 2022

camilamacedo86 commented Apr 1, 2022 • edited Loading

k8s-triage-robot commented Jun 30, 2022

camilamacedo86 commented Jun 30, 2022

rumstead commented Aug 10, 2022 • edited Loading

k8s-triage-robot commented Nov 8, 2022

k8s-triage-robot commented Dec 8, 2022

k8s-triage-robot commented Jan 7, 2023

k8s-ci-robot commented Jan 7, 2023

jroper commented Oct 9, 2023

yangsoon commented Oct 9, 2023

Huang-Wei commented Oct 19, 2023

zeeke commented Nov 24, 2023

camilamacedo86 commented Jan 14, 2022 •

edited

Loading

camilamacedo86 commented Apr 1, 2022 •

edited

Loading

rumstead commented Aug 10, 2022 •

edited

Loading