Merge pull request #371 from decibelcooper/feat/tester-with-initial-time

feat(tester): add WithInitialTime option

Author: cschleiden

tester/options.go

@@ -13,6 +13,7 @@ type options struct {
 	Logger      *slog.Logger
 	Converter   converter.Converter
 	Propagators []workflow.ContextPropagator
+	InitialTime time.Time
 }
 
 type WorkflowTesterOption func(*options)
@@ -40,3 +41,9 @@ func WithTestTimeout(timeout time.Duration) WorkflowTesterOption {
 		o.TestTimeout = timeout
 	}
 }
+
+func WithInitialTime(t time.Time) WorkflowTesterOption {
+	return func(o *options) {
+		o.InitialTime = t
+	}
+}

tester/tester.go

@@ -193,13 +193,6 @@ func NewWorkflowTester[TResult any](workflow workflow.Workflow, opts ...Workflow
 		panic(fmt.Sprintf("workflow return type does not match: %s", err))
 	}
 
-	// Start with the current wall-c time
-	c := clock.NewMock()
-	c.Set(time.Now())
-
-	wfi := core.NewWorkflowInstance(uuid.NewString(), uuid.NewString())
-	registry := registry.New()
-
 	options := &options{
 		TestTimeout: time.Second * 10,
 		Logger:      slog.Default(),
@@ -210,6 +203,17 @@ func NewWorkflowTester[TResult any](workflow workflow.Workflow, opts ...Workflow
 		o(options)
 	}
 
+	// Start with the current wall-c time unless InitialTime is set
+	c := clock.NewMock()
+	if options.InitialTime.IsZero() {
+		c.Set(time.Now())
+	} else {
+		c.Set(options.InitialTime)
+	}
+
+	wfi := core.NewWorkflowInstance(uuid.NewString(), uuid.NewString())
+	registry := registry.New()
+
 	tracer := noop.NewTracerProvider().Tracer("workflow-tester")
 
 	wt := &workflowTester[TResult]{

tester/tester_test.go

@@ -269,3 +269,18 @@ func waitForSignal(ctx workflow.Context) (int, error) {
 
 	return 42, nil
 }
+
+func Test_WithInitialTime(t *testing.T) {
+	getTimeWorkflow := func(ctx workflow.Context) (time.Time, error) {
+		return workflow.Now(ctx), nil
+	}
+
+	initialTime := time.Date(2021, 1, 1, 0, 0, 0, 0, time.UTC)
+	tester := NewWorkflowTester[time.Time](getTimeWorkflow, WithInitialTime(initialTime))
+
+	tester.Execute(context.Background())
+
+	require.True(t, tester.WorkflowFinished())
+	r, _ := tester.WorkflowResult()
+	require.Equal(t, initialTime, r)
+}