Merge pull request #420 from kstrenkova/rename-workflow-step-vars

Rename workflow number variables for clarity

Author: openshift-merge-bot[bot]

internal/controller/ansibletest_controller.go

@@ -127,9 +127,9 @@ func (r *AnsibleTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	instance.Status.ObservedGeneration = instance.Generation
 
 	workflowLength := len(instance.Spec.Workflow)
-	nextAction, nextWorkflowStep, err := r.NextAction(ctx, instance, workflowLength)
-	if nextWorkflowStep < workflowLength {
-		MergeSections(&instance.Spec, instance.Spec.Workflow[nextWorkflowStep])
+	nextAction, workflowStepIndex, err := r.NextAction(ctx, instance, workflowLength)
+	if workflowStepIndex < workflowLength {
+		MergeSections(&instance.Spec, instance.Spec.Workflow[workflowStepIndex])
 	}
 
 	switch nextAction {
@@ -166,7 +166,7 @@ func (r *AnsibleTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, workflowStepIndex))
 
 	case CreateNextPod:
 		// Confirm that we still hold the lock. This is useful to check if for
@@ -178,15 +178,15 @@ func (r *AnsibleTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingNextPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingNextPod, workflowStepIndex))
 
 	default:
 		return ctrl.Result{}, ErrReceivedUnexpectedAction
 	}
 
 	serviceLabels := map[string]string{
 		common.AppSelector: ansibletest.ServiceName,
-		workflowStepLabel:  strconv.Itoa(nextWorkflowStep),
+		workflowStepLabel:  strconv.Itoa(workflowStepIndex),
 		instanceNameLabel:  instance.Name,
 		operatorNameLabel:  "test-operator",
 	}
