チュートリアル: AWS Device Farm で Android アプリケーションを構築してテストするパイプラインを作成する

アプリケーションのコードのルートに buildspec.yml という名前のファイルを追加してコミットし、リポジトリにプッシュします。CodeBuild は、このファイルを使用してコマンドを実行し、アプリケーションを構築するために必要なアーティファクトにアクセスします。

version: 0.2

phases:
  build:
    commands:
      - chmod +x ./gradlew
      - ./gradlew assembleDebug
artifacts:
  files:
     - './android/app/build/outputs/**/*.apk'
  discard-paths: yes

(オプション) Calabash または Appium を使用してアプリケーションをテストする場合は、テスト定義ファイルをリポジトリに追加します。後のステップで、定義を使用してテストスイートを実行するように Device Farm を設定できます。

Device Farm の組み込みのテストを使用する場合は、このステップを省略できます。

パイプラインを作成してソースステージを追加するには、以下の手順を実行します。

1. AWS マネジメントコンソール にサインインして、https://console.aws.amazon.com/codepipeline/ で CodePipeline コンソールを開きます。

2. [ようこそ] ページ、[開始方法] ページ、または [パイプライン] ページで、[パイプラインの作成] を選択します。

3. [ステップ 1: 作成オプションを選択する] ページの [作成オプション] で、[カスタムパイプラインを構築する] オプションを選択します。[次へ] を選択します。

4. [ステップ 2: パイプラインの設定を選択する] ページで、[パイプライン名] にパイプラインの名前を入力します。

5. CodePipeline は、特徴と料金が異なる V1 タイプと V2 タイプのパイプラインを提供しています。V2 タイプは、コンソールで選択できる唯一のタイプです。詳細については、「パイプラインタイプ」を参照してください。CodePipeline の料金については、料金を参照してください。

6. [サービスロール] で、[New service role (新しいサービスロール)] は選択したままにして、[Role name (ロール名)] は変更しません。既存のサービスロール (ある場合) を使用することもできます。

   注記

   2018 年 7 月以前に作成した CodePipeline サービスロールを使用している場合、Device Farm の許可を追加する必要があります。これを行うには、IAM コンソールを開き、ロールを見つけて、ロールのポリシーに次の許可を追加します。詳細については、「CodePipeline サービスロールにアクセス許可を追加する」を参照してください。

   {
        "Effect": "Allow",
        "Action": [
           "devicefarm:ListProjects",
           "devicefarm:ListDevicePools",
           "devicefarm:GetRun",
           "devicefarm:GetUpload",
           "devicefarm:CreateUpload",
           "devicefarm:ScheduleRun"
        ],
        "Resource": "*"
   }

7. [詳細設定] をデフォルト設定のままにし、[次へ] を選択します。

8. [ステップ 3: ソースステージの追加] ページの [ソースプロバイダー] で、[GitHub (GitHub アプリ経由)] を選択します。

9. 接続 で、既存の接続を選択するか、新規の接続を作成します。GitHub ソースアクション用の接続を作成または管理するには、「GitHub コネクション」を参照してください。

10. [リポジトリ] で、ソースリポジトリを選択します。

11. [ブランチ] で、使用するブランチを選択します。

12. ソースアクションの残りはデフォルトのままにしておきます。[次へ] を選択します。

[ステップ 4: ビルドステージの追加] で、ビルドステージを追加します。

1. [プロバイダーを構築する] で、[その他のビルドプロバイダー]、[AWS CodeBuild] の順に選択します。[リージョン] をデフォルトでパイプラインのリージョンにすることを許可します。

2. [プロジェクトを作成] を選択します。

3. [プロジェクト名] に、このビルドプロジェクトの名前を入力します。

4. [環境イメージ] で、[Managed image (マネージド型イメージ)] を選択します。[Operating system] で、[Ubuntu] を選択します。

5. [ランタイム] で、[Standard (標準)] を選択します。[イメージ] で、[aws/codebuild/standard:5.0] を選択します。

   CodeBuild は、Android Studio がインストールされているこの OS イメージを使用してアプリケーションを構築します。

6. サービスロール で、既存の CodeBuild サービスロールを選択するか、新しいサービスロールを作成します。

