Testing/mocking Golang 中的第 3 方包

Question

我是 Golang 的新手，在学习这门语言时一直采用 TDD 方法。我一直相处得很好，但我发现测试第三方包非常笨拙，这让我相信我一直在采取错误的方法。

我遇到问题的具体情况是模拟 Redis client 进行错误处理。我采用的方法是创建自己的接口，实现包装我想使用的客户端方法。

type Redis interface {
    Get(key string) (string, error)
}

type RedisClient struct {
    client *redis.Client
}

func (redisClient *RedisClient) New(client *redis.Client) *RedisClient {
    redisClient.client = client

    return redisClient
}

func (redisClient *RedisClient) Get(key string) (string, error) {
    return redisClient.client.Get(key).Result()
}

然后我可以创建一个 mock，它实现与 return 我指定的任何值相同的接口，特别是用于测试错误处理。

我遇到了一个障碍，客户端上的特定方法 perform transactions (MULTI) return 属于该包的另一个接口。在这种情况下我会怎么做？自己实现该接口似乎是不可能的。

类似地，随着此客户端使用量的增长，我自己的实现可能会增长到实现 Redis 的整个接口的程度——这似乎与将其委托给外部依赖项的整个想法背道而驰。

有没有更好的方法来测试像这样的第三方包，例如错误处理？

Answer 1

一种方法是创建一个类型，重点关注您想要完成的事情，而不是您正在使用的客户端方法。

假设您只需要一个存储来保存和获取用户，您可以想象这样的界面：

type UserStore interface {
  SaveUser(*User) error
  GetUserByID(id string) (*User, error)
  SearchUsers(query string) ([]User, error)
}

然后您可以实现此存储的 Redis 版本并在其中调用您想要的任何客户端方法，这并不重要。您甚至可以在 PostgreSQL 或其他任何语言中实现一个。此外，使用这种方法进行模拟更容易，因为您需要做的就是实现此接口而不是 Redis 接口。

这里是这个接口的模拟版本的例子：

type UserStoreMock struct {
  SaveUserFn func (*User) error
  SaveUserInvoked bool
  ...
}

func (m *UserStoreMock) SaveUser(u *User) error {
  m.SaveUserInvoked = true

  if m.SaveUserFn != nil {
    return m.SaveUserFn(u)
  }

  return nil
}
...

然后您可以像这样在测试中使用这个模拟：

var m UserStoreMock

m.SaveUserFn = func(u *User) error {
  if u.ID != "123" {
    t.Fail("Bad ID")
  }

  return ErrDuplicateError
}
...

Testing/mocking Golang 中的第 3 方包

Testing/mocking 3rd party packages in Golang

testing

tdd

go