Add DelayInState() receiver function to pause in a state then continu… (#140)

* Add DelayInState() receiver function to pause in a state then continue the workflow.

Signed-off-by: Anthony Floeder <anthony.floeder@hpe.com>

* Allow multiple states to delay

Signed-off-by: Anthony Floeder <anthony.floeder@hpe.com>

---------

Signed-off-by: Anthony Floeder <anthony.floeder@hpe.com>

Author: ajfloeder

int_test.go

@@ -56,9 +56,13 @@ var tests = []*T{
 	// Mark a test case as Pending(). Ginkgo will not run any tests that have the Pending decorator
 	//   MakeTest("Pending", "#DW ...").Pending()
 	//
-	// Mark a test case so it will stop after the workflow achieves the desired state of PreRun
+	// Mark a test case, so it will stop after the workflow achieves the desired state of PreRun
 	//   MakeTest("Stop After", "#DW ...").StopAfter(dwsv1alpha7.StatePreRun),
 	//
+	// Mark a test case, so it delays for the specified period after a workflow achieves the desired state
+	// Multiple delays can be added by calling DelayInState multiple times.
+	//   MakeTest("Delay In State", "#DW ...").DelayInState(dwsv1alpha7.StateDataIn, 2*time.Minute).DelayInState(dwsv1alpha7.StateDataOut, 2*time.Minute),
+	//
 	// Duplicate a test case 20 times.
 	//   DuplicateTest(
 	//      MakeTest("XFS", "#DW jobdw type=xfs name=xfs capacity=50GB"),

internal/options.go

@@ -46,6 +46,7 @@ import (
 // execution. Nil values represent no configuration of that type.
 type TOptions struct {
 	stopAfter           *TStopAfter
+	delayInState        []TDelayInState
 	expectError         *TExpectError
 	storageProfile      *TStorageProfile
 	containerProfile    *TContainerProfile
@@ -76,6 +77,18 @@ func (t *T) StopAfter(state dwsv1alpha7.WorkflowState) *T {
 	return t
 }
 
+type TDelayInState struct {
+	state    dwsv1alpha7.WorkflowState
+	duration time.Duration
+}
+
+// DelayInState allows you to pause in a specific state for a given duration.
+// Multiple delays can be added by calling this method multiple times.
+func (t *T) DelayInState(state dwsv1alpha7.WorkflowState, duration time.Duration) *T {
+	t.options.delayInState = append(t.options.delayInState, TDelayInState{state: state, duration: duration})
+	return t
+}
+
 type TExpectError struct {
 	state dwsv1alpha7.WorkflowState
 }

internal/states.go

@@ -47,10 +47,21 @@ func (t *T) Execute(ctx context.Context, k8sClient client.Client) {
 	for _, fn := range []StateHandler{t.proposal, t.setup, t.dataIn, t.preRun, t.postRun, t.dataOut, t.teardown} {
 		fn(ctx, k8sClient, t.workflow)
 
+		// Extract the current state name from the function
+		fnName := runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name() // This will return something like `full-import-path.(*T).Function-fm`
+		fnName = fnName[strings.Index(fnName, "(*T).")+5 : len(fnName)-3] // Extract the function name
+		state := dwsv1alpha7.WorkflowState(strings.Title(fnName))
+
+		// Handle DelayInState - check all delays for this state
+		for _, delay := range t.options.delayInState {
+			if state == delay.state {
+				By(fmt.Sprintf("Delaying in state %s for %v", state, delay.duration))
+				time.Sleep(delay.duration)
+			}
+		}
+
+		// Handle StopAfter
 		if t.options.stopAfter != nil {
-			fnName := runtime.FuncForPC(reflect.ValueOf(fn).Pointer()).Name() // This will return something like `full-import-path.(*T).Function-fm`
-			fnName = fnName[strings.Index(fnName, "(*T).")+5 : len(fnName)-3] // Extract the function name
-			state := dwsv1alpha7.WorkflowState(strings.Title(fnName))
 			if state == t.options.stopAfter.state {
 				break
 			}