README
¶
Test utilities
TODO
- toc
- example in go doc, can there be example for test package?
Condition
TODO: example of using test condition
Env
TODO: load dot env
Golden
TODO: use golden file
actually, just Read/WriteFixture would work ...
// GenGolden check if env GOLDEN or GEN_GOLDEN is set, sometimes you need to generate test fixture in test
func GenGolden() Condition {
return Or(EnvHas("GOLDEN"), EnvHas("GEN_GOLDEN"))
}
Documentation
¶
Overview ¶
Package testutil defines helper functions that fails test instead of return error
Index ¶
- func DisableGenGolden(t *testing.T)
- func DumpAsJson(t *testing.T, v interface{})
- func DumpAsJsonTo(t *testing.T, v interface{}, w io.Writer)
- func EnableGenGolden(t *testing.T)
- func FormatJson(t *testing.T, src []byte) []byte
- func GOPATH() string
- func GetBody(t *testing.T, c *http.Client, url string) []byte
- func LoadDotEnv(t *testing.T)
- func LoadDotEnvFrom(t *testing.T, r io.Reader)
- func LoadDotEnvFromFile(t *testing.T, path string)
- func PrintTidyJson(t *testing.T, data interface{})
- func PrintTidyJsonTo(t *testing.T, data interface{}, w io.Writer)
- func ReadFixture(t *testing.T, path string) []byte
- func ReadJsonTo(t *testing.T, path string, v interface{})
- func ReadYAMLTo(t *testing.T, path string, v interface{})
- func ReadYAMLToStrict(t *testing.T, path string, v interface{})
- func RunIf(t *testing.T, con Condition)
- func SaveAsJson(t *testing.T, v interface{}, file string)
- func SaveAsJsonf(t *testing.T, v interface{}, format string, args ...interface{})
- func SaveAsPrettyJson(t *testing.T, v interface{}, file string)
- func SaveAsPrettyJsonf(t *testing.T, v interface{}, format string, args ...interface{})
- func SaveAsYAML(t *testing.T, v interface{}, file string)
- func SaveAsYAMLf(t *testing.T, v interface{}, format string, args ...interface{})
- func SkipIf(t *testing.T, con Condition)
- func WriteFixture(t *testing.T, path string, data []byte)
- func WriteOrCompare(t *testing.T, file string, data []byte)
- func WriteOrCompareAsString(t *testing.T, file string, data string)
- type Condition
- func And(l Condition, r Condition) Condition
- func Bool(name string, b bool) Condition
- func BoolP(name string, b *bool) Condition
- func Dump() Condition
- func EnvHas(name string) Condition
- func EnvTrue(name string) Condition
- func GenGolden() Condition
- func GenGoldenT(t *testing.T) Condition
- func IsTravis() Condition
- func Not(c Condition) Condition
- func Or(l Condition, r Condition) Condition
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DisableGenGolden ¶ added in v0.0.5
func DumpAsJson ¶ added in v0.0.8
TODO: it's dump w/ Print in pretty.go ... wrote too much and forgot ...
func EnableGenGolden ¶ added in v0.0.5
func GOPATH ¶
func GOPATH() string
GOPATH returns build.Default.GOPATH https://stackoverflow.com/questions/32649770/how-to-get-current-gopath-from-code
func LoadDotEnv ¶ added in v0.0.5
LoadDotEnv load .env in current directory into environment variable, line start with # are comments It is modeled after https://github.com/motdotla/dotenv
func LoadDotEnvFromFile ¶ added in v0.0.5
func PrintTidyJson ¶ added in v0.0.5
func PrintTidyJsonTo ¶ added in v0.0.5
func ReadJsonTo ¶ added in v0.0.4
func ReadYAMLTo ¶ added in v0.0.5
func ReadYAMLToStrict ¶ added in v0.0.5
ReadYAMLToStrict uses strict mode when decoding, if unknown fields shows up in YAML but not in struct it will error
func SaveAsJson ¶ added in v0.0.8
func SaveAsJsonf ¶ added in v0.0.8
func SaveAsPrettyJson ¶ added in v0.0.8
func SaveAsPrettyJsonf ¶ added in v0.0.8
func SaveAsYAML ¶ added in v0.0.8
func SaveAsYAMLf ¶ added in v0.0.8
Types ¶
type Condition ¶ added in v0.0.5
type Condition interface {
Eval() (res bool, msg string, err error)
// B is used for normal if condition
B() bool
}
func Dump ¶ added in v0.0.5
func Dump() Condition
Dump check if env DUMP or GOMMON_DUMP is set, so print detail or use go-spew to dump structs etc.
func GenGolden ¶ added in v0.0.5
func GenGolden() Condition
GenGolden check if env GOLDEN or GEN_GOLDEN is set, sometimes you need to generate test fixture in test
func GenGoldenT ¶ added in v0.0.5
GenGoldenT check if current test is manually set to generate golden file
Source Files