模拟 os.GetEnv("ENV_VAR")

Question

我试图os.GetEnv()在我的测试文件中模拟 Go 函数，以便我可以获得特定环境变量的所需值。

比如我已经定义了。

abc := os.GetEnv("XYZ_URL")

在这里，我应该能够获得变量所需的值abc。我也有几个地方有这些GetEnv功能。

如果有人可以在没有任何 Go 框架帮助的情况下给我一个解决方法，那将非常有帮助。

Answer 1

首先，您不能模拟该功能。您只能模拟作为接口公开的内容。

其次，你可能不需要。从广义上讲，模拟被过度使用，应尽可能避免。

测试环境变量时，您几乎没有选择。

如果您使用的是 Go 1.17 或更高版本，则可以利用新Setenv功能，该功能仅在当前测试期间设置环境变量：

func TestFoo(t *testing.T) {
    t.Setenv("XYZ_URL", "http://example.com")
    /* do your tests here */
}

对于旧版本的 Go，请考虑以下选项：

1. 创建一个可以模拟/加倍的对象，它公开必要的功能。例子：

type OS interface {
    Getenv(string) string
}

type defaultOS struct{}

func (defaultOS) Getenv(key string) string {
    return os.Getenv(key)
}

// Then in your code, replace `os.Getenv()` with:

myos := defaultOS{}
value := myos.Getenv("XYZ_URL")

在您的测试中，创建一个满足接口的自定义实现，但提供您测试所需的值。

这种方法对于一些事情（如包裹有用time包），但可能是一个糟糕的做法os.Getenv。

2. 让你的函数不依赖于os.Getenv，而只是传递值。例如，而不是：

func connect() (*DB, error) {
    db, err := sql.Connect(os.Getenv("XYZ_URL"), ...)
    /* ... */
    return db, err
}

用：

func connect(url string) (*DB, error) {
    db, err := sql.Connect(url, ...)
    /* ... */
    return db, err
}

从某种意义上说，这只是“移动”了问题——您可能仍想测试使用 的调用方，os.Getenv()但您至少可以减少依赖于此方法的 API 的表面积，这使得第三种方法更容易。

3. 在测试期间明确设置环境。例子：

func TestFoo(t *testing.T) {
    orig := os.Getenv("XYZ_URL")
    os.Setenv("XYZ_URL", "http://example.com")
    t.Cleanup(func() { os.Setenv("XYZ_URL", orig) })
    /* do your tests here */
}

这种方法确实有局限性。特别是，并行运行多个这些测试是行不通的，因此您仍然希望尽量减少运行的这些测试的数量。

这意味着方法 2 和方法 3 相互结合可以非常强大。

4. 最后一个选项是创建一个函数变量，可以在测试中替换它。我在另一篇文章中谈到过这个，但对于你的例子，它可能是这样的：

var getenv = os.Getenv

/* ... then in your code ... */

func foo() {
    value := getenv("XYZ_URL") // Instead of calling os.Getenv directly
}

并在测试中：

func TestFoo(t *testing.T) {
    getenv = func(string) string { return "http://example.com/" }
    /* ... your actual tests ... */
}

这与选项 #3 有许多相同的限制，因为您不能并行运行多个测试，因为它们会发生冲突。