Add codespell hook to precommit

ratailor · openshift-merge-bot[bot] · commit 46fa2382e197 · 2025-07-11T12:02:47.000Z
This change adds codespell hook in precommit.

This change also fixes typos in code in job-name, echo message,
function name and comments etc.
diff --git a/.codespell.ignore b/.codespell.ignore
@@ -0,0 +1 @@
+aNULL
diff --git a/.github/workflows/build-operator-dont-publish.yaml b/.github/workflows/build-operator-dont-publish.yaml
@@ -6,7 +6,7 @@ on:
       - '*'
 
 jobs:
-  build-nova-operator-with-bunlde-and-index:
+  build-nova-operator-with-bundle-and-index:
     name: Build
     runs-on: ubuntu-latest
 
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -76,6 +76,12 @@ repos:
       # E020: Function declaration not in format ^function name {$
       # E012: here doc didn't end before EOF
 
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.4.1
+  hooks:
+    - id: codespell
+      args: ['--ignore-words=.codespell.ignore']
+
 - repo: https://github.com/golangci/golangci-lint
   rev: v1.59.1
   hooks:
diff --git a/.zuul.yaml b/.zuul.yaml
@@ -8,7 +8,7 @@
     description: |
       This job deploy a basic "Compute Starter Kit" topology
       https://www.openstack.org/software/sample-configs#compute-starter-kit
-      that is the minium set of openstack services required to boot a vm.
+      that is the minimum set of openstack services required to boot a vm.
     post-run:
       - ci/nova-operator-base/playbooks/collect-logs.yaml
     vars:
@@ -163,8 +163,8 @@
       # test_server_detach_rules and test_old_versions_reject are blocked by the requirement
       # to use service tokens to authenticate with cinder when a volume is attached to a server
       # as such the tests are not valid following CVE-2023-2088
-      # test_encrypted_cinder_volumes_cryptsetup use encyption format plain which is either
-      # not supported by ceph or a volume type that supprots it is not available.
+      # test_encrypted_cinder_volumes_cryptsetup use encryption format plain which is either
+      # not supported by ceph or a volume type that supports it is not available.
       # luks support is enabled and we are testing encrypted volumes with luks.
       # tempest.scenario.test_network_v6 is disabled as it is 8 slow test case
       # that does not cover nova functionality. Also we keep running it in
diff --git a/Makefile b/Makefile
@@ -421,7 +421,7 @@ kuttl-test-cleanup:
 		oc delete --wait=true --all=true -n $(KUTTL_NAMESPACE) --timeout=120s OpenStackControlPlane; \
 		oc delete --wait=true namespace $(KUTTL_NAMESPACE); \
 	else \
-		echo "Namespce already cleaned up. Nothing to do"; \
+		echo "Namespace already cleaned up. Nothing to do"; \
 	fi
 
 CRD_SCHEMA_CHECKER_VERSION ?= release-4.16
diff --git a/README.md b/README.md
@@ -6,12 +6,12 @@ A golang operator for openstack nova lifecycle management
 
 The goal of nova-operator is to manage custom resource that define a nova control plane (CRD).
 Nova operator continuously monitors the state of Nova CR and takes actions to ensure that the desired state is applied and reflected in nova pods. These pods run actual nova services, nova-operators ensure they are deployed, scaled, and configured correctly.
-**Note:** Nova CR is created by openstack-operator as per user intial deployment.
+**Note:** Nova CR is created by openstack-operator as per user initial deployment.
 
 ## Description
 
 This operator is built using the operator-sdk framework to provide day one and day two
-lifecycle managment of the OpenStack nova service on an OpenShift cluster.
+lifecycle management of the OpenStack nova service on an OpenShift cluster.
 
 ## Getting Started
 
@@ -30,7 +30,7 @@ pre-commit is optional but recommend to ensure good git hygiene.
 sudo dnf install -y golang
 ```
 
-#### installing in a virutal env
+#### installing in a virtual env
 
 ```sh
 python3 -m venv .venv
@@ -93,7 +93,7 @@ trim trailing whitespace.................................................Passed
 
 ### Running kuttl tests
 
