Files
Alex ShtinandGitHub 30a21c1848 Refactor: remove key parameter from testvar methods (#7040)
## What changed?
<!-- Describe what has changed in this PR -->
Remove `key` parameter from `testvar` methods.

## Why?
<!-- Tell your future self why have you made these changes -->
It turn out to be confusing for people on how to use optional `key`
parameter. @bergundy got a great idea to remove this parameter and use
different instance of `tv` when more than one entity is needed.

## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
Run all tests. Refactoring affects test code only.

## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
No risks.

## Documentation
<!-- Have you made sure this change doesn't falsify anything currently
stated in `docs/`? If significant
new behavior is added, have you described that in `docs/`? -->
Yes, updated testing docs.

## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
No.
2025-01-09 16:38:53 -08:00

93 lines
2.7 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 testvars
import (
"time"
"github.com/pborman/uuid"
commonpb "go.temporal.io/api/common/v1"
failurepb "go.temporal.io/api/failure/v1"
"go.temporal.io/server/common/payload"
"go.temporal.io/server/common/payloads"
"google.golang.org/protobuf/types/known/durationpb"
)
type Any struct {
testName string
testHash uint32
}
func newAny(testName string, testHash uint32) Any {
return Any{
testName: testName,
testHash: testHash,
}
}
func (a Any) String() string {
return a.testName + "_any_random_string_" + randString(5)
}
func (a Any) Payload() *commonpb.Payload {
return payload.EncodeString(a.String())
}
func (a Any) Payloads() *commonpb.Payloads {
return payloads.EncodeString(a.String())
}
func (a Any) Int() int {
// This produces number in XXX000YYY format, where XXX is unique for every test and YYY is a random number.
return randInt(a.testHash, 3, 3, 3)
}
func (a Any) Int64() int64 {
return int64(a.Int())
}
func (a Any) EventID() int64 {
// This produces EventID in XX0YY format, where XX is unique for every test and YY is a random number.
return int64(randInt(a.testHash, 2, 1, 2))
}
func (a Any) ApplicationFailure() *failurepb.Failure {
return &failurepb.Failure{
Message: a.String(),
FailureInfo: &failurepb.Failure_ApplicationFailureInfo{ApplicationFailureInfo: &failurepb.ApplicationFailureInfo{
Type: a.String(),
NonRetryable: false,
}},
}
}
func (a Any) InfiniteTimeout() *durationpb.Duration {
return durationpb.New(10 * time.Hour)
}
func (a Any) RunID() string {
return uuid.New()
}