proxytest

README

test framework for proxy-wasm-go-sdk

With proxytest build tag, you can test your extension with the official command:

go test -tags=proxytest ./... 

This framework simulates the expected behavior of Envoyproxy, and you can test your extensions without running Envoy. For detail, see examples/*/main_test.go.

Note that we have not covered all the functionality, and the API is very likely to change in the future.

Documentation

Index

• type EmulatorOption
  • func NewEmulatorOption() *EmulatorOption
  • func (o *EmulatorOption) WithNewHttpContext(f func(uint32, uint32) proxywasm.HttpContext) *EmulatorOption
  • func (o *EmulatorOption) WithNewRootContext(f func(uint32) proxywasm.RootContext) *EmulatorOption
  • func (o *EmulatorOption) WithNewStreamContext(f func(uint32, uint32) proxywasm.StreamContext) *EmulatorOption
  • func (o *EmulatorOption) WithPluginConfiguration(data []byte) *EmulatorOption
  • func (o *EmulatorOption) WithVMConfiguration(data []byte) *EmulatorOption
• type HostEmulator
  • func NewHostEmulator(opt *EmulatorOption) HostEmulator
• type HttpCalloutAttribute
• type LocalHttpResponse

Types

type EmulatorOption

type EmulatorOption struct {
	// contains filtered or unexported fields
}

func NewEmulatorOption

func NewEmulatorOption() *EmulatorOption

func (*EmulatorOption) WithNewHttpContext

func (o *EmulatorOption) WithNewHttpContext(f func(uint32, uint32) proxywasm.HttpContext) *EmulatorOption

func (*EmulatorOption) WithNewRootContext

func (o *EmulatorOption) WithNewRootContext(f func(uint32) proxywasm.RootContext) *EmulatorOption

func (*EmulatorOption) WithNewStreamContext

func (o *EmulatorOption) WithNewStreamContext(f func(uint32, uint32) proxywasm.StreamContext) *EmulatorOption

func (*EmulatorOption) WithPluginConfiguration

func (o *EmulatorOption) WithPluginConfiguration(data []byte) *EmulatorOption

func (*EmulatorOption) WithVMConfiguration

func (o *EmulatorOption) WithVMConfiguration(data []byte) *EmulatorOption

type HostEmulator

type HostEmulator interface {
	Done()

	// Root
	StartVM()
	StartPlugin()
	FinishVM()

	GetCalloutAttributesFromContext(contextID uint32) []HttpCalloutAttribute
	PutCalloutResponse(contextID uint32, headers, trailers [][2]string, body []byte)

	GetLogs(level types.LogLevel) []string
	GetTickPeriod() uint32
	Tick()
	GetQueueSize(queueID uint32) int

	// network
	NetworkFilterInitConnection() (contextID uint32)
	NetworkFilterPutUpstreamData(contextID uint32, data []byte)
	NetworkFilterPutDownstreamData(contextID uint32, data []byte)
	NetworkFilterCloseUpstreamConnection(contextID uint32)
	NetworkFilterCloseDownstreamConnection(contextID uint32)
	NetworkFilterCompleteConnection(contextID uint32)

	// http
	HttpFilterInitContext() (contextID uint32)
	HttpFilterPutRequestHeaders(contextID uint32, headers [][2]string)
	HttpFilterGetRequestHeaders(contextID uint32) (headers [][2]string)
	HttpFilterPutRequestHeadersEndOfStream(contextID uint32, headers [][2]string, endOfStream bool)
	HttpFilterPutResponseHeaders(contextID uint32, headers [][2]string)
	HttpFilterGetResponseHeaders(contextID uint32) (headers [][2]string)
	HttpFilterPutResponseHeadersEndOfStream(contextID uint32, headers [][2]string, endOfStream bool)
	HttpFilterPutRequestTrailers(contextID uint32, headers [][2]string)
	HttpFilterPutResponseTrailers(contextID uint32, headers [][2]string)
	HttpFilterPutRequestBody(contextID uint32, body []byte)
	HttpFilterPutRequestBodyEndOfStream(contextID uint32, body []byte, endOfStream bool)
	HttpFilterGetRequestBody(contextID uint32) []byte
	HttpFilterPutResponseBody(contextID uint32, body []byte)
	HttpFilterPutResponseBodyEndOfStream(contextID uint32, body []byte, endOfStream bool)
	HttpFilterGetResponseBody(contextID uint32) []byte
	HttpFilterCompleteHttpStream(contextID uint32)
	HttpFilterGetCurrentStreamAction(contextID uint32) types.Action
	HttpFilterGetSentLocalResponse(contextID uint32) *LocalHttpResponse
}

func NewHostEmulator

func NewHostEmulator(opt *EmulatorOption) HostEmulator

type HttpCalloutAttribute

type HttpCalloutAttribute struct {
	CalloutID         uint32
	Upstream          string
	Headers, Trailers [][2]string
	Body              []byte
}

type LocalHttpResponse

type LocalHttpResponse struct {
	StatusCode       uint32
	StatusCodeDetail string
	Data             []byte
	Headers          [][2]string
	GRPCStatus       int32
}