flow

Documentation

Index

• func Async(task *AsyncTask, runnable Runnable, cleanup ...Runnable) (Runnable, Runnable)
• func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool
• type AsyncTask
  • func (t *AsyncTask) Cancel()
  • func (t *AsyncTask) CancelAndWait()
  • func (t *AsyncTask) Complete()
  • func (t *AsyncTask) Wait()
• type Context
  • func (c Context) Deadline() (deadline time.Time, ok bool)
  • func (c Context) Done() <-chan struct{}
  • func (c Context) Err() error
  • func (c Context) Get(args ...interface{}) bool
  • func (c Context) MustGet(args ...interface{})
  • func (c Context) Name() string
  • func (c Context) Set(varName string, value interface{})
  • func (c Context) Value(key interface{}) interface{}
  • func (c Context) WithCancel() (Context, context.CancelFunc)
  • func (c Context) WithTimeout(timeout time.Duration) (Context, context.CancelFunc)
• type Flow
  • func New(t *testing.T, name string) *Flow
  • func (f *Flow) Name() string
  • func (f *Flow) Run()
  • func (f *Flow) Step(name string, runnable Runnable, cleanup ...Runnable) *Flow
  • func (f *Flow) StepAsync(name string, task *AsyncTask, runnable Runnable, cleanup ...Runnable) *Flow
• type Resetable
• type Runnable
  • func Do(fn func() error) Runnable
  • func MustDo(fn func()) Runnable
  • func Reset(reset ...Resetable) Runnable
  • func Sleep(t time.Duration) Runnable

Functions

func Async

func Async(task *AsyncTask, runnable Runnable, cleanup ...Runnable) (Runnable, Runnable)

func WaitTimeout

func WaitTimeout(wg *sync.WaitGroup, timeout time.Duration) bool

WaitTimeout waits for `wg` for the specified `timeout`. Returns true if waiting timed out.

Types

type AsyncTask

type AsyncTask struct {
	Context
	// contains filtered or unexported fields
}

func (*AsyncTask) Cancel

func (t *AsyncTask) Cancel()

func (*AsyncTask) CancelAndWait

func (t *AsyncTask) CancelAndWait()

func (*AsyncTask) Complete

func (t *AsyncTask) Complete()

func (*AsyncTask) Wait

func (t *AsyncTask) Wait()

type Context

type Context struct {
	context.Context
	*testing.T
	*Flow
	// contains filtered or unexported fields
}

func (Context) Deadline

func (c Context) Deadline() (deadline time.Time, ok bool)

func (Context) Done

func (c Context) Done() <-chan struct{}

func (Context) Err

func (c Context) Err() error

func (Context) Get

func (c Context) Get(args ...interface{}) bool

func (Context) MustGet

func (c Context) MustGet(args ...interface{})

func (Context) Name

func (c Context) Name() string

func (Context) Set

func (c Context) Set(varName string, value interface{})

func (Context) Value

func (c Context) Value(key interface{}) interface{}

func (Context) WithCancel

func (c Context) WithCancel() (Context, context.CancelFunc)

func (Context) WithTimeout

func (c Context) WithTimeout(timeout time.Duration) (Context, context.CancelFunc)

type Flow

type Flow struct {
	// contains filtered or unexported fields
}

func New

func New(t *testing.T, name string) *Flow

func (*Flow) Name

func (f *Flow) Name() string

func (*Flow) Run

func (f *Flow) Run()

func (*Flow) Step

func (f *Flow) Step(name string, runnable Runnable, cleanup ...Runnable) *Flow

func (*Flow) StepAsync

func (f *Flow) StepAsync(name string, task *AsyncTask, runnable Runnable, cleanup ...Runnable) *Flow

type Resetable

type Resetable interface {
	Reset()
}

type Runnable

type Runnable func(ctx Context) error

func Do

func Do(fn func() error) Runnable

func MustDo

func MustDo(fn func()) Runnable

func Reset

func Reset(reset ...Resetable) Runnable

func Sleep

func Sleep(t time.Duration) Runnable