Fix iwftest pkg by exposing private interfaces in persistence and communications (#39)

Author: longquanzheng

iwf/communication.go

@@ -7,5 +7,9 @@ type Communication interface {
 	PublishInterstateChannel(channelName string, value interface{})
 
 	// below is for internal implementation
-	getToPublishInterStateChannel() map[string][]iwfidl.EncodedObject
+	communicationInternal
 }
+
+type communicationInternal interface {
+	GetToPublishInterStateChannel() map[string][]iwfidl.EncodedObject
+}

iwf/communication_impl.go

@@ -8,7 +8,7 @@ type communicationImpl struct {
 	encoder                    ObjectEncoder
 }
 
-func (c *communicationImpl) getToPublishInterStateChannel() map[string][]iwfidl.EncodedObject {
+func (c *communicationImpl) GetToPublishInterStateChannel() map[string][]iwfidl.EncodedObject {
 	return c.toPublishInterStateChannel
 }
 

iwf/persistence.go

@@ -48,11 +48,14 @@ type Persistence interface {
 	RecordEvent(key string, value interface{})
 
 	// below is for internal implementation
-	getToReturn() (
+	persistenceInternal
+}
+
+type persistenceInternal interface {
+	GetToReturn() (
 		dataObjectsToReturn []iwfidl.KeyValue,
 		stateLocalToReturn []iwfidl.KeyValue,
 		recordEvents []iwfidl.KeyValue,
 		searchAttributes []iwfidl.SearchAttribute,
 	)
 }
-

iwf/persistence_impl.go

@@ -249,7 +249,7 @@ func (p *persistenceImpl) RecordEvent(key string, value interface{}) {
 	p.recordedEvents[key] = *v
 }
 
-func (p *persistenceImpl) getToReturn() (
+func (p *persistenceImpl) GetToReturn() (
 	dataObjectsToReturn []iwfidl.KeyValue,
 	stateLocalToReturn []iwfidl.KeyValue,
 	recordEvents []iwfidl.KeyValue,

iwf/worker_service_impl.go

@@ -31,7 +31,7 @@ func (w *workerServiceImpl) HandleWorkflowStateStart(ctx context.Context, reques
 		return nil, err
 	}
 
-	err = canNotRequestAndPublishTheSameInterStateChannel(comm.getToPublishInterStateChannel(), commandRequest)
+	err = canNotRequestAndPublishTheSameInterStateChannel(comm.GetToPublishInterStateChannel(), commandRequest)
 	if err != nil {
 		return nil, err
 	}
@@ -40,14 +40,14 @@ func (w *workerServiceImpl) HandleWorkflowStateStart(ctx context.Context, reques
 	if err != nil {
 		return nil, err
 	}
-	publishings := toPublishing(comm.getToPublishInterStateChannel())
+	publishings := toPublishing(comm.GetToPublishInterStateChannel())
 	resp = &iwfidl.WorkflowStateStartResponse{
 		CommandRequest: idlCommandRequest,
 	}
 	if len(publishings) > 0 {
 		resp.PublishToInterStateChannel = publishings
 	}
-	dataObjectsToReturn, stateLocalToReturn, recordedEvents, upsertSearchAttributes := pers.getToReturn()
+	dataObjectsToReturn, stateLocalToReturn, recordedEvents, upsertSearchAttributes := pers.GetToReturn()
 	if len(dataObjectsToReturn) > 0 {
 		resp.UpsertDataObjects = dataObjectsToReturn
 	}
@@ -119,11 +119,11 @@ func (w *workerServiceImpl) HandleWorkflowStateDecide(ctx context.Context, reque
 	resp = &iwfidl.WorkflowStateDecideResponse{
 		StateDecision: idlDecision,
 	}
-	publishings := toPublishing(comm.getToPublishInterStateChannel())
+	publishings := toPublishing(comm.GetToPublishInterStateChannel())
 	if len(publishings) > 0 {
 		resp.PublishToInterStateChannel = publishings
 	}
-	dataObjectsToReturn, stateLocalToReturn, recordedEvents, upsertSearchAttributes := pers.getToReturn()
+	dataObjectsToReturn, stateLocalToReturn, recordedEvents, upsertSearchAttributes := pers.GetToReturn()
 	if len(dataObjectsToReturn) > 0 {
 		resp.UpsertDataObjects = dataObjectsToReturn
 	}

iwftest/README.md

@@ -0,0 +1,70 @@
+## Unit tests APIs for iWF 
+
+The APIs are generated by the below commands:
+```shell
+  mockgen -source=iwf/persistence.go -package=iwftest -destination=iwftest/persistence.go
+  mockgen -source=iwf/communication.go -package=iwftest -destination=iwftest/communication.go
+  mockgen -source=iwf/workflow_context.go -package=iwftest -destination=iwftest/workflow_context.go
+```
+
+## Usage
+
+See the [samples](https://github.com/indeedeng/iwf-golang-samples) for more details:
+
+```go
+package subscription
+
+import (
+	"github.com/golang/mock/gomock"
+	"github.com/indeedeng/iwf-golang-sdk/iwf"
+	"github.com/indeedeng/iwf-golang-sdk/iwftest"
+	"github.com/stretchr/testify/assert"
+	"testing"
+	"time"
+)
+
+var mockWfCtx *iwftest.MockWorkflowContext
+var mockPersistence *iwftest.MockPersistence
+var mockCommunication *iwftest.MockCommunication
+var emptyCmdResults = iwf.CommandResults{}
+var emptyObj = iwftest.NewTestObject(nil)
+var mockSvc *MockMyService
+
+func beforeEach(t *testing.T) {
+	ctrl := gomock.NewController(t)
+
+	mockSvc = NewMockMyService(ctrl)
+	mockWfCtx = iwftest.NewMockWorkflowContext(ctrl)
+	mockPersistence = iwftest.NewMockPersistence(ctrl)
+	mockCommunication = iwftest.NewMockCommunication(ctrl)
+}
+
+
+func TestInitState_Start(t *testing.T) {
+	beforeEach(t)
+
+	state := NewInitState()
+
+	mockPersistence.EXPECT().SetDataObject(keyCustomer, testCustomer)
+	cmdReq, err := state.Start(mockWfCtx, testCustomerObj, mockPersistence, mockCommunication)
+	assert.Nil(t, err)
+	assert.Equal(t, iwf.EmptyCommandRequest(), cmdReq)
+}
+
+
+func TestTrialState_Start(t *testing.T) {
+	beforeEach(t)
+
+	state := NewTrialState(mockSvc)
+
+	mockSvc.EXPECT().sendEmail(testCustomer.Email, gomock.Any(), gomock.Any())
+	mockPersistence.EXPECT().GetDataObject(keyCustomer, gomock.Any()).SetArg(1, testCustomer)
+	cmdReq, err := state.Start(mockWfCtx, emptyObj, mockPersistence, mockCommunication)
+	assert.Nil(t, err)
+	firingTime := cmdReq.Commands[0].TimerCommand.FiringUnixTimestampSeconds
+	assert.Equal(t, iwf.AllCommandsCompletedRequest(
+		iwf.NewTimerCommand("", time.Unix(firingTime, 0)),
+	), cmdReq)
+}
+
+```