1、为什么要使用Mock测试
当我们进行测试时，有时测试代码依赖于环境，耦合度较高。这样的测试会导致在不同环境下产生不一致的结果。
举个栗子，我们有一个函数读取文件的第一行：
func ReadFirstLine() string {
open, err := os.Open("test.txt")
defer open.Close()
if err != nil {
log.Print(err)
return ""
}
reader := bufio.NewReader(open)
line, _, err := reader.ReadLine()
if err != nil {
log.Print(err)
return ""
}
return string(line)
}
当我们使用常规测试时，需要在本环境下拥有test.txt文件
测试代码：
func TestReadFirstLine(t *testing.T) {
line := ReadFirstLine()
assert.Equal(t, line, "hello")
}
执行以下代码
go test -v -run TestReadFirstLine$ read_file.go read_file_test.go
测试结果：
2、使用Monkey进行mock测试
我们可以使用 monkeypatching进行mock测试，使用go get -v bou.ke/monkey获取
同样的，针对上面的案例，使用如下测试代码进行mock测试：
func TestReadFirstLineMock(t *testing.T) {
monkey.Patch(ReadFirstLine, func() string {
return "hi"
})
defer monkey.Unpatch(ReadFirstLine)
line := ReadFirstLine()
assert.Equal(t, line, "hi")
}
其中，Patch方法是我们关注的对象，其作用是更改 第一个参数函数(例子中的ReadFirstLine)的地址，将其改为第二个参数函数的地址，这样无论在什么环境下，我们调用ReadFirstLine()返回的都是"hi"，而UnPatch就是将ReadFirstLine恢复为原来的地址。
运行go test -v -run TestReadFirstLineMock$ read_file.go read_file_test.go进行测试。
测试结果：
可以看到，我们明明在test.txt中第一行为 hello ，但是测试中判断第一行为 hi 却通过了
3、Patch源码
我们点进Patch()源码：
func Patch(target, replacement interface{}) *PatchGuard {
t := reflect.ValueOf(target)
r := reflect.ValueOf(replacement)
patchValue(t, r)
return &PatchGuard{t, r}
}
首先通过反射获取了target和replacement的函数地址，之后调用patchValue()将target地址改为replacement。我们点进patchValue(t,r)
func patchValue(target, replacement reflect.Value) {
lock.Lock()
defer lock.Unlock()
if target.Kind() != reflect.Func {
panic("target has to be a Func")
}
if replacement.Kind() != reflect.Func {
panic("replacement has to be a Func")
}
if target.Type() != replacement.Type() {
panic(fmt.Sprintf("target and replacement have to have the same type %s != %s", target.Type(), replacement.Type()))
}
if patch, ok := patches[target.Pointer()]; ok {
unpatch(target.Pointer(), patch)
}
bytes := replaceFunction(target.Pointer(), (uintptr)(getPtr(replacement)))
patches[target.Pointer()] = patch{bytes, &replacement}
}
-
在这一步，首先做了加锁操作，保证一定并发的安全性。
-
接着，对各个参数进行校验。
-
再下来，查看这个函数是不是先前有patch过（这里维护了一个map即patches，存储已pacth的信息）。如果有，那么先unpatch，保证只patch一次。
-
之后的 replaceFunction(target.Pointer(), (uintptr)(getPtr(replacement))) 便是真正替代函数地址的方法，其返回的bytes包含了target的元信息。
-
最后将我们patch的原函数放入patches中，保存它的信息，以便之后unpatch时修改回来
我们再点进 replaceFunction（）
func replaceFunction(from, to uintptr) (original []byte) {
jumpData := jmpToFunctionValue(to)
f := rawMemoryAccess(from, len(jumpData))
original = make([]byte, len(f))
copy(original, f)
copyToLocation(from, jumpData)
return
}
- 这里的jumpData保存了to的jump信息
- rawMemoryAccess() 返回的是一个结构体f，包含了from(上文的target)的元信息
- original拷贝了f（即from）的元信息，也是返回值
- 之后将jumpData的信息复制到from（即将from的地址改为to的）
至于Unpatch就是从patches这个map中取到原来被替换的函数的信息，将其恢复，就不多赘述
4、tips
- 在测试时，有时候会有patch了但替换失败的情况出现，这是由于函数内联导致的。我们需要在go test中加上
-gcflags=-l参数来禁止函数内联。 - 在部分面向安全的操作系统上，系统不允许一个内存页同时写和执行，这会使得Monkey不能运行
- Monkey不是绝对线程安全的
参考资料：
