github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/namespace/metadata_matcher.go (about)

     1  // Copyright (c) 2017 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package namespace
    22  
    23  import (
    24  	"fmt"
    25  
    26  	"github.com/golang/mock/gomock"
    27  )
    28  
    29  // MetadataMatcher is a gomock.Matcher that matches metadata
    30  type MetadataMatcher interface {
    31  	gomock.Matcher
    32  }
    33  
    34  // NewMetadataMatcher returns a new MetadataMatcher
    35  func NewMetadataMatcher(md Metadata) MetadataMatcher {
    36  	return &mdMatcher{md: md}
    37  }
    38  
    39  type mdMatcher struct {
    40  	md Metadata
    41  }
    42  
    43  func (m *mdMatcher) Matches(x interface{}) bool {
    44  	omd, ok := x.(Metadata)
    45  	if !ok {
    46  		return false
    47  	}
    48  	return m.md.Equal(omd)
    49  }
    50  
    51  func (m *mdMatcher) String() string {
    52  	return fmt.Sprintf("metadata [ id = %s ]", m.md.ID().String())
    53  }