模拟获取环境变量 "ENV_VAR"

大家好，今天本人给大家带来文章《模拟获取环境变量 "ENV_VAR"》，文中内容主要涉及到，如果你对Golang方面的知识点感兴趣，那就请各位朋友继续看下去吧~希望能真正帮到你们，谢谢！

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

例如我已经定义了。

abc := os.GetEnv("XYZ_URL")

在这里我应该能够获得变量 abc 所需的值。我还有几个地方有 GetEnv 函数。

如果有人能够在没有任何 Go 框架帮助的情况下为我提供解决方法，那将非常有帮助。

解决方案

首先，你不能模拟该函数。您只能模拟作为接口公开的东西。

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

测试环境变量时，您的选择很少。

如果您使用的是 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 来说可能是一种坏方法。

1. 使您的函数不依赖于 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 的表面积方法，这使得第三种方法更容易。

1. 在测试期间明确设置环境。示例：

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 相互结合会非常强大。

1. 最后一个选项是创建一个可以在测试中替换的函数变量。我已经讨论过这个 in another post，但对于您的示例，它可能如下所示：

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 具有许多相同的限制，因为您无法并行运行多个测试，因为它们会发生冲突。

今天关于《模拟获取环境变量 "ENV_VAR"》的内容介绍就到此结束，如果有什么疑问或者建议，可以在golang学习网公众号下多多回复交流；文中若有不正之处，也希望回复留言以告知！