カテゴリ一 AWS ブログ開発構築クラウド

2024-04-03 #AWS #Laravel #test #CI/CD AWS #CDK #CodeBuild

こんにちは！エンジニアの岩間です。

今回は、AWS CDK × CodePipeline × CodeBuildでLaravelのユニットテストを自動化＆テストレポート出力してみる機会があったのでその手順とCDKのコードを公開したいと思います。

1 構成図
2 前提条件
3 ディレクトリ構成
4 コーディング
5 動作確認
- 5.1 レポート出力の動作確認
- 5.2 Artifacts出力の動作確認
6 まとめ

構成図

構成図は以下です。

開発者がAWS CodeCommitのdevelopブランチにソースコードをプッシュすると、AWS CodePipelineが自動的にトリガーされ、その後AWS CodeBuildでLaravelのユニットテストが行わる、といった流れです。

今回実行したいユニットテストには、データベース接続のテストも含まれています。
そのため、CodeBuild環境上ではテスト用のWEB、アプリケーション、データベース用のコンテナをDockerを使用して起動します。

通常、LaravelのユニットテストではデータベースのセットアップをLaravelのmigrationファイルを使用して行うことができますが、今回は直接SQLファイルを実行してデータベースをセットアップしたいため、コンテナを利用します。

前提条件

以下のバージョンで構築しています。

AWS CDK：2.116.0

AWS CodePipeline：v1

Laravel：10

Nginx：1.24.0

PostgreSQL：12.14

ディレクトリ構成

ディレクトリ構成は以下の通りです。

.
├── pipeline-cdk（CDKのディレクトリ）
├── docker
│ ├── docker-compose.yml
│ ├── docker-php
│ │ ├── Dockerfile
│ │ └── laravel（Laravelソース群）
│ ├── docker-nginx
│ │ └── Dockerfile
│ │ ├── default.conf（Nginxの設定ファイル）
│ └── docker-db
│ └── init.sql
└── buildspec_unit_test.yml（CodeBuildで実行されるファイル）

├── pipeline-cdk（CDKのディレクトリ）

├── docker

│ ├── docker-compose.yml

│ ├── docker-php

│ │ ├── Dockerfile

│ │ └── laravel（Laravelソース群）

│ ├── docker-nginx

│ │ └── Dockerfile

│ │ ├── default.conf（Nginxの設定ファイル）

│ └── docker-db

│ └── init.sql

└── buildspec_unit_test.yml（CodeBuildで実行されるファイル）

コーディング

以下のコードを書いていきます。

docker-compose.yml（Docker Composeの設定ファイル）
lib/piepline-cdk-stack.ts（CDKのコード）
buildspec_unit_test.yml（CodeBuildで実行されるファイル）
Laravelのコード

docker-compose.yml

まずはdocker-compose.ymlで、CodeBuildで立ち上げる3つのコンテナ（web、app、db）を以下のように定義します。

※sqlファイルはDBコンテナのdocker-entrypoint-initdb.d/配下に配置することでコンテナ初期立ち上げ時に実行してくれます。

services:
  web:
    # ./docker-nginx内のDockerfileを使用
    build: ./docker-nginx
    container_name: web
    ports:
      # ホストのポート80をコンテナのポート80にマッピング
      - 80:80
    depends_on:
      - app
    volumes:
      # Laravelのソース群をコンテナの/var/www/html/laravelにマウント
      - ./docker-php/laravel:/var/www/html/laravel
      # Nginxの設定ファイルをコンテナの/var/www/html/laravelにマウント
      - ./docker-nginx/default.conf:/etc/nginx/conf.d/default.conf
    platform: linux/arm64

  app:
    # ./docker-php内のDockerfileを使用
    build: ./docker-php
    container_name: app
    depends_on:
        - db
    volumes:
      # Laravelのソース群をコンテナの/var/www/html/laravelにマウント
      - ./docker-php/laravel:/var/www/html/laravel
    platform: linux/arm64
       
  db:
    container_name: db
    # イメージ: postgres:12.14 の PostgreSQL データベースを使用   
    image: postgres:12.14   
    ports: 
      # ホストのポート5432をコンテナのポート5432にマッピング     
      - 5432:5432   
    volumes: 
      # sqlファイルをコンテナの/docker-entrypoint-initdb.d/init.sqlにマウント
      # コンテナ内のdocker-entrypoint-initdb.d/に配置することで、コンテナ初期立ち上げ時に実行してくれます
      - ./docker-db/init.sql:/docker-entrypoint-initdb.d/init.sql
