README.md

TLDR

import (
	"testing"
	"github.com/razzie/mock"
)

type Fooer interface {
	Foo() error
}

func TestSomething(t *testing.T) {
	fooer, mck := mock.Mock[Fooer]() // <--- Mock generates a runtime mock implementation for Fooer
	mck.On("Foo").Return(nil)
	fooer.Foo()
	something(fooer)
	mck.AssertExpectations(t)
}

What does this package do?

To properly understand the purpose of this package, you must be familiar with mocking and testify mock.

Let's say that in a hypothetical test scenario you need to mock the following Adder interface:

type Adder interface {
	Add(a, b int) int
}

The usual way to do it would be writing some MockAdder boilerplate code very similar to this:

import (
	"testing"
	"github.com/stretchr/testify/mock"
)

type MockAdder struct {
	mock.Mock
}

func (adder *MockAdder) Add(a, b) int {
	ret := adder.Called(a, b)
	return ret.Int(0)
}

func TestSomething(t *testing.T) {
	adder := new(MockAdder)
	adder.On("Add", mock.Anything, mock.Anything).Return(0)
	something(adder)
	adder.AssertExpectations(t)
}

Maybe it doesn't look like a big deal, but with many large interfaces the work adds up. Of course you could just run mockery to generate it, and if you don't mind occasionally running an extra tool to generate your mocks, then by all means go ahead and use it.

With github.com/razzie/mock package though, you can shortcut the work:

import (
	"testing"
	"github.com/razzie/mock"
)

func TestSomething(t *testing.T) {
	var adder, mck = mock.Mock[Adder]() // mck is a testify mock.Mock object
	mck.On("Add", mock.Anything, mock.Anything).Return(0)
	something(adder)
	mck.AssertExpectations(t)
}