system

Documentation

Index

• type System
  • func NewSystem(filePath string) (*System, error)
  • func (s *System) Clean() error
  • func (s *System) NeedsCallbackServer() bool
  • func (s *System) Run(ctx context.Context) error

Types

type System

type System struct {
	BaseURL        string                       `json:"base_url"`
	EventTargetURL string                       `json:"event_target_url" envconfig:"IMMUNE_EVENT_TARGET_URL"`
	Database       immune.Database              `json:"database"`
	Callback       immune.CallbackConfiguration `json:"callback"`
	Variables      *immune.VariableMap          `json:"-"`
	SetupTestCases []immune.SetupTestCase       `json:"setup_test_cases"`
	TestCases      []immune.TestCase            `json:"test_cases"`
	// contains filtered or unexported fields
}

System represents the entire suite to be run against an API

func NewSystem

func NewSystem(filePath string) (*System, error)

func (*System) Clean

func (s *System) Clean() error

Clean validates the System's data

func (*System) NeedsCallbackServer

func (s *System) NeedsCallbackServer() bool

func (*System) Run

func (s *System) Run(ctx context.Context) error

Run executes the entire system, starting with the setup test cases, and then the test cases, a callback server will be started if needed.