spec

README

🚝 Spec

Write readable behavior-driven tests.

Documentation

Index

• Constants
• type DSL
  • func AfterAll(fallibles ...Fallible) DSL
  • func AfterEach(fallibles ...Fallible) DSL
  • func BeforeAll(fallibles ...Fallible) DSL
  • func BeforeEach(fallibles ...Fallible) DSL
  • func Context(title string, body ...DSL) DSL
  • func Describe(title string, body ...DSL) DSL
  • func Group(title string, body ...DSL) (ret DSL)
  • func Hook(ba, be, ae, aa bool, fallibles ...Fallible) (ret DSL)
  • func Inline(fallibles ...Fallible) DSL
  • func It(title string, fallibles ...Fallible) DSL
  • func Spec(title string, fallibles ...Fallible) (ret DSL)
• type DSLKind
• type EngineGroup
  • func (it EngineGroup) Alive() bool
  • func (it EngineGroup) Run(hooks []EngineHook) (ret []error)
• type EngineHook
  • func (it EngineHook) Run() (ret []error)
• type EngineSpec
  • func (it EngineSpec) Alive() bool
  • func (it EngineSpec) Run(hooks []EngineHook) (ret []error)
• type EngineSuite
  • func Suite(body ...DSL) (ret EngineSuite)
  • func (it EngineSuite) Handle(handler Handler)
• type Fallible
• type Handler

Constants

const (
	DSLGroupKind = DSLKind(0)
	DSLHookKind  = DSLKind(1)
	DSLSpecKind  = DSLKind(2)
)

Types

type DSL

type DSL struct {
	Kind DSLKind

	Group EngineGroup
	Hook  EngineHook
	Spec  EngineSpec
}

func AfterAll

func AfterAll(fallibles ...Fallible) DSL

func AfterEach

func AfterEach(fallibles ...Fallible) DSL

func BeforeAll

func BeforeAll(fallibles ...Fallible) DSL

func BeforeEach

func BeforeEach(fallibles ...Fallible) DSL

func Context

func Context(title string, body ...DSL) DSL

func Describe

func Describe(title string, body ...DSL) DSL

func Group

func Group(title string, body ...DSL) (ret DSL)

func Hook

func Hook(ba, be, ae, aa bool, fallibles ...Fallible) (ret DSL)

func Inline

func Inline(fallibles ...Fallible) DSL

func It

func It(title string, fallibles ...Fallible) DSL

func Spec

func Spec(title string, fallibles ...Fallible) (ret DSL)

type DSLKind

type DSLKind uint

type EngineGroup

type EngineGroup struct {
	Title string

	Hooks  []EngineHook
	Specs  []EngineSpec
	Groups []EngineGroup
}

func (EngineGroup) Alive

func (it EngineGroup) Alive() bool

func (EngineGroup) Run

func (it EngineGroup) Run(hooks []EngineHook) (ret []error)

type EngineHook

type EngineHook struct {
	Flags struct {
		BeforeAll  bool
		BeforeEach bool
		AfterEach  bool
		AfterAll   bool
	}

	Fallibles []Fallible
}

func (EngineHook) Run

func (it EngineHook) Run() (ret []error)

type EngineSpec

type EngineSpec struct {
	Title     string
	Fallibles []Fallible
}

func (EngineSpec) Alive

func (it EngineSpec) Alive() bool

func (EngineSpec) Run

func (it EngineSpec) Run(hooks []EngineHook) (ret []error)

type EngineSuite

type EngineSuite struct {
	Group EngineGroup
}

func Suite

func Suite(body ...DSL) (ret EngineSuite)

func (EngineSuite) Handle

func (it EngineSuite) Handle(handler Handler)

type Fallible

type Fallible func() error

type Handler

type Handler func(err error)