Documentation
¶
Index ¶
- func Actions(actions ...api.Action) api.Action
- func Body(msg string) api.RequestOption
- func Chooser(f func(peer.Identifier, peer.Transport) (peer.Chooser, error)) *types.ChooserFactory
- func ClientStreamActions(actions ...api.ClientStreamAction) api.ClientStreamRequestOption
- func CloseStream() api.ClientStreamAction
- func ConcurrentAction(action Action, threads int) api.Action
- func EchoHandler(mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
- func EchoHandlerWithPrefix(prefix string, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
- func EchoStreamHandler() api.ProcOption
- func ErrorHandler(err error, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
- func GRPCRequest(options ...api.RequestOption) api.Action
- func GRPCService(options ...api.ServiceOption) api.Lifecycle
- func GRPCStreamRequest(options ...api.ClientStreamRequestOption) api.Action
- func GiveAndWantLargeBodyIsEchoed(numOfBytes int) api.RequestOption
- func GiveTimeout(duration time.Duration) api.RequestOption
- func HTTPRequest(options ...api.RequestOption) api.Action
- func HTTPService(options ...api.ServiceOption) api.Lifecycle
- func Lifecycles(l ...api.Lifecycle) api.Lifecycle
- func Name(name string) *types.Name
- func NewPortProvider(t testing.TB) *types.PortProvider
- func OrderedRequestHandler(options ...api.HandlerOption) *types.OrderedHandler
- func OrderedStreamHandler(actions ...api.ServerStreamAction) api.ProcOption
- func Port(port uint16) *types.Port
- func Proc(options ...api.ProcOption) api.ServiceOption
- func Procedure(procedure string) *types.Procedure
- func RecvStreamErr(wantErrMsgs ...string) *types.RecvStreamMsg
- func RecvStreamErrInstance(wantErr error) *types.RecvStreamMsg
- func RecvStreamMsg(wantMsg string) *types.RecvStreamMsg
- func RepeatAction(action Action, times int) api.Action
- func Retry(count int, interval time.Duration) api.RequestOption
- func SendStreamDecodeErrorAndExpectError(decodeErr error, wantErrMsgs ...string) *types.SendStreamMsg
- func SendStreamMsg(sendMsg string) *types.SendStreamMsg
- func SendStreamMsgAndExpectError(sendMsg string, wantErrMsgs ...string) *types.SendStreamMsg
- func Service(service string) *types.Service
- func ShardKey(key string) *types.ShardKey
- func StaticHandler(msg string, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
- func StreamHandlerError(err error) api.ServerStreamAction
- func StreamSendHeaders(headers map[string]string) api.ServerStreamAction
- func TChannelRequest(options ...api.RequestOption) api.Action
- func TChannelService(options ...api.ServiceOption) api.Lifecycle
- func UnaryOutboundMiddleware(mw ...middleware.UnaryOutbound) api.RequestOption
- func WantError(errMsg string) api.RequestOption
- func WantHeader(key, value string) *types.WantHeader
- func WantHeaders(want map[string]string) api.ClientStreamAction
- func WantRespBody(body string) api.RequestOption
- func WantStreamError(wantErrMsgs ...string) api.ClientStreamRequestOption
- func WithHeader(key, value string) *types.GiveHeader
- type Action
- type Lifecycle
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Body ¶
func Body(msg string) api.RequestOption
Body sets the body on a request to the raw representation of the msg field.
func Chooser ¶ added in v1.46.0
func Chooser(f func(peer.Identifier, peer.Transport) (peer.Chooser, error)) *types.ChooserFactory
Chooser overrides the peer.Chooser for a request.
func ClientStreamActions ¶ added in v1.27.0
func ClientStreamActions(actions ...api.ClientStreamAction) api.ClientStreamRequestOption
ClientStreamActions combines a series of client stream actions into actions that will be applied when the StreamRequest is run.
func CloseStream ¶ added in v1.27.0
func CloseStream() api.ClientStreamAction
CloseStream is an action to close a client stream.
func ConcurrentAction ¶ added in v1.27.0
ConcurrentAction will call the provided action in n concurrent threads at the same time.
func EchoHandler ¶
func EchoHandler(mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
EchoHandler is a Unary Handler that will echo the body of the request into the response.
func EchoHandlerWithPrefix ¶
func EchoHandlerWithPrefix(prefix string, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
EchoHandlerWithPrefix will echo the request it receives into the response, but, it will insert a prefix in front of the message.
func EchoStreamHandler ¶ added in v1.27.0
func EchoStreamHandler() api.ProcOption
EchoStreamHandler is a Bidirectional Stream Handler that will echo any request that is sent to it.
func ErrorHandler ¶
func ErrorHandler(err error, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
ErrorHandler will always return an Error.
func GRPCRequest ¶
func GRPCRequest(options ...api.RequestOption) api.Action
GRPCRequest creates a new grpc unary request.
func GRPCService ¶
func GRPCService(options ...api.ServiceOption) api.Lifecycle
GRPCService will create a runnable GRPC service.
func GRPCStreamRequest ¶ added in v1.27.0
func GRPCStreamRequest(options ...api.ClientStreamRequestOption) api.Action
GRPCStreamRequest creates a new grpc stream request.
func GiveAndWantLargeBodyIsEchoed ¶
func GiveAndWantLargeBodyIsEchoed(numOfBytes int) api.RequestOption
GiveAndWantLargeBodyIsEchoed creates an extremely large random byte buffer and validates that the body is echoed back to the response.
func GiveTimeout ¶ added in v1.27.0
func GiveTimeout(duration time.Duration) api.RequestOption
GiveTimeout will set the timeout for the request.
func HTTPRequest ¶
func HTTPRequest(options ...api.RequestOption) api.Action
HTTPRequest creates a new YARPC http request.
func HTTPService ¶
func HTTPService(options ...api.ServiceOption) api.Lifecycle
HTTPService will create a runnable HTTP service.
func Lifecycles ¶
Lifecycles is a wrapper around a list of Lifecycle definitions.
func Name ¶
Name is a shared option across services and procedures. It can be used as input in the constructor of both types.
func NewPortProvider ¶
func NewPortProvider(t testing.TB) *types.PortProvider
NewPortProvider creates an object that can be used to synchronize ports in yarpctest infrastructure. Ports can be acquired through the "Port" function which will create new ports for the test based on the id passed into the function.
func OrderedRequestHandler ¶
func OrderedRequestHandler(options ...api.HandlerOption) *types.OrderedHandler
OrderedRequestHandler will execute a series of Handlers in the order they are passed in. If the number of requests does not match, it will return an unknown error.
func OrderedStreamHandler ¶ added in v1.27.0
func OrderedStreamHandler(actions ...api.ServerStreamAction) api.ProcOption
OrderedStreamHandler is a bidirectional stream handler that can apply stream actions in a specified order.
func Port ¶
Port is a shared option across services and requests. It can be embedded in the constructor of both types.
func Proc ¶
func Proc(options ...api.ProcOption) api.ServiceOption
Proc will create a new Procedure that can be included in a Service.
func Procedure ¶
Procedure specifies the "procedure" header for a request. It is a shared option across different requests.
func RecvStreamErr ¶ added in v1.27.0
func RecvStreamErr(wantErrMsgs ...string) *types.RecvStreamMsg
RecvStreamErr waits to receive a message on a client stream. It expects error messages.
func RecvStreamErrInstance ¶ added in v1.49.1
func RecvStreamErrInstance(wantErr error) *types.RecvStreamMsg
RecvStreamErrInstance waits to receive a message on a client stream. It expects an error.
func RecvStreamMsg ¶ added in v1.27.0
func RecvStreamMsg(wantMsg string) *types.RecvStreamMsg
RecvStreamMsg waits to receive a message on a client stream.
func RepeatAction ¶ added in v1.27.0
RepeatAction will call the provided action a set number of times (the action must be idempotent).
func Retry ¶ added in v1.33.0
func Retry(count int, interval time.Duration) api.RequestOption
Retry retries the request for a given times, until the request succeeds and the response matches.
func SendStreamDecodeErrorAndExpectError ¶ added in v1.27.0
func SendStreamDecodeErrorAndExpectError(decodeErr error, wantErrMsgs ...string) *types.SendStreamMsg
SendStreamDecodeErrorAndExpectError induces a decode error on the stream message and asserts on the result.
func SendStreamMsg ¶ added in v1.27.0
func SendStreamMsg(sendMsg string) *types.SendStreamMsg
SendStreamMsg sends a message to a stream.
func SendStreamMsgAndExpectError ¶ added in v1.27.0
func SendStreamMsgAndExpectError(sendMsg string, wantErrMsgs ...string) *types.SendStreamMsg
SendStreamMsgAndExpectError sends a message on a stream and asserts on the error returned.
func Service ¶
Service specifies the "service" header for a request. It is a shared option across different requests.
func ShardKey ¶
ShardKey specifies that "shard key" header for a request. It is a shared option across different requests.
func StaticHandler ¶
func StaticHandler(msg string, mw ...api.UnaryInboundMiddleware) *types.UnaryHandler
StaticHandler will always return the same response.
func StreamHandlerError ¶ added in v1.27.0
func StreamHandlerError(err error) api.ServerStreamAction
StreamHandlerError is an action to return an error from a ServerStream handler.
func StreamSendHeaders ¶ added in v1.47.0
func StreamSendHeaders(headers map[string]string) api.ServerStreamAction
StreamSendHeaders is an action to send stream headers.
func TChannelRequest ¶
func TChannelRequest(options ...api.RequestOption) api.Action
TChannelRequest creates a new tchannel request.
func TChannelService ¶
func TChannelService(options ...api.ServiceOption) api.Lifecycle
TChannelService will create a runnable TChannel service.
func UnaryOutboundMiddleware ¶ added in v1.32.0
func UnaryOutboundMiddleware(mw ...middleware.UnaryOutbound) api.RequestOption
UnaryOutboundMiddleware sets unary outbound middleware for a request.
Multiple invocations will append to existing middleware.
func WantError ¶
func WantError(errMsg string) api.RequestOption
WantError creates an assertion on the request response to validate the error.
func WantHeader ¶
func WantHeader(key, value string) *types.WantHeader
WantHeader will set up a header assertion for request/response headers.
func WantHeaders ¶ added in v1.47.0
func WantHeaders(want map[string]string) api.ClientStreamAction
WantHeaders is an action to fetch the client stream headers.
func WantRespBody ¶
func WantRespBody(body string) api.RequestOption
WantRespBody will assert that the response body matches at the end of the request.
func WantStreamError ¶ added in v1.27.0
func WantStreamError(wantErrMsgs ...string) api.ClientStreamRequestOption
WantStreamError asserts that the stream request had an error immediately.
func WithHeader ¶
func WithHeader(key, value string) *types.GiveHeader
WithHeader will send headers for requests and responses.
Types ¶
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api is for all interfaces and patterns that need to be implemented to interact with the yarpctest api, but not the explicit types we'll use to make requests, or the types that we'll use directly in tests.
|
Package api is for all interfaces and patterns that need to be implemented to interact with the yarpctest api, but not the explicit types we'll use to make requests, or the types that we'll use directly in tests. |
|
Package types are for objects in the yarpctest API that implement multiple interfaces.
|
Package types are for objects in the yarpctest API that implement multiple interfaces. |