My External Storage

Apr 16, 2021 - 3 minute read - Comments - go

[Go]環境変数を使ったテストを書く

Goで環境変数を使ってテストを行なうときに便利な関数を作ってみる。

TL;DR

現時点のサンプルコードは以下の通り。

// 環境変数名をキー、環境変数値をバリューとするマップ
func setup(t *testing.T, envs map[string]string) {
  for k, v := range envs {
    prev, ok := os.LookupEnv(k)
    if err := os.Setenv(k, v); err != nil {
      t.Fatalf("cannot set environment key: %q", k)
    }
    k := k // 束縛しておく
    if ok {
      t.Cleanup(func() { _ = os.Setenv(k, prev) })
    } else {
      t.Cleanup(func() { _ = os.Unsetenv(k) })
    }
  }
}

テストケースの中で環境変数を利用したい

なるべく環境変数への依存はおさえるべきだ。とは言え環境変数を使わずにアプリケーションを書くことはほとんどない。 環境変数の利用を含んだテストコードを書いて、そのテストコードの中でだけ環境変数を定義しておきたい。
また、テストケースが完了したら他のテストケースの邪魔にならないように環境変数をもとに戻したい。

os.Getenvとos.LookupEnv

ざっと標準パッケージを見ると環境変数を取得する関数はos.Getenvだ。 しかし、os.Getenv関数は「未定義の環境変数」からも空文字を取得してしまう。

To distinguish between an empty value and an unset value, use LookupEnv.

よって、「未定義の環境変数」と「空文字が設定された環境変数」を見分けるにはos.LookupEnv関数を利用する。
os.LookupEnv関数が事前に定義された値を見つければt.Cleanupメソッドでテスト終了後に元の値をセットする。
そうでなければos.UnsetEnv関数で環境変数の設定を削除すればよい。

テストコードで環境変数を使いこなすスニペット

deferを使うようなこともあったが、Go1.14からはt.Cleanup関数を利用すればスッキリ書ける。
スニペット利用者が正しく後処理関数の実行を行わず環境変数が定義されっぱなしになったという心配もない。
注意点としては当然ながらt.Parallel()関数との併用はできない。

環境変数名をキー、環境変数値をバリューとするマップ
func setup(t *testing.T, envs map[string]string) {
  for k, v := range envs {
    prev, ok := os.LookupEnv(k)
    if err := os.Setenv(k, v); err != nil {
      t.Fatalf("cannot set environment key: %q", k)
    }
    k := k // 束縛しておく
    if ok {
      t.Cleanup(func() { _ = os.Setenv(k, prev) })
    } else {
      t.Cleanup(func() { _ = os.Unsetenv(k) })
    }
  }
}

Go1.17以降は標準パッケージにT.Setenv関数が追加される。

ここまで書いたが、このような仕組みはGo1.17でtestingパッケージ提供される予定だ。

// Setenv calls os.Setenv(key, value) and uses Cleanup to
// restore the environment variable to its original value
// after the test.
//
// This cannot be used in parallel tests.
func (t *T) Setenv(key, value string)

リストア処理もやってくれるので、Go1.17以降はこのように書き直せる。

環境変数名をキー、環境変数値をバリューとするマップ
func setup(t *testing.T, envs map[string]string) {
  for k, v := range envs {
    t.Setenv(k, v)
  }
}

終わりに

さっと書こうとしたが、実はk := kを書かないまま動かして少しハマっていた。
ちゃんとテストを書くのは大事だ。

関連記事