refactor(api): create new state reasons

openclarity · Dec 12, 2023 · c80df58 · c80df58
1 parent bde5865
commit c80df58
Show file tree

Hide file tree

Showing 9 changed files with 224 additions and 222 deletions.
diff --git a/api/models/assetscanstatus.go b/api/models/assetscanstatus.go
@@ -33,24 +33,24 @@ var assetScanStatusReasonMapping = map[AssetScanStatusState][]AssetScanStatusRea
 		AssetScanStatusReasonCreated,
 	},
 	AssetScanStatusStateScheduled: {
-		AssetScanStatusReasonScheduled,
+		AssetScanStatusReasonProvisioning,
 	},
 	AssetScanStatusStateReadyToScan: {
-		AssetScanStatusReasonOutOfVMClarity,
-		AssetScanStatusReasonReadyToScan,
+		AssetScanStatusReasonUnSupervised,
+		AssetScanStatusReasonResourcesReady,
 	},
 	AssetScanStatusStateInProgress: {
-		AssetScanStatusReasonInProgress,
+		AssetScanStatusReasonScannerIsRunning,
 	},
 	AssetScanStatusStateAborted: {
-		AssetScanStatusReasonAborted,
+		AssetScanStatusReasonCancellation,
 	},
 	AssetScanStatusStateFailed: {
-		AssetScanStatusReasonFailed,
+		AssetScanStatusReasonError,
 		AssetScanStatusReasonAbortTimedOut,
 	},
 	AssetScanStatusStateDone: {
-		AssetScanStatusReasonDone,
+		AssetScanStatusReasonSuccess,
 	},
 }
 

diff --git a/api/models/models.gen.go b/api/models/models.gen.go
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -2451,38 +2451,38 @@ components:
           description: |
             Machine readable reason for state transition.
 
-            | State       | Reason         | Description                                  |
-            | ----------- | -------------- | -------------------------------------------- |
-            | Pending     | Created        | AssetScan has been created                   |
-            | Scheduled   | Scheduled      | Moved to scheduled state                     |
-            | ReadyToScan | OutOfVMClarity | Started without VMClarity orchestration      |
-            | ReadyToScan | ReadyToScan    | Scans are ready to be started                |
-            | InProgress  | InProgress     | Scans are running on the target              |
-            | Aborted     | Aborted        | Scans have been aborted                      |
-            | Failed      | Failed         | At least one scan failed on target           |
-            | Failed      | AbortTimedOut  | AssetScan was in Aborted state for too long  |
-            | Done        | Done           | Scan finished successfully                   |
+            | State       | Reason           | Description                                                                                |
+            | ----------- | ---------------- | ------------------------------------------------------------------------------------------ |
+            | Pending     | Created          | Scan is pending as it has been newly created                                               |
+            | Scheduled   | Provisioning     | Scan is scheduled as Asset resources are being provisioned                                 |
+            | ReadyToScan | UnSupervised     | Scan is created manually without the involvement of the Orchestrator (e.g. CI/CD scenario) |
+            | ReadyToScan | ResourcesReady   | Scan is ready to scan as Asset resources have been provisioned                             |
+            | InProgress  | ScannerIsRunning | Scan is in progress as Scanner is still performing scanning on Asset resources             |
+            | Aborted     | Cancellation     | Scans have been aborted                                                                    |
+            | Failed      | Error            | Scan has failed to one or more errors reported by the Scanner                              |
+            | Failed      | AbortTimedOut    | Scan has failed due to being in Aborted state for too long                                 |
+            | Done        | Success          | Scan has finished successfully                                                             |
           type: string
           enum:
             - Created
-            - Scheduled
-            - OutOfVMClarity
-            - ReadyToScan
-            - InProgress
-            - Aborted
-            - Failed
+            - Provisioning
+            - UnSupervised
+            - ResourcesReady
+            - ScannerIsRunning
+            - Cancellation
+            - Error
             - AbortTimedOut
-            - Done
+            - Success
           x-enum-varnames:
             - AssetScanStatusReasonCreated
-            - AssetScanStatusReasonScheduled
-            - AssetScanStatusReasonOutOfVMClarity
-            - AssetScanStatusReasonReadyToScan
-            - AssetScanStatusReasonInProgress
-            - AssetScanStatusReasonAborted
-            - AssetScanStatusReasonFailed
+            - AssetScanStatusReasonProvisioning
+            - AssetScanStatusReasonUnSupervised
+            - AssetScanStatusReasonResourcesReady
+            - AssetScanStatusReasonScannerIsRunning
+            - AssetScanStatusReasonCancellation
+            - AssetScanStatusReasonError
             - AssetScanStatusReasonAbortTimedOut
-            - AssetScanStatusReasonDone
+            - AssetScanStatusReasonSuccess
         message:
           description: Human readable message.
           type: string