Refactor: remove FunctionalTestSdkSuite base struct (#7762)

## What changed?
Refactor: remove `FunctionalTestSdkSuite` base struct and move SDK
client and worker to `FunctionalTestBase`.

## Why?
Many poller based tests use SDK client/worker for various operations. It
is much more convenient to have them defined in the top level base
class.

## How did you test it?
- [ ] built
- [ ] run locally and tested manually
- [x] covered by existing tests
- [ ] added new unit test(s)
- [ ] added new functional test(s)

Author: alexshtin

tests/activity_api_batch_unpause_test.go

@@ -24,18 +24,14 @@ import (
 )
 
 type ActivityApiBatchUnpauseClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 }
 
 func TestActivityApiBatchUnpauseClientTestSuite(t *testing.T) {
 	s := new(ActivityApiBatchUnpauseClientTestSuite)
 	suite.Run(t, s)
 }
 
-func (s *ActivityApiBatchUnpauseClientTestSuite) SetupTest() {
-	s.FunctionalTestSdkSuite.SetupTest()
-}
-
 type internalTestWorkflow struct {
 	initialRetryInterval   time.Duration
 	scheduleToCloseTimeout time.Duration

tests/activity_api_pause_test.go

@@ -21,7 +21,7 @@ import (
 )
 
 type ActivityApiPauseClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 	tv                     *testvars.TestVars
 	initialRetryInterval   time.Duration
 	scheduleToCloseTimeout time.Duration
@@ -36,7 +36,7 @@ func TestActivityApiPauseClientTestSuite(t *testing.T) {
 }
 
 func (s *ActivityApiPauseClientTestSuite) SetupTest() {
-	s.FunctionalTestSdkSuite.SetupTest()
+	s.FunctionalTestBase.SetupTest()
 
 	s.tv = testvars.New(s.T()).WithTaskQueue(s.TaskQueue()).WithNamespaceName(s.Namespace())
 

tests/activity_api_reset_test.go

@@ -47,7 +47,7 @@ import (
 )
 
 type ActivityApiResetClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 	tv                     *testvars.TestVars
 	initialRetryInterval   time.Duration
 	scheduleToCloseTimeout time.Duration
@@ -62,7 +62,7 @@ func TestActivityApiResetClientTestSuite(t *testing.T) {
 }
 
 func (s *ActivityApiResetClientTestSuite) SetupTest() {
-	s.FunctionalTestSdkSuite.SetupTest()
+	s.FunctionalTestBase.SetupTest()
 
 	s.tv = testvars.New(s.T()).WithTaskQueue(s.TaskQueue()).WithNamespaceName(s.Namespace())
 

tests/activity_api_rules_test.go

@@ -24,7 +24,7 @@ import (
 )
 
 type ActivityApiRulesClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 
 	initialRetryInterval   time.Duration
 	scheduleToCloseTimeout time.Duration
@@ -127,7 +127,7 @@ func (w *internalRulesTestWorkflow) ActivityFuncForPrePause() (string, error) {
 }
 
 func (s *ActivityApiRulesClientTestSuite) SetupTest() {
-	s.FunctionalTestSdkSuite.SetupTest()
+	s.FunctionalTestBase.SetupTest()
 
 	s.OverrideDynamicConfig(dynamicconfig.WorkflowRulesAPIsEnabled, true)
 

tests/activity_api_update_test.go

@@ -23,7 +23,7 @@ import (
 )
 
 type ActivityApiUpdateClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 	tv *testvars.TestVars
 }
 
@@ -33,7 +33,7 @@ func TestActivityApiUpdateClientTestSuite(t *testing.T) {
 }
 
 func (s *ActivityApiUpdateClientTestSuite) SetupTest() {
-	s.FunctionalTestSdkSuite.SetupTest()
+	s.FunctionalTestBase.SetupTest()
 	s.tv = testvars.New(s.T()).WithTaskQueue(s.TaskQueue()).WithNamespaceName(s.Namespace())
 }
 

tests/activity_test.go

@@ -41,7 +41,7 @@ type ActivityTestSuite struct {
 }
 
 type ActivityClientTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 }
 
 func TestActivityTestSuite(t *testing.T) {
@@ -1391,15 +1391,9 @@ func (s *ActivityTestSuite) TestActivityHeartBeat_RecordIdentity() {
 }
 
 func (s *ActivityTestSuite) TestActivityTaskCompleteForceCompletion() {
-	sdkClient, err := sdkclient.Dial(sdkclient.Options{
-		HostPort:  s.FrontendGRPCAddress(),
-		Namespace: s.Namespace().String(),
-	})
-	s.NoError(err)
-
 	activityInfo := make(chan activity.Info, 1)
 	taskQueue := testcore.RandomizeStr(s.T().Name())
-	w, wf := s.mockWorkflowWithErrorActivity(activityInfo, sdkClient, taskQueue)
+	w, wf := s.mockWorkflowWithErrorActivity(activityInfo, s.SdkClient(), taskQueue)
 	s.NoError(w.Start())
 	defer w.Stop()
 
@@ -1408,35 +1402,29 @@ func (s *ActivityTestSuite) TestActivityTaskCompleteForceCompletion() {
 		ID:        uuid.New(),
 		TaskQueue: taskQueue,
 	}
-	run, err := sdkClient.ExecuteWorkflow(ctx, workflowOptions, wf)
+	run, err := s.SdkClient().ExecuteWorkflow(ctx, workflowOptions, wf)
 	s.NoError(err)
 	ai := <-activityInfo
 	s.EventuallyWithT(func(t *assert.CollectT) {
-		description, err := sdkClient.DescribeWorkflowExecution(ctx, run.GetID(), run.GetRunID())
+		description, err := s.SdkClient().DescribeWorkflowExecution(ctx, run.GetID(), run.GetRunID())
 		assert.NoError(t, err)
 		assert.Equal(t, 1, len(description.PendingActivities))
 		assert.Equal(t, "mock error of an activity", description.PendingActivities[0].LastFailure.Message)
 	},
 		10*time.Second,
 		500*time.Millisecond)
 
-	err = sdkClient.CompleteActivityByID(ctx, s.Namespace().String(), run.GetID(), run.GetRunID(), ai.ActivityID, nil, nil)
+	err = s.SdkClient().CompleteActivityByID(ctx, s.Namespace().String(), run.GetID(), run.GetRunID(), ai.ActivityID, nil, nil)
 	s.NoError(err)
 
 	// Ensure the activity is completed and the workflow is unblcked.
 	s.NoError(run.Get(ctx, nil))
 }
 
 func (s *ActivityTestSuite) TestActivityTaskCompleteRejectCompletion() {
-	sdkClient, err := sdkclient.Dial(sdkclient.Options{
-		HostPort:  s.FrontendGRPCAddress(),
-		Namespace: s.Namespace().String(),
-	})
-	s.NoError(err)
-
 	activityInfo := make(chan activity.Info, 1)
 	taskQueue := testcore.RandomizeStr(s.T().Name())
-	w, wf := s.mockWorkflowWithErrorActivity(activityInfo, sdkClient, taskQueue)
+	w, wf := s.mockWorkflowWithErrorActivity(activityInfo, s.SdkClient(), taskQueue)
 	s.NoError(w.Start())
 	defer w.Stop()
 
@@ -1445,19 +1433,19 @@ func (s *ActivityTestSuite) TestActivityTaskCompleteRejectCompletion() {
 		ID:        uuid.New(),
 		TaskQueue: taskQueue,
 	}
-	run, err := sdkClient.ExecuteWorkflow(ctx, workflowOptions, wf)
+	run, err := s.SdkClient().ExecuteWorkflow(ctx, workflowOptions, wf)
 	s.NoError(err)
 	ai := <-activityInfo
 	s.EventuallyWithT(func(t *assert.CollectT) {
-		description, err := sdkClient.DescribeWorkflowExecution(ctx, run.GetID(), run.GetRunID())
+		description, err := s.SdkClient().DescribeWorkflowExecution(ctx, run.GetID(), run.GetRunID())
 		assert.NoError(t, err)
 		assert.Equal(t, 1, len(description.PendingActivities))
 		assert.Equal(t, "mock error of an activity", description.PendingActivities[0].LastFailure.Message)
 	},
 		10*time.Second,
 		500*time.Millisecond)
 
-	err = sdkClient.CompleteActivity(ctx, ai.TaskToken, nil, nil)
+	err = s.SdkClient().CompleteActivity(ctx, ai.TaskToken, nil, nil)
 	var svcErr *serviceerror.NotFound
 	s.ErrorAs(err, &svcErr, "invalid activityID or activity already timed out or invoking workflow is completed")
 }

tests/add_tasks_test.go

@@ -38,7 +38,6 @@ type (
 
 		shardController *faultyShardController
 		worker          worker.Worker
-		sdkClient       sdkclient.Client
 		skippedTasks    chan tasks.Task
 
 		shouldSkip   atomic.Bool
@@ -134,13 +133,6 @@ func (s *AddTasksSuite) SetupSuite() {
 		),
 	),
 	)
-	// Get an SDK client so that we can call ExecuteWorkflow.
-	s.sdkClient = s.newSDKClient()
-}
-
-func (s *AddTasksSuite) TearDownSuite() {
-	s.sdkClient.Close()
-	s.FunctionalTestBase.TearDownSuite()
 }
 
 func (s *AddTasksSuite) TestAddTasks_Ok() {
@@ -159,8 +151,7 @@ func (s *AddTasksSuite) TestAddTasks_Ok() {
 	} {
 		s.Run(tc.name, func() {
 			// Register a workflow which does nothing.
-			taskQueue := testcore.RandomizeStr("add-tasks-test-queue")
-			w := worker.New(s.sdkClient, taskQueue, worker.Options{DeadlockDetectionTimeout: 0})
+			w := worker.New(s.SdkClient(), s.TaskQueue(), worker.Options{DeadlockDetectionTimeout: 0})
 			myWorkflow := func(ctx workflow.Context) error {
 				return nil
 			}
@@ -178,9 +169,9 @@ func (s *AddTasksSuite) TestAddTasks_Ok() {
 			timeout := 5 * debug.TimeoutMultiplier * time.Second
 			ctx, cancel := context.WithTimeout(ctx, timeout)
 			defer cancel()
-			run, err := s.sdkClient.ExecuteWorkflow(ctx, sdkclient.StartWorkflowOptions{
+			run, err := s.SdkClient().ExecuteWorkflow(ctx, sdkclient.StartWorkflowOptions{
 				ID:        workflowID,
-				TaskQueue: taskQueue,
+				TaskQueue: s.TaskQueue(),
 			}, myWorkflow)
 			s.NoError(err)
 
@@ -244,12 +235,3 @@ func (s *AddTasksSuite) TestAddTasks_GetEngineErr() {
 	s.Error(err)
 	s.ErrorContains(err, (*s.getEngineErr.Load()).Error())
 }
-
-func (s *AddTasksSuite) newSDKClient() sdkclient.Client {
-	client, err := sdkclient.Dial(sdkclient.Options{
-		HostPort:  s.FrontendGRPCAddress(),
-		Namespace: s.Namespace().String(),
-	})
-	s.Require().NoError(err)
-	return client
-}

tests/admin_test.go

@@ -17,7 +17,7 @@ import (
 )
 
 type AdminTestSuite struct {
-	testcore.FunctionalTestSdkSuite
+	testcore.FunctionalTestBase
 }
 
 func TestAdminTestSuite(t *testing.T) {