README
¶
neko - a simple golang test organizer
There are many tools for improving Go's tests.
It's hard to beat the simplicity of go test but we all know it can get, well,
a little disorganized.
neko helps by just give you an extra little bit of organization to perform
common setup between tests.
Oh, and it integrates with github.com/stretchr/testify/mock to coordinate
your mocks (clearing and asserting them).
Here is a quick example:
import (
"testing"
"github.com/vektra/neko"
)
func TestNekoEnjoysFun(t *testing.T) {
n := neko.Start(t)
var fun Fun
n.Setup(func() {
fun = CreateAmeowsements()
})
n.It("enjoys fun", func() {
if !fun.IsFun() {
t.Fatal("fun isn't fun?? :( :(")
}
})
n.It("knows when it's fun time", func() {
if !fun.ItsTime() {
t.Fatal("no fun time? :( :(")
}
})
n.Meow()
}
Documentation
¶
Index ¶
- type Organizer
- func (o *Organizer) CheckMock(m *mock.Mock)
- func (o *Organizer) Cleanup(f func())
- func (o *Organizer) It(name string, f func())
- func (o *Organizer) Meow()
- func (o *Organizer) NIt(name string, f func())
- func (o *Organizer) Only(name string, f func())
- func (o *Organizer) Run()
- func (o *Organizer) Setup(f func())
- type OrganizerModern
- func (o *OrganizerModern) CheckMock(m *mock.Mock)
- func (o *OrganizerModern) Cleanup(f func())
- func (o *OrganizerModern) It(name string, f func(t *testing.T))
- func (o *OrganizerModern) Meow()
- func (o *OrganizerModern) NIt(name string, f func(t *testing.T))
- func (o *OrganizerModern) Only(name string, f func(t *testing.T))
- func (o *OrganizerModern) Run()
- func (o *OrganizerModern) Setup(f func())
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Organizer ¶
type Organizer struct {
// contains filtered or unexported fields
}
func (*Organizer) Cleanup ¶
func (o *Organizer) Cleanup(f func())
Add some work to be done after each test
func (*Organizer) NIt ¶
Useful by allowing the developer to simply add 'N' before It to disable a block.
type OrganizerModern ¶
type OrganizerModern struct {
// contains filtered or unexported fields
}
func Modern ¶
func Modern(t *testing.T) *OrganizerModern
Create a new OrganizerModern against testing's T interface
func (*OrganizerModern) CheckMock ¶
func (o *OrganizerModern) CheckMock(m *mock.Mock)
Track a github.com/stretchr/testify/mock.Mock along with the tests
func (*OrganizerModern) Cleanup ¶
func (o *OrganizerModern) Cleanup(f func())
Add some work to be done after each test
func (*OrganizerModern) It ¶
func (o *OrganizerModern) It(name string, f func(t *testing.T))
Add a test.
func (*OrganizerModern) NIt ¶
func (o *OrganizerModern) NIt(name string, f func(t *testing.T))
Useful by allowing the developer to simply add 'N' before It to disable a block.
func (*OrganizerModern) Run ¶
func (o *OrganizerModern) Run()
Coordinate running the tests with the setups and mocks
func (*OrganizerModern) Setup ¶
func (o *OrganizerModern) Setup(f func())
Add some work to be done before each test
Source Files