Go：ファイルに依存するコードを対象としたテストでの No such file or directory を簡単に直す

go build で得たバイナリを実行する時に、例えば bin/foobar のように実行すると、current working directoryはもちろんbinの親ディレクトリになります。

一方で、 go test はテストファイルのあるディレクトリをcurrent working directoryとして実行します。

そのため、テスト対象のコードにおいて、 os.ReadFile("foo/bar/data.csv") や template.ParseFiles("templates/foo/bar.txt") など、ローカルのファイルを相対パスで読み込んでいると、バイナリ実行の時は問題ないのに、テストでは No such file or directory が起きます。

そんな時は、テストの先頭に下記を貼ると直せます。

cwd, err := os.Getwd()
if err != nil {
	t.Fatalf("failed to get current working directory: %v", err)
}
t.Cleanup(func() {
	err := os.Chdir(cwd)
	if err != nil {
		t.Fatalf("failed to get current working directory: %v", err)
	}
})
err := t, os.Chdir("../..")
if err != nil {
	t.Fatalf("failed to get current working directory: %v", err)
}

Goなのでerrチェックが長くなるので、 t.Helper() な関数に切り出して置くと良いかもしれません (deferを使っていないなので可能です)。下記のようにtestify/requireを使うのもおすすめです。

cwd, err := os.Getwd()
require.NoError(t, err)
t.Cleanup(func() {
	require.NoError(t, os.Chdir(cwd))
})
require.NoError(t, os.Chdir("../.."))

テストプロセスは同じディレクトリ (package？) の他のテストでも使いまわされるので、 Cleanup() 内でcurrent working directory元に戻しておきます。