Added the Activity Registration required failure scenario to replayer test suite (#1231)

* Added the Activity Registration required failure scenario to replayer test suite

* Renamed files according to go convention

* added copyright info to the files

* Skipped the test case that panics at incompatible activity returns. This is an expected behaviour and test is included for documentation purposes.

Author: agautam478

test/replaytests/activity_check.go

@@ -0,0 +1,72 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
+package replaytests
+
+import (
+	"go.uber.org/cadence/workflow"
+	"go.uber.org/zap"
+	"time"
+)
+
+// greetingsWorkflowActivity demonstrates the case in replayer where if an activity name is changed in a workflow or if a new activity is introdced in a workflow then the shdower fails.
+// There is also no other way to register the activity except for changing the json file so far.
+// CDNC-2267 addresses a fix for this.
+func greetingsWorkflowActivity(ctx workflow.Context) error {
+	// Get Greeting.
+	ao := workflow.ActivityOptions{
+		ScheduleToStartTimeout: time.Minute,
+		StartToCloseTimeout:    time.Minute,
+		HeartbeatTimeout:       time.Second * 20,
+	}
+	ctx = workflow.WithActivityOptions(ctx, ao)
+
+	logger := workflow.GetLogger(ctx)
+	var greetResult int64
+	err := workflow.ExecuteActivity(ctx, getGreetingActivitytest).Get(ctx, &greetResult)
+	if err != nil {
+		logger.Error("Get greeting failed.", zap.Error(err))
+		return err
+	}
+
+	// Get Name.
+	var nameResult string
+	err = workflow.ExecuteActivity(ctx, getNameActivity).Get(ctx, &nameResult)
+	if err != nil {
+		logger.Error("Get name failed.", zap.Error(err))
+		return err
+	}
+
+	// Say Greeting.
+	var sayResult string
+	err = workflow.ExecuteActivity(ctx, sayGreetingActivity, greetResult, nameResult).Get(ctx, &sayResult)
+	if err != nil {
+		logger.Error("Marshalling failed with error.", zap.Error(err))
+		return err
+	}
+
+	logger.Info("Workflow completed.", zap.String("Result", sayResult))
+	return nil
+}
+
+// Get Greeting Activity.
+func getGreetingActivitytest() (string, error) {
+	return "Hello", nil
+}

test/replaytests/replay_test.go

@@ -53,6 +53,14 @@ func TestReplayChildWorkflowBugBackport(t *testing.T) {
 	require.NoError(t, err)
 }
 
+// Gives a non-deterministic-error because the getGreetingActivitytest was not registered on the replayer.
+func TestGreetingsWorkflowforActivity(t *testing.T) {
+	replayer := worker.NewWorkflowReplayer()
+	replayer.RegisterWorkflowWithOptions(greetingsWorkflowActivity, workflow.RegisterOptions{Name: "greetings"})
+	err := replayer.ReplayWorkflowHistoryFromJSONFile(zaptest.NewLogger(t), "greetings.json")
+	require.Error(t, err)
+}
+
 func TestGreetingsWorkflow(t *testing.T) {
 	replayer := worker.NewWorkflowReplayer()
 	replayer.RegisterWorkflowWithOptions(greetingsWorkflow, workflow.RegisterOptions{Name: "greetings"})
@@ -75,16 +83,18 @@ func TestGreetingsWorkflow4(t *testing.T) {
 	activity.RegisterWithOptions(getNameActivity4, activity.RegisterOptions{Name: "main.getNameActivity", DisableAlreadyRegisteredCheck: true})
 	replayer.RegisterWorkflowWithOptions(greetingsWorkflow4, workflow.RegisterOptions{Name: "greetings"})
 	err := replayer.ReplayWorkflowHistoryFromJSONFile(zaptest.NewLogger(t), "greetings.json")
-	require.NoError(t, err)
+	require.Error(t, err)
 }
 
-// Fails with a non deterministic error. This passes in cadence_samples because it's registered in Helper.
+// Panic with failed to register activity. This passes in cadence_samples because it's registered in Helper.
 // To test it on cadence_samples change the https://github.com/uber-common/cadence-samples/blob/master/cmd/samples/recipes/greetings/greetings_workflow.go
 // to include the extra return types in getNameActivity.
 func TestGreetingsWorkflow2(t *testing.T) {
+
+	t.Skip("Panic with failed to register activity. Here the activity returns incompatible arguments so the test should fail")
 	replayer := worker.NewWorkflowReplayer()
 	activity.RegisterWithOptions(getNameActivity2, activity.RegisterOptions{Name: "main.getNameActivity", DisableAlreadyRegisteredCheck: true})
 	replayer.RegisterWorkflowWithOptions(greetingsWorkflow2, workflow.RegisterOptions{Name: "greetings"})
 	err := replayer.ReplayWorkflowHistoryFromJSONFile(zaptest.NewLogger(t), "greetings.json")
-	require.NoError(t, err)
+	require.Error(t, err)
 }

test/replaytests/signatureBugWorkflow.go renamed to test/replaytests/signature_bug.go

@@ -1,3 +1,23 @@
+// Copyright (c) 2017 Uber Technologies, Inc.
+//
+// Permission is hereby granted, free of charge, to any person obtaining a copy
+// of this software and associated documentation files (the "Software"), to deal
+// in the Software without restriction, including without limitation the rights
+// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+// copies of the Software, and to permit persons to whom the Software is
+// furnished to do so, subject to the following conditions:
+//
+// The above copyright notice and this permission notice shall be included in
+// all copies or substantial portions of the Software.
+//
+// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+// THE SOFTWARE.
+
 package replaytests
 
 import (