在 Golang 中测试/模拟 3rd 方包

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()
}

然后我可以创建一个模拟来实现相同的接口以返回我指定的任何值，特别是用于测试错误处理。

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

同样，随着该客户端使用量的增长，我自己的实现可能会增长到实现 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
}
...