Skip to content
Automatically generate mocks for interfaces with go generate
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_examples
automock
templates
vendor
.gitignore
.travis.yml
Gopkg.lock
Gopkg.toml
README.md
automock_unexported2_test.go
http_cookie_jar_mock_test.go
io_byte_scanner_mock_test.go
io_writer_mock_test.go
main.go
main_test.go
snake_case.go
templates.go
unexported_mock_test.go

README.md

goautomock

Automatically generate mocks from interfaces using go generate.

Installation

go get github.com/ernesto-jimenez/goautomock

Usage

Creating an interface in your code to mock a dependency:

//go:generate goautomock server

type server interface {
	Serve(string) ([]byte, error)
}

func request(s server, path string) ([]byte, error) {
	return s.Serve(path)
}

// Dummy test
func TestRequestReturnsServerError(t *testing.T) {
	m := NewServerMock()
	m.ServeFunc = func(in string) ([]byte, error) {
		return nil, errors.New("error")
	}
	_, err := request(m, "/something")
	assert.Error(t, err)
	assert.Equal(t, 1, m.ServeTotalCalls())
}

Here you can see what the generated mock looks like:

/*
* CODE GENERATED AUTOMATICALLY WITH github.com/ernesto-jimenez/goautomock
* THIS FILE MUST NEVER BE EDITED MANUALLY
 */

package simple

// serverMock mock
type serverMock struct {
	calls map[string]int

	ServeFunc func(string) ([]byte, error)
}

func NewServerMock() *serverMock {
	return &serverMock{
		calls: make(map[string]int),
	}
}

// Serve mocked method
func (m *serverMock) Serve(p0 string) ([]byte, error) {
	if m.ServeFunc == nil {
		panic("unexpected call to mocked method Serve")
	}
	m.calls["Serve"]++
	return m.ServeFunc(p0)
}

// ServeCalls returns the amount of calls to the mocked method Serve
func (m *serverMock) ServeTotalCalls() int {
	return m.calls["Serve"]
}

Mocking an interface from the standard library:

//go:generate goautomock io.Writer

// Dummy test using the generated mock
func TestWriter(t *testing.T) {
	m := NewWriterMock()
	expected := []byte("hello world")

	m.WriteFunc = func(b []byte) (int, error) {
		assert.Equal(t, expected, b)
		return len(b), nil
	}

	n, err := m.Write(expected)
	assert.NoError(t, err)
	assert.Equal(t, 11, n)
	assert.Equal(t, 1, m.WriteTotalCalls())
}

Picking a different mock style

goautomock ships with different mock templates. You can see which ones with:

$ goautomock -list-templates
simple
testify

You can pick the template you want to use with -template

//go:generate goautomock -template=testify server

type server interface {
	Serve(string) ([]byte, error)
}

func request(s server, path string) ([]byte, error) {
	return s.Serve(path)
}

// Dummy test
func TestRequestReturnsServerError(t *testing.T) {
	m := &serverMock{}
	m.On("Serve", "/something").Return(nil, errors.New("error"))

	_, err := request(m, "/something")
	assert.Error(t, err)
	m.AssertNumberOfCalls(t, "Serve", 1)
}

Defining your own mock templates

You can use your own custom template by passing a file name to -template. Example:

# Create a new template based on goautocomplete's testify template
$ goautomock -template=simple -print-template > mock.go.tpl

# Customise your template

# Use your template
$ goautomock -template=mock.go.tpl io.Writer
You can’t perform that action at this time.