7. [ビルド仕様] で、[Use a buildspec file (ビルド仕様ファイルの使用)] を選択します。

8. [Continue to CodePipeline ] (CodePipeline に進む) を選択します。これにより、CodePipeline コンソールに戻り、設定用にリポジトリ内の buildspec.yml を使用する CodeBuild プロジェクトが作成されます。ビルドプロジェクトでは、サービスロールを使用して AWS のサービス のアクセス許可を管理します。このステップには数分かかる場合があります。

9. [次へ] を選択します。

[ステップ 5: テストステージの追加] で、[テストステージをスキップ] を選択し、もう一度 [スキップ] を選択して警告メッセージを受け入れます。

[次へ] を選択します。

[ステップ 6: デプロイステージの追加] ページで、[デプロイステージをスキップ] を選択し、もう一度 [スキップ] を選択して警告メッセージを受け入れます。[次へ] を選択します。

[ステップ 7: レビュー] で、[パイプラインを作成する] を選択します。ソースとビルドステージを示す図が表示されます。

パイプラインに Device Farm テストアクションを追加します。

1. 右上の [編集] を選択します。

2. 図の最下部で [+ Add stage] (+ ステージの追加) を選択します。[ステージ名] に名前 (Test など) を入力します。

3. [+ Add action group (+ アクションの追加)] を選択します。

4. [アクション名] に名前を入力します。

5. アクションプロバイダ で、AWS Device Farm を選択します。[リージョン] をデフォルトでパイプラインのリージョンにすることを許可します。

6. [入力アーティファクト] で、テストステージに先立つステージの出力アーティファクトと一致する入力アーティファクト (BuildArtifact など) を選択します。

   AWS CodePipeline コンソールでは、パイプライン図の情報アイコンの上にカーソルを置くことで、各ステージの出力アーティファクトの名前を見つけることができます。パイプラインでアプリケーションを [ソース] ステージから直接テストする場合は、[SourceArtifact] を選択します。パイプラインに [ビルド] ステージが含まれている場合は、[BuildArtifact] を選択します。

7. ProjectId に、Device Farm プロジェクト ID を入力します。このチュートリアルの最初の手順に従い、プロジェクト ID を取得します。

8. [DevicePoolArn] に、デバイスプールの ARN を入力します。トップデバイスの ARN を含む、プロジェクトで使用可能なデバイスプール ARN を取得するには、AWS CLI を使用して次のコマンドを入力します。

   aws devicefarm list-device-pools --arn arn:aws:devicefarm:us-west-2:account_ID:project:project_ID

9. [AppType] に、「Android」と入力します。

   [AppType] の有効な値は次のとおりです。

   • iOS -

   • Android -

   • Web

10. [デプロイ] に、コンパイルされたアプリケーションパッケージのパスを入力します。パスは、テストステージの入力アーティファクトのルートを基準とする相対パスです。このパスは app-release.apk に似ています。

11. TestType にテストのタイプを入力し、Test にテスト定義ファイルのパスを入力します。パスは、テストの入力アーティファクトのルートに関連します。

    [TestType] の有効な値は次のとおりです。

    • APPIUM_JAVA_JUNIT

    • APPIUM_JAVA_TESTNG

    • APPIUM_NODE

    • APPIUM_RUBY

    • APPIUM_PYTHON

    • APPIUM_WEB_JAVA_JUNIT

    • APPIUM_WEB_JAVA_TESTNG

    • APPIUM_WEB_NODE

    • APPIUM_WEB_RUBY

    • APPIUM_WEB_PYTHON

    • BUILTIN_FUZZZ

    • INSTRUMENTATION

    • XCTEST

    • XCTEST_UI

    注記

    カスタム環境ノードはサポートされていません。

12. 残りのフィールドにはテストおよびアプリケーションタイプに適した構成を入力します。

13. (オプション) [アドバンスト] で、テストランの情報の設定を行います。

14. [保存] を選択します。

15. 編集中のステージで、[完了] を選択します。AWS CodePipeline のペインで [保存] を選択し、警告メッセージで [保存] を選択します。

16. 変更を送信してパイプラインのビルドを開始するには、[変更をリリース]、[リリース] の順に選択します。