Use conditions from lib-common

Signed-off-by: Fabricio Aguiar <[email protected]>
openstack-k8s-operators · May 23, 2024 · c6e11d8 · c6e11d8
1 parent f9f5ecd
commit c6e11d8
Show file tree

Hide file tree

Showing 7 changed files with 48 additions and 96 deletions.
diff --git a/README.md b/README.md
@@ -113,7 +113,7 @@ You can get the OpenStackAnsibleEE resource created with the `oc get openstackan
 ```bash
 $ oc get osaee
 NAME                       NETWORKATTACHMENTS   STATUS   MESSAGE
-ansibleee-playbook-local                        True     AnsibleExecutionJob complete
+ansibleee-playbook-local                        True     Job completed
 ```
 
 After knowing the name of the OpenStackAnsibleEE resource, you can search for its pod by filtering the `openstackansibleee_cr` label.

diff --git a/api/v1beta1/conditions.go b/api/v1beta1/conditions.go
diff --git a/api/v1beta1/openstack_ansibleee_types.go b/api/v1beta1/openstack_ansibleee_types.go
@@ -182,7 +182,7 @@ func init() {
 
 // IsReady - returns true if the OpenStackAnsibleEE is ready
 func (instance OpenStackAnsibleEE) IsReady() bool {
-	return instance.Status.Conditions.IsTrue(AnsibleExecutionJobReadyCondition)
+	return instance.Status.Conditions.IsTrue(condition.JobReadyCondition)
 }
 
 // SetupDefaults - initializes any CRD field defaults based on environment variables (the defaulting mechanism itself is implemented via webhooks)

diff --git a/controllers/openstack_ansibleee_controller.go b/controllers/openstack_ansibleee_controller.go
@@ -134,7 +134,7 @@ func (r *OpenStackAnsibleEEReconciler) Reconcile(ctx context.Context, req ctrl.R
 
 	cl := condition.CreateList(
 		condition.UnknownCondition(condition.ReadyCondition, condition.InitReason, condition.ReadyInitMessage),
-		condition.UnknownCondition(ansibleeev1.AnsibleExecutionJobReadyCondition, condition.InitReason, ansibleeev1.AnsibleExecutionJobInitMessage),
+		condition.UnknownCondition(condition.JobReadyCondition, condition.InitReason, condition.JobReadyInitMessage),
 	)
 
 	instance.Status.Conditions.Init(&cl)
@@ -208,20 +208,20 @@ func (r *OpenStackAnsibleEEReconciler) Reconcile(ctx context.Context, req ctrl.R
 
 	if (ctrlResult != ctrl.Result{}) {
 		instance.Status.Conditions.Set(condition.FalseCondition(
-			ansibleeev1.AnsibleExecutionJobReadyCondition,
+			condition.JobReadyCondition,
 			condition.RequestedReason,
 			condition.SeverityInfo,
-			ansibleeev1.AnsibleExecutionJobWaitingMessage))
+			condition.JobReadyRunningMessage))
 		instance.Status.JobStatus = ansibleeev1.JobStatusRunning
 		return ctrlResult, nil
 	}
 
 	if err != nil {
 		instance.Status.Conditions.Set(condition.FalseCondition(
-			ansibleeev1.AnsibleExecutionJobReadyCondition,
+			condition.JobReadyCondition,
 			condition.ErrorReason,
 			condition.SeverityWarning,
-			ansibleeev1.AnsibleExecutionJobErrorMessage,
+			condition.JobReadyErrorMessage,
 			err.Error()))
 		instance.Status.JobStatus = ansibleeev1.JobStatusFailed
 		return ctrl.Result{}, err
@@ -232,7 +232,7 @@ func (r *OpenStackAnsibleEEReconciler) Reconcile(ctx context.Context, req ctrl.R
 		Log.Info(fmt.Sprintf("AnsibleEE CR '%s' - Job %s hash added - %s", instance.Name, jobDef.Name, instance.Status.Hash[ansibleeeJobType]))
 	}
 
-	instance.Status.Conditions.MarkTrue(ansibleeev1.AnsibleExecutionJobReadyCondition, ansibleeev1.AnsibleExecutionJobReadyMessage)
+	instance.Status.Conditions.MarkTrue(condition.JobReadyCondition, condition.JobReadyMessage)
 	instance.Status.JobStatus = ansibleeev1.JobStatusSucceeded
 
 	// We reached the end of the Reconcile, update the Ready condition based on

diff --git a/docs/assemblies/index.adoc b/docs/assemblies/index.adoc
@@ -126,7 +126,7 @@ You can get the OpenStackAnsibleEE resource created with the `oc get openstackan
 ----
 $ oc get osaee
 NAME                       NETWORKATTACHMENTS   STATUS   MESSAGE
