Mockery

Mockery is a code generation tool that produces mock implementations from Go interfaces, designed to simplify unit testing by automating the creation of test doubles. It parses Go source files using abstract syntax tree analysis to extract interface method signatures, then generates complete mock struct types that implement those interfaces with configurable function fields for test injection.

The tool distinguishes itself through its configuration and customization capabilities. Rather than embedding directives in source code annotations, Mockery reads generation settings from a YAML configuration file, centralizing mock generation parameters. It also supports custom Go text/templates to control the structure and behavior of generated mock code, allowing teams to shape output to match their testing patterns and conventions.

Mockery covers the full workflow of interface-to-mock generation, from parsing interface definitions to producing ready-to-use mock source files. Its template-driven output and YAML-based configuration provide a flexible foundation for integrating mock generation into existing Go testing workflows.

Features

Go Interface - A framework that creates mock objects from Go interface definitions to simplify test setup and verification.

Method Signature Analyzers - Analyzes parameter and return types of interface methods to generate matching mock function signatures.

Mock Code Generators - Automatically generates mock implementations from Go interfaces for use in unit testing and dependency injection.

Interface Mock Generators - Generates mock implementations from Go interfaces to replace real dependencies in unit tests.

Interface AST Parsers - Parses Go interface definitions into ASTs to extract method signatures for mock generation.

Compile-Time Code Generation - Generates mock source files at build time by parsing Go interfaces and producing implementation code.

Test Service Injections - Creates mock objects that can be injected into Go code to isolate and test specific components.

Struct-Based - Creates struct types that implement interfaces by delegating to configurable function fields for test injection.

Interface-to-Mock Generators - Generates mock objects from Go interfaces to remove manual boilerplate needed for testing with mock frameworks.

Code Generation Templates - Uses Go text/template files to control the structure and behavior of generated mock code.

Template-Based Code Customizers - Uses custom templates and template data to control the structure and behavior of generated mocks.

Mock Generation Template Customizers - Supplies custom templates and data to shape the structure and behavior of generated mock code.

YAML Configuration Files - Reads mock generation settings from a YAML file to centralize configuration instead of using source code annotations.

Mock Generation Configuration Files - Configures mock generation settings in a YAML file instead of scattering directives across source code.

Mock Generator Configurations - Reads configuration from YAML files instead of inline source code directives for mock generation.

Generation Templates - Customizes generated mock code by supplying templates and template data to control its structure and behavior.

Mock Generation Configurations - Configures mock generation settings and templates through a YAML file instead of inline source annotations.

Frameworks and Libraries - An automatic mock code generator for testing.

Testing Frameworks - Generates mock code for interfaces.

vektramockery

Features

Star history