Support status field named "runnerCompletions" and addtional printer columns

Signed-off-by: Yoichi Kawasaki <[email protected]>

Author: yokawasa

api/v1alpha1/gatling_types.go

@@ -21,9 +21,6 @@ import (
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 )
 
-// EDIT THIS FILE!  THIS IS SCAFFOLDING FOR YOU TO OWN!
-// NOTE: json tags are required.  Any new fields you add must have json tags for the fields to be serialized.
-
 // GatlingSpec defines the desired state of Gatling
 type GatlingSpec struct {
 	// INSERT ADDITIONAL SPEC FIELDS - desired state of cluster
@@ -200,6 +197,10 @@ type GatlingStatus struct {
 	// +optional
 	RunnerCompleted bool `json:"runnerCompleted,omitempty"`
 
+	// The number of successfully completed runner pods. The format is (completed#/parallelism#)
+	// +optional
+	RunnerCompletions string `json:"runnerCompletions,omitempty"`
+
 	// Reporter job name
 	// +optional
 	ReporterJobName string `json:"reporterJobName,omitempty"`
@@ -231,6 +232,11 @@ type GatlingStatus struct {
 
 //+kubebuilder:object:root=true
 //+kubebuilder:subresource:status
+//+kubebuilder:printcolumn:name="Runned",type=string,JSONPath=`.status.runnerCompletions`
+//+kubebuilder:printcolumn:name="Reported",type=boolean,JSONPath=`.status.reportCompleted`
+//+kubebuilder:printcolumn:name="Notified",type=boolean,JSONPath=`.status.notificationCompleted`
+//+kubebuilder:printcolumn:name="ReportURL",type=string,JSONPath=`.status.reportUrl`
+//+kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp"
 
 // Gatling is the Schema for the gatlings API
 type Gatling struct {

config/crd/bases/gatling-operator.tech.zozo.com_gatlings.yaml

@@ -16,7 +16,23 @@ spec:
     singular: gatling
   scope: Namespaced
   versions:
-  - name: v1alpha1
+  - additionalPrinterColumns:
+    - jsonPath: .status.runnerCompletions
+      name: Runned
+      type: string
+    - jsonPath: .status.reportCompleted
+      name: Reported
+      type: boolean
+    - jsonPath: .status.notificationCompleted
+      name: Notified
+      type: boolean
+    - jsonPath: .status.reportUrl
+      name: ReportURL
+      type: string
+    - jsonPath: .metadata.creationTimestamp
+      name: Age
+      type: date
+    name: v1alpha1
     schema:
       openAPIV3Schema:
         description: Gatling is the Schema for the gatlings API
@@ -1339,6 +1355,10 @@ spec:
               runnerCompleted:
                 description: Is runner job completed (default false)
                 type: boolean
+              runnerCompletions:
+                description: The number of successfully completed runner pods. The
+                  format is (completed#/parallelism#)
+                type: string
               runnerJobName:
                 description: Runner job name
                 type: string

controllers/gatling_controller.go

@@ -205,6 +205,7 @@ func (r *GatlingReconciler) gatlingRunnerReconcile(ctx context.Context, req ctrl
 		gatling.Status.Active = runnerJob.Status.Active
 		gatling.Status.Failed = runnerJob.Status.Failed
 		gatling.Status.Succeeded = runnerJob.Status.Succeeded
+		gatling.Status.RunnerCompletions = r.getRunnerCompletionsStatus(gatling)
 		gatling.Status.RunnerCompleted = false
 		gatling.Status.ReportCompleted = false
 		gatling.Status.NotificationCompleted = false
@@ -235,6 +236,7 @@ func (r *GatlingReconciler) gatlingRunnerReconcile(ctx context.Context, req ctrl
 	gatling.Status.Active = foundJob.Status.Active
 	gatling.Status.Failed = foundJob.Status.Failed
 	gatling.Status.Succeeded = foundJob.Status.Succeeded
+	gatling.Status.RunnerCompletions = r.getRunnerCompletionsStatus(gatling)
 
 	// Check if the job runs out of time in running the job
 	duration := utils.GetEpocTime() - gatling.Status.RunnerStartTime
@@ -838,10 +840,11 @@ func (r *GatlingReconciler) updateGatlingStatus(ctx context.Context, gatling *ga
 }
 
 func (r *GatlingReconciler) dumpGatlingStatus(gatling *gatlingv1alpha1.Gatling, log logr.Logger) {
-	log.Info(fmt.Sprintf("GatlingStatus: Active %d Succeeded %d Failed %d ReportCompleted %t NotificationCompleted %t ReportUrl %s Error %v",
+	log.Info(fmt.Sprintf("GatlingStatus: Active %d Succeeded %d Failed %d RunnerCompletions %s ReportCompleted %t NotificationCompleted %t ReportUrl %s Error %v",
 		gatling.Status.Active,
 		gatling.Status.Succeeded,
 		gatling.Status.Failed,
+		gatling.Status.RunnerCompletions,
 		gatling.Status.ReportCompleted,
 		gatling.Status.NotificationCompleted,
 		gatling.Status.ReportUrl,
@@ -1004,6 +1007,10 @@ func (r *GatlingReconciler) getGenerateLocalReport(gatling *gatlingv1alpha1.Gatl
 	return gatling.Spec.GenerateLocalReport
 }
 
+func (r *GatlingReconciler) getRunnerCompletionsStatus(gatling *gatlingv1alpha1.Gatling) string {
+	return fmt.Sprintf("%d/%d", gatling.Status.Succeeded, *(r.getGatlingRunnerJobParallelism(gatling)))
+}
+
 // SetupWithManager sets up the controller with the Manager.
 func (r *GatlingReconciler) SetupWithManager(mgr ctrl.Manager, options controller.Options) error {
 	return ctrl.NewControllerManagedBy(mgr).