　  restart: always
    environment:
      - POSTGRES_DB=laravel # DB名を指定
      - POSTGRES_USER=xxxx # ユーザー名を指定
      - POSTGRES_PASSWORD=xxxx # パスワードを指定
    platform: linux/arm64

services:

web:

# ./docker-nginx内のDockerfileを使用

build: ./docker-nginx

container_name: web

ports:

# ホストのポート80をコンテナのポート80にマッピング

- 80:80

depends_on:

- app

volumes:

# Laravelのソース群をコンテナの/var/www/html/laravelにマウント

- ./docker-php/laravel:/var/www/html/laravel

# Nginxの設定ファイルをコンテナの/var/www/html/laravelにマウント

- ./docker-nginx/default.conf:/etc/nginx/conf.d/default.conf

platform: linux/arm64

app:

# ./docker-php内のDockerfileを使用

build: ./docker-php

container_name: app

depends_on:

- db

volumes:

# Laravelのソース群をコンテナの/var/www/html/laravelにマウント

- ./docker-php/laravel:/var/www/html/laravel

platform: linux/arm64

db:

container_name: db

# イメージ: postgres:12.14 の PostgreSQL データベースを使用

image: postgres:12.14

ports:

# ホストのポート5432をコンテナのポート5432にマッピング

- 5432:5432

volumes:

# sqlファイルをコンテナの/docker-entrypoint-initdb.d/init.sqlにマウント

# コンテナ内のdocker-entrypoint-initdb.d/に配置することで、コンテナ初期立ち上げ時に実行してくれます

- ./docker-db/init.sql:/docker-entrypoint-initdb.d/init.sql

　 restart: always

environment:

- POSTGRES_DB=laravel # DB名を指定

- POSTGRES_USER=xxxx # ユーザー名を指定

- POSTGRES_PASSWORD=xxxx # パスワードを指定

platform: linux/arm64

各Dockerfileではタイムゾーンや言語の設定を行っています。※今回は省略します

CDK

次にCDKの設定です。今回はTypeScriptで、CI/CDプロセスを自動化するためのCDKスタックを定義しています。

pipeline-cdkディレクトリ配下で、

cdk init sample-app --language typescript
cdk bootstrap

を実行済みの状態で、lib/piepline-cdk-stack.tsに以下の記述を追加します。

