Add debug mode for test-operator

This patch introduces an option for test-operator that keeps the pod
running even after a failure occured or after the file run_tempest.sh
has reached its end (sleep infinity). It resolves the issue that oc rsh
session is killed once the execution of the run_tempest.sh finishes.

Author: kstrenkova

api/bases/test.openstack.org_tempests.yaml

@@ -65,6 +65,14 @@ spec:
                 description: An URL of a tempest container image that should be used
                   for the execution of tempest tests.
                 type: string
+              debug:
+                default: false
+                description: Activate debug mode. When debug mode is activated any
+                  error encountered inside the test-pod causes that the pod will be
+                  kept alive indefinitely (stuck in "Running" phase) or until the
+                  corresponding Tempest CR is deleted. This allows the user to debug
+                  any potential troubles with `oc rsh`.
+                type: boolean
               networkAttachments:
                 description: NetworkAttachments is a list of NetworkAttachment resource
                   names to expose the services to the given network

api/v1beta1/tempest_types.go

@@ -346,6 +346,15 @@ type TempestSpec struct {
 	// spawned by the test operator.
 	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
 
+
+	// +kubebuilder:validation:Optional
+        // +kubebuilder:default=false
+        // Activate debug mode. When debug mode is activated any error encountered
+        // inside the test-pod causes that the pod will be kept alive indefinitely
+        // (stuck in "Running" phase) or until the corresponding Tempest CR is deleted.
+        // This allows the user to debug any potential troubles with `oc rsh`.
+        Debug bool `json:"debug,omitempty"`
+
 	// +kubebuilder:validation:Optional
 	// This value contains a toleration that is applied to pods spawned by the
 	// test pods that are spawned by the test-operator.

config/crd/bases/test.openstack.org_tempests.yaml

@@ -65,6 +65,14 @@ spec:
                 description: An URL of a tempest container image that should be used
                   for the execution of tempest tests.
                 type: string
+              debug:
+                default: false
+                description: Activate debug mode. When debug mode is activated any
+                  error encountered inside the test-pod causes that the pod will be
+                  kept alive indefinitely (stuck in "Running" phase) or until the
+                  corresponding Tempest CR is deleted. This allows the user to debug
+                  any potential troubles with `oc rsh`.
+                type: boolean
               networkAttachments:
                 description: NetworkAttachments is a list of NetworkAttachment resource
                   names to expose the services to the given network

config/samples/test_v1beta1_tempest.yaml

@@ -8,6 +8,7 @@ spec:
   containerImage: quay.io/podified-antelope-centos9/openstack-tempest:current-podified
   # storageClass: local-storage
   # parallel: false
+  # debug: false
 
   # configOverwrite
   # ---------------

controllers/tempest_controller.go

@@ -595,6 +595,8 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 	r.setTempestconfConfigVars(envVars, customData, instance, ctx, workflowStepNum)
 	r.setConfigOverwrite(customData, instance.Spec.ConfigOverwrite)
 
+	envVars["TEMPEST_DEBUG_MODE"] = r.GetDefaultBool(instance.Spec.Debug)
+
 	cms := []util.Template{
 		// ConfigMap
 		{