tests

Documentation

Index

• Constants
• type Parameters
• type Test
  • func (t Test) GetResponse(statusCode string) (*orderedmap.OrderedMap[string, yaml.Node], bool, error)
• type Tests
  • func Load(dir string) (*Tests, string, error)
  • func (t Tests) Validate() error

Constants

const (
	TestsVersion = "0.0.1"
)

Types

type Parameters

type Parameters struct {
	Path   *orderedmap.OrderedMap[string, yaml.Node] `yaml:"path,omitempty"`
	Query  *orderedmap.OrderedMap[string, yaml.Node] `yaml:"query,omitempty"`
	Header *orderedmap.OrderedMap[string, yaml.Node] `yaml:"header,omitempty"`
}

type Test

type Test struct {
	Name        string                                    `yaml:"name"`
	Description string                                    `yaml:"description,omitempty"`
	Targets     []string                                  `yaml:"targets,omitempty"`
	Server      string                                    `yaml:"server,omitempty"`
	Security    yaml.Node                                 `yaml:"security,omitempty"`
	Parameters  *Parameters                               `yaml:"parameters,omitempty"`
	RequestBody *orderedmap.OrderedMap[string, yaml.Node] `yaml:"requestBody,omitempty"`
	Responses   *orderedmap.OrderedMap[string, yaml.Node] `yaml:"responses,omitempty"`

	// Internal use only
	InternalID      string                                 `yaml:"internalId,omitempty"`
	TestGroups      []string                               `yaml:"testGroups,omitempty"`
	InternalEnvVars *orderedmap.OrderedMap[string, string] `yaml:"internalEnvVars,omitempty"`
}

func (Test) GetResponse

func (t Test) GetResponse(statusCode string) (*orderedmap.OrderedMap[string, yaml.Node], bool, error)

type Tests

type Tests struct {
	Version string                                 `yaml:"testsVersion"`
	Tests   *orderedmap.OrderedMap[string, []Test] `yaml:"tests"`
}

func Load

func Load(dir string) (*Tests, string, error)

func (Tests) Validate

func (t Tests) Validate() error