Remove tools.go and require Go 1.24 (#3181)

sjberman · web-flow · commit 04c17a2c5dfd · 2025-02-27T20:11:25.000Z
go 1.24 removes the need for tools.go to include extra packages.

Updating the project to use the new tools method, and require Go 1.24 because of this. Also removed a deprecated linter.
diff --git a/.golangci.yml b/.golangci.yml
@@ -105,7 +105,6 @@ linters:
     - staticcheck
     - stylecheck
     - tagalign
-    - tenv
     - thelper
     - tparallel
     - typecheck
diff --git a/go.mod b/go.mod
@@ -1,12 +1,11 @@
 module github.com/nginx/nginx-gateway-fabric
 
-go 1.23.0
+go 1.24.0
 
 require (
 	github.com/go-kit/log v0.2.1
 	github.com/go-logr/logr v1.4.2
 	github.com/google/go-cmp v0.7.0
-	github.com/maxbrunsfeld/counterfeiter/v6 v6.11.2
 	github.com/nginx/telemetry-exporter v0.1.3
 	github.com/nginxinc/nginx-plus-go-client v1.3.0
 	github.com/nginxinc/nginx-prometheus-exporter v1.3.0
@@ -57,6 +56,7 @@ require (
 	github.com/json-iterator/go v1.1.12 // indirect
 	github.com/klauspost/compress v1.17.9 // indirect
 	github.com/mailru/easyjson v0.7.7 // indirect
+	github.com/maxbrunsfeld/counterfeiter/v6 v6.11.2 // indirect
 	github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd // indirect
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
@@ -94,3 +94,5 @@ require (
 	sigs.k8s.io/structured-merge-diff/v4 v4.4.2 // indirect
 	sigs.k8s.io/yaml v1.4.0 // indirect
 )
+
+tool github.com/maxbrunsfeld/counterfeiter/v6
diff --git a/internal/framework/controller/fakes.go b/internal/framework/controller/fakes.go
@@ -5,7 +5,7 @@ import (
 	_ "sigs.k8s.io/controller-runtime/pkg/manager" // used below to generate a fake
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 //counterfeiter:generate  sigs.k8s.io/controller-runtime/pkg/manager.Manager
 
diff --git a/internal/framework/events/handler.go b/internal/framework/events/handler.go
@@ -6,7 +6,7 @@ import (
 	"github.com/go-logr/logr"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 //counterfeiter:generate . EventHandler
 
 // EventHandler handles events.
diff --git a/internal/framework/kubernetes/client.go b/internal/framework/kubernetes/client.go
@@ -2,7 +2,7 @@ package kubernetes
 
 import "sigs.k8s.io/controller-runtime/pkg/client"
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 //counterfeiter:generate . Reader
 
diff --git a/internal/framework/status/k8s_updater.go b/internal/framework/status/k8s_updater.go
@@ -9,7 +9,7 @@ import (
 // K8sUpdater updates a resource from the k8s API.
 // It allows us to mock the client.Reader.Status.Update method.
 //
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 //counterfeiter:generate . K8sUpdater
 type K8sUpdater interface {
 	// Update is from client.StatusClient.SubResourceWriter.
diff --git a/internal/mode/static/licensing/collector.go b/internal/mode/static/licensing/collector.go
@@ -11,7 +11,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/telemetry"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 //counterfeiter:generate . Collector
 
diff --git a/internal/mode/static/nginx/config/generator.go b/internal/mode/static/nginx/config/generator.go
@@ -17,7 +17,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 //counterfeiter:generate . Generator
 
 // Volumes here also need to be added to our crossplane ephemeral test container.
diff --git a/internal/mode/static/nginx/config/policies/policy.go b/internal/mode/static/nginx/config/policies/policy.go
@@ -9,7 +9,7 @@ import (
 	"sigs.k8s.io/gateway-api/apis/v1alpha2"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 // Policy is an extension of client.Object. It adds methods that are common among all NGF Policies.
 //
diff --git a/internal/mode/static/nginx/config/policies/validator.go b/internal/mode/static/nginx/config/policies/validator.go
@@ -1,6 +1,6 @@
 package policies
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 import (
 	"fmt"
diff --git a/internal/mode/static/nginx/file/manager.go b/internal/mode/static/nginx/file/manager.go
@@ -10,7 +10,7 @@ import (
 	"github.com/go-logr/logr"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 const (
 	// regularFileMode defines the default file mode for regular files.
diff --git a/internal/mode/static/nginx/runtime/manager.go b/internal/mode/static/nginx/runtime/manager.go
@@ -16,7 +16,7 @@ import (
 	"k8s.io/apimachinery/pkg/util/wait"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 const (
 	// PidFile specifies the location of the PID file for the Nginx process.
diff --git a/internal/mode/static/nginx/runtime/verify.go b/internal/mode/static/nginx/runtime/verify.go
@@ -19,7 +19,7 @@ const configVersionURI = "/var/run/nginx/nginx-config-version.sock"
 var noNewWorkersErrFmt = "reload unsuccessful: no new NGINX worker processes started for config version %d." +
 	" Please check the NGINX container logs for possible configuration issues: %w"
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 . nginxConfigVerifier
+//go:generate go tool counterfeiter . nginxConfigVerifier
 
 type nginxConfigVerifier interface {
 	GetConfigVersion() (int, error)
diff --git a/internal/mode/static/state/change_processor.go b/internal/mode/static/state/change_processor.go
@@ -26,7 +26,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/validation"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 // ChangeType is the type of change that occurred based on a k8s object event.
 type ChangeType int
diff --git a/internal/mode/static/state/resolver/resolver.go b/internal/mode/static/state/resolver/resolver.go
@@ -14,7 +14,7 @@ import (
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/controller/index"
 )
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 //counterfeiter:generate . ServiceResolver
 
 // ServiceResolver resolves a Service's NamespacedName and ServicePort to a list of Endpoints.
diff --git a/internal/mode/static/state/validation/validator.go b/internal/mode/static/state/validation/validator.go
@@ -1,6 +1,6 @@
 package validation
 
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 
 import (
 	"github.com/nginx/nginx-gateway-fabric/internal/framework/conditions"
diff --git a/internal/mode/static/telemetry/exporter.go b/internal/mode/static/telemetry/exporter.go
@@ -9,7 +9,7 @@ import (
 
 // Exporter exports telemetry data to some destination.
 //
-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate
+//go:generate go tool counterfeiter -generate
 //counterfeiter:generate . Exporter
 type Exporter interface {
 	Export(ctx context.Context, data tel.Exportable) error
diff --git a/tests/framework/crossplane/go.mod b/tests/framework/crossplane/go.mod
@@ -1,6 +1,6 @@
 module github.com/nginx/nginx-gateway-fabric/tests/framework/crossplane
 
-go 1.23.1
+go 1.24.0
 
 require github.com/nginxinc/nginx-go-crossplane v0.4.73
 
diff --git a/tests/go.mod b/tests/go.mod
@@ -1,6 +1,6 @@
 module github.com/nginx/nginx-gateway-fabric/tests
 
-go 1.23.0
+go 1.24.0
 
 replace github.com/nginx/nginx-gateway-fabric => ../
 
diff --git a/tools.go b/tools.go

Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ import (`
`5`	`5`	`_ "sigs.k8s.io/controller-runtime/pkg/manager" // used below to generate a fake`
`6`	`6`	`)`
`7`	`7`
`8`		`-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate`
	`8`	`+//go:generate go tool counterfeiter -generate`
`9`	`9`
`10`	`10`	`//counterfeiter:generate sigs.k8s.io/controller-runtime/pkg/manager.Manager`
`11`	`11`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ import (`
`6`	`6`	`"github.com/go-logr/logr"`
`7`	`7`	`)`
`8`	`8`
`9`		`-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate`
	`9`	`+//go:generate go tool counterfeiter -generate`
`10`	`10`	`//counterfeiter:generate . EventHandler`
`11`	`11`
`12`	`12`	`// EventHandler handles events.`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ import (`
`11`	`11`	`"github.com/nginx/nginx-gateway-fabric/internal/mode/static/telemetry"`
`12`	`12`	`)`
`13`	`13`
`14`		`-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate`
	`14`	`+//go:generate go tool counterfeiter -generate`
`15`	`15`
`16`	`16`	`//counterfeiter:generate . Collector`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ import (`
`17`	`17`	`"github.com/nginx/nginx-gateway-fabric/internal/mode/static/state/dataplane"`
`18`	`18`	`)`
`19`	`19`
`20`		`-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate`
	`20`	`+//go:generate go tool counterfeiter -generate`
`21`	`21`	`//counterfeiter:generate . Generator`
`22`	`22`
`23`	`23`	`// Volumes here also need to be added to our crossplane ephemeral test container.`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`"sigs.k8s.io/gateway-api/apis/v1alpha2"`
`10`	`10`	`)`
`11`	`11`
`12`		`-//go:generate go run github.com/maxbrunsfeld/counterfeiter/v6 -generate`
	`12`	`+//go:generate go tool counterfeiter -generate`
`13`	`13`
`14`	`14`	`// Policy is an extension of client.Object. It adds methods that are common among all NGF Policies.`
`15`	`15`	`//`