stretchr/testify

Add command to autogenerate mocks from interfaces

Open

#273 opened on Feb 12, 2016

View on GitHub
 (14 comments) (1 reaction) (0 assignees)Go (25,958 stars) (1,704 forks)batch import
enhancementhelp wantedmockery

Description

The best way to use mock is with a program that will automatically generate the code for the mocks based on the interfaces.

mockery pioneered this approach but has some current limitations such as being unable to generate mocks from interfaces from other packages and incomplete mocks from composed interfaces.

goautocomplete addresses these issues but lacks documentation and reviewing the default behaviour to have less verbose go generate declarations.

Whichever implementation we use as a base, requirements would be:

  • Backwards compatibility once released with testify
  • Support for composed interfaces
  • Hability to generate mocks from the stdlib and other packages
  • Simplicity of use with go generate
  • Default arguments generating mocks follow conventions + arguments to override defaults
  • Generated mocks should have documentation for team mates who don't know much about mock
  • Quick way for packages to generate a package with mocks for their exported interfaces

Will follow up with an initial proposal

Contributor guide

Tech stack
go
Domain
testingtooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
over 1 week
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Go programmingFamiliarity with testify mock packageMock generation concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
This issue requests a command to automate mock generation from interfaces. Currently, no implementation exists. Review the requirements list and examine existing mock generation tools like mockery and goautocomplete. Consider backwards compatibility with testify's mock package. Proposed solution should address composed interfaces, generation from other packages, and simplicity with go generate. Look at related issues or PRs in the repository.