Documentation
¶
Overview ¶
Package nettest provides an in-memory socket, Pipe. It can be used in place of net.Dial and net.Listen for faster and more hermetic tests.
Index ¶
- Variables
- type Pipe
- type PipeListener
- type RPCFactory
- func (f *RPCFactory) CreateHistoryGRPCConnection(rpcAddress string) grpc.ClientConnInterface
- func (f *RPCFactory) CreateLocalFrontendGRPCConnection() grpc.ClientConnInterface
- func (f *RPCFactory) CreateLocalFrontendHTTPClient() (*common.FrontendHTTPClient, error)
- func (f *RPCFactory) CreateMatchingGRPCConnection(rpcAddress string) grpc.ClientConnInterface
- func (f *RPCFactory) CreateRemoteFrontendGRPCConnection(rpcAddress string) grpc.ClientConnInterface
- func (f *RPCFactory) GetFrontendGRPCServerOptions() ([]grpc.ServerOption, error)
- func (f *RPCFactory) GetGRPCListener() net.Listener
- func (f *RPCFactory) GetInternodeGRPCServerOptions() ([]grpc.ServerOption, error)
Constants ¶
This section is empty.
Variables ¶
var ErrCanceled = errors.New("pipe operation canceled by client")
ErrCanceled indicates that an operation was canceled by the client (e.g. via ctx.Done()).
Functions ¶
This section is empty.
Types ¶
type Pipe ¶
type Pipe struct {
// contains filtered or unexported fields
}
Pipe is an in-memory socket. It provides similar functionality to net.Listen and net.Dial via the Pipe.Accept and Pipe.Connect methods, respectively. It is useful for faster and more deterministic testing of netcode.
type PipeListener ¶
type PipeListener struct {
*Pipe
// contains filtered or unexported fields
}
PipeListener is a net.Listener which uses a Pipe to simulate a network connection.
func NewListener ¶
func NewListener(pipe *Pipe) *PipeListener
NewListener returns a net.Listener which uses the given Pipe to simulate a network connection.
func (*PipeListener) Addr ¶
func (t *PipeListener) Addr() net.Addr
func (*PipeListener) Close ¶
func (t *PipeListener) Close() error
type RPCFactory ¶
type RPCFactory struct {
// contains filtered or unexported fields
}
RPCFactory is a common.RPCFactory implementation that uses a PipeListener to create connections. It is useful for testing gRPC servers.
func NewRPCFactory ¶
func NewRPCFactory(listener *PipeListener, dialOptions ...grpc.DialOption) *RPCFactory
NewRPCFactory creates a new RPCFactory backed by a PipeListener.
func (*RPCFactory) CreateHistoryGRPCConnection ¶
func (f *RPCFactory) CreateHistoryGRPCConnection(rpcAddress string) grpc.ClientConnInterface
func (*RPCFactory) CreateLocalFrontendGRPCConnection ¶
func (f *RPCFactory) CreateLocalFrontendGRPCConnection() grpc.ClientConnInterface
func (*RPCFactory) CreateLocalFrontendHTTPClient ¶
func (f *RPCFactory) CreateLocalFrontendHTTPClient() (*common.FrontendHTTPClient, error)
func (*RPCFactory) CreateMatchingGRPCConnection ¶
func (f *RPCFactory) CreateMatchingGRPCConnection(rpcAddress string) grpc.ClientConnInterface
func (*RPCFactory) CreateRemoteFrontendGRPCConnection ¶
func (f *RPCFactory) CreateRemoteFrontendGRPCConnection(rpcAddress string) grpc.ClientConnInterface
func (*RPCFactory) GetFrontendGRPCServerOptions ¶
func (f *RPCFactory) GetFrontendGRPCServerOptions() ([]grpc.ServerOption, error)
func (*RPCFactory) GetGRPCListener ¶
func (f *RPCFactory) GetGRPCListener() net.Listener
func (*RPCFactory) GetInternodeGRPCServerOptions ¶
func (f *RPCFactory) GetInternodeGRPCServerOptions() ([]grpc.ServerOption, error)