@@ -221,7 +221,7 @@ func (r *AnsibleTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 
 	// Create a new pod
 	mountCerts := r.CheckSecretExists(ctx, instance, "combined-ca-bundle")
-	podName := r.GetPodName(instance, nextWorkflowStep)
+	podName := r.GetPodName(instance, workflowStepIndex)
 	envVars := r.PrepareAnsibleEnv(instance)
 	logsPVCName := r.GetPVCLogsName(instance, 0)
 	containerImage, err := r.GetContainerImage(ctx, instance)
@@ -236,7 +236,7 @@ func (r *AnsibleTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 		logsPVCName,
 		mountCerts,
 		envVars,
-		nextWorkflowStep,
+		workflowStepIndex,
 		containerImage,
 	)
 

internal/controller/common.go

@@ -333,12 +333,12 @@ func (r *Reconciler) GetPodName(instance interface{}, stepNum int) string {
 }
 
 // GetPVCLogsName returns the name of the PVC for logs for the given instance and workflow step
-func (r *Reconciler) GetPVCLogsName(instance client.Object, workflowStepNum int) string {
+func (r *Reconciler) GetPVCLogsName(instance client.Object, pvcIndex int) string {
 	instanceName := instance.GetName()
 	instanceCreationTimestamp := instance.GetCreationTimestamp().Format(time.UnixDate)
 	suffixLength := 5
 	nameSuffix := GetStringHash(instanceName+instanceCreationTimestamp, suffixLength)
-	workflowStep := strconv.Itoa(workflowStepNum)
+	workflowStep := strconv.Itoa(pvcIndex)
 	return instanceName + "-" + workflowStep + "-" + nameSuffix
 }
 
@@ -446,10 +446,10 @@ func (r *Reconciler) EnsureLogsPVCExists(
 	helper *helper.Helper,
 	labels map[string]string,
 	StorageClassName string,
-	workflowStepNum int,
+	pvcIndex int,
 ) (ctrl.Result, error) {
 	instanceNamespace := instance.GetNamespace()
-	pvcName := r.GetPVCLogsName(instance, workflowStepNum)
+	pvcName := r.GetPVCLogsName(instance, pvcIndex)
 
 	pvvc := &corev1.PersistentVolumeClaim{}
 	err := r.Client.Get(ctx, client.ObjectKey{Namespace: instanceNamespace, Name: pvcName}, pvvc)
@@ -591,9 +591,9 @@ func (r *Reconciler) ReleaseLock(ctx context.Context, instance client.Object) (b
 }
 
 // PodExists checks if a pod exists for the given instance and workflow step
-func (r *Reconciler) PodExists(ctx context.Context, instance client.Object, workflowStepNum int) bool {
+func (r *Reconciler) PodExists(ctx context.Context, instance client.Object, workflowStepIndex int) bool {
 	pod := &corev1.Pod{}
-	podName := r.GetPodName(instance, workflowStepNum)
+	podName := r.GetPodName(instance, workflowStepIndex)
 	objectKey := client.ObjectKey{Namespace: instance.GetNamespace(), Name: podName}
 	err := r.Client.Get(ctx, objectKey, pod)
 	if err != nil && k8s_errors.IsNotFound(err) {
@@ -678,11 +678,11 @@ func (r *Reconciler) VerifyNetworkAttachments(
 	instance client.Object,
 	networkAttachments []string,
 	serviceLabels map[string]string,
-	nextWorkflowStep int,
+	workflowStepIndex int,
 	conditions *condition.Conditions,
 	networkAttachmentStatus *map[string][]string,
 ) (ctrl.Result, error) {
-	if !r.PodExists(ctx, instance, nextWorkflowStep) {
+	if !r.PodExists(ctx, instance, workflowStepIndex) {
 		return ctrl.Result{}, nil
 	}
 

internal/controller/horizontest_controller.go

@@ -122,7 +122,7 @@ func (r *HorizonTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 	instance.Status.ObservedGeneration = instance.Generation
 
 	workflowLength := 0
-	nextAction, nextWorkflowStep, err := r.NextAction(ctx, instance, workflowLength)
+	nextAction, workflowStepIndex, err := r.NextAction(ctx, instance, workflowLength)
 
 	switch nextAction {
 	case Failure:
@@ -158,7 +158,7 @@ func (r *HorizonTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, workflowStepIndex))
 
 	case CreateNextPod:
 		// Confirm that we still hold the lock. This is useful to check if for
@@ -170,7 +170,7 @@ func (r *HorizonTestReconciler) Reconcile(ctx context.Context, req ctrl.Request)
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingNextPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingNextPod, workflowStepIndex))
 
 	default:
 		return ctrl.Result{}, ErrReceivedUnexpectedAction

internal/controller/tempest_controller.go

@@ -146,9 +146,9 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 	}
 
 	workflowLength := len(instance.Spec.Workflow)
-	nextAction, nextWorkflowStep, err := r.NextAction(ctx, instance, workflowLength)
-	if nextWorkflowStep < workflowLength {
-		MergeSections(&instance.Spec, instance.Spec.Workflow[nextWorkflowStep])
+	nextAction, workflowStepIndex, err := r.NextAction(ctx, instance, workflowLength)
+	if workflowStepIndex < workflowLength {
+		MergeSections(&instance.Spec, instance.Spec.Workflow[workflowStepIndex])
 	}
 
 	switch nextAction {
@@ -185,7 +185,7 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingFirstPod, workflowStepIndex))
 
 	case CreateNextPod:
 		// Confirm that we still hold the lock. This is useful to check if for
@@ -197,23 +197,23 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 			return ctrl.Result{RequeueAfter: RequeueAfterValue}, err
 		}
 
-		Log.Info(fmt.Sprintf(InfoCreatingNextPod, nextWorkflowStep))
+		Log.Info(fmt.Sprintf(InfoCreatingNextPod, workflowStepIndex))
 
 	default:
 		return ctrl.Result{}, ErrReceivedUnexpectedAction
 	}
 
 	serviceLabels := map[string]string{
 		common.AppSelector: tempest.ServiceName,
-		workflowStepLabel:  strconv.Itoa(nextWorkflowStep),
+		workflowStepLabel:  strconv.Itoa(workflowStepIndex),
 		instanceNameLabel:  instance.Name,
 		operatorNameLabel:  "test-operator",
 	}
 
-	workflowStepNum := 0
+	pvcIndex := 0
 	// Create multiple PVCs for parallel execution
-	if instance.Spec.Parallel && nextWorkflowStep < len(instance.Spec.Workflow) {
-		workflowStepNum = nextWorkflowStep
+	if instance.Spec.Parallel && workflowStepIndex < len(instance.Spec.Workflow) {
+		pvcIndex = workflowStepIndex
 	}
 
 	err = r.ValidateOpenstackInputs(ctx, instance, instance.Spec.OpenStackConfigMap, instance.Spec.OpenStackConfigSecret)
@@ -248,7 +248,7 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 		helper,
 		serviceLabels,
 		instance.Spec.StorageClass,
-		workflowStepNum,
+		pvcIndex,
 	)
 
 	if err != nil {
@@ -259,7 +259,7 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 	// Create PersistentVolumeClaim - end
 
 	// Generate ConfigMaps
-	err = r.generateServiceConfigMaps(ctx, helper, instance, nextWorkflowStep)
+	err = r.generateServiceConfigMaps(ctx, helper, instance, workflowStepIndex)
 	if err != nil {
 		instance.Status.Conditions.Set(condition.FalseCondition(
 			condition.ServiceConfigReadyCondition,
@@ -286,10 +286,10 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 
 	// Create a new pod
 	mountCerts := r.CheckSecretExists(ctx, instance, "combined-ca-bundle")
-	customDataConfigMapName := GetCustomDataConfigMapName(instance, nextWorkflowStep)
-	EnvVarsConfigMapName := GetEnvVarsConfigMapName(instance, nextWorkflowStep)
-	podName := r.GetPodName(instance, nextWorkflowStep)
-	logsPVCName := r.GetPVCLogsName(instance, workflowStepNum)
+	customDataConfigMapName := GetCustomDataConfigMapName(instance, workflowStepIndex)
+	EnvVarsConfigMapName := GetEnvVarsConfigMapName(instance, workflowStepIndex)
+	podName := r.GetPodName(instance, workflowStepIndex)
+	logsPVCName := r.GetPVCLogsName(instance, pvcIndex)
 	containerImage, err := r.GetContainerImage(ctx, instance)
 	if err != nil {
 		return ctrl.Result{}, err
@@ -341,7 +341,7 @@ func (r *TempestReconciler) Reconcile(ctx context.Context, req ctrl.Request) (re
 		instance,
 		instance.Spec.NetworkAttachments,
 		serviceLabels,
-		nextWorkflowStep,
+		workflowStepIndex,
 		&instance.Status.Conditions,
 		&instance.Status.NetworkAttachments,
 	)
@@ -385,7 +385,7 @@ func (r *TempestReconciler) SetupWithManager(mgr ctrl.Manager) error {
 func (r *TempestReconciler) setTempestConfigVars(envVars map[string]string,
 	customData map[string]string,
 	instance *testv1beta1.Tempest,
-	workflowStepNum int,
+	workflowStepIndex int,
 ) {
 	tRun := instance.Spec.TempestRun
 
@@ -421,7 +421,7 @@ func (r *TempestReconciler) setTempestConfigVars(envVars map[string]string,
 		})
 	}
 
-	envVars["TEMPEST_WORKFLOW_STEP_DIR_NAME"] = r.GetPodName(instance, workflowStepNum)
+	envVars["TEMPEST_WORKFLOW_STEP_DIR_NAME"] = r.GetPodName(instance, workflowStepIndex)
 
 	for _, img := range tRun.ExtraImages {
 		SetDictEnvVar(envVars, map[string]string{
@@ -509,7 +509,7 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 	ctx context.Context,
 	h *helper.Helper,
 	instance *testv1beta1.Tempest,
-	workflowStepNum int,
+	workflowStepIndex int,
 ) error {
 	// Create/update configmaps from template
 	cmLabels := labels.GetLabels(instance, labels.GetGroupLabel(tempest.ServiceName), map[string]string{})
@@ -528,7 +528,7 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 	customData := make(map[string]string)
 	envVars := make(map[string]string)
 
-	r.setTempestConfigVars(envVars, customData, instance, workflowStepNum)
+	r.setTempestConfigVars(envVars, customData, instance, workflowStepIndex)
 	r.setTempestconfConfigVars(envVars, customData, instance)
 
 	for key, data := range instance.Spec.ConfigOverwrite {
@@ -544,7 +544,7 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 	cms := []util.Template{
 		// ConfigMap
 		{
-			Name:          GetCustomDataConfigMapName(instance, workflowStepNum),
+			Name:          GetCustomDataConfigMapName(instance, workflowStepIndex),
 			Namespace:     instance.Namespace,
 			InstanceType:  instance.Kind,
 			Labels:        cmLabels,
@@ -553,7 +553,7 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 		},
 		// configMap - EnvVars
 		{
-			Name:          GetEnvVarsConfigMapName(instance, workflowStepNum),
+			Name:          GetEnvVarsConfigMapName(instance, workflowStepIndex),
 			Namespace:     instance.Namespace,
 			InstanceType:  instance.Kind,
 			Labels:        cmLabels,
@@ -566,11 +566,11 @@ func (r *TempestReconciler) generateServiceConfigMaps(
 }
 
 // GetEnvVarsConfigMapName returns the name of the environment variables ConfigMap for the given workflow step
-func GetEnvVarsConfigMapName(instance *testv1beta1.Tempest, workflowStepNum int) string {
-	return instance.Name + envVarsConfigMapInfix + strconv.Itoa(workflowStepNum)
+func GetEnvVarsConfigMapName(instance *testv1beta1.Tempest, workflowStepIndex int) string {
+	return instance.Name + envVarsConfigMapInfix + strconv.Itoa(workflowStepIndex)
 }
 
 // GetCustomDataConfigMapName returns the name of the custom data ConfigMap for the given workflow step
-func GetCustomDataConfigMapName(instance *testv1beta1.Tempest, workflowStepNum int) string {
-	return instance.Name + customDataConfigMapInfix + strconv.Itoa(workflowStepNum)
+func GetCustomDataConfigMapName(instance *testv1beta1.Tempest, workflowStepIndex int) string {
+	return instance.Name + customDataConfigMapInfix + strconv.Itoa(workflowStepIndex)
 }