パイプラインの構築（その3）

本連載では、マイクロサービスアーキテクチャでの継続的デリバリ(CD：Continuous Delivery:CD)を以下のようなパイプラインで実装する方法について、解説を進めています。

本連載で実装を進めている継続的デリバリのパイプライン

前回は、ECSクラスタ上にバックエンドのマイクロサービスアプリケーションのコンテナイメージをデプロイするパイプラインを構築しました。続く今回は、本連載の第9回で実装したE2Eテストを実行するパイプラインを構築します。

E2Eテストとして、Seleniumを使用したテストコードを実行する

1. CodeBuildがBFFアプリケーションソースプロジェクトにあるbuildspec_e2e.ymlに記載したビルド処理(テスト)を行うコンテナを実行します。
2. ビルド処理の中で、GitHubからBFFのアプリケーションソースコードをクローンします。
3. ビルド処理の中で、MavenビルドによりSeleniumを使ったE2Eテストを実行します。E2Eテストでは前回デプロイしたバックエンドアプリケーションの呼び出しを通してテスト実行されます。

E2Eテストとして、Seleniumを使用したテストコードを実行する

E2Eテストを実行するbuildspec.ymlの実装

今回作成するパイプラインは、前回のコンテナビルド時と同様、CodeBuildを起動してE2Eテストを実行します。CodeBuildで使用されているデフォルトのUbuntuをベースとしたビルド用コンテナイメージには、ChromeDriverがインストールされているので、それをそのまま利用します。

下記のようなディレクトリ構成で、E2Eテストを実行するbuildspec_e2e.ymlを作成しましょう。

作成する「buildspec_e2e.yml」は、以下の通りです。

version: 0.2
env:
  parameter-store:
    SERVICE_DNS: "SERVICE_DNS_STAGING"                                       # ...(A)
phases:
  install:
    runtime-versions:
      docker: 18                                                             # ...(B)
    commands:
      - apt-get update -y
      - apt-get -y install language-pack-ja-base language-pack-ja
  pre_build:
    commands:
      - /usr/sbin/update-locale LANG=ja_JP.UTF-8 LANGUAGE="ja_JP:ja"
      - export LC_ALL="ja_JP.UTF-8"
      - locale-gen ja_JP.UTF-8
      - dpkg-reconfigure locales                                             # ...(C)
  build:
    commands:
      - mvn -f common/pom.xml install                                        # ...(D)
      - mvn -P e2e-test -f backend-for-frontend/pom.xml test -Dspring.profiles.active="dev"
                                                                             # ...(E)
      - export ARTIFACT_FILENAME="test-evidence-"`date "+%Y%m%d_%H%M%S"`.zip # ...(F)
      - zip -r $ARTIFACT_FILENAME backend-for-frontend/test-evidence         # ...(G)
artifacts:
  files:
    - $ARTIFACT_FILENAME                                                     # ...(H)

E2Eテストを実行するパイプラインの設定

パイプラインの設定に入る前に、E2Eテスト用のCodeBuildプロジェクトを作成します。第11回で説明したのと同じ要領で、CodeBuildサービスから「ビルドプロジェクトを作成する」ボタンを押下して、新規のCodeBuildプロジェクトを作成してください。ただし、設定の際は、以下の項目に留意が必要です。

CodeBuildの実行に必要なポリシーをアタッチしたサービスロールを設定	コンテナイメージへ設定したい環境変数を設定

アーティファクトの設定

プロジェクトを作成したら、CodeBuildからSystemsManagerParameterStoreに環境変数のアクセスができるよう、サービスロールに権限を付与しておきます。

サービスロールに権限を付与

続いて、E2Eテストを実行するパイプラインを作成します。

CodePipelineサービス・メニューで、これまで作成してきたパイプラインを選択して「編集する」ボタンを押下し、末端の「ステージを追加する」ボタンを選択します。

パイプラインの作成

任意のステージ名を入力します。

任意のステージ名を入力

ステージが作成されたら、「アクションを追加する」ボタンを押下し、以下の要領でアクションを設定し、「完了」ボタンを押下します。

• アクション名：任意のアクション名を追加します。
• アクションプロバイダー：「AWS CodeBuild」を選択します。
• リージョン：ステージング環境があるリージョンを選択します。
• 入力アーティファクト：1番目のパイプラインで出力アーティファクトとなっている「- SourceArtifact」を選択します。なお、これはGitHubからチェックアウトしたソースコードプロジェクトで実体はS3にZIPアーカイブされて保存されています。
• プロジェクト名：先ほど作成したプロジェクトを入力します。
• 出力アーティファクト：出力アーティファクト名を入力します。buildspec.ymlでは、最終的にテストの画面イメージをZIPアーカイブ化して出力しています。

アクションを設定

設定完了後、「変更をリリースする」ボタンを押下し、パイプラインを起動して、E2Eテストが実行されるかどうかを確認します。

E2Eテストの実行を確認

これで、E2Eテスト用のパイプラインが作成されました。今回はCodeBuildから提供されているデフォルトのUbuntuのビルドイメージを使ってChromeでのE2Eテストを実行しましたが、他のブラウザやWindowsOSのテストが必要な場合は、このパイプラインの中で、別のコンテナイメージを使用したテストコンテナを作成し、並行してテストパイプライン処理を構成すると良いでしょう。これは、マシンリソースを気にすることなく、並列でテストを並走可能なのはCodeBuildならではのメリットです。

次回は、BFFアプリケーションのコンテナイメージをビルドしてDockerHubへプッシュするパイプラインを構築します。

著者紹介

川畑 光平(KAWABATA Kohei) - NTTデータ 課長代理

金融機関システム業務アプリケーション開発・システム基盤担当を経て、現在はソフトウェア開発自動化関連の研究開発・推進に従事。

Red Hat Certified Engineer、Pivotal Certified Spring Professional、AWS Certified Solutions Architect Professional等の資格を持ち、アプリケーション基盤・クラウドなどさまざまな開発プロジェクト支援にも携わる。2019 APN AWS Top Engineers & Ambassadors選出。

本連載の内容に対するご意見・ご質問は Facebook まで。