go.uber.org/yarpc@v1.72.1/yarpctest/fake_peer_chooser.go (about)

     1  // Copyright (c) 2022 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 yarpctest
    22  
    23  import (
    24  	"context"
    25  	"fmt"
    26  
    27  	"go.uber.org/yarpc/api/peer"
    28  	"go.uber.org/yarpc/api/transport"
    29  	"go.uber.org/yarpc/pkg/lifecycletest"
    30  )
    31  
    32  // FakePeerChooserOption is an option for NewFakePeerChooser.
    33  type FakePeerChooserOption func(*FakePeerChooser)
    34  
    35  // ChooserNop is a fake option for NewFakePeerChooser that sets a nop var. It's fake.
    36  func ChooserNop(nop string) func(*FakePeerChooser) {
    37  	return func(u *FakePeerChooser) {
    38  		u.nop = nop
    39  	}
    40  }
    41  
    42  // FakePeerChooser is a fake peer chooser.
    43  type FakePeerChooser struct {
    44  	transport.Lifecycle
    45  
    46  	nop string
    47  }
    48  
    49  // NewFakePeerChooser returns a fake peer list.
    50  func NewFakePeerChooser(opts ...FakePeerChooserOption) *FakePeerChooser {
    51  	pl := &FakePeerChooser{
    52  		Lifecycle: lifecycletest.NewNop(),
    53  	}
    54  	for _, opt := range opts {
    55  		opt(pl)
    56  	}
    57  	return pl
    58  }
    59  
    60  // Choose pretends to choose a peer, but actually always returns an error. It's fake.
    61  func (c *FakePeerChooser) Choose(ctx context.Context, req *transport.Request) (peer.Peer, func(error), error) {
    62  	return nil, nil, fmt.Errorf(`fake peer chooser can't actually choose peers`)
    63  }
    64  
    65  // Nop returns the Peer Chooser's nop variable.
    66  func (c *FakePeerChooser) Nop() string {
    67  	return c.nop
    68  }