chore(ci): add modernize as one of the linter steps (#7603)

* chore(ci): add modernize as one of the linter steps

* Update internal/annotations/annotations.go

Co-authored-by: Patryk Małek <patryk.malek@konghq.com>

---------

Co-authored-by: Patryk Małek <patryk.malek@konghq.com>

Author: programmer04

.tools_versions.yaml

@@ -4,6 +4,8 @@ controller-tools: "0.18.0"
 kustomize: "5.7.0"
 # renovate: datasource=github-releases depName=golangci/golangci-lint
 golangci-lint: "2.2.1"
+# TODO: Renovate comment is missing. This needs to be added at some point.
+modernize: "v0.19.1"
 # renovate: datasource=github-releases depName=GoogleContainerTools/skaffold
 skaffold: "2.16.1"
 # renovate: datasource=github-releases depName=kubernetes-sigs/controller-runtime

Makefile

@@ -154,6 +154,13 @@ download.shellcheck: mise yq ## Download shellcheck locally if necessary.
 	@$(MISE) plugin install --yes -q shellcheck
 	@$(MISE) install -q shellcheck@$(SHELLCHECK_VERSION)
 
+MODERNIZE_VERSION = $(shell $(YQ) -r '.modernize' < $(TOOLS_VERSIONS_FILE))
+MODERNIZE = $(PROJECT_DIR)/bin/modernize
+.PHONY: modernize
+modernize: yq
+	GOBIN=$(PROJECT_DIR)/bin go install -v \
+		golang.org/x/tools/gopls/internal/analysis/modernize/cmd/modernize@$(MODERNIZE_VERSION)
+
 # ------------------------------------------------------------------------------
 # Build
 # ------------------------------------------------------------------------------
@@ -203,8 +210,13 @@ _build.template.debug:
 fmt:
 	go fmt ./...
 
+
+.PHONY: lint.modernize
+lint.modernize: modernize
+	$(MODERNIZE) ./...
+
 .PHONY: lint
-lint: verify.tidy golangci-lint staticcheck
+lint: verify.tidy golangci-lint lint.modernize staticcheck
 
 .PHONY: lint.actions
 lint.actions: download.actionlint download.shellcheck

controllers/license/konglicense_controller.go

@@ -121,7 +121,7 @@ func NewLicenseCache() cache.Store {
 	return cache.NewStore(kongLicenseKeyFunc)
 }
 
-func kongLicenseKeyFunc(obj interface{}) (string, error) {
+func kongLicenseKeyFunc(obj any) (string, error) {
 	l, ok := obj.(*configurationv1alpha1.KongLicense)
 	if !ok {
 		return "", fmt.Errorf("object is type %T, not KongLicense", obj)

internal/adminapi/client.go

@@ -134,7 +134,7 @@ func (c *Client) GetKongVersion(ctx context.Context) (string, error) {
 	return version, nil
 }
 
-func extractStringFromRoot(data map[string]interface{}, key string) (string, error) {
+func extractStringFromRoot(data map[string]any, key string) (string, error) {
 	val, ok := data[key]
 	if !ok {
 		return "", fmt.Errorf("%q key not found", key)

internal/admission/validator.go

@@ -658,7 +658,7 @@ func (validator KongHTTPValidator) ValidateCustomEntity(ctx context.Context, ent
 		// The admission webhook needs a placeholder value because the actual value isn't present in the KongCustomEntity spec.
 		// It will be derived from the resource(s) used by the parent KongPlugin during translation.
 		if field.Required && field.Type == kongstate.EntityFieldTypeForeign {
-			fields[fieldName] = map[string]interface{}{
+			fields[fieldName] = map[string]any{
 				"id": util.DefaultUUIDGenerator{}.NewString(),
 			}
 		}

internal/admission/validator_test.go

@@ -1518,10 +1518,10 @@ func TestValidator_ValidateCustomEntity(t *testing.T) {
 
 	for _, tc := range testCases {
 		t.Run(tc.name, func(t *testing.T) {
-			fieldList := make([]interface{}, 0, len(tc.fields))
+			fieldList := make([]any, 0, len(tc.fields))
 			for _, field := range tc.fields {
-				fieldList = append(fieldList, map[string]interface{}{
-					field.Name: map[string]interface{}{
+				fieldList = append(fieldList, map[string]any{
+					field.Name: map[string]any{
 						"type":      string(field.Type),
 						"required":  field.Required,
 						"reference": field.Reference,
@@ -1533,7 +1533,7 @@ func TestValidator_ValidateCustomEntity(t *testing.T) {
 				AdminAPIServicesProvider: fakeServicesProvider{
 					schemaSvc: fakeSchemaSvc{
 						entityTypeExist: tc.entityTypeExist,
-						schema: map[string]interface{}{
+						schema: map[string]any{
 							"fields": fieldList,
 						},
 						shouldFail: tc.validateSvcFail,
@@ -1550,7 +1550,7 @@ func TestValidator_ValidateCustomEntity(t *testing.T) {
 }
 
 type fakeSchemaSvc struct {
-	schema          map[string]interface{}
+	schema          map[string]any
 	entityTypeExist bool
 	shouldFail      bool
 }
@@ -1564,7 +1564,7 @@ func (s fakeSchemaSvc) Get(_ context.Context, _ string) (kong.Schema, error) {
 	return s.schema, nil
 }
 
-func (s fakeSchemaSvc) Validate(_ context.Context, _ kong.EntityType, _ interface{}) (bool, string, error) {
+func (s fakeSchemaSvc) Validate(_ context.Context, _ kong.EntityType, _ any) (bool, string, error) {
 	if s.shouldFail {
 		return false, "something is wrong in the entity", nil
 	}

internal/annotations/annotations.go

@@ -293,8 +293,7 @@ func ExtractHeaders(anns map[string]string) (map[string][]string, bool) {
 		separator = ","
 	}
 	for key, val := range anns {
-		if strings.HasPrefix(key, prefix) {
-			header := strings.TrimPrefix(key, prefix)
+		if header, ok0 := strings.CutPrefix(key, prefix); ok0 {
 			if len(header) == 0 || len(val) == 0 {
 				continue
 			}

internal/annotations/annotations_test.go

@@ -76,7 +76,7 @@ func TestIngressClassValidatorFunc(t *testing.T) {
 
 	data := map[string]string{}
 	ing.SetAnnotations(data)
-	for i := 0; i < len(tests); i++ {
+	for i := range tests {
 		test := tests[i]
 		ing.Annotations[IngressClassKey] = test.ingress
 		ingv1.Spec.IngressClassName = &test.ingress

internal/clients/config_status_test.go

@@ -19,11 +19,11 @@ func TestChannelConfigNotifier(t *testing.T) {
 	ch := n.SubscribeGatewayConfigStatus()
 
 	// Call NotifyConfigStatus 5 times to make sure that the method is non-blocking.
-	for i := 0; i < 5; i++ {
+	for range 5 {
 		n.NotifyGatewayConfigStatus(ctx, clients.GatewayConfigApplyStatus{})
 	}
 
-	for i := 0; i < 5; i++ {
+	for i := range 5 {
 		select {
 		case <-ch:
 		case <-time.After(time.Second):

internal/clients/manager_test.go

@@ -354,7 +354,7 @@ func TestAdminAPIClientsManager_ConcurrentNotify(t *testing.T) {
 	}()
 
 	go func() {
-		for i := 0; i < 100; i++ {
+		for range 100 {
 			go m.Notify(ctx, []adminapi.DiscoveredAdminAPI{testDiscoveredAdminAPI(testURL1)})
 		}
 	}()