Flutterでテスト実行時に環境変数を設定する

はじめに

flutter testを実行するときに環境変数を設定する方法を紹介します。

1. VSCodeの設定を追加する

プロジェクトの設定ファイルに設定を追加します。

.vscode/settings.json

{
    "dart.flutterTestAdditionalArgs": [
        "--dart-define=HOGE=fuga",
        "--dart-define=FOO=bar",
    ]
}

メリット

• 実行結果が見やすい
• VSCodeで実行・再実行するときに環境変数が渡される

デメリット

• VSCode以外のエディタを使っている人には適用されない

2. CLIで実行する

以下のコマンドで実行します。

flutter test --dart-define=HOGE=fuga --dart-define=FOO=bar ./path/to/test(.dart)

メリット

• どの環境でも実行できる

デメリット

• テスト結果が見づらい
• テストケースを指定しての実行や再実行ができない

3. VSCodeの実行構成を追加する

プロジェクトの実行構成ファイルに設定を追加します。1より優れている点はないと思いますが、使えることもあるかもしれないので記載しました。

{
  "configurations": [
    {
      "name": "Run Test",
      "type": "dart",
      "request": "launch",
      "program": "path/to/test(.dart)",
      "args": [
        "--dart-define=HOGE=fuga",
        "--dart-define=FOO=bar",
      ]
    },
  ]
}

メリット
特に思いつきませんでした。

デメリット

• テストケースを指定して実行できない
• 再実行時に環境変数が設定されない

参考
Launch Configuration

まとめ

CLI実行ではログが見づらすぎるので、基本VSCodeから実行するのが良いと思います。1の方法で設定したことでテストビューやTest Resultsタブからテストケースを指定しての実行や再実行がしやすくなりました◎