statemachine: purge unused state, fix statemachine docs

metal-toolbox · May 4, 2023 · fd345f1 · fd345f1
1 parent 342794f
commit fd345f1
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 11 deletions.
diff --git a/internal/statemachine/actions.go b/internal/statemachine/actions.go
@@ -18,7 +18,7 @@ const (
 	// state for failed actions
 	StateActionFailed sw.State = model.StateFailed
 
-	// transition for completed actions
+	// transition for successful actions
 	TransitionTypeActionSuccess sw.TransitionType = "succeeded"
 	// transition for failed actions
 	TransitionTypeActionFailed sw.TransitionType = "failed"

diff --git a/internal/statemachine/task.go b/internal/statemachine/task.go
@@ -228,13 +228,8 @@ func NewTaskStateMachine(handler TaskTransitioner) (*TaskStateMachine, error) {
 
 func (m *TaskStateMachine) addDocumentation() {
 	m.sm.DescribeState(model.StatePending, sw.StateDoc{
-		Name:        "Requested",
-		Description: "In this state the task has been requested (this is done outside of the state machine).",
-	})
-
-	m.sm.DescribeState(model.StatePending, sw.StateDoc{
-		Name:        "Queued",
-		Description: "In this state the task is being initialized (this is done outside of the state machine).",
+		Name:        "Pending",
+		Description: "In this state the task is being initialized.",
 	})
 
 	m.sm.DescribeState(model.StateActive, sw.StateDoc{
@@ -248,7 +243,7 @@ func (m *TaskStateMachine) addDocumentation() {
 	})
 
 	m.sm.DescribeState(model.StateSucceeded, sw.StateDoc{
-		Name:        "Success",
+		Name:        "Succeeded",
 		Description: "In this state the task execution has completed successfully.",
 	})
 
@@ -269,12 +264,12 @@ func (m *TaskStateMachine) addDocumentation() {
 
 	m.sm.DescribeTransitionType(TransitionTypeTaskFail, sw.TransitionTypeDoc{
 		Name:        string(TransitionTypeTaskFail),
-		Description: "In this transition the task has failed and any post failure steps are being executed.",
+		Description: "In this transition the task has failed and any post-failure steps are being executed.",
 	})
 
 	m.sm.DescribeTransitionType(TransitionTypeTaskSuccess, sw.TransitionTypeDoc{
 		Name:        string(TransitionTypeTaskSuccess),
-		Description: "In this transition the task has completed successfully and any post failure steps are being executed.",
+		Description: "In this transition the task has completed successfully and any post-success steps are executed.",
 	})
 }