traefik / mocktail Goto Github PK

View Code? Open in Web Editor NEW

201.0 12.0 15.0 153 KB

Naive code generator that creates mock implementation using testify.mock

Home Page: https://traefik.io/blog/mocktail-the-mock-generator-for-strongly-typed-mocks/

License: Apache License 2.0

Makefile 0.79% Go 99.21%

go golang mock mock-generator testify testify-mocking

mocktail's Introduction

Mocktail

Mocktail logo

Naive code generator that creates mock implementation using testify.mock.

Unlike mockery, Mocktail generates typed methods on mocks.

For an explanation of why we created Mocktail, you can read this article.

How to use

Create a file named mock_test.go inside the package that you can to create mocks.
Add one or multiple comments // mocktail:MyInterface inside the file mock_test.go.

package example

// mocktail:MyInterface

How to Install

Go Install

You can install Mocktail by running the following command:

go install github.com/traefik/mocktail@latest

Pre-build Binaries

You can use pre-compiled binaries:

To get the binary just download the latest release for your OS/Arch from the releases page
Unzip the archive.
Add mocktail in your PATH.

Notes

It requires testify >= v1.7.0

Mocktail can only generate mock of interfaces inside a module itself (not from stdlib or dependencies)

The // mocktail comments must be added to a file named mock_test.go only,
comments in other files will not be detected

Examples

package a

import (
	"context"
	"time"
)

type Pineapple interface {
	Juice(context.Context, string, Water) Water
}

type Coconut interface {
	Open(string, int) time.Duration
}

type Water struct{}

package a

import (
	"context"
	"testing"
)

// mocktail:Pineapple
// mocktail:Coconut

func TestMock(t *testing.T) {
	var s Pineapple = newPineappleMock(t).
		OnJuice("foo", Water{}).TypedReturns(Water{}).Once().
		Parent

	s.Juice(context.Background(), "", Water{})

	var c Coconut = newCoconutMock(t).
		OnOpen("bar", 2).Once().
		Parent

	c.Open("a", 2)
}

Exportable Mocks

If you need to use your mocks in external packages just add flag -e:

mocktail -e

In this case, mock will be created in the same package but in the file mock_gen.go.

mocktail's People

Contributors

Stargazers

Watchers

Forkers

lbenguigui youkoulayley jbdoumenjou fairhopeweb jspdown 0xforked vidhill ivan-feofanov jasmeetsinghbhatia m12r johannessteu juliens wvell mloiseleur tommoulard

mocktail's Issues

Release failure

⨯ release failed after 1m45s               error=1 error occurred:
	* homebrew tap formula: could not update "Formula/mocktail.rb": PUT https://api.github.com/repos/traefik/homebrew-tap/contents/Formula/mocktail.rb: 409 Could not update file: Changes must be made through a pull request. []

The constraints on the repo https://github.com/traefik/homebrew-tap should be removed, this repo is only used by automation because the content is generated, no pull request is required in this context.

Add explanation

I miss the bit where test test must be in the same package, while normally it would go in a package_test (to emulate outside usage)

Add an ability to generate exported mocks

Explanation:
I'm using a few packages in my code and I need to use generated mocks in other packages, not only in the package where interfaces are placed.
It's useful, for example, if you have a separate database/repository package and need to mock DB requests for tests in other packages.

Add install instructions

I guessed that using go install does the trick but not sure if everyone would know offhand

$ go install github.com/traefik/mocktail@latest

If this is the recommended way of installing I can make a PR

Add note about required file naming convention

I had some head-scratching before I realised that my file had to start with mock_

[feature request] allow specifying interfaces to be mocked via mocktail argument (vs mock_test.go)

In our project, we use a codegen https://github.com/deepmap/oapi-codegen to generate client under a path ./codegen and this path is ignored in .gitignore (for obvious reason - the code is generated on the fly per build)

The codegen automatiically creates a ClientInterface interface, e.g.

// The interface specification for the client above.
type ClientInterface interface {
	// SubscribeActionWS request
	SubscribeActionWS(ctx context.Context, sourceId SourceID, params *SubscribeActionWSParams, reqEditors ...RequestEditorFn) (*http.Response, error)

	// TriggerAction request with any body
	TriggerActionWithBody(ctx context.Context, sourceId SourceID, name ActionName, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	TriggerAction(ctx context.Context, sourceId SourceID, name ActionName, body TriggerActionJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

	// GetActionTypes request
	GetActionTypes(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)

	// RegisterActionTypes request with any body
	RegisterActionTypesWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)

	RegisterActionTypes(ctx context.Context, body RegisterActionTypesJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)

Because ./codegen is ignored, to use mocktail we will have to inconveniently create a mock_test.go as part of the build process before calling mocktail.

It'd be nice to allow passing ClientInterface (together with package name/path) via mocktail arguments. E.g.

mocktail --interface ./codegen#ClientInterface