goでのenvの置き方について

Question

このように

.main.go
|_ responder/
|    -_responder.go
|    - responser_test.go
|_ .env

のようにしてrepsonder.goで以下のように

if err := godotenv.Load(); err != nil {
		logger.Fatal("Error to load envfile")
}

を読み込むとgo testではenvがないと怒られますが、go run`はできます。

また.envをresponder/の中に入れるとgo testはできるようになるのですがgo runは.envファイルが無いと怒られます。

どのような解決策があり、なぜこうなるのでしょうか？

Answer 1

単純にメインパッケージでないパッケージフォルダにダミーの.envファイルを置くというのも解決方法としてはありですが。あくまでそれらはテスト用のダミーであることを忘れないようにしてください。

func TestResponder(t *testing.T) {
　err := godotenv.Load("test_dummy.env")
　if err != nil {
    ...
  }
  ...

あと、Unload機能がgodotenvにないので、
テスト実行時に複数のダミーファイルを読み込んだ状態になるし、
.envの内容やテストが込み入ってくると
トラブルを招くこともありそうなので前述の方がオススメです。

Answer 2

godotenvのコードをみるとロードするファイル名を省略した場合は
カレントフォルダにある".env"ファイルが読み込み対象です。

「go run」するときはカレントフォルダを参照しますのでmain.goのあるフォルダで「go run」したのでしょう。その場合.envがみつかります。

「go test」した時は各パッケージフォルダにカレントディレクトリが切り替えられてからテスト処理が実行されます。なのでパッケージフォルダに.envがない場合に存在しないというエラーになるのでしょう。

カレントフォルダに依存するファイルローダーはメインパッケージフォルダを想定しておかないといろいろ面倒になります。なのでサブパッケージのテスト実装でローダーが実行されるようにするのはNGでしょう。

メインパッケージで読み込んだ情報をresponderパッケージで参照するように設計する時は
「準備の段階でresponderに読み込んだ情報を渡す」方が良いでしょう。

func main() {
  err := godotenv.Load()
  if err != nil {
    log.Fatal("Error loading .env file")
  }

  s3Bucket := os.Getenv("S3_BUCKET")
  secretKey := os.Getenv("SECRET_KEY")

  r := responder.New(s3Bucket, secretKey)
  ...
}

そしてテストでは本番に使う.envを使わないのが一般的です。「準備の段階でresponderに読み込んだ情報を渡す」時の情報にダミーを渡してテストを実装しましょう。

responder_test.go

func TestResponder(t *testing.T) {
  r := New("dummy_bucket/uri", "dummy_secret")
  ...
}