got

README

Overview

A tiny test framework for go projects. The test of this lib is its doc.

All functions in this lib are side-effect free.

Examples

• simple

• basic

Documentation

Index

• func Each(t Testable, iteratee interface{}) (count int)
• type Assertion
  • func New(t Testable) Assertion
  • func NewWith(t Testable, opts Options) Assertion
  • func (as Assertion) E(args ...interface{})
  • func (as Assertion) Eq(a, b interface{}) (result Result)
  • func (as Assertion) Err(args ...interface{}) (result Result)
  • func (as Assertion) False(a bool) (result Result)
  • func (as Assertion) Gt(a, b interface{}) (result Result)
  • func (as Assertion) Gte(a, b interface{}) (result Result)
  • func (as Assertion) Has(container, str string) (result Result)
  • func (as Assertion) Is(a, b interface{}) (result Result)
  • func (as Assertion) Len(list interface{}, l int) (result Result)
  • func (as Assertion) Lt(a, b interface{}) (result Result)
  • func (as Assertion) Lte(a, b interface{}) (result Result)
  • func (as Assertion) Neq(a, b interface{}) (result Result)
  • func (as Assertion) Nil(args ...interface{}) (result Result)
  • func (as Assertion) NotNil(args ...interface{}) (result Result)
  • func (as Assertion) Panic(fn func()) (result Result)
  • func (as Assertion) Regex(pattern, str string) (result Result)
  • func (as Assertion) True(a bool) (result Result)
• type Options
  • func Defaults() Options
• type Result
  • func (r Result) Msg(format string, args ...interface{}) Result
  • func (r Result) Must() Result
• type Testable

Functions

func Each

func Each(t Testable, iteratee interface{}) (count int)

Each runs each exported method Fn on type Ctx as a subtest of t. The iteratee can be a struct Ctx or:

iteratee(t Testable) (ctx Ctx)

Each Fn will be called like:

ctx.Fn()

If iteratee is Ctx, its Assertion and T fields will be set to New(t) and t for each test. Any Fn that has the same name with the embedded one will be ignored.

Types

type Assertion

type Assertion struct {
	Testable
	// contains filtered or unexported fields
}

Assertion is the assertion context

func New

func New(t Testable) Assertion

New assertion helper

func NewWith

func NewWith(t Testable, opts Options) Assertion

NewWith assertion helper with options

func (Assertion) E

func (as Assertion) E(args ...interface{})

E is a shortcut for Nil(args...).Must()

func (Assertion) Eq

func (as Assertion) Eq(a, b interface{}) (result Result)

Eq a == b

func (Assertion) Err

func (as Assertion) Err(args ...interface{}) (result Result)

Err args[-1] is error and not nil

func (Assertion) False

func (as Assertion) False(a bool) (result Result)

False a == false

func (Assertion) Gt

func (as Assertion) Gt(a, b interface{}) (result Result)

Gt a > b

func (Assertion) Gte

func (as Assertion) Gte(a, b interface{}) (result Result)

Gte a >= b

func (Assertion) Has

func (as Assertion) Has(container, str string) (result Result)

Has str in container

func (Assertion) Is

func (as Assertion) Is(a, b interface{}) (result Result)

Is a a kind of b

func (Assertion) Len

func (as Assertion) Len(list interface{}, l int) (result Result)

Len len(list) == l

func (Assertion) Lt

func (as Assertion) Lt(a, b interface{}) (result Result)

Lt a < b

func (Assertion) Lte

func (as Assertion) Lte(a, b interface{}) (result Result)

Lte a <= b

func (Assertion) Neq

func (as Assertion) Neq(a, b interface{}) (result Result)

Neq a != b

func (Assertion) Nil

func (as Assertion) Nil(args ...interface{}) (result Result)

Nil args[-1] == nil

func (Assertion) NotNil

func (as Assertion) NotNil(args ...interface{}) (result Result)

NotNil args[-1] != nil

func (Assertion) Panic

func (as Assertion) Panic(fn func()) (result Result)

Panic fn should panic

func (Assertion) Regex

func (as Assertion) Regex(pattern, str string) (result Result)

Regex matches str

func (Assertion) True

func (as Assertion) True(a bool) (result Result)

True a == true

type Options

type Options struct {
	// Dump a value to human readable string
	Dump func(interface{}) string

	// Format keywords in the assertion message.
	// Such as color it for CLI output.
	Keyword func(string) string
}

Options for Assertion

func Defaults

func Defaults() Options

Defaults for Options

type Result

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

Result helper

func (Result) Msg

func (r Result) Msg(format string, args ...interface{}) Result

Msg if fails

func (Result) Must

func (r Result) Must() Result

Must FailNow if fails

type Testable

type Testable interface {
	Helper()
	Fail()
	FailNow()
	Logf(format string, args ...interface{})
}

Testable interface