schema

Documentation

Overview

Package schema provides the test scenario data schema for scenarigo.

Index

• type Bind
• type Config
  • func LoadConfig(path string, colored bool) (*Config, error)
• type Expect
  • func (e *Expect) Build(ctx *context.Context) (assert.Assertion, error)
  • func (e *Expect) UnmarshalYAML(bytes []byte) error
• type JSONReportConfig
• type JUnitReportConfig
• type OutputConfig
• type PluginConfig
• type ReportConfig
• type Request
  • func (r *Request) Invoke(ctx *context.Context) (*context.Context, interface{}, error)
  • func (r *Request) UnmarshalYAML(bytes []byte) error
• type RetryPolicy
  • func (p *RetryPolicy) Build() (backoff.Policy, error)
• type RetryPolicyConstant
  • func (p *RetryPolicyConstant) Build() (backoff.Policy, error)
• type RetryPolicyExponential
  • func (p *RetryPolicyExponential) Build() (backoff.Policy, error)
• type Scenario
  • func LoadScenarios(path string) ([]*Scenario, error)
  • func LoadScenariosFromReader(r io.Reader) ([]*Scenario, error)
  • func (s *Scenario) Filepath() string
• type Step
  • func (s *Step) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type Bind

type Bind struct {
	Vars map[string]interface{} `yaml:"vars"`
}

Bind represents bindings of variables.

type Config

type Config struct {
	SchemaVersion   string                  `yaml:"schemaVersion,omitempty"`
	Scenarios       []string                `yaml:"scenarios,omitempty"`
	PluginDirectory string                  `yaml:"pluginDirectory,omitempty"`
	Plugins         map[string]PluginConfig `yaml:"plugins,omitempty"`
	Output          OutputConfig            `yaml:"output,omitempty"`

	// absolute path to the configuration file
	Root string `yaml:"-"`
}

Config represents a configuration.

func LoadConfig

func LoadConfig(path string, colored bool) (*Config, error)

LoadConfig loads a configuration from path.

type Expect

type Expect struct {
	protocol.AssertionBuilder
	// contains filtered or unexported fields
}

Expect represents a expect response.

func (*Expect) Build

func (e *Expect) Build(ctx *context.Context) (assert.Assertion, error)

Build builds the assertion which asserts the response.

func (*Expect) UnmarshalYAML

func (e *Expect) UnmarshalYAML(bytes []byte) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type JSONReportConfig

type JSONReportConfig struct {
	Filename string `yaml:"filename,omitempty"`
}

JSONReportConfig represents a JSON report configuration.

type JUnitReportConfig

type JUnitReportConfig struct {
	Filename string `yaml:"filename,omitempty"`
}

JUnitReportConfig represents a JUnit report configuration.

type OutputConfig

type OutputConfig struct {
	Verbose bool         `yaml:"verbose,omitempty"`
	Colored *bool        `yaml:"colored,omitempty"`
	Report  ReportConfig `yaml:"report,omitempty"`
}

OutputConfig represents a output configuration.

type PluginConfig

type PluginConfig struct {
	Src string `yaml:"src,omitempty"`
}

PluginConfig represents a plugin configuration.

type ReportConfig

type ReportConfig struct {
	JSON  JSONReportConfig  `yaml:"json,omitempty"`
	JUnit JUnitReportConfig `yaml:"junit,omitempty"`
}

ReportConfig represents a report configuration.

type Request

type Request struct {
	protocol.Invoker
	// contains filtered or unexported fields
}

Request represents a request.

func (*Request) Invoke

func (r *Request) Invoke(ctx *context.Context) (*context.Context, interface{}, error)

Invoke sends the request.

func (*Request) UnmarshalYAML

func (r *Request) UnmarshalYAML(bytes []byte) error

UnmarshalYAML implements yaml.Unmarshaler interface.

type RetryPolicy

type RetryPolicy struct {
	Constant    *RetryPolicyConstant    `yaml:"constant"`
	Exponential *RetryPolicyExponential `yaml:"exponential"`
}

RetryPolicy represents a retry policy.

func (*RetryPolicy) Build

func (p *RetryPolicy) Build() (backoff.Policy, error)

Build returns p as backoff.Policy. If p is nil, Build returns the policy which never retry.

type RetryPolicyConstant

type RetryPolicyConstant struct {
	Interval       string  `yaml:"interval"`
	MaxElapsedTime *string `yaml:"maxElapsedTime"`
	MaxRetries     *int    `yaml:"maxRetries"`
}

RetryPolicyConstant represents a constant retry policy.

func (*RetryPolicyConstant) Build

func (p *RetryPolicyConstant) Build() (backoff.Policy, error)

Build returns p as backoff.Policy.

type RetryPolicyExponential

type RetryPolicyExponential struct {
	InitialInterval *string  `yaml:"initialInterval"`
	Factor          *float64 `yaml:"factor"`
	JitterFactor    *float64 `yaml:"jitterFactor"`
	MaxInterval     *string  `yaml:"maxInterval"`
	MaxElapsedTime  *string  `yaml:"maxElapsedTime"`
	MaxRetries      *int     `yaml:"maxRetries"`
}

RetryPolicyExponential represents a exponential retry policy.

func (*RetryPolicyExponential) Build

func (p *RetryPolicyExponential) Build() (backoff.Policy, error)

Build returns p as backoff.Policy.

type Scenario

type Scenario struct {
	Title       string                 `yaml:"title"`
	Description string                 `yaml:"description"`
	Plugins     map[string]string      `yaml:"plugins"`
	Vars        map[string]interface{} `yaml:"vars"`
	Steps       []*Step                `yaml:"steps"`

	// The strict YAML decoder fails to decode if finds an unknown field.
	// Anchors is the field for enabling to define YAML anchors by avoiding the error.
	// This field doesn't need to hold some data because anchors expand by the decoder.
	Anchors anchors `yaml:"anchors"`

	Node ast.Node
	// contains filtered or unexported fields
}

Scenario represents a test scenario.

func LoadScenarios

func LoadScenarios(path string) ([]*Scenario, error)

LoadScenarios loads test scenarios from path.

func LoadScenariosFromReader

func LoadScenariosFromReader(r io.Reader) ([]*Scenario, error)

LoadScenariosFromReader loads test scenarios with io.Reader.

func (*Scenario) Filepath

func (s *Scenario) Filepath() string

Filepath returns YAML filepath of s.

type Step

type Step struct {
	Title       string                 `yaml:"title"`
	Description string                 `yaml:"description"`
	Vars        map[string]interface{} `yaml:"vars"`
	Protocol    string                 `yaml:"protocol"`
	Request     Request                `yaml:"request"`
	Expect      Expect                 `yaml:"expect"`
	Include     string                 `yaml:"include"`
	Ref         string                 `yaml:"ref"`
	Bind        Bind                   `yaml:"bind"`
	Retry       *RetryPolicy           `yaml:"retry"`
}

Step represents a step of scenario.

func (*Step) UnmarshalYAML

func (s *Step) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements yaml.Unmarshaler interface.