change require.protoEquals to support compare options (#9937)

## What changed?
Added ProtoEqualIgnoreFields to protoassert and protorequire packages.
Refactored 3 call sites in standalone_activity_test.go to use the new
helper.

## Why?
Comparing proto messages while ignoring specific fields required a
verbose pattern (cmp.Diff + protocmp.Transform() +
protocmp.IgnoreFields() + require.Empty). The new option extends
ProtoEqual with a clean call site that infers the message type
automatically. The Option func type and config struct are designed to
support additional comparison options in the future without changing the
ProtoEqual signature.

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

Author: fretz12

common/testing/protorequire/require.go

@@ -1,15 +1,37 @@
 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 {
 	Helper()
 }
 
+// config holds settings populated by Option functions. Add new fields here for custom comparison behaviors beyond cmp
+// options.
+type config struct {
+	cmpOpts []cmp.Option
+}
+
+// Option configures how proto comparison behaves.
+type Option func(msg proto.Message, cfg *config)
+
+// IgnoreFields returns an Option that ignores the specified fields (by proto name) on the top-level message type
+// when comparing.
+func IgnoreFields(fields ...protoreflect.Name) Option {
+	return func(msg proto.Message, cfg *config) {
+		cfg.cmpOpts = append(cfg.cmpOpts, protocmp.IgnoreFields(msg, fields...))
+	}
+}
+
 type ProtoAssertions struct {
 	t require.TestingT
 }
@@ -18,12 +40,19 @@ func New(t require.TestingT) ProtoAssertions {
 	return ProtoAssertions{t}
 }
 
-func ProtoEqual(t require.TestingT, a proto.Message, b proto.Message) {
+// ProtoEqual compares two proto messages for equality using proto semantics. Options can be passed to customize
+// comparison behavior, e.g. protorequire.IgnoreFields to exclude specific fields.
+func ProtoEqual(t require.TestingT, a proto.Message, b proto.Message, opts ...Option) {
 	if th, ok := t.(helper); ok {
 		th.Helper()
 	}
-	if !protoassert.ProtoEqual(t, a, b) {
-		t.FailNow()
+	cfg := &config{}
+	for _, opt := range opts {
+		opt(a, cfg)
+	}
+	cmpOpts := append([]cmp.Option{protocmp.Transform()}, cfg.cmpOpts...)
+	if diff := cmp.Diff(a, b, cmpOpts...); diff != "" {
+		require.Fail(t, fmt.Sprintf("Proto mismatch (-want +got):\n%v", diff))
 	}
 }
 
@@ -49,13 +78,11 @@ func ProtoSliceEqual[T proto.Message](t require.TestingT, a []T, b []T) {
 	}
 }
 
-func (x ProtoAssertions) ProtoEqual(a proto.Message, b proto.Message) {
+func (x ProtoAssertions) ProtoEqual(a proto.Message, b proto.Message, opts ...Option) {
 	if th, ok := x.t.(helper); ok {
 		th.Helper()
 	}
-	if !protoassert.ProtoEqual(x.t, a, b) {
-		x.t.FailNow()
-	}
+	ProtoEqual(x.t, a, b, opts...)
 }
 
 func (x ProtoAssertions) NotProtoEqual(a proto.Message, b proto.Message) {

common/testing/protorequire/require_test.go

@@ -0,0 +1,63 @@
+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"
+
+type mockT struct {
+	failed bool
+}
+
+func (m *mockT) Errorf(string, ...any) {
+	m.failed = true
+}
+
+func (m *mockT) FailNow() {
+	m.failed = true
+}
+
+func TestProtoEqualIgnoreFields(t *testing.T) {
+	a := &workflowpb.WorkflowExecutionInfo{
+		Execution: &commonpb.WorkflowExecution{
+			WorkflowId: "wf-1",
+			RunId:      myUUID,
+		},
+		Status:    1,
+		TaskQueue: "queue-a",
+	}
+	b := &workflowpb.WorkflowExecutionInfo{
+		Execution: &commonpb.WorkflowExecution{
+			WorkflowId: "wf-1",
+			RunId:      myUUID,
+		},
+		Status:    2,
+		TaskQueue: "queue-b",
+	}
+
+	t.Run("all differing fields ignored", func(t *testing.T) {
+		protorequire.ProtoEqual(t, a, b,
+			protorequire.IgnoreFields(
+				"status",
+				"task_queue",
+			),
+		)
+	})
+
+	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")
+		}
+	})
+}

tests/standalone_activity_test.go

@@ -9,7 +9,6 @@ import (
 	"testing"
 	"time"
 
-	"github.com/google/go-cmp/cmp"
 	"github.com/nexus-rpc/sdk-go/nexus"
 	"github.com/stretchr/testify/require"
 	"github.com/stretchr/testify/suite"
@@ -37,7 +36,6 @@ import (
 	"go.temporal.io/server/components/callbacks"
 	"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"
 )
@@ -3044,17 +3042,15 @@ func (s *standaloneActivityTestSuite) TestDescribeActivityExecution_NoWait() {
 			UserMetadata:           defaultUserMetadata,
 		}
 
-		diff := cmp.Diff(expected, respInfo,
-			protocmp.Transform(),
-			// Ignore non-deterministic fields. Validated separately.
-			protocmp.IgnoreFields(&activitypb.ActivityExecutionInfo{},
+		// Ignore non-deterministic fields. Validated separately.
+		protorequire.ProtoEqual(t, expected, respInfo,
+			protorequire.IgnoreFields(
 				"execution_duration",
 				"schedule_time",
 				"state_size_bytes",
 				"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())
@@ -3107,17 +3103,16 @@ 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{},
+
+	// Ignore non-deterministic fields. Validated separately.
+	protorequire.ProtoEqual(t, expected, firstDescribeResp.GetInfo(),
+		protorequire.IgnoreFields(
 			"execution_duration",
 			"schedule_time",
 			"state_size_bytes",
 			"state_transition_count",
 		),
 	)
-	require.Empty(t, diff)
 	require.Positive(t, firstDescribeResp.GetInfo().GetStateSizeBytes())
 
 	taskQueuePollErr := make(chan error, 1)
@@ -3167,18 +3162,17 @@ 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{},
+
+		// Ignore non-deterministic fields. Validated separately.
+		protorequire.ProtoEqual(t, expected, describeResp.GetInfo(),
+			protorequire.IgnoreFields(
 				"execution_duration",
 				"last_started_time",
 				"schedule_time",
 				"state_size_bytes",
 				"state_transition_count",
 			),
 		)
-		require.Empty(t, diff)
 		require.Positive(t, describeResp.GetInfo().GetStateSizeBytes())
 
 		protorequire.ProtoEqual(t, defaultInput, describeResp.Input)