Files
tasks/tests/functional.go
Alex ShtinandGitHub 3748b3eb75 Workflow Update: replace runtime.WaitGoRoutineWithFn with PollWorkflowExecution API (#6258)
## What changed?
<!-- Describe what has changed in this PR -->
Replace `runtime.WaitGoRoutineWithFn` with `PollWorkflowExecution` API
in Workflow Update functional tests.

## Why?
<!-- Tell your future self why have you made these changes -->
It turned out that `runtime.WaitGoRoutineWithFn` is not reliable. After
few iteration with improvements, I decided to take a different approach.
Update is sent in separate go routine and then `PollWorkflowExecution`
API call guarantees that update reached server and admitted.

As as side effect, go routine creation was moved from test code to
`sendUpdate*` helper funcs which makes test code cleaner.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
Run few times.
2024-07-10 16:47:31 +00:00

113 lines
3.8 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 2020 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 tests
import (
"time"
"github.com/stretchr/testify/require"
commonpb "go.temporal.io/api/common/v1"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/api/adminservice/v1"
"go.temporal.io/server/common"
"go.temporal.io/server/common/dynamicconfig"
"go.temporal.io/server/common/payloads"
"go.temporal.io/server/common/testing/historyrequire"
"go.temporal.io/server/common/testing/protorequire"
"go.temporal.io/server/common/testing/updateutils"
)
type (
FunctionalSuite struct {
// override suite.Suite.Assertions with require.Assertions; this means that s.NotNil(nil) will stop the test,
// not merely log an error
*require.Assertions
protorequire.ProtoAssertions
historyrequire.HistoryRequire
updateutils.UpdateUtils
FunctionalTestBase
}
)
func (s *FunctionalSuite) SetupSuite() {
s.dynamicConfigOverrides = map[dynamicconfig.Key]any{
dynamicconfig.RetentionTimerJitterDuration.Key(): time.Second,
dynamicconfig.EnableEagerWorkflowStart.Key(): true,
dynamicconfig.EnableNexus.Key(): true,
dynamicconfig.FrontendEnableExecuteMultiOperation.Key(): true,
}
s.setupSuite("testdata/es_cluster.yaml")
}
func (s *FunctionalSuite) TearDownSuite() {
s.tearDownSuite()
}
func (s *FunctionalSuite) SetupTest() {
s.FunctionalTestBase.SetupTest()
// Have to define our overridden assertions in the test setup. If we did it earlier, s.T() will return nil
s.Assertions = require.New(s.T())
s.ProtoAssertions = protorequire.New(s.T())
s.HistoryRequire = historyrequire.New(s.T())
s.UpdateUtils = updateutils.New(s.T())
}
func (s *FunctionalSuite) sendSignal(namespace string, execution *commonpb.WorkflowExecution, signalName string,
input *commonpb.Payloads, identity string) error {
_, err := s.client.SignalWorkflowExecution(NewContext(), &workflowservice.SignalWorkflowExecutionRequest{
Namespace: namespace,
WorkflowExecution: execution,
SignalName: signalName,
Input: input,
Identity: identity,
})
return err
}
func (s *FunctionalSuite) closeShard(wid string) {
s.T().Helper()
resp, err := s.client.DescribeNamespace(NewContext(), &workflowservice.DescribeNamespaceRequest{
Namespace: s.namespace,
})
s.NoError(err)
_, err = s.adminClient.CloseShard(NewContext(), &adminservice.CloseShardRequest{
ShardId: common.WorkflowIDToHistoryShard(resp.NamespaceInfo.Id, wid, s.testClusterConfig.HistoryConfig.NumHistoryShards),
})
s.NoError(err)
}
func decodeString(s *FunctionalSuite, pls *commonpb.Payloads) string {
s.T().Helper()
var str string
err := payloads.Decode(pls, &str)
s.NoError(err)
return str
}