import { CfnOutput, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import * as codecommit from 'aws-cdk-lib/aws-codecommit';
import * as codepipeline from 'aws-cdk-lib/aws-codepipeline';
import * as codebuild from 'aws-cdk-lib/aws-codebuild';
import * as codepipeline_actions from 'aws-cdk-lib/aws-codepipeline-actions';
import * as iam from 'aws-cdk-lib/aws-iam';

export class PipelineCdkStack extends Stack {
  constructor(scope: Construct, id: string, props?: StackProps) {
    super(scope, id, props);
   
    // CodeCommitリポジトリ作成
    const sourceRepo = new codecommit.Repository(this, 'test-code-repository', {
      repositoryName: 'TEST',
    });

    // CodePipeline作成
    const pipeline = new codepipeline.Pipeline(this, 'test-pipeline', {
      pipelineName: 'test-pipeline',
    });

    // CodeBuild作成
    const unitTestBuild = new codebuild.PipelineProject(
      this,
      'unit-test',
      {
        environment: {
　　　　　　// 上記のdocker-compose.ymlのplatformで指定したLinux/ARM64を設定
          buildImage: codebuild.LinuxBuildImage.AMAZON_LINUX_2_ARM_3,
          computeType: codebuild.ComputeType.LARGE,
        },
        environmentVariables: {
          // DockerHubのユーザーとパスワードを環境変数で渡します ※詳しくはbuildspec_unit_test.ymlで解説
          DOCKERHUB_USER: {
            value: 'xxxxxxxx'
          },
          DOCKERHUB_PASS: {
            value: 'xxxxxxxx'
          },
        },
        buildSpec: codebuild.BuildSpec.fromSourceFilename('buildspec_unit_test.yml'),
      }
    );

    const sourceOutput = new codepipeline.Artifact();
    const unitTestOutput = new codepipeline.Artifact();

    // CodePipelineにCodeCommitステージを追加
    pipeline.addStage({
      stageName: 'Develop-Commit',
      actions: [
        new codepipeline_actions.CodeCommitSourceAction({
          actionName: 'CodeCommit',
          repository: sourceRepo,
          output: sourceOutput,
          branch: 'develop',
        }),
      ],
    });

    // CodePipelineにCodeBuildステージを追加
    pipeline.addStage({
      stageName: 'Unit-Testing',
      actions: [
        new codepipeline_actions.CodeBuildAction({
          actionName: 'UnitTest',
          project: unitTestBuild,
          input: sourceOutput,
          outputs: [unitTestOutput],
        }),
      ],
    });

    // CloudFormation「出力」タブに出力設定
    new CfnOutput(this, 'CodeCommitRepositoryUrl', {
      value: sourceRepo.repositoryCloneUrlHttp,
    });
  }
}

import { CfnOutput, Stack, StackProps } from 'aws-cdk-lib';

import { Construct } from 'constructs';

import * as codecommit from 'aws-cdk-lib/aws-codecommit';

import * as codepipeline from 'aws-cdk-lib/aws-codepipeline';

import * as codebuild from 'aws-cdk-lib/aws-codebuild';

import * as codepipeline_actions from 'aws-cdk-lib/aws-codepipeline-actions';

import * as iam from 'aws-cdk-lib/aws-iam';

export class PipelineCdkStack extends Stack {

constructor(scope: Construct, id: string, props?: StackProps) {

super(scope, id, props);

// CodeCommitリポジトリ作成

const sourceRepo = new codecommit.Repository(this, 'test-code-repository', {

repositoryName: 'TEST',

});

// CodePipeline作成

const pipeline = new codepipeline.Pipeline(this, 'test-pipeline', {

pipelineName: 'test-pipeline',

});

// CodeBuild作成

const unitTestBuild = new codebuild.PipelineProject(

this,

'unit-test',

{

environment: {

　　　　　　// 上記のdocker-compose.ymlのplatformで指定したLinux/ARM64を設定

buildImage: codebuild.LinuxBuildImage.AMAZON_LINUX_2_ARM_3,

computeType: codebuild.ComputeType.LARGE,

environmentVariables: {

// DockerHubのユーザーとパスワードを環境変数で渡します ※詳しくはbuildspec_unit_test.ymlで解説

DOCKERHUB_USER: {

value: 'xxxxxxxx'

DOCKERHUB_PASS: {

value: 'xxxxxxxx'

buildSpec: codebuild.BuildSpec.fromSourceFilename('buildspec_unit_test.yml'),

}

);

const sourceOutput = new codepipeline.Artifact();

const unitTestOutput = new codepipeline.Artifact();

// CodePipelineにCodeCommitステージを追加

pipeline.addStage({

stageName: 'Develop-Commit',

actions: [

new codepipeline_actions.CodeCommitSourceAction({

actionName: 'CodeCommit',

repository: sourceRepo,

output: sourceOutput,

branch: 'develop',

}),

});

// CodePipelineにCodeBuildステージを追加

pipeline.addStage({

stageName: 'Unit-Testing',

actions: [

new codepipeline_actions.CodeBuildAction({

actionName: 'UnitTest',

project: unitTestBuild,

input: sourceOutput,

outputs: [unitTestOutput],

}),

});

// CloudFormation「出力」タブに出力設定

new CfnOutput(this, 'CodeCommitRepositoryUrl', {

value: sourceRepo.repositoryCloneUrlHttp,

});

}

CodeBuildの環境変数で渡しているDockerHubのユーザー名とパスワード（33~39行目）は、cdkディレクトリ内のconfig.tsで環境ごとに定義したり、SSMパラメータストアから取得するやり方がおすすめです。

※DockerHubのユーザーとパスワードの設定については、次のbuildspec_unit_test.ymlのセクションに記載しています。

上記の記述を追加後、cdk deployを実行し、正しくリソースが作成されていればOKです。

buildspec_unit_test.yml

buildspecファイルとは、AWS CodeBuildでビルドプロジェクトを実行する際に使用される構成ファイルです。

buildspec_unit_test.ymlを以下のように記述します。

version: 0.2

phases:
  pre_build:
    commands:
      # DockerHubにログイン
　    - echo $DOCKERHUB_PASS | docker login -u $DOCKERHUB_USER --password-stdin

      # Dockerコンテナ立ち上げ
      - cd docker && docker-compose up -d

  build:
    commands:
      # appコンテナ内でLaravelのアプリケーションキーを設定
　    - docker-compose exec app php artisan key:generate --env=testing

      # appコンテナ内でユニットテスト実行＆レポート出力
      - docker-compose exec app php artisan test --env=testing --log-junit ./phpunit-log.xml

reports:
  # テスト結果のレポートを定義
  SurefireReports: # レポートグループ名を指定
    files:
      # レポートファイルのパスを指定
      - 'phpunit-log.xml'

    # レポートファイルが存在するベースディレクトリを指定
    base-directory: 'docker/docker-php/laravel/'

    # レポートファイルの形式を指定
    file-format: JunitXml

artifacts:
  files:
    # ユニットテストのログファイルをアーティファクトとして保存
    - docker/docker-php/laravel/storage/logs/*

version: 0.2

phases:

pre_build:

commands:

# DockerHubにログイン

　 - echo $DOCKERHUB_PASS | docker login -u $DOCKERHUB_USER --password-stdin

# Dockerコンテナ立ち上げ

- cd docker && docker-compose up -d

build:

commands:

# appコンテナ内でLaravelのアプリケーションキーを設定

　 - docker-compose exec app php artisan key:generate --env=testing

# appコンテナ内でユニットテスト実行＆レポート出力

- docker-compose exec app php artisan test --env=testing --log-junit ./phpunit-log.xml

reports:

# テスト結果のレポートを定義

SurefireReports: # レポートグループ名を指定

files:

# レポートファイルのパスを指定

- 'phpunit-log.xml'

# レポートファイルが存在するベースディレクトリを指定

base-directory: 'docker/docker-php/laravel/'

# レポートファイルの形式を指定

file-format: JunitXml

artifacts:

files:

# ユニットテストのログファイルをアーティファクトとして保存

- docker/docker-php/laravel/storage/logs/*

ポイントは以下の3点です。

①DockerHubへのログイン

7行目のコマンド（echo $DOCKERHUB_PASS | docker login -u $DOCKERHUB_USER --password-stdin）では、DockerHubからのコンテナイメージの呼び出し回数制限エラー回避のため、DockerHubにログインしています。
DockerHubにログインしていない匿名ユーザーの状態だと、 IP アドレス単位での回数呼び出し制限がかかります。

今回、CodeBuild は非 VPC 環境で作成しているため、共用のグローバルIPが利用されることになります。
つまり、CodeBuildから自分がコンテナイメージを呼び出した回数に関係なく、制限に引っかかってしまいます。

※DockerHubにログインしない場合、以下のようなエラーがでることがあります。
toomanyrequests: You have reached your pull rate limit. You may increase the limit by authenticating and upgrading: https://www.docker.com/increase-rate-limit
上記のIP制限に引っかからないように、DockerHubのアカウントを作成し、ユーザー名とパスワードでログインをします。DockerHubアカウント作成はこちら

②テストレポート出力引数

appコンテナ内でユニットテスト実行する18行目のコマンド（php artisan test --env=testing）の引数に--log-junit ./phpunit-log.xmlを指定することでテストレポートの出力に関して指定しています。

PHPUnitの公式ドキュメントに記載されているように、このオプションは、テスト実行の結果をJUnit形式のXMLファイルに出力するために使用されます。

③reportsセクション

20行目のreportsセクションは、AWS CodeBuildのビルドで生成されたレポートを指定するためのセクションです。
このセクションを使用すると、ビルドの結果や生成物を保存し、後で参照できるようにすることができます。
今回、file-formatにはJunitXmlを指定していますが、他の形式も指定可能です。
構文について詳しくはこちら

Laravel設定

最後にLaravel側でユニットテストの設定を行います。

１．テスト用の環境変数ファイルを作成します。

Laravelのプロジェクトディレクトリに移動し、docker/docker-php/laravel/.env.testingを作成し、以下を編集します。

アプリケーションキーはCodeBuild上で作成するので空欄にします。

APP_ENV=testing
APP_KEY=
DB_CONNECTION=pgsql
DB_HOST=db
DB_PORT=5432
DB_DATABASE=laravel
DB_USERNAME=docker-compose.ymlで設定したユーザー名
DB_PASSWORD=docker-compose.ymlで設定したパスワード

APP_ENV=testing

APP_KEY=

DB_CONNECTION=pgsql

DB_HOST=db

DB_PORT=5432

DB_DATABASE=laravel

DB_USERNAME=docker-compose.ymlで設定したユーザー名

DB_PASSWORD=docker-compose.ymlで設定したパスワード

２．次にLaravelプロジェクト内のdocker/docker-php/laravel/phpunit.xmlを開き、以下のように変更します。

 <env name="APP_ENV" value="testing"/>
 <env name="DB_CONNECTION" value="pgsql"/>
 <env name="DB_DATABASE"value="laravel"/>

３．テストケースをdocker/docker-php/laravel/tests以下に作成します。

動作確認

CodeCommitのdevelopブランチにすべてのソースをpushして、動作確認をします。

AWSコンソールでCodePipelineと検索し、対象のパイプライン名を選択すると以下の画面が確認できます。
CodeCommitのdevelopブランチにpushしたのをトリガーにCodePipelineが動いています！

レポート出力の動作確認

次にレポートが出力されているか確認します。
上記の画面でUnit-Testingステージが成功したら、画面内の「AWS CodeBuild」のリンクをクリックします。

次に、レポートタブをクリックし、レポート名をクリックします。

すると、以下の画像のようにレポート結果が作成されていることが確認できます。

テストに失敗したときは以下の画像のように、不合格の件数と割合も表示されます。

どのテストケースで失敗したのか、失敗時のエラーメッセージ等も確認することができます。

さらに、AWSコンソールのCodeBuild→レポートグループの画面からは、これまで行ったテストのパスレートや実行時間、テスト総数等がレポートグループごとに表示されています。

Artifacts出力の動作確認

ユニットテストのログファイルがアーティファクトとして保存されているか確認します。

Unit-Testingステージが成功した状態で画面内の「AWS CodeBuild」のリンクをクリック→「ビルドの詳細」タブに移動します。

以下の画像のように、アーティファクトのセクションに「アーティファクトのアップロード場所」の項目があるのでリンクをクリックします。

S3の画面が表示されるのでフォルダをダウンロードし、docker/docker-php/laravel/storage/logs/以下のファイルがアップロードされていればOKです。

まとめ

以上、AWS CDK×CodeBuildでLaravelのユニットテストを自動化＆テストレポート出力してみるでした。

ここまでお読みいただきありがとうございました。

この記事を書いた人
最近の記事

iwama

システム開発事業部所属/エンジニア/2023 Japan AWS Jr. Champions。 PHP/Laravel/FreePBX/AWSなどいろいろやってます。React勉強中。

iwama (全て見る)

【採用情報】一緒に働く仲間を募集しています

2024-04-03 #AWS #Laravel #test #CI/CD AWS #CDK #CodeBuild

AWS CDK × CodeBuildでLaravelのユニットテストを自動化＆テストレポート出力してみる

構成図

前提条件

ディレクトリ構成

コーディング

docker-compose.yml

CDK

buildspec_unit_test.yml

①DockerHubへのログイン

②テストレポート出力引数

③reportsセクション

Laravel設定

動作確認

レポート出力の動作確認

Artifacts出力の動作確認

まとめ

【採用情報】一緒に働く仲間を募集しています

エンジニア募集

Asterisk13CLI_チートシート

CentOS7_チートシート

カテゴリー

月別で見る

投稿者から見る

サイト内検索

AWS CDK × CodeBuildでLaravelのユニットテストを自動化 ＆ テストレポート出力してみる

構成図

前提条件

ディレクトリ構成

コーディング

docker-compose.yml

CDK

buildspec_unit_test.yml

①DockerHubへのログイン

②テストレポート出力引数

③reportsセクション

Laravel設定

動作確認

レポート出力の動作確認

Artifacts出力の動作確認

まとめ

【採用情報】一緒に働く仲間を募集しています

関連投稿

[Amazon Connect]東京リージョンで電話番号取得に時間がかかる理由を調べてみた – Amazon Connect アドベントカレンダー 2024

おすすめガジェット紹介！2024年12月編

Synology NASとAmazon CLIの連携を試してみました！

【入社エントリ】エンジニア6年生の転職活動

【Amazon RDS】意図せず突発的な再起動が起こった原因

CodeCommitからGithubへのソース移行

エンジニア募集

Asterisk13CLI_チートシート

CentOS7_チートシート

カテゴリー

月別で見る

投稿者から見る

サイト内検索

AWS CDK × CodeBuildでLaravelのユニットテストを自動化＆テストレポート出力してみる