Remove interface and improve comments

Author: cschleiden

tester/signaler.go

@@ -0,0 +1,18 @@
+package tester
+
+import (
+	"context"
+
+	"github.com/cschleiden/go-workflows/core"
+	"github.com/cschleiden/go-workflows/internal/signals"
+)
+
+type signaler[T any] struct {
+	wt *workflowTester[T]
+}
+
+func (s *signaler[T]) SignalWorkflow(ctx context.Context, instanceID string, name string, arg interface{}) error {
+	return s.wt.SignalWorkflowInstance(core.NewWorkflowInstance(instanceID, ""), name, arg)
+}
+
+var _ signals.Signaler = (*signaler[any])(nil)

tester/tester.go

@@ -75,40 +75,6 @@ type testWorkflow struct {
 	pendingEvents []*history.Event
 }
 
-type WorkflowTester[TResult any] interface {
-	// Now returns the current time of the simulated clock in the tester
-	Now() time.Time
-
-	Execute(ctx context.Context, args ...interface{})
-
-	Registry() *registry.Registry
-
-	OnActivity(activity workflow.Activity, args ...interface{}) *mock.Call
-
-	OnActivityByName(name string, activity workflow.Activity, args ...interface{}) *mock.Call
-
-	OnSubWorkflow(workflow workflow.Workflow, args ...interface{}) *mock.Call
-
-	OnSubWorkflowByName(name string, workflow workflow.Workflow, args ...interface{}) *mock.Call
-
-	SignalWorkflow(signalName string, value interface{})
-
-	SignalWorkflowInstance(wfi *core.WorkflowInstance, signalName string, value interface{}) error
-
-	WorkflowFinished() bool
-
-	WorkflowResult() (TResult, error)
-
-	// AssertExpectations asserts any assertions set up for mock activities and sub-workflow
-	AssertExpectations(t *testing.T)
-
-	// ScheduleCallback schedules the given callback after the given delay in workflow time (not wall clock).
-	ScheduleCallback(delay time.Duration, callback func())
-
-	// ListenSubWorkflow registers a handler to be called when a sub-workflow is started.
-	ListenSubWorkflow(listener func(instance *core.WorkflowInstance, name string))
-}
-
 type workflowTester[TResult any] struct {
 	options *options
 
@@ -162,8 +128,6 @@ type workflowTester[TResult any] struct {
 	propagators []workflow.ContextPropagator
 }
 
-var _ WorkflowTester[any] = (*workflowTester[any])(nil)
-
 func NewWorkflowTester[TResult any](workflow workflow.Workflow, opts ...WorkflowTesterOption) *workflowTester[TResult] {
 	if err := args.ReturnTypeMatch[TResult](workflow); err != nil {
 		panic(fmt.Sprintf("workflow return type does not match: %s", err))
@@ -231,14 +195,17 @@ func NewWorkflowTester[TResult any](workflow workflow.Workflow, opts ...Workflow
 	return wt
 }
 
+// Now returns the current time in the workflow tester's clock
 func (wt *workflowTester[TResult]) Now() time.Time {
 	return wt.clock.Now()
 }
 
+// Registry returns the registry used by the workflow tester.
 func (wt *workflowTester[TResult]) Registry() *registry.Registry {
 	return wt.registry
 }
 
+// ScheduleCallback schedules a callback to be called after the given delay.
 func (wt *workflowTester[TResult]) ScheduleCallback(delay time.Duration, callback func()) {
 	wt.timers = append(wt.timers, &testTimer{
 		At:         wt.clock.Now().Add(delay),
@@ -247,10 +214,13 @@ func (wt *workflowTester[TResult]) ScheduleCallback(delay time.Duration, callbac
 	})
 }
 
+// ListenSubWorkflow registers a listener that is called whenever a sub-workflow is started. It receives
+// the workflow instance and the name of the sub-workflow.
 func (wt *workflowTester[TResult]) ListenSubWorkflow(listener func(*core.WorkflowInstance, string)) {
 	wt.subWorkflowListener = listener
 }
 
+// OnActivityByName registers a mock activity with the given name.
 func (wt *workflowTester[TResult]) OnActivityByName(name string, activity workflow.Activity, args ...any) *mock.Call {
 	// Register activity so that we can correctly identify its arguments later
 	wt.registry.RegisterActivity(activity, registry.WithName(name))
@@ -259,6 +229,7 @@ func (wt *workflowTester[TResult]) OnActivityByName(name string, activity workfl
 	return wt.ma.On(name, args...)
 }
 
+// OnActivity registers a mock activity.
 func (wt *workflowTester[TResult]) OnActivity(activity workflow.Activity, args ...any) *mock.Call {
 	// Register activity so that we can correctly identify its arguments later
 	wt.registry.RegisterActivity(activity)
@@ -268,6 +239,7 @@ func (wt *workflowTester[TResult]) OnActivity(activity workflow.Activity, args .
 	return wt.ma.On(name, args...)
 }
 
+// OnSubWorkflowByName registers a mock sub-workflow with the given name.
 func (wt *workflowTester[TResult]) OnSubWorkflowByName(name string, workflow workflow.Workflow, args ...any) *mock.Call {
 	// Register workflow so that we can correctly identify its arguments later
 	wt.registry.RegisterWorkflow(workflow, registry.WithName(name))
@@ -276,6 +248,7 @@ func (wt *workflowTester[TResult]) OnSubWorkflowByName(name string, workflow wor
 	return wt.mw.On(name, args...)
 }
 
+// OnSubWorkflow registers a mock sub-workflow.
 func (wt *workflowTester[TResult]) OnSubWorkflow(workflow workflow.Workflow, args ...any) *mock.Call {
 	// Register workflow so that we can correctly identify its arguments later
 	wt.registry.RegisterWorkflow(workflow)
@@ -285,6 +258,7 @@ func (wt *workflowTester[TResult]) OnSubWorkflow(workflow workflow.Workflow, arg
 	return wt.mw.On(name, args...)
 }
 
+// Execute executes the workflow under test with the given arguments.
 func (wt *workflowTester[TResult]) Execute(ctx context.Context, args ...any) {
 	for _, propagator := range wt.propagators {
 		if err := propagator.Inject(ctx, wt.wfm); err != nil {
@@ -508,11 +482,13 @@ func (wt *workflowTester[TResult]) sendEvent(wfi *core.WorkflowInstance, event *
 	w.pendingEvents = append(w.pendingEvents, event)
 }
 
-func (wt *workflowTester[TResult]) SignalWorkflow(name string, value interface{}) {
+// SignalWorkflow sends a signal to the workflow under test.
+func (wt *workflowTester[TResult]) SignalWorkflow(name string, value any) {
 	wt.SignalWorkflowInstance(wt.wfi, name, value)
 }
 
-func (wt *workflowTester[TResult]) SignalWorkflowInstance(wfi *core.WorkflowInstance, name string, value interface{}) error {
+// SignalWorkflowInstance sends a signal to the given workflow instance.
+func (wt *workflowTester[TResult]) SignalWorkflowInstance(wfi *core.WorkflowInstance, name string, value any) error {
 	if wt.getWorkflow(wfi) == nil {
 		return backend.ErrInstanceNotFound
 	}
@@ -541,10 +517,12 @@ func (wt *workflowTester[TResult]) SignalWorkflowInstance(wfi *core.WorkflowInst
 	return nil
 }
 
+// WorkflowFinished returns true if the workflow under test has finished.
 func (wt *workflowTester[TResult]) WorkflowFinished() bool {
 	return wt.workflowFinished
 }
 
+// WorkflowResult returns the result of the workflow under test.
 func (wt *workflowTester[TResult]) WorkflowResult() (TResult, error) {
 	var r TResult
 	if wt.workflowResult != nil {
@@ -557,6 +535,7 @@ func (wt *workflowTester[TResult]) WorkflowResult() (TResult, error) {
 	return r, err
 }
 
+// AssertExpectations asserts that all expected activities were executed.
 func (wt *workflowTester[TResult]) AssertExpectations(t *testing.T) {
 	wt.ma.AssertExpectations(t)
 }
@@ -829,13 +808,3 @@ func getNextWorkflowTask(wfi *core.WorkflowInstance, history []*history.Event, n
 		NewEvents:        newEvents,
 	}
 }
-
-type signaler[T any] struct {
-	wt *workflowTester[T]
-}
-
-func (s *signaler[T]) SignalWorkflow(ctx context.Context, instanceID string, name string, arg interface{}) error {
-	return s.wt.SignalWorkflowInstance(core.NewWorkflowInstance(instanceID, ""), name, arg)
-}
-
-var _ signals.Signaler = (*signaler[any])(nil)