Skip to content

Commit

Permalink
Extract protoutils package (temporalio#5422)
Browse files Browse the repository at this point in the history
## What changed?
<!-- Describe what has changed in this PR -->
Extract `common/testing/protoutils` package.

## Why?
<!-- Tell your future self why have you made these changes -->
I plan to use this package outside of functional tests.

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

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

## 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.
  • Loading branch information
alexshtin authored Feb 14, 2024
1 parent f8050cc commit 4b47ecd
Show file tree
Hide file tree
Showing 4 changed files with 100 additions and 64 deletions.
55 changes: 55 additions & 0 deletions common/testing/protoutils/any.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
// 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 protoutils

import (
"reflect"

"github.com/stretchr/testify/require"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/anypb"
)

func UnmarshalAny[T proto.Message](t require.TestingT, a *anypb.Any) T {
if th, ok := t.(interface{ Helper() }); ok {
th.Helper()
}
pb := new(T)
ppb := reflect.ValueOf(pb).Elem()
pbNew := reflect.New(reflect.TypeOf(pb).Elem().Elem())
ppb.Set(pbNew)

require.NoError(t, a.UnmarshalTo(*pb))
return *pb
}

func MarshalAny(t require.TestingT, pb proto.Message) *anypb.Any {
if th, ok := t.(interface{ Helper() }); ok {
th.Helper()
}
a, err := anypb.New(pb)
require.NoError(t, err)
return a
}
2 changes: 2 additions & 0 deletions common/testing/runtime/goroutine.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,8 @@ import (

// WaitGoRoutineWithFn waits for a go routine with the given function to appear within the duration.
func WaitGoRoutineWithFn(t testing.TB, fn any, maxDuration time.Duration) {
t.Helper()

targetFnName, ok := functionNameForPC(reflect.ValueOf(fn).Pointer())
if !ok {
t.Errorf("Invalid function %#v", fn)
Expand Down
24 changes: 1 addition & 23 deletions tests/functional.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,20 +25,16 @@
package tests

import (
"reflect"
"time"

"github.com/stretchr/testify/require"
commonpb "go.temporal.io/api/common/v1"
"go.temporal.io/api/workflowservice/v1"
"go.temporal.io/server/common/testing/historyrequire"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/known/anypb"

"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"
)

Expand Down Expand Up @@ -99,24 +95,6 @@ func (s *FunctionalSuite) closeShard(wid string) {
s.NoError(err)
}

func unmarshalAny[T proto.Message](s *FunctionalSuite, a *anypb.Any) T {
s.T().Helper()
pb := new(T)
ppb := reflect.ValueOf(pb).Elem()
pbNew := reflect.New(reflect.TypeOf(pb).Elem().Elem())
ppb.Set(pbNew)

s.NoError(a.UnmarshalTo(*pb))
return *pb
}

func marshalAny(s *FunctionalSuite, pb proto.Message) *anypb.Any {
s.T().Helper()
a, err := anypb.New(pb)
s.NoError(err)
return a
}

func decodeString(s *FunctionalSuite, pls *commonpb.Payloads) string {
s.T().Helper()
var str string
Expand Down
Loading

0 comments on commit 4b47ecd

Please sign in to comment.