-ansibleee-playbook-local                        True     AnsibleExecutionJob complete
+ansibleee-playbook-local                        True     Job completed
 ----
 
 After knowing the name of the OpenStackAnsibleEE resource, you can search for its pod by filtering the `openstackansibleee_cr` label.

diff --git a/tests/functional/ansibleee_controller_test.go b/tests/functional/ansibleee_controller_test.go
@@ -27,7 +27,6 @@ import (
 
 	//revive:disable-next-line:dot-imports
 	. "github.com/openstack-k8s-operators/lib-common/modules/common/test/helpers"
-	"github.com/openstack-k8s-operators/openstack-ansibleee-operator/api/v1beta1"
 )
 
 var _ = Describe("Ansibleee controller", func() {
@@ -40,10 +39,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -61,7 +60,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				th.ExpectCondition(
@@ -80,10 +79,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -102,10 +101,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.ErrorReason,
-					"AnsibleExecutionJob error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
+					"Job error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -123,10 +122,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -140,7 +139,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				ansibleee := GetAnsibleee(ansibleeeName)
@@ -163,10 +162,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				ansibleee = GetAnsibleee(ansibleeeName)
 				Expect(ansibleee.Status.JobStatus).To(Equal("Running"))
@@ -177,7 +176,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				ansibleee = GetAnsibleee(ansibleeeName)
@@ -197,10 +196,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -218,7 +217,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				th.ExpectCondition(
@@ -237,10 +236,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -259,10 +258,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.ErrorReason,
-					"AnsibleExecutionJob error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
+					"Job error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -328,10 +327,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -349,7 +348,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				th.ExpectCondition(
@@ -368,10 +367,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -390,10 +389,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.ErrorReason,
-					"AnsibleExecutionJob error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
+					"Job error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -476,10 +475,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -497,7 +496,7 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectCondition(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionTrue,
 				)
 				th.ExpectCondition(
@@ -516,10 +515,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -538,10 +537,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.ErrorReason,
-					"AnsibleExecutionJob error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
+					"Job error occurred Internal error occurred: Job Attempt #1 Failed. Check job logs",
 				)
 				th.ExpectCondition(
 					ansibleeeName,
@@ -569,10 +568,10 @@ var _ = Describe("Ansibleee controller", func() {
 				th.ExpectConditionWithDetails(
 					ansibleeeName,
 					ConditionGetterFunc(AnsibleeeConditionGetter),
-					v1beta1.AnsibleExecutionJobReadyCondition,
+					condition.JobReadyCondition,
 					corev1.ConditionFalse,
 					condition.RequestedReason,
-					"AnsibleExecutionJob is running",
+					"Job in progress",
 				)
 				marshalled := map[string]json.RawMessage{
 					"foo":  json.RawMessage([]byte("\"bar\"")),

diff --git a/tests/kuttl/tests/run_failed_playbook/01-assert.yaml b/tests/kuttl/tests/run_failed_playbook/01-assert.yaml
@@ -24,18 +24,18 @@ spec:
 status:
   JobStatus: Failed
   conditions:
-  - message: 'AnsibleExecutionJob error occurred Internal error occurred: Job has reached the specified backoff limit.
+  - message: 'Job error occurred Internal error occurred: Job has reached the specified backoff limit.
       Check job logs'
     reason: Error
     severity: Warning
     status: "False"
     type: Ready
-  - message: 'AnsibleExecutionJob error occurred Internal error occurred: Job has reached the specified backoff limit.
+  - message: 'Job error occurred Internal error occurred: Job has reached the specified backoff limit.
       Check job logs'
     reason: Error
     severity: Warning
     status: "False"
-    type: AnsibleExecutionJobReady
+    type: JobReady
 ---
 apiVersion: v1
 kind: Pod