go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/testing/mock/gomock.go (about)

     1  // Copyright 2020 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  // Package mock has utility functions for gomock.
    16  package mock
    17  
    18  import (
    19  	"fmt"
    20  
    21  	"github.com/golang/mock/gomock"
    22  	"github.com/golang/protobuf/proto"
    23  )
    24  
    25  type protoEqMatcher struct {
    26  	textDef string
    27  }
    28  
    29  func (m *protoEqMatcher) Matches(x any) bool {
    30  	return proto.CompactTextString(x.(proto.Message)) == m.textDef
    31  }
    32  
    33  func (m *protoEqMatcher) String() string {
    34  	return fmt.Sprintf("is equivalent to proto %q", m.textDef)
    35  }
    36  
    37  // EqProto is an equivalent of gomock.Eq for protobuf messages.
    38  func EqProto(m proto.Message) gomock.Matcher {
    39  	return &protoEqMatcher{textDef: proto.CompactTextString(m)}
    40  }