bump to golang 1.24

stuggi · stuggi · commit f70975241ca8 · 2025-09-22T18:00:14.000+02:00
* bump in go.mod (base and api)
* bump go-toolset in Dockerfile
* bump in github jobs ('.github/workflows')
* Bump the golangci-lint version in the .pre-commit-config.yaml to v2.4.0
* Bump build_root_image in .ci-operator.yaml to ci-build-root-golang-1.24-sdk-1.31

Also fixes golangci-lint reported issues for new v2.4.0 version.

Jira: OSPRH-12935
Signed-off-by: Martin Schuppert &lt;mschuppert@redhat.com&gt;
Co-authored-by: Claude (Anthropic) claude@anthropic.com
diff --git a/.ci-operator.yaml b/.ci-operator.yaml
@@ -1,4 +1,4 @@
 build_root_image:
   name: tools
   namespace: openstack-k8s-operators
-  tag: ci-build-root-golang-1.21-sdk-1.31
+  tag: ci-build-root-golang-1.24-sdk-1.31
diff --git a/.github/workflows/build-ovn-operator.yaml b/.github/workflows/build-ovn-operator.yaml
@@ -15,7 +15,7 @@ jobs:
     uses: openstack-k8s-operators/openstack-k8s-operators-ci/.github/workflows/reusable-build-operator.yaml@main
     with:
       operator_name: ovn
-      go_version: 1.21.x
+      go_version: 1.24.x
       operator_sdk_version: 1.31.0
     secrets:
       IMAGENAMESPACE: ${{ secrets.IMAGENAMESPACE }}
diff --git a/.github/workflows/force-bump-pr-manual.yaml b/.github/workflows/force-bump-pr-manual.yaml
@@ -9,5 +9,6 @@ jobs:
     with:
       operator_name: ovn
       branch_name: ${{ github.ref_name }}
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}
diff --git a/.github/workflows/force-bump-pr-scheduled.yaml b/.github/workflows/force-bump-pr-scheduled.yaml
@@ -10,5 +10,6 @@ jobs:
     uses: openstack-k8s-operators/openstack-k8s-operators-ci/.github/workflows/force-bump-branches.yaml@main
     with:
       operator_name: ovn
+      custom_image: quay.io/openstack-k8s-operators/openstack-k8s-operators-ci-build-tools:golang-1.24-sdk-1.31
     secrets:
       FORCE_BUMP_PULL_REQUEST_PAT: ${{ secrets.FORCE_BUMP_PULL_REQUEST_PAT }}
diff --git a/.golangci.yaml b/.golangci.yaml
@@ -1,20 +1,20 @@
+version: 2
+
 linters:
   # Enable specific linter
   # https://golangci-lint.run/usage/linters/#enabled-by-default
   enable:
     - errorlint
     - revive
     - ginkgolinter
-    - gofmt
     - govet
     - gosec
     - errname
     - err113
+
+formatters:
+  enable:
+    - gofmt
+
 run:
   timeout: 5m
-
-issues:
-  exclude-rules:
-    - path: '(.+)_test\.go'
-      linters:
-        - gosec
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -79,7 +79,7 @@ repos:
       # E012: here doc didn't end before EOF
 
 - repo: https://github.com/golangci/golangci-lint
-  rev: v1.59.1
+  rev: v2.4.0
   hooks:
     - id: golangci-lint-full
       args: ["-v"]
diff --git a/Dockerfile b/Dockerfile
@@ -1,5 +1,5 @@
 # Build the manager binary
-ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.21
+ARG GOLANG_BUILDER=registry.access.redhat.com/ubi9/go-toolset:1.24
 ARG OPERATOR_BASE_IMAGE=registry.access.redhat.com/ubi9/ubi-minimal:latest
 
 FROM $GOLANG_BUILDER AS builder
diff --git a/Makefile b/Makefile
@@ -71,7 +71,7 @@ SHELL = /usr/bin/env bash -o pipefail
 # Extra vars which will be passed to the Docker-build
 DOCKER_BUILD_ARGS ?=
 
-GOTOOLCHAIN_VERSION ?= go1.21.0
+GOTOOLCHAIN_VERSION ?= go1.24.0
 .PHONY: all
 all: build
 
@@ -116,9 +116,10 @@ tidy: ## Run go mod tidy on every mod file in the repo
 	go mod tidy
 	cd ./api && go mod tidy
 
