bump to golang 1.24

stuggi · stuggi · commit 33369e1f380b · 2025-09-22T16:54:59.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-neutron-operator.yaml b/.github/workflows/build-neutron-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: neutron
-      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: neutron
       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: neutron
+      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
@@ -56,7 +56,7 @@ IMG ?= quay.io/openstack-k8s-operators/neutron-operator:latest
 ENVTEST_K8S_VERSION = 1.29
 
 # Set minimum Go version
-GOTOOLCHAIN_VERSION ?= go1.21.0
+GOTOOLCHAIN_VERSION ?= go1.24.0
 
 # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set)
 ifeq (,$(shell go env GOBIN))
@@ -119,9 +119,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/neutron-operator/api
 
-go 1.21
+go 1.24
 
 require (
 	github.com/openstack-k8s-operators/infra-operator/apis v0.6.1-0.20250909143828-e33d35ffd64f
diff --git a/controllers/neutronapi_controller.go b/controllers/neutronapi_controller.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers contains the NeutronAPI controller for the neutron-operator.
 package controllers
 
 import (
@@ -73,7 +74,7 @@ import (
 // errTransportURLSecretNameNilOrEmpty
 var errTransportURLSecretNameNilOrEmpty = errors.New("transport_url secret name is nil or empty")
 
-// getlogger 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 *NeutronAPIReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("NeutronAPI")
 }
@@ -119,7 +120,7 @@ func (r *NeutronAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 
 	// Fetch the NeutronAPI instance
 	instance := &neutronv1beta1.NeutronAPI{}
-	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.
@@ -391,7 +392,7 @@ func (r *NeutronAPIReconciler) findObjectForSrc(ctx context.Context, src client.
 	listOps := &client.ListOptions{
 		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 namespace: %s", crList.GroupVersionKind().Kind, src.GetNamespace()))
 		return requests
@@ -532,7 +533,7 @@ func (r *NeutronAPIReconciler) reconcileInit(
 					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(
@@ -557,7 +558,7 @@ func (r *NeutronAPIReconciler) reconcileInit(
 				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(
@@ -582,7 +583,7 @@ func (r *NeutronAPIReconciler) reconcileInit(
 					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(
@@ -1365,7 +1366,7 @@ func (r *NeutronAPIReconciler) transportURLDeleted(
 		},
 	}
 
-	err := r.Client.Delete(ctx, transportURL)
+	err := r.Delete(ctx, transportURL)
 	if err != nil {
 		if k8s_errors.IsNotFound(err) {
 			return nil
@@ -1761,7 +1762,7 @@ func (r *NeutronAPIReconciler) generateServiceSecrets(
 	cmLabels := labels.GetLabels(instance, labels.GetGroupLabel(neutronapi.ServiceName), map[string]string{})
 
 	var tlsCfg *tls.Service
-	if instance.Spec.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 	// customData hold any customization for the service.
@@ -1958,7 +1959,7 @@ func (r *NeutronAPIReconciler) memcachedNamespaceMapFunc(ctx context.Context) ha
 		listOpts := []client.ListOption{
 			client.InNamespace(o.GetNamespace()),
 		}
-		if err := r.Client.List(context.Background(), neutrons, listOpts...); err != nil {
+		if err := r.List(context.Background(), neutrons, listOpts...); err != nil {
 			Log.Error(err, "Unable to retrieve Neutron CRs %w")
 			return nil
 		}
diff --git a/go.mod b/go.mod
@@ -1,6 +1,6 @@
 module github.com/openstack-k8s-operators/neutron-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 implements the neutron-operator controller manager.
 package main
 
 import (
diff --git a/pkg/neutronapi/const.go b/pkg/neutronapi/const.go
@@ -1,3 +1,4 @@
+// Package neutronapi contains Neutron API service management functionality.
 package neutronapi
 
 import (
@@ -19,8 +20,9 @@ const (
 	// is to be generated, e.g. "neutron_e5a4", "neutron_78bc", etc
 	DatabaseUsernamePrefix = "neutron"
 
-	// neutron:neutron
+	// NeutronUID is the UID for the neutron user (neutron:neutron)
 	NeutronUID int64 = 42435
+	// NeutronGID is the GID for the neutron group
 	NeutronGID int64 = 42435
 
 	// NeutronPublicPort -
@@ -37,16 +39,16 @@ const (
 	// by the neutron-operator
 	Neutron storage.PropagationType = "Neutron"
 
-	// Key in external Secret for Neutron OVN Metadata Agent with agent config
+	// NeutronOVNMetadataAgentSecretKey is the key in external Secret for Neutron OVN Metadata Agent with agent config
 	NeutronOVNMetadataAgentSecretKey = "10-neutron-metadata.conf"
 
-	// Key in external Secret for Neutron OVN Agent with agent config
+	// NeutronOVNAgentSecretKey is the key in external Secret for Neutron OVN Agent with agent config
 	NeutronOVNAgentSecretKey = "10-neutron-ovn.conf" // #nosec
 
-	// Key in external Secret for Neutron SR-IOV Agent with agent config
+	// NeutronSriovAgentSecretKey is the key in external Secret for Neutron SR-IOV Agent with agent config
 	NeutronSriovAgentSecretKey = "10-neutron-sriov.conf"
 
-	// Key in external Secret for Neutron DHCP Agent with agent config
+	// NeutronDhcpAgentSecretKey is the key in external Secret for Neutron DHCP Agent with agent config
 	NeutronDhcpAgentSecretKey = "10-neutron-dhcp.conf"
 )
 
diff --git a/pkg/neutronapi/deployment.go b/pkg/neutronapi/deployment.go
@@ -32,6 +32,7 @@ import (
 )
 
 const (
+	// ServiceCommand is the command used to start the Neutron service
 	ServiceCommand = "/usr/local/bin/kolla_start"
 )
 
diff --git a/test/functional/base_test.go b/test/functional/base_test.go
@@ -35,10 +35,10 @@ import (
 const (
 	SecretName = "test-secret"
 
-	PublicCertSecretName   = "public-tls-certs"
-	InternalCertSecretName = "internal-tls-certs"
-	CABundleSecretName     = "combined-ca-bundle"
-	OVNDbCertSecretName    = "ovndb-tls-certs"
+	PublicCertSecretName   = "public-tls-certs"   // #nosec G101 -- Test constant, not a credential
+	InternalCertSecretName = "internal-tls-certs" // #nosec G101 -- Test constant, not a credential
+	CABundleSecretName     = "combined-ca-bundle" // #nosec G101 -- Test constant, not a credential
+	OVNDbCertSecretName    = "ovndb-tls-certs"    // #nosec G101 -- Test constant, not a credential
 
 	timeout  = time.Second * 10
 	interval = timeout / 100
diff --git a/test/functional/suite_test.go b/test/functional/suite_test.go
@@ -218,11 +218,11 @@ var _ = BeforeSuite(func() {
 	dialer := &net.Dialer{Timeout: time.Second}
 	addrPort := fmt.Sprintf("%s:%d", webhookInstallOptions.LocalServingHost, webhookInstallOptions.LocalServingPort)
 	Eventually(func() error {
-		conn, err := tls.DialWithDialer(dialer, "tcp", addrPort, &tls.Config{InsecureSkipVerify: true})
+		conn, err := tls.DialWithDialer(dialer, "tcp", addrPort, &tls.Config{InsecureSkipVerify: true}) // #nosec G402 -- Test environment, TLS verification not required
 		if err != nil {
 			return err
 		}
-		conn.Close()
+		_ = conn.Close() // Ignore close error in test
 		return nil
 	}).Should(Succeed())
 })