-Kuttl testing requires some inital setup on the host to enable running them.
+Kuttl testing requires some initial setup on the host to enable running them.
 first the kuttl oc/kubectl plugin need to be installed, that is done via using
 the krew plugin manager. kuttl testing in this repo will never install or modify
 operators in the test cloud. that means that you can run them in the openshift
@@ -143,7 +143,7 @@ cd ..
 make openstack
 ```
 note: we will use the `crc-csi-hostpath-provisioner` storage class so "make crc_storage"
-is not required but it wont break anything either.
+is not required but it won't break anything either.
 
 4. prepare kuttl deps
 
diff --git a/api/bases/nova.openstack.org_novaapis.yaml b/api/bases/nova.openstack.org_novaapis.yaml
@@ -503,7 +503,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/bases/nova.openstack.org_novacells.yaml b/api/bases/nova.openstack.org_novacells.yaml
@@ -1110,7 +1110,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
             type: object
diff --git a/api/bases/nova.openstack.org_novacomputes.yaml b/api/bases/nova.openstack.org_novacomputes.yaml
@@ -287,7 +287,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/bases/nova.openstack.org_novaconductors.yaml b/api/bases/nova.openstack.org_novaconductors.yaml
@@ -329,7 +329,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/bases/nova.openstack.org_novametadata.yaml b/api/bases/nova.openstack.org_novametadata.yaml
@@ -479,7 +479,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/bases/nova.openstack.org_novanovncproxies.yaml b/api/bases/nova.openstack.org_novanovncproxies.yaml
@@ -459,7 +459,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/bases/nova.openstack.org_novaschedulers.yaml b/api/bases/nova.openstack.org_novaschedulers.yaml
@@ -307,7 +307,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/api/v1beta1/conditions.go b/api/v1beta1/conditions.go
@@ -123,7 +123,7 @@ const (
 	NovaAllCellsMQReadyErrorMessage = "Message bus creation failed for %s"
 
 	// NovaAllCellsMQReadyMessage
-	NovaAllCellsMQReadyMessage = "All message busses created successfully"
+	NovaAllCellsMQReadyMessage = "All message buses created successfully"
 
 	// NovaSchedulerReadyInitMessage
 	NovaSchedulerReadyInitMessage = "NovaScheduler not started"
diff --git a/api/v1beta1/nova_types.go b/api/v1beta1/nova_types.go
@@ -135,7 +135,7 @@ type NovaSpecCore struct {
 
 // NovaSpec defines the desired state of Nova
 type NovaSpec struct {
-	// NOTE(bogdando): Anything that is only submitted by opentack-operator should be in NovaSpec but not in NovaSpecCore.
+	// NOTE(bogdando): Anything that is only submitted by openstack-operator should be in NovaSpec but not in NovaSpecCore.
 
 	// +kubebuilder:validation:Required
 	NovaSpecCore `json:",inline"`
diff --git a/api/v1beta1/novaapi_types.go b/api/v1beta1/novaapi_types.go
@@ -195,7 +195,7 @@ type NovaAPIStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/api/v1beta1/novacell_types.go b/api/v1beta1/novacell_types.go
@@ -269,7 +269,7 @@ type NovaCellStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 }
 
diff --git a/api/v1beta1/novacompute_types.go b/api/v1beta1/novacompute_types.go
@@ -144,7 +144,7 @@ type NovaComputeStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/api/v1beta1/novaconductor_types.go b/api/v1beta1/novaconductor_types.go
@@ -159,7 +159,7 @@ type NovaConductorStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/api/v1beta1/novametadata_types.go b/api/v1beta1/novametadata_types.go
@@ -213,7 +213,7 @@ type NovaMetadataStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/api/v1beta1/novanovncproxy_types.go b/api/v1beta1/novanovncproxy_types.go
@@ -189,7 +189,7 @@ type NovaNoVNCProxyStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/api/v1beta1/novascheduler_types.go b/api/v1beta1/novascheduler_types.go
@@ -149,7 +149,7 @@ type NovaSchedulerStatus struct {
 	// ObservedGeneration - the most recent generation observed for this
 	// service. If the observed generation is less than the spec generation,
 	// then the controller has not processed the latest changes injected by
-	// the opentack-operator in the top-level CR (e.g. the ContainerImage)
+	// the openstack-operator in the top-level CR (e.g. the ContainerImage)
 	ObservedGeneration int64 `json:"observedGeneration,omitempty"`
 
 	// LastAppliedTopology - the last applied Topology
diff --git a/ci/nova-operator-tempest-multinode-ceph/ci_fw_vars.yaml b/ci/nova-operator-tempest-multinode-ceph/ci_fw_vars.yaml
@@ -13,7 +13,7 @@ pre_deploy:
     type: playbook
     source: control_plane_hci_pre_deploy.yml
 
-# note by defualt the source for the playbook specified
+# note by default the source for the playbook specified
 # in the hooks is relative to
 # https://github.com/openstack-k8s-operators/ci-framework/tree/main/hooks/playbooks
 # if you want to use a different source you can use the full path on the ansible controller
@@ -39,7 +39,7 @@ pre_tests:
 
 cifmw_run_tests: true
 cifmw_tempest_container: openstack-tempest-extras
-# we do not want the ci framwork trying to enbable any
+# we do not want the ci framework trying to enable any
 # tempest groups by default we will manage all tempest execution
 # via the job definition.
 cifmw_tempest_default_groups: []
diff --git a/config/crd/bases/nova.openstack.org_novaapis.yaml b/config/crd/bases/nova.openstack.org_novaapis.yaml
@@ -503,7 +503,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/crd/bases/nova.openstack.org_novacells.yaml b/config/crd/bases/nova.openstack.org_novacells.yaml
@@ -1110,7 +1110,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
             type: object
diff --git a/config/crd/bases/nova.openstack.org_novacomputes.yaml b/config/crd/bases/nova.openstack.org_novacomputes.yaml
@@ -287,7 +287,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/crd/bases/nova.openstack.org_novaconductors.yaml b/config/crd/bases/nova.openstack.org_novaconductors.yaml
@@ -329,7 +329,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/crd/bases/nova.openstack.org_novametadata.yaml b/config/crd/bases/nova.openstack.org_novametadata.yaml
@@ -479,7 +479,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/crd/bases/nova.openstack.org_novanovncproxies.yaml b/config/crd/bases/nova.openstack.org_novanovncproxies.yaml
@@ -459,7 +459,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/crd/bases/nova.openstack.org_novaschedulers.yaml b/config/crd/bases/nova.openstack.org_novaschedulers.yaml
@@ -307,7 +307,7 @@ spec:
                   ObservedGeneration - the most recent generation observed for this
                   service. If the observed generation is less than the spec generation,
                   then the controller has not processed the latest changes injected by
-                  the opentack-operator in the top-level CR (e.g. the ContainerImage)
+                  the openstack-operator in the top-level CR (e.g. the ContainerImage)
                 format: int64
                 type: integer
               readyCount:
diff --git a/config/samples/nova_v1beta1_nova-multi-cell.yaml b/config/samples/nova_v1beta1_nova-multi-cell.yaml
@@ -50,7 +50,7 @@ spec:
       cellDatabaseInstance: openstack
       cellDatabaseAccount: nova-cell0
       cellMessageBusInstance: rabbitmq
-      # cell0 alway needs access to the API DB and MQ as it hosts the super
+      # cell0 always needs access to the API DB and MQ as it hosts the super
       # conductor. It will inherit the API DB and MQ access from the Nova CR
       # that creates it.
       hasAPIAccess: true
diff --git a/controllers/novaapi_controller.go b/controllers/novaapi_controller.go
@@ -521,7 +521,7 @@ func (r *NovaAPIReconciler) generateConfigs(
 	for _, endpt := range []service.Endpoint{service.EndpointInternal, service.EndpointPublic} {
 		endptConfig := map[string]interface{}{}
 		endptConfig["ServerName"] = fmt.Sprintf("nova-%s.%s.svc", endpt.String(), instance.Namespace)
-		endptConfig["tls"] = false // default TLS to false, and set it bellow to true if enabled
+		endptConfig["tls"] = false // default TLS to false, and set it below to true if enabled
 		endptConfig["TimeOut"] = instance.Spec.APITimeout
 		if instance.Spec.TLS.API.Enabled(endpt) {
 			templateParameters["tls"] = true
diff --git a/controllers/novacell_controller.go b/controllers/novacell_controller.go
@@ -949,7 +949,7 @@ func (r *NovaCellReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		Owns(&novav1.NovaMetadata{}).
 		Owns(&novav1.NovaNoVNCProxy{}).
 		Owns(&novav1.NovaCompute{}).
-		// It generates and therefor owns the compute config secret
+		// It generates and therefore owns the compute config secret
 		Owns(&corev1.Secret{}).
 		// watch the input secrets
 		Watches(
diff --git a/templates/nova-manage/bin/delete_cell.sh b/templates/nova-manage/bin/delete_cell.sh
@@ -18,7 +18,7 @@ set -xe
 export CELL_NAME=${CELL_NAME:?"Please specify a CELL_NAME variable."}
 
 # NOTE(gibi): nova-manage should be enhanced upstream to get rid of this
-# uglyness
+# ugliness
 # Note the "|" around the CELL_NAME, that is needed as a single line from
 # nova-manage cell_v2 cell_list can match to multiple cells if the cell name
 # is part of the line, e.g. as the user name of the DB URL
diff --git a/templates/nova-manage/bin/ensure_cell_mapping.sh b/templates/nova-manage/bin/ensure_cell_mapping.sh
@@ -18,7 +18,7 @@ set -xe
 export CELL_NAME=${CELL_NAME:?"Please specify a CELL_NAME variable."}
 
 # NOTE(gibi): nova-manage should be enhanced upstream to get rid of this
-# uglyness
+# ugliness
 # Note the "|" around the CELL_NAME, that is needed as a single line from
 # nova-manage cell_v2 cell_list can match to multiple cells if the cell name
 # is part of the line, e.g. as the user name of the DB URL
@@ -30,7 +30,7 @@ if [ -z "${cell_uuid}" ]; then
         # NOTE(gibi): cell_v2 map_cell0 command above blindly appended _cell0 to the end
         # of the DB URL found in the configuration and ended up with nova_cell0_cell0 which
         # is invalid. This is an nova upstream bug to fix. But we can workaround it as
-        # update_cell does have the corret behavior when collecting the cell mapping information
+        # update_cell does have the correct behavior when collecting the cell mapping information
         # from the nova.conf
         nova-manage cell_v2 update_cell --cell_uuid 00000000-0000-0000-0000-000000000000
     else
diff --git a/templates/nova.conf b/templates/nova.conf
diff --git a/templates/novaconductor/bin/dbpurge.sh b/templates/novaconductor/bin/dbpurge.sh
diff --git a/test/functional/base_test.go b/test/functional/base_test.go
diff --git a/test/functional/nova_controller_test.go b/test/functional/nova_controller_test.go
diff --git a/test/functional/nova_scheduler_test.go b/test/functional/nova_scheduler_test.go
diff --git a/test/functional/novaapi_controller_test.go b/test/functional/novaapi_controller_test.go
diff --git a/test/functional/suite_test.go b/test/functional/suite_test.go
diff --git a/test/kuttl/test-suites/default/cell-tests/01-assert.yaml b/test/kuttl/test-suites/default/cell-tests/01-assert.yaml
diff --git a/test/kuttl/test-suites/default/cell-tests/02-assert.yaml b/test/kuttl/test-suites/default/cell-tests/02-assert.yaml
diff --git a/test/kuttl/test-suites/default/config-tests/01-assert.yaml b/test/kuttl/test-suites/default/config-tests/01-assert.yaml
diff --git a/test/kuttl/test-suites/default/config-tests/02-assert.yaml b/test/kuttl/test-suites/default/config-tests/02-assert.yaml
diff --git a/test/kuttl/test-suites/default/scale-tests/01-assert.yaml b/test/kuttl/test-suites/default/scale-tests/01-assert.yaml
