github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/m3ninx/doc/document_matcher.go (about)

     1  // Copyright (c) 2018 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 doc
    22  
    23  import (
    24  	"fmt"
    25  	"reflect"
    26  
    27  	"github.com/golang/mock/gomock"
    28  )
    29  
    30  // DocumentMatcher matches a given document.
    31  type DocumentMatcher interface {
    32  	gomock.Matcher
    33  }
    34  
    35  // NewDocumentMatcher returns a new DocumentMatcher.
    36  func NewDocumentMatcher(d Metadata) DocumentMatcher {
    37  	return docMatcher{d}
    38  }
    39  
    40  type docMatcher struct {
    41  	d Metadata
    42  }
    43  
    44  func (dm docMatcher) Matches(x interface{}) bool {
    45  	return reflect.DeepEqual(dm.d, x)
    46  
    47  }
    48  
    49  func (dm docMatcher) String() string {
    50  	return fmt.Sprintf("doc is %+v", dm.d)
    51  }