gomonkey

README

gomonkey

gomonkey is a library to make monkey patching in unit tests easy.

Features

• support a patch for a function
• support a patch for a member method
• support a patch for a interface
• support a patch for a function variable
• support a patch for a global variable
• support patches of a specified sequence for a function
• support patches of a specified sequence for a member method
• support patches of a specified sequence for a interface
• support patches of a specified sequence for a function variable

Notes

• gomonkey fails to patch a function or a member method if inlining is enabled, please running your tests with inlining disabled by adding the command line argument that is -gcflags=-l(below go1.10) or -gcflags=all=-l(go1.10 and above).
• gomonkey should work on any amd64 system.
• A panic may happen when a goroutine is patching a function or a member method that is visited by another goroutine at the same time. That is to say, gomonkey is not threadsafe.
• go1.6 version of the reflection mechanism supports the query of private member methods, but go1.7 and above does not support it. However, all versions of the reflection mechanism support the query of private functions, so gomonkey will trigger a panic for only patching a private member method when go1.7 and above is used.

Supported Platform:

• MAC OS X amd64
• Linux amd64
• Windows amd64

Installation

$ go get github.com/agiledragon/gomonkey

Using gomonkey

Please refer to the test cases as idioms, very complete and detailed.

Documentation

Index

• func GetResultValues(funcType reflect.Type, results ...interface{}) []reflect.Value
• type OutputCell
• type Params
• type Patches
  • func ApplyFunc(target, double interface{}) *Patches
  • func ApplyFuncSeq(target interface{}, outputs []OutputCell) *Patches
  • func ApplyFuncVar(target, double interface{}) *Patches
  • func ApplyFuncVarSeq(target interface{}, outputs []OutputCell) *Patches
  • func ApplyGlobalVar(target, double interface{}) *Patches
  • func ApplyMethod(target reflect.Type, methodName string, double interface{}) *Patches
  • func ApplyMethodSeq(target reflect.Type, methodName string, outputs []OutputCell) *Patches
  • func NewPatches() *Patches
  • func (this *Patches) ApplyCore(target, double reflect.Value) *Patches
  • func (this *Patches) ApplyFunc(target, double interface{}) *Patches
  • func (this *Patches) ApplyFuncSeq(target interface{}, outputs []OutputCell) *Patches
  • func (this *Patches) ApplyFuncVar(target, double interface{}) *Patches
  • func (this *Patches) ApplyFuncVarSeq(target interface{}, outputs []OutputCell) *Patches
  • func (this *Patches) ApplyGlobalVar(target, double interface{}) *Patches
  • func (this *Patches) ApplyMethod(target reflect.Type, methodName string, double interface{}) *Patches
  • func (this *Patches) ApplyMethodSeq(target reflect.Type, methodName string, outputs []OutputCell) *Patches
  • func (this *Patches) Reset()

Functions

func GetResultValues

func GetResultValues(funcType reflect.Type, results ...interface{}) []reflect.Value

Types

type OutputCell

type OutputCell struct {
	Values Params
	Times  int
}

type Params

type Params []interface{}

type Patches

type Patches struct {
	// contains filtered or unexported fields
}

func ApplyFunc

func ApplyFunc(target, double interface{}) *Patches

func ApplyFuncSeq

func ApplyFuncSeq(target interface{}, outputs []OutputCell) *Patches

func ApplyFuncVar

func ApplyFuncVar(target, double interface{}) *Patches

func ApplyFuncVarSeq

func ApplyFuncVarSeq(target interface{}, outputs []OutputCell) *Patches

func ApplyGlobalVar

func ApplyGlobalVar(target, double interface{}) *Patches

func ApplyMethod

func ApplyMethod(target reflect.Type, methodName string, double interface{}) *Patches

func ApplyMethodSeq

func ApplyMethodSeq(target reflect.Type, methodName string, outputs []OutputCell) *Patches

func NewPatches

func NewPatches() *Patches

func (*Patches) ApplyCore

func (this *Patches) ApplyCore(target, double reflect.Value) *Patches

func (*Patches) ApplyFunc

func (this *Patches) ApplyFunc(target, double interface{}) *Patches

func (*Patches) ApplyFuncSeq

func (this *Patches) ApplyFuncSeq(target interface{}, outputs []OutputCell) *Patches

func (*Patches) ApplyFuncVar

func (this *Patches) ApplyFuncVar(target, double interface{}) *Patches

func (*Patches) ApplyFuncVarSeq

func (this *Patches) ApplyFuncVarSeq(target interface{}, outputs []OutputCell) *Patches

func (*Patches) ApplyGlobalVar

func (this *Patches) ApplyGlobalVar(target, double interface{}) *Patches

func (*Patches) ApplyMethod

func (this *Patches) ApplyMethod(target reflect.Type, methodName string, double interface{}) *Patches

func (*Patches) ApplyMethodSeq

func (this *Patches) ApplyMethodSeq(target reflect.Type, methodName string, outputs []OutputCell) *Patches

func (*Patches) Reset

func (this *Patches) Reset()