Skip to content

change require.protoEquals to support compare options #9937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fretz12 merged 10 commits into from
Apr 24, 2026
+108 −24
Merged

change require.protoEquals to support compare options #9937

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
8207153
add protorequire.ProtoEqualIgnoreFields helper
fretz12 Apr 13, 2026
89e4431
remove assert version
fretz12 Apr 13, 2026
2c6e553
change to test multiple ignore fields
fretz12 Apr 13, 2026
4ec2902
Merge main
fretz12 Apr 22, 2026
dc23b9c
Remove unused import
fretz12 Apr 22, 2026
7dde6ef
Add IgnoreFields option to protorequire.ProtoEqual
fretz12 Apr 23, 2026
9cc3ac4
Merge branch 'main' into fredtzeng/proto-equals-ignore
fretz12 Apr 23, 2026
d03939d
Fix lint.
fretz12 Apr 23, 2026
64f0af3
Merge remote-tracking branch 'origin/fredtzeng/proto-equals-ignore' i…
fretz12 Apr 23, 2026
7a317ff
Use mock testing harness
fretz12 Apr 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions common/testing/protorequire/require.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
package protorequire

import (
"fmt"

"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/require"
"go.temporal.io/server/common/testing/protoassert"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/reflect/protoreflect"
"google.golang.org/protobuf/testing/protocmp"
)

type helper interface {
Expand All @@ -27,6 +32,17 @@ func ProtoEqual(t require.TestingT, a proto.Message, b proto.Message) {
}
}

// ProtoEqualIgnoreFields compares two proto messages for equality, ignoring the specified fields on the given message
// type. Fields are specified by their proto name (snake_case).
func ProtoEqualIgnoreFields(t require.TestingT, a proto.Message, b proto.Message, msgType proto.Message, fields ...protoreflect.Name) {
Copy link
Copy Markdown
Contributor Author

@fretz12 fretz12 Apr 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Food for thought.
There's some other interesting options we can potentially expose:

protocmp.SortRepeatedFields
protocmp.IgnoreEnums
cmpopts.EquateApproxTime
Also another approach is to make this a really generic function:
func ProtoEqualWithOptions(t assert.TestingT, a proto.Message, b proto.Message, opts ...cmp.Option) bool

and it can be used as such:
protorequire.ProtoEqualWithOptions(t, expected, actual, protocmp.IgnoreFields(&activitypb.ActivityExecutionInfo{}, "state_transition_count"), cmpopts.EquateApproxTime(5*time.Second), )

However, that leaks proto/cmp abstractions making the helper harder to use. I decided to make the helper focused on ignore fields, as that's our majority use case and the interface is very clean. I propose for other useful options, like EquateApproxTime, we create separate helpers. But open to thoughts

if th, ok := t.(helper); ok {
th.Helper()
}
if diff := cmp.Diff(a, b, protocmp.Transform(), protocmp.IgnoreFields(msgType, fields...)); diff != "" {
require.Fail(t, fmt.Sprintf("Proto mismatch (-want +got):\n%v", diff))
}
}

