add tests in Test_MockGetVersion

Author: arzonus

internal/internal_workflow_testsuite.go

@@ -1975,7 +1975,7 @@ func (env *testWorkflowEnvironmentImpl) GetVersion(changeID string, minSupported
 	validateVersion(changeID, version, minSupported, maxSupported)
 
 	// If the version is not the DefaultVersion, update search attributes
-	// Keeping the DefaultVersion as a special case where no version marker is recorded
+	// Keeping the DefaultVersion as a special case where no search attributes are updated
 	if version != DefaultVersion {
 		env.UpsertSearchAttributes(createSearchAttributesForChangeVersion(changeID, version, env.changeVersions))
 	}

internal/internal_workflow_testsuite_test.go

@@ -1360,6 +1360,142 @@ func (s *WorkflowTestSuiteUnitTest) Test_GetVersion_ExecuteWithVersion() {
 	env.AssertExpectations(s.T())
 }
 
+func (s *WorkflowTestSuiteUnitTest) Test_MockGetVersion_ExecuteWithVersion() {
+	oldActivity := func(ctx context.Context, msg string) (string, error) {
+		return "hello" + "_" + msg, nil
+	}
+	newActivity := func(ctx context.Context, msg string) (string, error) {
+		return "hello" + "_" + msg, nil
+	}
+	workflowFn := func(ctx Context) (string, error) {
+		ctx = WithActivityOptions(ctx, s.activityOptions)
+		var f Future
+		v1 := GetVersion(ctx, "change_1", DefaultVersion, 2, ExecuteWithVersion(1))
+		if v1 == DefaultVersion {
+			f = ExecuteActivity(ctx, oldActivity, "old1")
+		} else {
+			f = ExecuteActivity(ctx, newActivity, "new1")
+		}
+		var ret1 string
+		err := f.Get(ctx, &ret1) // wait for result
+		if err != nil {
+			return "", err
+		}
+
+		v2 := GetVersion(ctx, "change_2", DefaultVersion, 2)
+		if v2 == DefaultVersion {
+			f = ExecuteActivity(ctx, oldActivity, "old2")
+		} else {
+			f = ExecuteActivity(ctx, newActivity, "new2")
+		}
+		var ret2 string
+		err = f.Get(ctx, &ret2) // wait for result
+		if err != nil {
+			return "", err
+		}
+
+		// test searchable change version
+		wfInfo := GetWorkflowInfo(ctx)
+		s.NotNil(wfInfo.SearchAttributes)
+		changeVersionsBytes, ok := wfInfo.SearchAttributes.IndexedFields[CadenceChangeVersion]
+		s.True(ok)
+		var changeVersions []string
+		err = json.Unmarshal(changeVersionsBytes, &changeVersions)
+		s.NoError(err)
+		s.Equal(2, len(changeVersions))
+		s.Equal("change_2-2", changeVersions[0])
+		s.Equal("change_1--1", changeVersions[1])
+
+		return ret1 + ret2, err
+	}
+
+	env := s.NewTestWorkflowEnvironment()
+	env.RegisterWorkflow(workflowFn)
+	env.RegisterActivity(oldActivity)
+	env.RegisterActivity(newActivity)
+
+	env.OnGetVersion("change_1", DefaultVersion, 2).Return(func(string, Version, Version) Version {
+		return DefaultVersion
+	})
+	env.OnGetVersion(mock.Anything, DefaultVersion, 2).Return(Version(2))
+	env.ExecuteWorkflow(workflowFn)
+
+	s.True(env.IsWorkflowCompleted())
+	s.Nil(env.GetWorkflowError())
+	var ret string
+	s.NoError(env.GetWorkflowResult(&ret))
+	s.Equal("hello_old1hello_new2", ret)
+	env.AssertExpectations(s.T())
+}
+
+func (s *WorkflowTestSuiteUnitTest) Test_MockGetVersion_ExecuteWithMinVersion() {
+	oldActivity := func(ctx context.Context, msg string) (string, error) {
+		return "hello" + "_" + msg, nil
+	}
+	newActivity := func(ctx context.Context, msg string) (string, error) {
+		return "hello" + "_" + msg, nil
+	}
+	workflowFn := func(ctx Context) (string, error) {
+		ctx = WithActivityOptions(ctx, s.activityOptions)
+		var f Future
+		v1 := GetVersion(ctx, "change_1", DefaultVersion, 2)
+		if v1 == DefaultVersion {
+			f = ExecuteActivity(ctx, oldActivity, "old1")
+		} else {
+			f = ExecuteActivity(ctx, newActivity, "new1")
+		}
+		var ret1 string
+		err := f.Get(ctx, &ret1) // wait for result
+		if err != nil {
+			return "", err
+		}
+
+		v2 := GetVersion(ctx, "change_2", DefaultVersion, 2, ExecuteWithMinVersion())
+		if v2 == DefaultVersion {
+			f = ExecuteActivity(ctx, oldActivity, "old2")
+		} else {
+			f = ExecuteActivity(ctx, newActivity, "new2")
+		}
+		var ret2 string
+		err = f.Get(ctx, &ret2) // wait for result
+		if err != nil {
+			return "", err
+		}
+
+		// test searchable change version
+		wfInfo := GetWorkflowInfo(ctx)
+		s.NotNil(wfInfo.SearchAttributes)
+		changeVersionsBytes, ok := wfInfo.SearchAttributes.IndexedFields[CadenceChangeVersion]
+		s.True(ok)
+		var changeVersions []string
+		err = json.Unmarshal(changeVersionsBytes, &changeVersions)
+		s.NoError(err)
+		s.Equal(2, len(changeVersions))
+		s.Equal("change_2-2", changeVersions[0])
+		s.Equal("change_1--1", changeVersions[1])
+
+		return ret1 + ret2, err
+	}
+
+	env := s.NewTestWorkflowEnvironment()
+	env.RegisterWorkflow(workflowFn)
+	env.RegisterActivity(oldActivity)
+	env.RegisterActivity(newActivity)
+
+	env.OnGetVersion("change_1", DefaultVersion, 2).Return(func(string, Version, Version) Version {
+		return DefaultVersion
+	})
+	env.OnGetVersion(mock.Anything, DefaultVersion, 2).Return(Version(2))
+	env.ExecuteWorkflow(workflowFn)
+
+	s.True(env.IsWorkflowCompleted())
+	s.Nil(env.GetWorkflowError())
+	var ret string
+	s.NoError(env.GetWorkflowResult(&ret))
+	s.Equal("hello_old1hello_new2", ret)
+	env.AssertExpectations(s.T())
+}
+
 func (s *WorkflowTestSuiteUnitTest) Test_MockGetVersion() {
 	oldActivity := func(ctx context.Context, msg string) (string, error) {
 		return "hello" + "_" + msg, nil

internal/workflow_testsuite.go

@@ -365,8 +365,8 @@ func (t *TestWorkflowEnvironment) OnRequestCancelExternalWorkflow(domainName, wo
 }
 
 // OnGetVersion setup a mock for workflow.GetVersion() call. By default, if mock is not setup, the GetVersion call from
-// workflow code will always return the maxSupported version. Make it not possible to test old version branch. With this
-// mock support, it is possible to test code branch for different versions.
+// workflow code will always return the maxSupported version or version specified by GetVersionOption.
+// Make it not possible to test old version branch. With this mock support, it is possible to test code branch for different versions.
 //
 // Note: mock can be setup for a specific changeID. Or if mock.Anything is used as changeID then all calls to GetVersion
 // will be mocked. Mock for a specific changeID has higher priority over mock.Anything.