feat(scanresult): resource cleanup state refactor

openclarity · Sep 13, 2023 · 32281e6 · 32281e6
1 parent 3eef08c
commit 32281e6
Show file tree

Hide file tree

Showing 9 changed files with 310 additions and 171 deletions.
diff --git a/api/models/models.gen.go b/api/models/models.gen.go
diff --git a/api/models/state.go b/api/models/state.go
@@ -0,0 +1,25 @@
+package models
+
+import "fmt"
+
+type ResourceCleanupStateMachine map[ResourceCleanupStatusState][]ResourceCleanupStatusState
+
+var ResourceCleanupStatusStateValidTransitions = ResourceCleanupStateMachine{
+	ResourceCleanupStatusStatePending: {
+		ResourceCleanupStatusStateSkipped,
+		ResourceCleanupStatusStateFailed,
+		ResourceCleanupStatusStateDone,
+	},
+}
+
+func (rcs *ResourceCleanupStatus) UpdateState(toState ResourceCleanupStatusState) error {
+	transitions := ResourceCleanupStatusStateValidTransitions[*rcs.State]
+	for _, transition := range transitions {
+		if transition == toState {
+			rcs.State = &toState
+			return nil
+		}
+	}
+
+	return fmt.Errorf("invalid transition, from: %s to: %s", *rcs.State, toState)
+}
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -2030,13 +2030,41 @@ components:
             $ref: '#/components/schemas/AssetScan'
           readOnly: true
 
-    ResourceCleanupState:
-      type: string
-      enum:
-        - Pending
-        - Skipped
-        - Failed
-        - Done
+    CommonStatus:
+      type: object
+      properties:
+        reason:
+          type: string
+          description: Machine readable message.
+        message:
+          type: string
+          description: Human readable message.
+        lastTransitionTime:
+          type: string
+          format: date-time
+          description: Last date time when the status has changed.
+
+    ResourceCleanupStatus:
+      allOf:
+        - $ref: '#/components/schemas/CommonStatus'
+        - type: object
+          properties:
+            state:
+              type: string
+              enum:
+                - Pending
+                - Skipped
+                - Failed
+                - Done
+              description: |
+                Describes the state of resource cleanup.
+                
+                | State   | Description                                                |
+                | ------- | ---------------------------------------------------------- |
+                | Pending | Initial state for cleaning up resources                    |
+                | Skipped | Resource cleanup has been skipped due to Delete Job Policy |
+                | Failed  | Cleaning up resources has been failed                      |
+                | Done    | Resources have been successfully cleaned up                |
 
     AssetScanTemplate:
       type: object
@@ -2090,7 +2118,7 @@ components:
             findingsProcessed:
               type: boolean
             resourceCleanup:
-              $ref: '#/components/schemas/ResourceCleanupState'
+              $ref: '#/components/schemas/ResourceCleanupStatus'
             stats:
               $ref: '#/components/schemas/AssetScanStats'
             summary:
@@ -2210,7 +2238,7 @@ components:
               type: boolean
               readOnly: true
             resourceCleanup:
-              $ref: '#/components/schemas/ResourceCleanupState'
+              $ref: '#/components/schemas/ResourceCleanupStatus'
               readOnly: true
             stats:
               $ref: '#/components/schemas/AssetScanStats'