func NotProtoEqual(t require.TestingT, a proto.Message, b proto.Message) {
if th, ok := t.(helper); ok {
th.Helper()
Expand Down Expand Up @@ -83,3 +99,10 @@ func (x ProtoAssertions) ProtoElementsMatch(a any, b any) bool {

return protoassert.ProtoElementsMatch(x.t, a, b)
}

func (x ProtoAssertions) ProtoEqualIgnoreFields(a proto.Message, b proto.Message, msgType proto.Message, fields ...protoreflect.Name) {
if th, ok := x.t.(helper); ok {
th.Helper()
}
ProtoEqualIgnoreFields(x.t, a, b, msgType, fields...)
}
34 changes: 34 additions & 0 deletions common/testing/protorequire/require_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
package protorequire_test

import (
"testing"

commonpb "go.temporal.io/api/common/v1"
workflowpb "go.temporal.io/api/workflow/v1"
"go.temporal.io/server/common/testing/protorequire"
)

const myUUID = "deb7b204-b384-4fde-85c6-e5a56c42336a"

func TestProtoEqualIgnoreFields(t *testing.T) {
a := &workflowpb.WorkflowExecutionInfo{
Execution: &commonpb.WorkflowExecution{
WorkflowId: "wf-1",
RunId: myUUID,
},
Status: 1,
}
b := &workflowpb.WorkflowExecutionInfo{
Execution: &commonpb.WorkflowExecution{
WorkflowId: "wf-1",
RunId: myUUID,
},
Status: 2, // different — will be ignored
}

// Should pass: "status" is ignored
protorequire.ProtoEqualIgnoreFields(t, a, b,
&workflowpb.WorkflowExecutionInfo{},
"status",
)
}
Copy link
Copy Markdown
Contributor

@long-nt-tran long-nt-tran Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like the negative test's expected failure is leaking as the suite failure. We might need a mock for require.testingT interface, i.e.,

type mockT struct {
    failed bool
}

func (m *mockT) Errorf(format string, args ...interface{}) {
    m.failed = true
}

func (m *mockT) FailNow() {
    m.failed = true
}

then this test can be

	t.Run("partial ignore still fails", func(t *testing.T) {
		mt := &mockT{}
		protorequire.ProtoEqual(mt, a, b,
			protorequire.IgnoreFields(
				"status",
			),
		)
		if !mt.failed {
			t.Fatal("expected comparison to fail when not all differing fields are ignored")
		}
	})

Copy link
Copy Markdown
Contributor Author

@fretz12 fretz12 Apr 23, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good call.. changed

49 changes: 19 additions & 30 deletions tests/standalone_activity_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ import (
"testing"
"time"

"github.com/google/go-cmp/cmp"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
activitypb "go.temporal.io/api/activity/v1"
Expand All @@ -29,7 +28,6 @@ import (
"go.temporal.io/server/common/testing/testvars"
"go.temporal.io/server/tests/testcore"
"google.golang.org/grpc/codes"
"google.golang.org/protobuf/testing/protocmp"
"google.golang.org/protobuf/types/known/durationpb"
"google.golang.org/protobuf/types/known/timestamppb"
)
Expand Down Expand Up @@ -2866,16 +2864,13 @@ func (s *standaloneActivityTestSuite) TestDescribeActivityExecution_NoWait() {
UserMetadata: defaultUserMetadata,
}

diff := cmp.Diff(expected, respInfo,
protocmp.Transform(),
// Ignore non-deterministic fields. Validated separately.
protocmp.IgnoreFields(&activitypb.ActivityExecutionInfo{},
"execution_duration",
"schedule_time",
"state_transition_count",
),
// Ignore non-deterministic fields. Validated separately.
protorequire.ProtoEqualIgnoreFields(t, expected, respInfo,
&activitypb.ActivityExecutionInfo{},
"execution_duration",
"schedule_time",
"state_transition_count",
)
require.Empty(t, diff)
require.Equal(t, respInfo.GetExecutionDuration().AsDuration(), time.Duration(0)) // Never completed, so expect 0
require.Nil(t, describeResp.GetInfo().GetCloseTime())
require.Positive(t, respInfo.GetScheduleTime().AsTime().Unix())
Expand Down Expand Up @@ -2927,16 +2922,13 @@ func (s *standaloneActivityTestSuite) TestDescribeActivityExecution_WaitAnyState
Status: enumspb.ACTIVITY_EXECUTION_STATUS_RUNNING,
TaskQueue: taskQueue.Name,
}
diff := cmp.Diff(expected, firstDescribeResp.GetInfo(),
protocmp.Transform(),
// Ignore non-deterministic fields. Validated separately.
protocmp.IgnoreFields(&activitypb.ActivityExecutionInfo{},
"execution_duration",
"schedule_time",
"state_transition_count",
),
// Ignore non-deterministic fields. Validated separately.
protorequire.ProtoEqualIgnoreFields(t, expected, firstDescribeResp.GetInfo(),
&activitypb.ActivityExecutionInfo{},
"execution_duration",
"schedule_time",
"state_transition_count",
)
require.Empty(t, diff)

taskQueuePollErr := make(chan error, 1)
activityPollDone := make(chan struct{})
Expand Down Expand Up @@ -2985,17 +2977,14 @@ func (s *standaloneActivityTestSuite) TestDescribeActivityExecution_WaitAnyState
Status: enumspb.ACTIVITY_EXECUTION_STATUS_RUNNING,
TaskQueue: taskQueue.Name,
}
diff := cmp.Diff(expected, describeResp.GetInfo(),
protocmp.Transform(),
// Ignore non-deterministic fields. Validated separately.
protocmp.IgnoreFields(&activitypb.ActivityExecutionInfo{},
"execution_duration",
"last_started_time",
"schedule_time",
"state_transition_count",
),
// Ignore non-deterministic fields. Validated separately.
protorequire.ProtoEqualIgnoreFields(t, expected, describeResp.GetInfo(),
&activitypb.ActivityExecutionInfo{},
"execution_duration",
"last_started_time",
"schedule_time",
"state_transition_count",
)
require.Empty(t, diff)

protorequire.ProtoEqual(t, defaultInput, describeResp.Input)

Expand Down
Loading