接口“未定义”：模拟测试文件中是否已定义？

本篇文章给大家分享《接口“未定义”：模拟测试文件中是否已定义？》，覆盖了Golang的常见基础知识，其实一个语言的全部知识点一篇文章是不可能说完的，但希望通过这些问题，让读者对自己的掌握程度有一定的认识(B 数)，从而弥补自己的不足，更好的掌握它。

这是一个错误，我试图用一个最小的例子来重现，但到目前为止还没有成功。 go 模块类似于以下内容：

.
├── go.mod
└── handler
    ├── handler.go
    ├── handler_test.go
    └── mock_handler.go

其中 handler.go 为空（仅包含 package handler），handler_test.go 包含 handler 接口定义（与 go 的 http.handler 相同）和占位符测试，

package handler

import (
    "net/http"
    "testing"
)

type handler interface {
    servehttp(http.responsewriter, *http.request)
}

func testmockhandler(t *testing.t) {
    mockhandler := mockhandler{}
    t.log(mockhandler)
}

并且mock_handler.go包含一个mockhandler结构，它实现了handler接口并使用moq生成：

// code generated by moq; do not edit.
// github.com/matryer/moq

package handler

import (
    "net/http"
    "sync"
)

var (
    lockmockhandlerservehttp sync.rwmutex
)

// ensure, that mockhandler does implement handler.
// if this is not the case, regenerate this file with moq.
var _ handler = &mockhandler{}

// mockhandler is a mock implementation of handler.
//
//     func testsomethingthatuseshandler(t *testing.t) {
//
//         // make and configure a mocked handler
//         mockedhandler := &mockhandler{
//             servehttpfunc: func(in1 http.responsewriter, in2 *http.request)  {
//                 panic("mock out the servehttp method")
//             },
//         }
//
//         // use mockedhandler in code that requires handler
//         // and then make assertions.
//
//     }
type mockhandler struct {
    // servehttpfunc mocks the servehttp method.
    servehttpfunc func(in1 http.responsewriter, in2 *http.request)

    // calls tracks calls to the methods.
    calls struct {
        // servehttp holds details about calls to the servehttp method.
        servehttp []struct {
            // in1 is the in1 argument value.
            in1 http.responsewriter
            // in2 is the in2 argument value.
            in2 *http.request
        }
    }
}

// servehttp calls servehttpfunc.
func (mock *mockhandler) servehttp(in1 http.responsewriter, in2 *http.request) {
    if mock.servehttpfunc == nil {
        panic("mockhandler.servehttpfunc: method is nil but handler.servehttp was just called")
    }
    callinfo := struct {
        in1 http.responsewriter
        in2 *http.request
    }{
        in1: in1,
        in2: in2,
    }
    lockmockhandlerservehttp.lock()
    mock.calls.servehttp = append(mock.calls.servehttp, callinfo)
    lockmockhandlerservehttp.unlock()
    mock.servehttpfunc(in1, in2)
}

// servehttpcalls gets all the calls that were made to servehttp.
// check the length with:
//     len(mockedhandler.servehttpcalls())
func (mock *mockhandler) servehttpcalls() []struct {
    in1 http.responsewriter
    in2 *http.request
} {
    var calls []struct {
        in1 http.responsewriter
        in2 *http.request
    }
    lockmockhandlerservehttp.rlock()
    calls = mock.calls.servehttp
    lockmockhandlerservehttp.runlock()
    return calls
}

为了生成mock_handler.go，我最初在handler.go中定义了handler，然后在handler目录中运行命令

moq -out mock_handler.go . handler

我随后将 handler 接口定义移至 handler_test.go，因为它仅用于测试。

在这个简化的示例中，我可以在根目录中以包列表模式运行 go test：

~/g/s/g/k/mockhandler> go test ./... -count=1
ok      github.com/kurtpeek/mockhandler/handler 0.448s

我的“实际”模块具有类似的结构，类似于以下内容：

.
├── cmd
│   └── root.go
├── images
├── main.go
└── vpp
    ├── ensure_license_test.go
    └── mock_handler.go

handler 接口在 ensure_license_test.go 中的定义方式与简化模块中 handler_test.go 中的定义方式完全相同； ensure_license_test.go 的开头如下：

package vpp

import (
    "encoding/json"
    "io/ioutil"
    "net/http"
    "net/http/httptest"
    "net/url"
    "testing"

    "github.com/stretchr/testify/assert"
    "github.com/stretchr/testify/require"
)

type handler interface {
    servehttp(http.responsewriter, *http.request)
}

type mocktestserver struct {
    testserver  *httptest.server
    mockhandler *mockhandler
}

mock_handler.go 也与简化模块中的 mock_handler.go 完全相同（除了包名）。

但是，当我在“实际”模块的根目录中运行 go test ./... 时，我收到 undefined 错误：handler：

~/g/s/g/f/vpp-client> go test ./... -count=1
# github.com/fleetsmith/vpp-client/vpp
vpp/mock_handler.go:17:7: undefined: handler
ok      github.com/fleetsmith/vpp-client/vpp    0.128s

奇怪的是，当我从 vpp 包中运行它时，它通过了：

> go test ./... -count=1
ok      github.com/fleetsmith/vpp-client/vpp    0.601s

像第一个示例一样，当从根目录以包列表模式运行 go test 时，无法定义 handler 的定义，这可能是什么原因？

解决方案

事实证明，测试失败的是 cmd 包，因为无法从 handler 包中的测试文件导入 handler 接口。因此，我更改了 mock_handler.go 的第 17 行以使用 http.handler 而不是 handler：

var _ http.handler = &mockhandler{}

现在测试通过了：

~/g/s/g/f/vpp-client> go test ./...
?       github.com/fleetsmith/vpp-client    [no test files]
?       github.com/fleetsmith/vpp-client/cmd    [no test files]
ok      github.com/fleetsmith/vpp-client/vpp    0.462s

我还可以从 ensure_license_test.go 中删除 handler 接口的定义，因为我现在直接使用 http 标准库中的定义。

这种方法的缺点是它需要编辑由 moq 自动生成的代码，但是，我无法弄清楚如何运行 moq 来模拟 go 标准库中的接口，并且无论如何这个接口是不太可能改变。

理论要掌握，实操不能落！以上关于《接口“未定义”：模拟测试文件中是否已定义？》的详细介绍，大家都掌握了吧！如果想要继续提升自己的能力，那么就来关注golang学习网公众号吧！