apitest

Documentation

Index

• Variables
• func FilterSuites(p *Project, suiteName string) error
• func SetDefaults(p *Project)
• func Validate(p Project) error
• type Project
  • func FromFile(cfgPath string) (Project, error)
• type Runner
  • func (r *Runner) RunProject() (int, error)
• type Suite

Variables

var (
	// Kind represents the type definition of this config.
	Kind = "apitest"

	// APIVersion represents the supported config version.
	APIVersion = "v1alpha"
)

Config descriptors.

Functions

func FilterSuites

func FilterSuites(p *Project, suiteName string) error

FilterSuites filters out suites in the project that don't match the given suite name.

func SetDefaults

func SetDefaults(p *Project)

SetDefaults applies config defaults in case the user has left them blank.

func Validate

func Validate(p Project) error

Types

type Project

type Project struct {
	config.TypeDef `yaml:",inline" mapstructure:",squash"`
	ConfigFilePath string             `yaml:"-" json:"-"`
	Suites         []Suite            `yaml:"suites,omitempty"`
	Sauce          config.SauceConfig `yaml:"sauce,omitempty"`
	RootDir        string             `yaml:"rootDir,omitempty"`
}

Project represents the apitest project configuration.

func FromFile

func FromFile(cfgPath string) (Project, error)

FromFile creates a new apitest Project based on the filepath cfgPath.

type Runner

type Runner struct {
	Project       Project
	Client        apitesting.Client
	Region        region.Region
	Reporters     []report.Reporter
	Async         bool
	TunnelService tunnel.Service
}

Runner represents an executor for api tests

func (*Runner) RunProject

func (r *Runner) RunProject() (int, error)

RunProject runs the tests defined in apitest.Project

type Suite

type Suite struct {
	Timeout        time.Duration `yaml:"timeout,omitempty"`
	Name           string        `yaml:"name,omitempty"`
	HookID         string        `yaml:"hookId,omitempty"`
	UseRemoteTests bool          `yaml:"useRemoteTests,omitempty"`
	Tests          []string      `yaml:"tests,omitempty"`
	Tags           []string      `yaml:"tags,omitempty"`
	TestMatch      []string      `yaml:"testMatch,omitempty"`
}

Suite represents the apitest suite configuration.