メインコンテンツまでスキップ

FlutterアプリのユニットテストとUIテストの実行

Flutter Test Step を使用すると、Bitrise 上で Flutter アプリのユニットテスト、ウィジェットテスト、統合テスト (エンドツーエンドテストまたは UI テストとも呼ばれます) を実行できます。Step は flutter test コマンドを実行し、コマンドが生成する json ファイルを保存します。その後、いつでもテスト結果を確認できます: テスト結果の表示

コードカバレッジ

Flutter Test Step は、コードカバレッジレポートも生成できます。

UI Maestro によるテスト

エミュレーターやシミュレーターでタップや入力を行うフローを使って、Flutter アプリの UI を外部からテストするには、Maestro を参照してください: Bitrise での Maestro テストの実行

Flutter Test を使用してテストを実行するには、次の手順に従います。

  1. Flutter プロジェクトにテストを含めます。

    テストの書き方と Flutter プロジェクトへの組み込み方の詳細については、Flutter の公式ドキュメントを参照してください: Flutter アプリのテスト

  2. Flutter Install Step を Workflow に追加します。

    この Step は、Flutter SDK の初期セットアップを実行し、不足しているコンポーネントをインストールします。

  3. Flutter Install Step が、アプリに適したバージョンの Flutter SDK をインストールすることを確認します。Flutter SDK version or bundle URL 入力を確認してください。

    flutter-install-step.png

    入力の default value は stable で、SDK の最新の安定版がインストールされます。ただし、特定のバージョンタグ、ブランチラベル、または Flutter SDK のインストールバンドル URL を値に設定することもできます。

    • 利用可能なバージョンタグは次の場所で確認できます: Version tags
    • 利用可能なブランチラベルは次の場所で確認できます: Branch labels
    インストールバンドル URL

    インストールバンドル URL から Flutter SDK をインストールすることもできます。同じ Flutter SDK version or bundle URL 入力の値に URL を設定します。例: https://storage.googleapis.com/flutter_infra/releases/beta/macos/flutter_macos_v1.6.3-beta.zip

  4. Flutter Test Step を Workflow に追加します。Flutter Install Step の後に配置してください。

    Step は、オプションのフラグを付けて flutter test コマンドを実行します。コードカバレッジを確認することもできます。

  5. Project Location 入力が、Flutter プロジェクトのルートディレクトリを指していることを確認します。

    flutter-test-step.png

    • Bitrise でアプリとして追加したときに、プロジェクトスキャナーが Flutter プロジェクトとして自動的に検出した場合は、default value を変更する必要はありません。
    • アプリを手動で設定した場合は、場所が正しいことを確認します。確認するには、Workflow Editor の Env Vars タブに移動し、BITRISE_FLUTTER_PROJECT_LOCATION Environment Variable を確認します。
  6. デフォルトでは、Step はすべてのテストを検索して実行します。ただし、選択したテストのみを実行するように設定することもできます。Test files pattern 入力を使用して、実行するテストを Step に指定します。

    この入力では、* 形式と ** 形式の両方の glob を使用できます。たとえば、lib/**/*_test.dart は有効な入力です。

    flutter-test-files-pattern.png

  7. 必要に応じて、Additional parameters 入力を使用して、flutter test コマンドにフラグを追加します。

    利用可能なオプションを確認するには、flutter help test コマンドを実行します。ご自身のデバイス上、または Bitrise の Script Step で実行できます。

  8. 必要に応じて、Generate code coverage files? 入力を yes に設定して、コードカバレッジファイルを生成します。

    この入力を有効にすると、flutter test コマンドに --coverage フラグが追加されます。

  9. 必要に応じて、生成された JSON テストレポートとコードカバレッジファイル (lcov.info) に、後続の Steps から、BITRISE_FLUTTER_TESTRESULT_PATH と BITRISE_FLUTTER_COVERAGE_PATH Environment Variables を使用してアクセスできます。

  10. テスト結果を表示するには、Deploy to Bitrise.io Step を Workflow に追加します: テスト結果のデプロイ