Add Findings Stats to scheduled Scans which reflect the stats of the most recent scan

Author: J12934

operator/apis/execution/v1/scheduledscan_types.go

@@ -45,10 +45,17 @@ type ScheduledScanStatus struct {
 	// Important: Run "make" to regenerate code after modifying this file
 
 	LastScheduleTime *metav1.Time `json:"lastScheduleTime,omitempty"`
+
+	// Findings Contains the findings stats of the most recent completed scan
+	Findings FindingStats `json:"findings,omitempty"`
 }
 
 // +kubebuilder:object:root=true
 // +kubebuilder:subresource:status
+// +kubebuilder:printcolumn:name="UID",type=string,JSONPath=`.metadata.uid`,description="K8s Resource UID",priority=1
+// +kubebuilder:printcolumn:name="Type",type=string,JSONPath=`.spec.scanSpec.scanType`,description="Scan Type"
+// +kubebuilder:printcolumn:name="Findings",type=string,JSONPath=`.status.findings.count`,description="Total Finding Count"
+// +kubebuilder:printcolumn:name="Parameters",type=string,JSONPath=`.spec.scanSpec.parameters`,description="Arguments passed to the Scanner",priority=1
 
 // ScheduledScan is the Schema for the scheduledscans API
 type ScheduledScan struct {

operator/apis/execution/v1/zz_generated.deepcopy.go

@@ -8,6 +8,25 @@ metadata:
   creationTimestamp: null
   name: scheduledscans.execution.experimental.securecodebox.io
 spec:
+  additionalPrinterColumns:
+  - JSONPath: .metadata.uid
+    description: K8s Resource UID
+    name: UID
+    priority: 1
+    type: string
+  - JSONPath: .spec.scanSpec.scanType
+    description: Scan Type
+    name: Type
+    type: string
+  - JSONPath: .status.findings.count
+    description: Total Finding Count
+    name: Findings
+    type: string
+  - JSONPath: .spec.scanSpec.parameters
+    description: Arguments passed to the Scanner
+    name: Parameters
+    priority: 1
+    type: string
   group: execution.experimental.securecodebox.io
   names:
     kind: ScheduledScan
@@ -65,6 +84,40 @@ spec:
         status:
           description: ScheduledScanStatus defines the observed state of ScheduledScan
           properties:
+            findings:
+              description: Findings Contains the findings stats of the most recent
+                completed scan
+              properties:
+                categories:
+                  additionalProperties:
+                    format: int64
+                    type: integer
+                  description: FindingCategories indicates the count of finding broken
+                    down by their categories
+                  type: object
+                count:
+                  description: Count indicates how many findings were identified in
+                    total
+                  format: int64
+                  type: integer
+                severities:
+                  description: FindingSeverities indicates the count of finding with
+                    the respective severity
+                  properties:
+                    high:
+                      format: int64
+                      type: integer
+                    informational:
+                      format: int64
+                      type: integer
+                    low:
+                      format: int64
+                      type: integer
+                    medium:
+                      format: int64
+                      type: integer
+                  type: object
+              type: object
             lastScheduleTime:
               format: date-time
               type: string

operator/config/crd/bases/execution.experimental.securecodebox.io_scheduledscans.yaml

@@ -9,4 +9,4 @@ spec:
     scanType: "nmap"
     parameters:
       - "-Pn"
-      - localhost
+      - "192.168.178.24"

operator/config/samples/execution_v1_scheduledscan.yaml

@@ -19,6 +19,7 @@ package controllers
 import (
 	"context"
 	"fmt"
+	"reflect"
 	"sort"
 	"time"
 
@@ -78,6 +79,18 @@ func (r *ScheduledScanReconciler) Reconcile(req ctrl.Request) (ctrl.Result, erro
 		return completedScans[i].Status.StartTime.Before(completedScans[j].Status.StartTime)
 	})
 
+	if len(completedScans) >= 1 {
+		lastFindings := completedScans[len(completedScans)-1].Status.Findings
+		if !reflect.DeepEqual(lastFindings, scheduledScan.Status.Findings) {
+			log.V(2).Info("Updating ScheduledScans Findings as they appear to have changed")
+			scheduledScan.Status.Findings = *lastFindings.DeepCopy()
+			if err := r.Status().Update(ctx, &scheduledScan); err != nil {
+				log.Error(err, "unable to update ScheduledScan status")
+				return ctrl.Result{}, err
+			}
+		}
+	}
+
 	for i, scan := range completedScans {
 		if int64(i) >= int64(len(completedScans))-scheduledScan.Spec.HistoryLimit {
 			break