fix golangci reported issues

stuggi · stuggi · commit 2fd4bd5820cd · 2025-08-22T11:22:01.000+02:00
Signed-off-by: Martin Schuppert &lt;mschuppert@redhat.com&gt;
diff --git a/controllers/common.go b/controllers/common.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package controllers contains the Nova operator controllers for managing OpenStack Nova services.
 package controllers
 
 import (
@@ -279,7 +280,7 @@ func ensureSecret(
 				condition.InputReadyCondition,
 				condition.RequestedReason,
 				condition.SeverityInfo,
-				fmt.Sprintf(novav1.InputReadyWaitingMessage, "secret/"+secretName.Name)))
+				novav1.InputReadyWaitingMessage, "secret/"+secretName.Name))
 			return "",
 				ctrl.Result{RequeueAfter: requeueTimeout},
 				*secret,
@@ -564,6 +565,7 @@ func hashOfStringMap(input map[string]string) (string, error) {
 	return util.ObjectHash(keyValues)
 }
 
+// GetSecret defines an interface for objects that can provide a secret name
 type GetSecret interface {
 	GetSecret() string
 	client.Object
@@ -742,6 +744,7 @@ func ensureMemcached(
 	return memcached, err
 }
 
+// SortNovaCellListByName sorts a NovaCellList by name in ascending order
 func SortNovaCellListByName(cellList *novav1.NovaCellList) {
 	sort.SliceStable(cellList.Items, func(i, j int) bool {
 		return cellList.Items[i].Name < cellList.Items[j].Name
diff --git a/controllers/nova_controller.go b/controllers/nova_controller.go
@@ -686,7 +686,7 @@ func (r *NovaReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul
 				cr.Spec.CellName, apiTransportURL,
 				secret, apiDB, cellDBs[novav1.Cell0Name].Database.GetDatabaseHostname(), cells[novav1.Cell0Name])
 			if err != nil {
-				deleteErrs = append(deleteErrs, fmt.Errorf("Cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))
+				deleteErrs = append(deleteErrs, fmt.Errorf("cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))
 			}
 			if result == nova.CellDeleteComplete {
 				Log.Info("Cell deleted", "cell", cr.Spec.CellName)
@@ -1027,7 +1027,7 @@ func (r *NovaReconciler) ensureNovaManageJobSecret(
 	)
 
 	var tlsCfg *tls.Service
-	if instance.Spec.APIServiceTemplate.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.APIServiceTemplate.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 
@@ -1601,7 +1601,7 @@ func (r *NovaReconciler) ensureDBDeletion(
 	for _, novaDb := range novaDbs {
 		dbName, accountName := novaDb[0], novaDb[1]
 
-		err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.ObjectMeta.Namespace)
+		err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.Namespace)
 		if err != nil {
 			return err
 		}
diff --git a/controllers/novaapi_controller.go b/controllers/novaapi_controller.go
@@ -278,7 +278,7 @@ func (r *NovaAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 					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(
@@ -303,7 +303,7 @@ func (r *NovaAPIReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 				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(
@@ -535,7 +535,7 @@ func (r *NovaAPIReconciler) generateConfigs(
 	templateParameters["VHosts"] = httpdVhostConfig
 
 	var tlsCfg *tls.Service
-	if instance.Spec.TLS.Ca.CaBundleSecretName != "" {
+	if instance.Spec.TLS.CaBundleSecretName != "" {
 		tlsCfg = &tls.Service{}
 	}
 
diff --git a/controllers/novacompute_controller.go b/controllers/novacompute_controller.go
@@ -59,7 +59,7 @@ type NovaComputeReconciler struct {
 	ReconcilerBase
 }
 
-// GetLOgger returns a logger object with a prefix of "controller.name" and additional controller context fields
+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields
 func (r *NovaComputeReconciler) GetLogger(ctx context.Context) logr.Logger {
 	return log.FromContext(ctx).WithName("Controllers").WithName("NovaCompute")
 }
@@ -219,7 +219,7 @@ func (r *NovaComputeReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 					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(
diff --git a/controllers/novaconductor_controller.go b/controllers/novaconductor_controller.go
@@ -240,7 +240,7 @@ func (r *NovaConductorReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 					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(
diff --git a/controllers/novametadata_controller.go b/controllers/novametadata_controller.go
@@ -255,7 +255,7 @@ func (r *NovaMetadataReconciler) Reconcile(ctx context.Context, req ctrl.Request
 					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(
@@ -281,7 +281,7 @@ func (r *NovaMetadataReconciler) Reconcile(ctx context.Context, req ctrl.Request
 					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(
@@ -535,7 +535,7 @@ func (r *NovaMetadataReconciler) generateConfigs(
 	}
 
 	// create httpd tls template parameters
-	if instance.Spec.TLS.GenericService.Enabled() {
+	if instance.Spec.TLS.Enabled() {
 		templateParameters["tls"] = true
 		templateParameters["SSLCertificateFile"] = fmt.Sprintf("/etc/pki/tls/certs/%s.crt", novametadata.ServiceName)
 		templateParameters["SSLCertificateKeyFile"] = fmt.Sprintf("/etc/pki/tls/private/%s.key", novametadata.ServiceName)
diff --git a/controllers/novanovncproxy_controller.go b/controllers/novanovncproxy_controller.go
@@ -234,7 +234,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					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(
@@ -260,7 +260,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					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(
@@ -283,7 +283,7 @@ func (r *NovaNoVNCProxyReconciler) Reconcile(ctx context.Context, req ctrl.Reque
 					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(
diff --git a/controllers/novascheduler_controller.go b/controllers/novascheduler_controller.go
@@ -241,7 +241,7 @@ func (r *NovaSchedulerReconciler) Reconcile(ctx context.Context, req ctrl.Reques
 					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(
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 nova-operator controller manager.
 package main
 
 import (
diff --git a/pkg/nova/celldelete.go b/pkg/nova/celldelete.go
@@ -1,3 +1,4 @@
+// Package nova contains common Nova service functionality and utilities.
 package nova
 
 import (
@@ -10,6 +11,7 @@ import (
 	novav1 "github.com/openstack-k8s-operators/nova-operator/api/v1beta1"
 )
 
+// CellDeleteJob creates a Kubernetes job to delete a Nova cell
 func CellDeleteJob(
 	instance *novav1.Nova,
 	cell *novav1.NovaCell,
diff --git a/pkg/nova/cellmapping.go b/pkg/nova/cellmapping.go
@@ -10,6 +10,7 @@ import (
 	novav1 "github.com/openstack-k8s-operators/nova-operator/api/v1beta1"
 )
 
+// CellMappingJob creates a Kubernetes job to create Nova cell mappings
 func CellMappingJob(
 	instance *novav1.Nova,
 	cell *novav1.NovaCell,
diff --git a/pkg/nova/common.go b/pkg/nova/common.go
@@ -66,6 +66,7 @@ const (
 	MQCompleted MessageBusStatus = iota
 )
 
+// CellDeploymentStatus represents the deployment status of a Nova cell
 type CellDeploymentStatus int
 
 // CellDeploymentStatus -
diff --git a/pkg/nova/host_discover.go b/pkg/nova/host_discover.go
@@ -12,6 +12,7 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 */
+
 package nova
 
 import (
@@ -24,6 +25,7 @@ import (
 	"k8s.io/utils/ptr"
 )
 
+// HostDiscoveryJob creates a Kubernetes job to discover Nova compute hosts
 func HostDiscoveryJob(
 	instance *novav1.NovaCell,
 	configName string,
diff --git a/pkg/nova/volumes.go b/pkg/nova/volumes.go
@@ -31,6 +31,7 @@ var (
 	scriptMode int32 = 0740
 )
 
+// GetConfigVolumeMount returns a volume mount for Nova configuration files
 func GetConfigVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      configVolume,
@@ -39,6 +40,7 @@ func GetConfigVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetKollaConfigVolumeMount returns a volume mount for Kolla configuration files
 func GetKollaConfigVolumeMount(serviceName string) corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      configVolume,
@@ -48,6 +50,7 @@ func GetKollaConfigVolumeMount(serviceName string) corev1.VolumeMount {
 	}
 }
 
+// GetConfigVolume returns a volume for Nova configuration files from a secret
 func GetConfigVolume(secretName string) corev1.Volume {
 	return corev1.Volume{
 		Name: configVolume,
@@ -60,6 +63,7 @@ func GetConfigVolume(secretName string) corev1.Volume {
 	}
 }
 
+// GetLogVolumeMount returns a volume mount for Nova log files
 func GetLogVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      logVolume,
@@ -68,6 +72,7 @@ func GetLogVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetLogVolume returns an empty directory volume for Nova log files
 func GetLogVolume() corev1.Volume {
 	return corev1.Volume{
 		Name: logVolume,
@@ -77,6 +82,7 @@ func GetLogVolume() corev1.Volume {
 	}
 }
 
+// GetScriptVolumeMount returns a volume mount for Nova script files
 func GetScriptVolumeMount() corev1.VolumeMount {
 	return corev1.VolumeMount{
 		Name:      scriptVolume,
@@ -85,6 +91,7 @@ func GetScriptVolumeMount() corev1.VolumeMount {
 	}
 }
 
+// GetScriptVolume returns a volume for Nova script files from a secret
 func GetScriptVolume(secretName string) corev1.Volume {
 	return corev1.Volume{
 		Name: scriptVolume,
diff --git a/pkg/novaapi/const.go b/pkg/novaapi/const.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novaapi contains Nova API service configuration and deployment functionality.
 package novaapi
 
 const (
diff --git a/pkg/novacompute/deployment.go b/pkg/novacompute/deployment.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novacompute contains Nova Compute service deployment functionality.
 package novacompute
 
 import (
diff --git a/pkg/novaconductor/dbpurge.go b/pkg/novaconductor/dbpurge.go
@@ -1,3 +1,4 @@
+// Package novaconductor contains Nova Conductor service deployment and management functionality.
 package novaconductor
 
 import (
@@ -15,6 +16,7 @@ import (
 	"github.com/openstack-k8s-operators/nova-operator/pkg/nova"
 )
 
+// DBPurgeCronJob creates a Kubernetes CronJob for purging old Nova database records
 func DBPurgeCronJob(
 	instance *novav1.NovaConductor,
 	labels map[string]string,
diff --git a/pkg/novametadata/const.go b/pkg/novametadata/const.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novametadata contains Nova Metadata service configuration and deployment functionality.
 package novametadata
 
 const (
diff --git a/pkg/novametadata/deployment.go b/pkg/novametadata/deployment.go
@@ -70,7 +70,7 @@ func StatefulSet(
 		Port: intstr.IntOrString{Type: intstr.Int, IntVal: int32(APIServicePort)},
 	}
 
-	if instance.Spec.TLS.GenericService.Enabled() {
+	if instance.Spec.TLS.Enabled() {
 		livenessProbe.HTTPGet.Scheme = corev1.URISchemeHTTPS
 		readinessProbe.HTTPGet.Scheme = corev1.URISchemeHTTPS
 		startupProbe.HTTPGet.Scheme = corev1.URISchemeHTTPS
@@ -108,8 +108,8 @@ func StatefulSet(
 		volumeMounts = append(volumeMounts, memcached.CreateMTLSVolumeMounts(nil, nil)...)
 	}
 
-	if instance.Spec.TLS.GenericService.Enabled() {
-		svc, err := instance.Spec.TLS.GenericService.ToService()
+	if instance.Spec.TLS.Enabled() {
+		svc, err := instance.Spec.TLS.ToService()
 		if err != nil {
 			return nil, err
 		}
diff --git a/pkg/novascheduler/deployment.go b/pkg/novascheduler/deployment.go
@@ -14,6 +14,7 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novascheduler contains Nova Scheduler service deployment functionality.
 package novascheduler
 
 import (
diff --git a/pkg/novncproxy/const.go b/pkg/novncproxy/const.go
@@ -14,13 +14,16 @@ See the License for the specific language governing permissions and
 limitations under the License.
 */
 
+// Package novncproxy contains Nova noVNC proxy service configuration and deployment functionality.
 package novncproxy
 
 const (
 	//NoVNCProxyPort - The port the nova-noVNCProxyPort service is exposed on
 	NoVNCProxyPort = 6080
 	// ServiceName - The name of the service exposed to k8s
-	ServiceName  = "nova-novncproxy"
-	Host         = "::0"
+	ServiceName = "nova-novncproxy"
+	// Host is the default host address for noVNC proxy to bind to
+	Host = "::0"
+	// VencryptName is the name used for VeNCrypt encryption
 	VencryptName = "vencrypt"
 )
diff --git a/test/functional/api_fixture.go b/test/functional/api_fixture.go
diff --git a/test/functional/nova_multicell_test.go b/test/functional/nova_multicell_test.go
diff --git a/test/functional/nova_reconfiguration_test.go b/test/functional/nova_reconfiguration_test.go
diff --git a/test/functional/novacell_controller_test.go b/test/functional/novacell_controller_test.go
diff --git a/test/functional/sample_test.go b/test/functional/sample_test.go
diff --git a/test/functional/suite_test.go b/test/functional/suite_test.go

Original file line number	Diff line number	Diff line change
`@@ -686,7 +686,7 @@ func (r *NovaReconciler) Reconcile(ctx context.Context, req ctrl.Request) (resul`
`686`	`686`	`cr.Spec.CellName, apiTransportURL,`
`687`	`687`	`secret, apiDB, cellDBs[novav1.Cell0Name].Database.GetDatabaseHostname(), cells[novav1.Cell0Name])`
`688`	`688`	`if err != nil {`
`689`		`- deleteErrs = append(deleteErrs, fmt.Errorf("Cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))`
	`689`	`+ deleteErrs = append(deleteErrs, fmt.Errorf("cell '%s' deletion failed, because: %w", cr.Spec.CellName, err))`
`690`	`690`	`}`
`691`	`691`	`if result == nova.CellDeleteComplete {`
`692`	`692`	`Log.Info("Cell deleted", "cell", cr.Spec.CellName)`
`@@ -1027,7 +1027,7 @@ func (r *NovaReconciler) ensureNovaManageJobSecret(`
`1027`	`1027`	`)`
`1028`	`1028`
`1029`	`1029`	`var tlsCfg *tls.Service`
`1030`		`- if instance.Spec.APIServiceTemplate.TLS.Ca.CaBundleSecretName != "" {`
	`1030`	`+ if instance.Spec.APIServiceTemplate.TLS.CaBundleSecretName != "" {`
`1031`	`1031`	`tlsCfg = &tls.Service{}`
`1032`	`1032`	`}`
`1033`	`1033`
`@@ -1601,7 +1601,7 @@ func (r *NovaReconciler) ensureDBDeletion(`
`1601`	`1601`	`for _, novaDb := range novaDbs {`
`1602`	`1602`	`dbName, accountName := novaDb[0], novaDb[1]`
`1603`	`1603`
`1604`		`- err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.ObjectMeta.Namespace)`
	`1604`	`+ err := mariadbv1.DeleteDatabaseAndAccountFinalizers(ctx, h, dbName, accountName, instance.Namespace)`
`1605`	`1605`	`if err != nil {`
`1606`	`1606`	`return err`
`1607`	`1607`	`}`
Original file line number	Diff line number	Diff line change
`@@ -59,7 +59,7 @@ type NovaComputeReconciler struct {`
`59`	`59`	`ReconcilerBase`
`60`	`60`	`}`
`61`	`61`
`62`		`-// GetLOgger returns a logger object with a prefix of "controller.name" and additional controller context fields`
	`62`	`+// GetLogger returns a logger object with a prefix of "controller.name" and additional controller context fields`
`63`	`63`	`func (r *NovaComputeReconciler) GetLogger(ctx context.Context) logr.Logger {`
`64`	`64`	`return log.FromContext(ctx).WithName("Controllers").WithName("NovaCompute")`
`65`	`65`	`}`
`@@ -219,7 +219,7 @@ func (r *NovaComputeReconciler) Reconcile(ctx context.Context, req ctrl.Request)`
`219`	`219`	`condition.TLSInputReadyCondition,`
`220`	`220`	`condition.RequestedReason,`
`221`	`221`	`condition.SeverityInfo,`
`222`		`- fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))`
	`222`	`+ condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))`
`223`	`223`	`return ctrl.Result{}, nil`
`224`	`224`	`}`
`225`	`225`	`instance.Status.Conditions.Set(condition.FalseCondition(`
Original file line number	Diff line number	Diff line change
`@@ -240,7 +240,7 @@ func (r *NovaConductorReconciler) Reconcile(ctx context.Context, req ctrl.Reques`
`240`	`240`	`condition.TLSInputReadyCondition,`
`241`	`241`	`condition.RequestedReason,`
`242`	`242`	`condition.SeverityInfo,`
`243`		`- fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))`
	`243`	`+ condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))`
`244`	`244`	`return ctrl.Result{}, nil`
`245`	`245`	`}`
`246`	`246`	`instance.Status.Conditions.Set(condition.FalseCondition(`
Original file line number	Diff line number	Diff line change
`@@ -241,7 +241,7 @@ func (r *NovaSchedulerReconciler) Reconcile(ctx context.Context, req ctrl.Reques`
`241`	`241`	`condition.TLSInputReadyCondition,`
`242`	`242`	`condition.RequestedReason,`
`243`	`243`	`condition.SeverityInfo,`
`244`		`- fmt.Sprintf(condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName)))`
	`244`	`+ condition.TLSInputReadyWaitingMessage, instance.Spec.TLS.CaBundleSecretName))`
`245`	`245`	`return ctrl.Result{}, nil`
`246`	`246`	`}`
`247`	`247`	`instance.Status.Conditions.Set(condition.FalseCondition(`