CircleCIでプルリク時にUnitテストが走るようにする
投稿日:
CircleCIを使って、GitHubにてプルリクエストを投げた際に
Unitテストが走るようにします。
ソースコードはPHPで、Unitテストにはphpunitを使っている前提とします。
Circle CIのアカウント登録
Circle CIのホームページにアクセスし、右上のSign Up
をクリックします。
GitHubかBitBucketのアカウントでログインできるようです。
今回はGitHubのアカウントでログインしました。
連携を許可するか聞かれるのでAuthorize circleci
をクリックします。
Circle CIにプロジェクト作成
アカウント作成が完了したらプロジェクト作成するためAdd Projects
をクリックします。
紐付けるリポジトリのSet Up Project
をクリックします。
対象リポジトリの環境を設定します。
該当するものをクリックします。
下にスクロールすると今後の流れが書いてあります。
まず該当リポジトリに.circleci/config.yml
を作成します。
config.ymlの内容はとりあえず内容はCopy To Clipboardでコピーしたもの(2018/8/11現在)に
以下の修正を加えたものにしています。
①Dockerイメージ変更
Dockerイメージを自分のサーバーの環境に近いものに変更します。
どのようなイメージがあるかは詳細はDockerHubで確認してください。
https://hub.docker.com/r/circleci/
(使いたいDockerイメージが別にであるなら、circleci公式のイメージじゃなくても動くらしい)
なお、サンプルのconfig.ymlに書いてあったcircleci/php:7.1.5-browsers
は存在しません。
サンプルのまま実行すると以下のエラーが発生します。
Error response from daemon: manifest for circleci/php:7.1.5-browsers not found
②phpunit実行コマンドを変更
composerなどでphpunitを入れている場合はコマンドが違うと思うので変更します。
出来上がったconfig.ymlが以下です
# PHP CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-php/ for more details
#
version: 2
jobs:
build:
docker:
# specify the version you desire here
#- image: circleci/php:7.1.5-browsers
- image: circleci/php:7.1-fpm-node-browsers
# Specify service dependencies here if necessary
# CircleCI maintains a library of pre-built images
# documented at https://circleci.com/docs/2.0/circleci-images/
# - image: circleci/mysql:9.4
working_directory: ~/repo
steps:
- checkout
# Download and cache dependencies
- restore_cache:
keys:
- v1-dependencies-{{ checksum "composer.json" }}
# fallback to using the latest cache if no exact match is found
- v1-dependencies-
- run: composer install -n --prefer-dist
- save_cache:
paths:
- ./vendor
key: v1-dependencies-{{ checksum "composer.json" }}
# run tests!
#- run: phpunit
- run: vendor/phpunit/phpunit/phpunit tests/
これで作成したconfig.ymlをmasterリポジトリにpushしておき
さきほどのCircle CIの画面にて『Start building』をクリックします。
これで登録は完了です。
該当リポジトリにてプルリクを投げると自動でphpunitのテストが走るようになります。
また、CircleCIの実行結果はデフォルトではCircleCIに設定したメールアドレスに届くようになります。