golang测试临时目录

Question

我有一个简单的函数,它将配置文件解析为JSON.我想编写一个测试,它使用一些示例静态配置文件并解析它们,或者在测试期间创建样本并尝试解析它们.

这个问题并不完全是必要的,但这里是基本代码:

// config.go

// ...(package,imports)...

// Overall settings - corresponds to main.conf
type MainSettings struct {
    // stuff
}

// Load main.conf from the specified file path
func LoadMainSettings(path string) (*MainSettings, error) {

    b, err := ioutil.ReadFile(path)
    if err != nil { return nil, err }

    r := &MainSettings{}
    err = json.Unmarshal(b, r)
    if err != nil { return nil, err }

    return r, nil

}

和测试:

// config_test.go

func TestLoadMainSettings(t *testing.T) {

    // possibly generate some example config files,
    // or use static samples packaged with the source

    s, err := LoadMainSettings("conf/main.conf") // <-- what should this path be??
    if err != nil { panic(err) }

    // more sanity checking...

}

---

那就是说,我的具体问题是:

• 是否有适用于测试的静态资产(如示例配置文件)的适当位置？
• 在测试执行期间是否存在适当的(跨平台,用"清理"清理)位置来写出临时文件？

(注意:我在Linux上运行我的大部分东西用于升级和生产,Mac用于本地开发 - 所以使用/ tmp /作为测试的临时目录在实践中对我有用.但是想知道是否有更好的方法......)

---

编辑:结束使用这种方法进行测试:

f, err := ioutil.TempFile("", "testmainconf")
if err != nil { panic(err) }
defer syscall.Unlink(f.Name())
ioutil.WriteFile(f.Name(), []byte("{...sample config data...}"), 0644)

s, err := LoadMainSettings(f.Name())

但另一个让LoadMainSettings接受io.Reader而不是a string的建议也是一个好主意.

Answer 1

您可以使用同一个包中的ioutil.TempDir或TempFile.

Answer 2

从 Go 1.15 版开始，现在T.TempDir()在标准testing包中。该文档解释如下：

TempDir 返回一个临时目录供测试使用。当测试及其所有子测试完成时，Cleanup 会自动删除该目录。每次对 t.TempDir 的后续调用都会返回一个唯一的目录；如果目录创建失败，TempDir 通过调用 Fatal 终止测试。

Answer 3

只是为了与你所拥有ioutil.TempDir的东西进行比较,这里的内容是io.Reader:

// Load main.conf from the specified file path
func LoadMainSettings(src io.Reader) (*MainSettings, error) {
    b, err := ioutil.ReadAll(src)
    if err != nil { return nil, err }

    r := &MainSettings{}
    err = json.Unmarshal(b, r)
    if err != nil { return nil, err }

    return r, nil
}

具体来说,我们改变从参数path字符串的src io.Reader实例,我们在更换ioutil.ReadFile用ioutil.ReadAll.

您编写的测试用例最后会缩短一点,因为我们可以免除文件操作:

s, err := LoadMainSettings(strings.NewReader("{...sample config data...}"))