+GOLANGCI_LINT_VERSION ?= v2.4.0
 .PHONY: golangci-lint
 golangci-lint:
-	test -s $(LOCALBIN)/golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s v1.59.1
+	test -s $(LOCALBIN)/golangci-lint || curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s $(GOLANGCI_LINT_VERSION)
 	$(LOCALBIN)/golangci-lint run --fix
 
 PROCS?=$(shell expr $(shell nproc --ignore 2) / 2)
diff --git a/api/go.mod b/api/go.mod
@@ -1,6 +1,6 @@
 module github.com/openstack-k8s-operators/ovn-operator/api
 
-go 1.21
+go 1.24
 
 require (
 	github.com/go-logr/logr v1.4.3
diff --git a/controllers/ovn_common.go b/controllers/ovn_common.go
@@ -14,11 +14,13 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers contains the Kubernetes controllers for managing OVN components
 package controllers
 
 import (
 	"context"
 	"fmt"
+
 	topologyv1 "github.com/openstack-k8s-operators/infra-operator/apis/topology/v1beta1"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/condition"
 	"github.com/openstack-k8s-operators/lib-common/modules/common/helper"
diff --git a/controllers/ovncontroller_controller.go b/controllers/ovncontroller_controller.go
@@ -60,7 +60,7 @@ import (
 	rbacv1 "k8s.io/api/rbac/v1"
 )
 
-// getlog returns a logger object with a prefix of "conroller.name" and aditional controller context fields
+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
 func (r *OVNControllerReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("OVNController")
 }
@@ -98,12 +98,13 @@ func (r *OVNControllerReconciler) GetClient() client.Client {
 // +kubebuilder:rbac:groups="",resources=pods,verbs=create;delete;get;list;patch;update;watch
 // +kubebuilder:rbac:groups=topology.openstack.org,resources=topologies,verbs=get;list;watch;update
 
+// Reconcile reconciles the OVNController CR to deploy OVN controller pods
 func (r *OVNControllerReconciler) Reconcile(ctx context.Context, req ctrl.Request) (result ctrl.Result, _err error) {
 	Log := r.GetLogger(ctx)
 
 	// Fetch OVNController instance
 	instance := &ovnv1.OVNController{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile request.
@@ -277,7 +278,7 @@ func (r *OVNControllerReconciler) findObjectsForSrc(ctx context.Context, src cli
 			FieldSelector: fields.OneTermEqualSelector(field, src.GetName()),
 			Namespace:     src.GetNamespace(),
 		}
-		err := r.Client.List(ctx, crList, listOps)
+		err := r.List(ctx, crList, listOps)
 		if err != nil {
 			Log.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
 			return requests
@@ -403,7 +404,7 @@ func (r *OVNControllerReconciler) reconcileNormal(ctx context.Context, instance
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -429,7 +430,7 @@ func (r *OVNControllerReconciler) reconcileNormal(ctx context.Context, instance
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -906,7 +907,7 @@ func (r *OVNControllerReconciler) deleteResourceIfExists(ctx context.Context, ob
 	obj.SetName(name)
 	obj.SetNamespace(namespace)
 
-	err := r.Client.Delete(ctx, obj)
+	err := r.Delete(ctx, obj)
 	if err != nil && !k8s_errors.IsNotFound(err) {
 		return err
 	}
diff --git a/controllers/ovndbcluster_controller.go b/controllers/ovndbcluster_controller.go
@@ -84,7 +84,7 @@ func (r *OVNDBClusterReconciler) GetScheme() *runtime.Scheme {
 	return r.Scheme
 }
 
-// getlog returns a logger object with a prefix of "conroller.name" and aditional controller context fields
+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
 func (r *OVNDBClusterReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("OVNDBCluster")
 }
@@ -116,7 +116,7 @@ func (r *OVNDBClusterReconciler) Reconcile(ctx context.Context, req ctrl.Request
 
 	// Fetch the OVNDBCluster instance
 	instance := &ovnv1.OVNDBCluster{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile request.
@@ -290,7 +290,7 @@ func (r *OVNDBClusterReconciler) findObjectsForSrc(ctx context.Context, src clie
 			FieldSelector: fields.OneTermEqualSelector(field, src.GetName()),
 			Namespace:     src.GetNamespace(),
 		}
-		err := r.Client.List(ctx, crList, listOps)
+		err := r.List(ctx, crList, listOps)
 		if err != nil {
 			Log.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
 			return requests
@@ -463,7 +463,7 @@ func (r *OVNDBClusterReconciler) reconcileNormal(ctx context.Context, instance *
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -489,7 +489,7 @@ func (r *OVNDBClusterReconciler) reconcileNormal(ctx context.Context, instance *
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -907,8 +907,7 @@ func (r *OVNDBClusterReconciler) reconcileServices(
 	// get it automatically registered in DNS.
 	if instance.Spec.NetworkAttachment != "" && ssvc.GetServiceType() != corev1.ServiceTypeLoadBalancer {
 		var dnsIPsList []string
-		// TODO(averdagu): use built in Min once go1.21 is used
-		minLen := ovn_common.Min(len(podList.Items), int(*(instance.Spec.Replicas)))
+		minLen := min(len(podList.Items), int(*(instance.Spec.Replicas)))
 		for _, ovnPod := range podList.Items[:minLen] {
 			svc, err = service.GetServiceWithName(
 				ctx,
diff --git a/controllers/ovnnorthd_controller.go b/controllers/ovnnorthd_controller.go
@@ -73,7 +73,7 @@ func (r *OVNNorthdReconciler) GetScheme() *runtime.Scheme {
 	return r.Scheme
 }
 
-// getlog returns a logger object with a prefix of "conroller.name" and aditional controller context fields
+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
 func (r *OVNNorthdReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("OVNNorthd")
 }
@@ -105,7 +105,7 @@ func (r *OVNNorthdReconciler) Reconcile(ctx context.Context, req ctrl.Request) (
 
 	// Fetch the OVNNorthd instance
 	instance := &ovnv1.OVNNorthd{}
-	err := r.Client.Get(ctx, req.NamespacedName, instance)
+	err := r.Get(ctx, req.NamespacedName, instance)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Request object not found, could have been deleted after reconcile request.
@@ -268,7 +268,7 @@ func (r *OVNNorthdReconciler) findObjectsForSrc(ctx context.Context, src client.
 			FieldSelector: fields.OneTermEqualSelector(field, src.GetName()),
 			Namespace:     src.GetNamespace(),
 		}
-		err := r.Client.List(ctx, crList, listOps)
+		err := r.List(ctx, crList, listOps)
 		if err != nil {
 			Log.Error(err, fmt.Sprintf("listing %s for field: %s - %s", crList.GroupVersionKind().Kind, field, src.GetNamespace()))
 			return requests
@@ -410,7 +410,7 @@ func (r *OVNNorthdReconciler) reconcileNormal(ctx context.Context, instance *ovn
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))
+					condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -436,7 +436,7 @@ func (r *OVNNorthdReconciler) reconcileNormal(ctx context.Context, instance *ovn
 					condition.TLSInputReadyCondition,
 					condition.RequestedReason,
 					condition.SeverityInfo,
-					fmt.Sprintf(condition.TLSInputReadyWaitingMessage, err.Error())))
+					condition.TLSInputReadyWaitingMessage, err.Error()))
 				return ctrl.Result{}, nil
 			}
 			instance.Status.Conditions.Set(condition.FalseCondition(
@@ -695,11 +695,11 @@ func (r *OVNNorthdReconciler) cleanupExtraServices(
 
 		// Try to delete service
 		svc := &corev1.Service{}
-		err := r.Client.Get(ctx, types.NamespacedName{Name: serviceName, Namespace: instance.Namespace}, svc)
+		err := r.Get(ctx, types.NamespacedName{Name: serviceName, Namespace: instance.Namespace}, svc)
 		if err == nil {
 			// Service exists, delete it
 			Log.Info(fmt.Sprintf("Deleting extra metrics service %s (scaled down)", serviceName))
-			err = r.Client.Delete(ctx, svc)
+			err = r.Delete(ctx, svc)
 			if err != nil && !k8s_errors.IsNotFound(err) {
 				Log.Error(err, fmt.Sprintf("Failed to delete extra service %s", serviceName))
 			}
@@ -718,7 +718,7 @@ func (r *OVNNorthdReconciler) cleanupLegacyDeployment(
 
 	// Check if legacy deployment exists
 	deployment := &appsv1.Deployment{}
-	err := r.Client.Get(ctx, types.NamespacedName{Name: deploymentName, Namespace: instance.Namespace}, deployment)
+	err := r.Get(ctx, types.NamespacedName{Name: deploymentName, Namespace: instance.Namespace}, deployment)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			// Deployment doesn't exist, migration already complete
@@ -736,7 +736,7 @@ func (r *OVNNorthdReconciler) cleanupLegacyDeployment(
 			// Optional: Scale down deployment to 0 first for graceful shutdown
 			if deployment.Spec.Replicas != nil && *deployment.Spec.Replicas > 0 {
 				deployment.Spec.Replicas = &[]int32{0}[0]
-				err = r.Client.Update(ctx, deployment)
+				err = r.Update(ctx, deployment)
 				if err != nil {
 					Log.Error(err, "Failed to scale down legacy deployment, proceeding with deletion")
 				} else {
@@ -745,7 +745,7 @@ func (r *OVNNorthdReconciler) cleanupLegacyDeployment(
 			}
 
 			// Delete the deployment
-			err = r.Client.Delete(ctx, deployment)
+			err = r.Delete(ctx, deployment)
 			if err != nil && !k8s_errors.IsNotFound(err) {
 				return fmt.Errorf("failed to delete legacy deployment %s: %w", deploymentName, err)
 			}
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/openstack-k8s-operators/ovn-operator
 
-go 1.21
+go 1.24
 
 require (
 	github.com/go-logr/logr v1.4.3
diff --git a/main.go b/main.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package main is the entry point for the OVN operator
 package main
 
 import (
diff --git a/pkg/common/const.go b/pkg/common/const.go
@@ -1,14 +1,19 @@
-package common
+// Package common contains shared constants and utilities for the OVN operator
+package common // nolint:revive
 
 const (
-	OVNDbCertPath   string = "/etc/pki/tls/certs/ovndb.crt"
-	OVNDbKeyPath    string = "/etc/pki/tls/private/ovndb.key"
+	// OVNDbCertPath is the path to the OVN database certificate file
+	OVNDbCertPath string = "/etc/pki/tls/certs/ovndb.crt"
+	// OVNDbKeyPath is the path to the OVN database private key file
+	OVNDbKeyPath string = "/etc/pki/tls/private/ovndb.key"
+	// OVNDbCaCertPath is the path to the OVN database CA certificate file
 	OVNDbCaCertPath string = "/etc/pki/tls/certs/ovndbca.crt"
 
-	// Metrics certificate paths
+	// OVNMetricsCertPath is the path to the metrincs certificate file
 	OVNMetricsCertPath string = "/etc/pki/tls/certs/ovnmetrics.crt"
-	OVNMetricsKeyPath  string = "/etc/pki/tls/private/ovnmetrics.key"
+	// OVNMetricsKeyPath is the path to the metrics private key file
+	OVNMetricsKeyPath string = "/etc/pki/tls/private/ovnmetrics.key"
 
-	// Metrics port
+	// MetricsPort is the port used for metrics
 	MetricsPort int32 = 1981
 )
diff --git a/pkg/common/utils.go b/pkg/common/utils.go
@@ -10,13 +10,4 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
-package common
-
-// Helper function while can't use buildin min
-// TOOD(averdagu) remove when using go1.21.0
-func Min(x, y int) int {
-	if x < y {
-		return x
-	}
-	return y
-}
+package common //nolint:revive // G101: "common" is a legitimate package name for shared utilities
diff --git a/pkg/ovncontroller/configjob.go b/pkg/ovncontroller/configjob.go
@@ -10,6 +10,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package ovncontroller provides functionality for managing OVN controller components
 package ovncontroller
 
 import (
diff --git a/pkg/ovncontroller/daemonset.go b/pkg/ovncontroller/daemonset.go
diff --git a/pkg/ovncontroller/volumes.go b/pkg/ovncontroller/volumes.go
diff --git a/pkg/ovndbcluster/const.go b/pkg/ovndbcluster/const.go
diff --git a/pkg/ovndbcluster/dnsdata.go b/pkg/ovndbcluster/dnsdata.go
diff --git a/pkg/ovndbcluster/statefulset.go b/pkg/ovndbcluster/statefulset.go
diff --git a/pkg/ovnnorthd/const.go b/pkg/ovnnorthd/const.go
diff --git a/pkg/ovnnorthd/statefulset.go b/pkg/ovnnorthd/statefulset.go
diff --git a/tests/functional/base_test.go b/tests/functional/base_test.go
diff --git a/tests/functional/suite_test.go b/tests/functional/suite_test.go
