got

README

Overview

A dependency-free test framework for go projects. Examples:

• simple usage

• advanced usage

Documentation

Index

• func Each(t Testable, iteratee interface{}) (count int)
• type G
  • func New(t Testable) G
  • func NewWith(t Testable, opts Options) G
  • func (as G) E(args ...interface{})
  • func (as G) Eq(a, b interface{}) (result Result)
  • func (as G) Equal(a, b interface{}) (result Result)
  • func (as G) Err(args ...interface{}) (result Result)
  • func (as G) False(a bool) (result Result)
  • func (as G) Gt(a, b interface{}) (result Result)
  • func (as G) Gte(a, b interface{}) (result Result)
  • func (as G) Has(container, str string) (result Result)
  • func (as G) Is(a, b interface{}) (result Result)
  • func (as G) Len(list interface{}, l int) (result Result)
  • func (as G) Lt(a, b interface{}) (result Result)
  • func (as G) Lte(a, b interface{}) (result Result)
  • func (as G) Neq(a, b interface{}) (result Result)
  • func (as G) Nil(args ...interface{}) (result Result)
  • func (as G) NotNil(args ...interface{}) (result Result)
  • func (hp G) Open(create bool, path ...string) (f *os.File)
  • func (as G) Panic(fn func()) (result Result)
  • func (hp G) Read(r io.Reader) []byte
  • func (hp G) ReadJSON(r io.Reader) (v interface{})
  • func (hp G) ReadString(r io.Reader) string
  • func (as G) Regex(pattern, str string) (result Result)
  • func (hp G) Req(method, url string, body ...interface{}) *ResHelper
  • func (hp G) Serve() *Router
  • func (hp G) Srand(l int) string
  • func (as G) True(a bool) (result Result)
  • func (hp G) Write(obj interface{}, w io.Writer)
• type Only
• type Options
  • func Defaults() Options
• type ResHelper
  • func (res *ResHelper) Bytes() []byte
  • func (res *ResHelper) JSON() (v interface{})
  • func (res *ResHelper) String() string
• type Result
  • func (r Result) Msg(format string, args ...interface{}) Result
  • func (r Result) Must() Result
• type Router
  • func (rt *Router) Route(pattern, file string, value ...interface{}) *Router
  • func (rt *Router) URL(path ...string) string
• type Skip
• 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 G 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 G

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

G is the helper context

func New

func New(t Testable) G

New assertion helper

func NewWith

func NewWith(t Testable, opts Options) G

NewWith assertion helper with options

func (G) E

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

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

func (G) Eq

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

Eq a ≂ b

func (G) Equal

func (as G) Equal(a, b interface{}) (result Result)

Equal a == b

func (G) Err

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

Err args[-1] is error and not nil

func (G) False

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

False a == false

func (G) Gt

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

Gt a > b

func (G) Gte

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

Gte a >= b

func (G) Has

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

Has str in container

func (G) Is

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

Is a a kind of b

func (G) Len

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

Len len(list) == l

func (G) Lt

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

Lt a < b

func (G) Lte

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

Lte a <= b

func (G) Neq

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

Neq a != b

func (G) Nil

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

Nil args[-1] == nil

func (G) NotNil

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

NotNil args[-1] != nil

func (G) Open

func (hp G) Open(create bool, path ...string) (f *os.File)

Open a file. Override it if create is true. Directories will be auto-created. path will be joined with filepath.Join so that it's cross-platform

func (G) Panic

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

Panic fn should panic

func (G) Read

func (hp G) Read(r io.Reader) []byte

Read all from r

func (G) ReadJSON

func (hp G) ReadJSON(r io.Reader) (v interface{})

ReadJSON from r

func (G) ReadString

func (hp G) ReadString(r io.Reader) string

ReadString from r

func (G) Regex

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

Regex matches str

func (G) Req

func (hp G) Req(method, url string, body ...interface{}) *ResHelper

Req to the url

func (G) Serve

func (hp G) Serve() *Router

Serve http on a random port. The server will be auto-closed after the test.

func (G) Srand

func (hp G) Srand(l int) string

Srand generates a random string with the specified length

func (G) True

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

True a == true

func (G) Write

func (hp G) Write(obj interface{}, w io.Writer)

Write obj to the w

type Only

type Only struct{}

Only run tests with it

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 ResHelper

type ResHelper struct {
	*http.Response
	// contains filtered or unexported fields
}

ResHelper of the request

func (*ResHelper) Bytes

func (res *ResHelper) Bytes() []byte

Bytes body

func (*ResHelper) JSON

func (res *ResHelper) JSON() (v interface{})

JSON body

func (*ResHelper) String

func (res *ResHelper) String() string

String body

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 Router

type Router struct {
	HostURL *url.URL
	Server  *http.Server
	Mux     *http.ServeMux
	// contains filtered or unexported fields
}

Router of a http server

func (*Router) Route

func (rt *Router) Route(pattern, file string, value ...interface{}) *Router

Route on the pattern.

func (*Router) URL

func (rt *Router) URL(path ...string) string

URL will prefix the path with the server's host

type Skip

type Skip struct{}

Skip current test

type Testable

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

Testable interface