feat: Extend ApprovalTask with approval details

- Add `approvedBy` and `comment` fields to the `ApprovalTask` spec - Include `approvedBy`, `comment`, and `approve` fields in the `CustomRun` results
KubeRocketCI · Oct 7, 2024 · f8cb96f · f8cb96f
1 parent 12f089b
commit f8cb96f
Show file tree

Hide file tree

Showing 7 changed files with 167 additions and 5 deletions.
diff --git a/api/v1alpha1/approvaltask_types.go b/api/v1alpha1/approvaltask_types.go
@@ -25,6 +25,20 @@ type ApprovalTaskSpec struct {
 	// +optional
 	// +kubebuilder:default=Proceed
 	Description string `json:"description,omitempty"`
+
+	// Approve is the approval information.
+	// +optional
+	Approve *Approve `json:"approve,omitempty"`
+}
+
+type Approve struct {
+	// ApprovedBy is indicating the identity of the approver.
+	// +required
+	ApprovedBy string `json:"approvedBy"`
+
+	// Comment is the comment provided by the approver.
+	// +optional
+	Comment string `json:"comment,omitempty"`
 }
 
 type PipelineRef struct {

diff --git a/api/v1alpha1/zz_generated.deepcopy.go b/api/v1alpha1/zz_generated.deepcopy.go
diff --git a/config/crd/bases/edp.epam.com_approvaltasks.yaml b/config/crd/bases/edp.epam.com_approvaltasks.yaml
@@ -48,6 +48,18 @@ spec:
                 - Rejected
                 - Canceled
                 type: string
+              approve:
+                description: Approve is the approval information.
+                properties:
+                  approvedBy:
+                    description: ApprovedBy is indicating the identity of the approver.
+                    type: string
+                  comment:
+                    description: Comment is the comment provided by the approver.
+                    type: string
+                required:
+                - approvedBy
+                type: object
               description:
                 default: Proceed
                 description: Description that is shown to the user for the approval

diff --git a/deploy-templates/crds/edp.epam.com_approvaltasks.yaml b/deploy-templates/crds/edp.epam.com_approvaltasks.yaml
@@ -48,6 +48,18 @@ spec:
                 - Rejected
                 - Canceled
                 type: string
+              approve:
+                description: Approve is the approval information.
+                properties:
+                  approvedBy:
+                    description: ApprovedBy is indicating the identity of the approver.
+                    type: string
+                  comment:
+                    description: Comment is the comment provided by the approver.
+                    type: string
+                required:
+                - approvedBy
+                type: object
               description:
                 default: Proceed
                 description: Description that is shown to the user for the approval

diff --git a/docs/api.md b/docs/api.md
@@ -93,6 +93,13 @@ ApprovalTaskSpec defines the desired state of ApprovalTask
             <i>Default</i>: Pending<br/>
         </td>
         <td>false</td>
+      </tr><tr>
+        <td><b><a href="#approvaltaskspecapprove">approve</a></b></td>
+        <td>object</td>
+        <td>
+          Approve is the approval information.<br/>
+        </td>
+        <td>false</td>
       </tr><tr>
         <td><b>description</b></td>
         <td>string</td>
@@ -104,3 +111,37 @@ ApprovalTaskSpec defines the desired state of ApprovalTask
         <td>false</td>
       </tr></tbody>
 </table>
+
+
+### ApprovalTask.spec.approve
+<sup><sup>[↩ Parent](#approvaltaskspec)</sup></sup>
+
+
+
+Approve is the approval information.
+
+<table>
+    <thead>
+        <tr>
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+            <th>Required</th>
+        </tr>
+    </thead>
+    <tbody><tr>
+        <td><b>approvedBy</b></td>
+        <td>string</td>
+        <td>
+          ApprovedBy is indicating the identity of the approver.<br/>
+        </td>
+        <td>true</td>
+      </tr><tr>
+        <td><b>comment</b></td>
+        <td>string</td>
+        <td>
+          Comment is the comment provided by the approver.<br/>
+        </td>
+        <td>false</td>
+      </tr></tbody>
+</table>
diff --git a/internal/controller/customrun_controller.go b/internal/controller/customrun_controller.go
@@ -3,6 +3,7 @@ package controller
 import (
 	"context"
 	"fmt"
+	"strconv"
 	"time"
 
 	customTasksApi "github.com/KubeRocketCI/tekton-custom-task/api/v1alpha1"
@@ -96,11 +97,20 @@ func (r *ReconcileCustomRun) setRunningStatus(ctx context.Context, run *tektonPi
 	return nil
 }
 
-func (r *ReconcileCustomRun) setSucceededStatus(ctx context.Context, run *tektonPipelineApi.CustomRun) error {
+func (r *ReconcileCustomRun) setSucceededStatus(
+	ctx context.Context,
+	run *tektonPipelineApi.CustomRun,
+	results []tektonPipelineApi.CustomRunResult,
+) error {
 	now := metav1.Now()
 	run.Status.CompletionTime = &now
 	run.Status.MarkCustomRunSucceeded("Approved", "Pipeline run was approved")
 
+	run.Status.Results = append(
+		run.Status.Results,
+		results...,
+	)
+
 	if err := r.client.Status().Update(ctx, run); err != nil {
 		return fmt.Errorf("failed to update CustomRun status: %w", err)
 	}
@@ -112,9 +122,15 @@ func (r *ReconcileCustomRun) setFailedStatus(
 	ctx context.Context,
 	run *tektonPipelineApi.CustomRun,
 	reason, message string,
+	results []tektonPipelineApi.CustomRunResult,
 ) error {
 	run.Status.MarkCustomRunFailed(reason, message)
 
+	run.Status.Results = append(
+		run.Status.Results,
+		results...,
+	)
+
 	if err := r.client.Status().Update(ctx, run); err != nil {
 		return fmt.Errorf("failed to update CustomRun status: %w", err)
 	}
@@ -147,7 +163,7 @@ func (r *ReconcileCustomRun) processApprovalTask(ctx context.Context, run *tekto
 	if task.IsApproved() {
 		log.Info("ApprovalTask is approved")
 
-		if err = r.setSucceededStatus(ctx, run); err != nil {
+		if err = r.setSucceededStatus(ctx, run, getResults(task)); err != nil {
 			return err
 		}
 
@@ -157,7 +173,7 @@ func (r *ReconcileCustomRun) processApprovalTask(ctx context.Context, run *tekto
 	if task.IsRejected() {
 		log.Info("ApprovalTask is rejected")
 
-		if err = r.setFailedStatus(ctx, run, "Rejected", "Pipeline run was rejected"); err != nil {
+		if err = r.setFailedStatus(ctx, run, "Rejected", "Pipeline run was rejected", getResults(task)); err != nil {
 			return err
 		}
 
@@ -217,7 +233,7 @@ func (r *ReconcileCustomRun) cancelApprovalTask(ctx context.Context, run *tekton
 		log.Info("ApprovalTask canceled")
 	}
 
-	if err = r.setFailedStatus(ctx, run, "Canceled", "Pipeline run was canceled"); err != nil {
+	if err = r.setFailedStatus(ctx, run, "Canceled", "Pipeline run was canceled", getResults(task)); err != nil {
 		return err
 	}
 
@@ -305,3 +321,36 @@ func getApprovalTaskDescription(run *tektonPipelineApi.CustomRun) string {
 
 	return ""
 }
+
+func getResults(task *customTasksApi.ApprovalTask) []tektonPipelineApi.CustomRunResult {
+	if task == nil {
+		return []tektonPipelineApi.CustomRunResult{
+			{
+				Name:  "approved",
+				Value: "false",
+			},
+		}
+	}
+
+	r := []tektonPipelineApi.CustomRunResult{
+		{
+			Name:  "approved",
+			Value: strconv.FormatBool(task.IsApproved()),
+		},
+	}
+
+	if task.Spec.Approve != nil {
+		r = append(r,
+			tektonPipelineApi.CustomRunResult{
+				Name:  "approvedBy",
+				Value: task.Spec.Approve.ApprovedBy,
+			},
+			tektonPipelineApi.CustomRunResult{
+				Name:  "comment",
+				Value: task.Spec.Approve.Comment,
+			},
+		)
+	}
+
+	return r
+}
diff --git a/internal/controller/customrun_controller_test.go b/internal/controller/customrun_controller_test.go
@@ -75,6 +75,10 @@ var _ = Describe("CodebaseIntegration controller", func() {
 
 			By("Approving ApprovalTask")
 			task.Spec.Action = customTasksApi.TaskApproved
+			task.Spec.Approve = &customTasksApi.Approve{
+				ApprovedBy: "admin",
+				Comment:    "ok",
+			}
 			g.Expect(k8sClient.Update(ctx, task)).Should(Succeed())
 		}).WithTimeout(time.Second * 5).WithPolling(time.Second).Should(Succeed())
 		By("Checking CustomRun completion")
@@ -86,6 +90,8 @@ var _ = Describe("CodebaseIntegration controller", func() {
 			g.Expect(err).ShouldNot(HaveOccurred())
 			g.Expect(createdRun.IsSuccessful()).Should(BeTrue())
 			g.Expect(createdRun.Status.CompletionTime).ShouldNot(BeNil())
+			g.Expect(createdRun.Status.Results).Should(HaveLen(3))
+			g.Expect(createdRun.Status.Results[0].Value).Should(Equal("true"))
 		}).WithTimeout(time.Second * 20).WithPolling(time.Second).Should(Succeed())
 	})
 	It("Should process CustomRun with reject ApprovalTask", func() {
@@ -111,6 +117,10 @@ var _ = Describe("CodebaseIntegration controller", func() {
 
 			By("Rejecting ApprovalTask")
 			task.Spec.Action = customTasksApi.TaskRejected
+			task.Spec.Approve = &customTasksApi.Approve{
+				ApprovedBy: "admin",
+				Comment:    "not ok",
+			}
 			g.Expect(k8sClient.Update(ctx, task)).Should(Succeed())
 		}).WithTimeout(time.Second * 5).WithPolling(time.Second).Should(Succeed())
 		By("Checking CustomRun completion")
@@ -122,6 +132,8 @@ var _ = Describe("CodebaseIntegration controller", func() {
 			g.Expect(err).ShouldNot(HaveOccurred())
 			g.Expect(createdRun.IsSuccessful()).Should(BeFalse())
 			g.Expect(createdRun.Status.CompletionTime).ShouldNot(BeNil())
+			g.Expect(createdRun.Status.Results).Should(HaveLen(3))
+			g.Expect(createdRun.Status.Results[0].Value).Should(Equal("false"))
 		}).WithTimeout(time.Second * 20).WithPolling(time.Second).Should(Succeed())
 	})
 	It("Should cancel ApprovalTask after canceling CustomRun", func() {
@@ -171,6 +183,8 @@ var _ = Describe("CodebaseIntegration controller", func() {
 			g.Expect(err).ShouldNot(HaveOccurred())
 			g.Expect(createdRun.IsSuccessful()).Should(BeFalse())
 			g.Expect(createdRun.Status.CompletionTime).ShouldNot(BeNil())
+			g.Expect(createdRun.Status.Results).Should(HaveLen(1))
+			g.Expect(createdRun.Status.Results[0].Value).Should(Equal("false"))
 		}).WithTimeout(time.Second * 20).WithPolling(time.Second).Should(Succeed())
 	})
 	It("Should skip CustomRun without ApprovalTask ref", func() {