v1helpers

Documentation

Index

• Constants
• func ExpectCurlWithOffset(offset int, request CurlRequest, expectedResponse CurlResponse)
• func ExpectGrpcHealthOK(rootca *string, envoyPort uint32, service string)
• func ExpectHttpOK(body []byte, rootca *string, envoyPort uint32, response string)
• func ExpectHttpOKWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string)
• func ExpectHttpStatusWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string, ...)
• func ExpectHttpUnavailableWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string)
• func NewTestHttpUpstreamWithHandler(handler http.Handler) func(ctx context.Context, addr string) *TestUpstream
• func StartSslProxy(ctx context.Context, port uint32) uint32
• func StartSslProxyWithHelloCB(ctx context.Context, port uint32, cb func(chi *tls.ClientHelloInfo)) uint32
• func TestUpstreamReachable(envoyPort uint32, tu *TestUpstream, rootca *string)
• func TestUpstreamReachableWithOffset(offset int, envoyPort uint32, tu *TestUpstream, rootca *string)
• type CurlRequest
• type CurlResponse
• type ReceivedRequest
  • func (rr *ReceivedRequest) String() string
• type ReturnedResponse
  • func (rr *ReturnedResponse) String() string
• type TestUpstream
  • func NewTestGRPCUpstream(ctx context.Context, addr string, replicas int) *TestUpstream
  • func NewTestHttpUpstream(ctx context.Context, addr string) *TestUpstream
  • func NewTestHttpUpstreamWithHttpbin(ctx context.Context, addr string) *TestUpstream
  • func NewTestHttpUpstreamWithReply(ctx context.Context, addr, reply string) *TestUpstream
  • func NewTestHttpUpstreamWithReplyAndHealthReply(ctx context.Context, addr, reply, healthReply string) *TestUpstream
  • func NewTestHttpUpstreamWithTls(ctx context.Context, addr string, tlsServer UpstreamTlsRequired) *TestUpstream
  • func NewTestHttpsUpstreamWithReply(ctx context.Context, addr, reply string) *TestUpstream
  • func (tu *TestUpstream) FailGrpcHealthCheck() *testgrpcservice.TestGRPCServer
• type UpstreamTlsRequired

Constants

const (
	NO_TLS = iota
	TLS
	MTLS
)

Functions

func ExpectCurlWithOffset

func ExpectCurlWithOffset(offset int, request CurlRequest, expectedResponse CurlResponse)

ExpectCurlWithOffset is the preferred utility for asserting that a request to a port was received and returned the expectedResponse. It provides the same functionality as the above methods, but groups parameters into a CurlRequest and CurlResponse object, which helps us avoid frequently updating the method parameters whenever new properties are required (telescoping constructor anti-pattern:

func ExpectGrpcHealthOK

func ExpectGrpcHealthOK(rootca *string, envoyPort uint32, service string)

func ExpectHttpOK

func ExpectHttpOK(body []byte, rootca *string, envoyPort uint32, response string)

func ExpectHttpOKWithOffset

func ExpectHttpOKWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string)

func ExpectHttpStatusWithOffset

func ExpectHttpStatusWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string, status int)

func ExpectHttpUnavailableWithOffset

func ExpectHttpUnavailableWithOffset(offset int, body []byte, rootca *string, envoyPort uint32, response string)

func NewTestHttpUpstreamWithHandler

func NewTestHttpUpstreamWithHandler(handler http.Handler) func(ctx context.Context, addr string) *TestUpstream

NewTestHttpUpstreamWithHandler creates a test upstream that routes to a server that responds with the provided http.Handler.

func StartSslProxy

func StartSslProxy(ctx context.Context, port uint32) uint32

func StartSslProxyWithHelloCB

func StartSslProxyWithHelloCB(ctx context.Context, port uint32, cb func(chi *tls.ClientHelloInfo)) uint32

func TestUpstreamReachable

func TestUpstreamReachable(envoyPort uint32, tu *TestUpstream, rootca *string)

func TestUpstreamReachableWithOffset

func TestUpstreamReachableWithOffset(offset int, envoyPort uint32, tu *TestUpstream, rootca *string)

Types

type CurlRequest

type CurlRequest struct {
	RootCA  *string
	Port    uint32
	Path    string
	Body    []byte
	Host    string
	Headers map[string]string
}

type CurlResponse

type CurlResponse struct {
	Status  int
	Message string
}

type ReceivedRequest

type ReceivedRequest struct {
	Method      string
	Headers     map[string][]string
	URL         *url.URL
	Body        []byte
	Host        string
	GRPCRequest proto.Message
	Port        uint32
}

func (*ReceivedRequest) String

func (rr *ReceivedRequest) String() string

type ReturnedResponse

type ReturnedResponse struct {
	Code    int
	Body    []byte
	Headers map[string][]string
}

func (*ReturnedResponse) String

func (rr *ReturnedResponse) String() string

type TestUpstream

type TestUpstream struct {
	Upstream    *gloov1.Upstream
	C           <-chan *ReceivedRequest
	CResp       <-chan *ReturnedResponse
	Address     string
	Port        uint32
	GrpcServers []*testgrpcservice.TestGRPCServer
}

TestUpstream is a testing utility (used in in-memory e2e tests) to compose the following concepts:

1. Running an application with a custom response message (see: runTestServer)
2. Configuring an Upstream object to route to that application (see: newTestUpstream)
3. Utility methods for asserting that traffic was successfully routed to the application (see: Assertion Utilities)

func NewTestGRPCUpstream

func NewTestGRPCUpstream(ctx context.Context, addr string, replicas int) *TestUpstream

func NewTestHttpUpstream

func NewTestHttpUpstream(ctx context.Context, addr string) *TestUpstream

func NewTestHttpUpstreamWithHttpbin

func NewTestHttpUpstreamWithHttpbin(ctx context.Context, addr string) *TestUpstream

NewTestHttpUpstreamWithHttpbin creates a test upstream that routes to a server that responds with go-httpbin. HTTPBin (https://httpbin.org/) provides common introspection endpoints and responses that can be used to simulate a variety of common HTTP behaviors.

func NewTestHttpUpstreamWithReply

func NewTestHttpUpstreamWithReply(ctx context.Context, addr, reply string) *TestUpstream

func NewTestHttpUpstreamWithReplyAndHealthReply

func NewTestHttpUpstreamWithReplyAndHealthReply(ctx context.Context, addr, reply, healthReply string) *TestUpstream

func NewTestHttpUpstreamWithTls

func NewTestHttpUpstreamWithTls(ctx context.Context, addr string, tlsServer UpstreamTlsRequired) *TestUpstream

func NewTestHttpsUpstreamWithReply

func NewTestHttpsUpstreamWithReply(ctx context.Context, addr, reply string) *TestUpstream

func (*TestUpstream) FailGrpcHealthCheck

func (tu *TestUpstream) FailGrpcHealthCheck() *testgrpcservice.TestGRPCServer

type UpstreamTlsRequired

type UpstreamTlsRequired int