tester

Documentation

Index

• type Contract
• type Option
  • func WithHTTPClient(client *http.Client) Option
  • func WithVerboseModeOn(verboseMode bool) Option
• type Runner
  • func NewRunner(url string, test *Test, opts ...Option) *Runner
  • func (runner *Runner) Run() bool
• type Test
  • func NewTest(inputFile string) (*Test, error)

Types

type Contract

type Contract struct {
	Name    string            `json:"name" yaml:"name"`
	Path    string            `json:"path" yaml:"path"`
	Method  string            `json:"method" yaml:"method"`
	Body    string            `json:"body" yaml:"body"`
	Headers map[string]string `json:"headers" yaml:"headers"`

	Locals map[string]string `json:"locals" yaml:"locals"`

	Outputs map[string]string `json:"outputs" yaml:"outputs"`

	ExpectedHTTPCode     int               `json:"http_code_is" yaml:"http_code_is"`
	ExpectedResponseBody string            `json:"response_body_contains" yaml:"response_body_contains"`
	ExpectedResponses    []string          `json:"response_contains" yaml:"response_contains"`
	ExpectedHeaders      map[string]string `json:"response_headers_contain" yaml:"response_headers_contain"`
}

Contract represents the data for a single test case: the definition of the HTTP call and the expected result

type Option

type Option func(*Runner)

Option is a function which can change some properties of the Runner

func WithHTTPClient

func WithHTTPClient(client *http.Client) Option

WithHTTPClient returns an Option which overrides the default http client

func WithVerboseModeOn

func WithVerboseModeOn(verboseMode bool) Option

WithVerboseModeOn returns an Option which sets the verbosity of the runner. Default is false.

type Runner

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

Runner is the primary struct of this package and is responsible for running the test suite

func NewRunner

func NewRunner(url string, test *Test, opts ...Option) *Runner

NewRunner returns a *Runner for a given url and Test.

func (*Runner) Run

func (runner *Runner) Run() bool

Run is the method which runs the Test associated with this Runner. Returns a bool representing the result of the test.

type Test

type Test struct {
	Globals   map[string]string `json:"globals" yaml:"globals"`
	Contracts []Contract        `json:"contracts" yaml:"contracts"`
}

Test represents the data for a full test suite

func NewTest

func NewTest(inputFile string) (*Test, error)

NewTest returns an initialized *Test and any error encountered along the way