CI環境構築 ~ PHP編 ~

PHPの継続的インテグレーション環境を無料で簡単にセットアップする方法

利用するサービス

• Travis CI（無料のCI環境）
• CoverAll（Travis CIで実行したコードのカバレッジを閲覧できるサービス）
• Slack（Travis CIからの通知を受け取るチャットサービス）

事前準備

1. GitHubアカウントの取得
2. リポジトリ作成
3. RubyGemのインストール（Travisコマンドインストールに使用）

Travis CIのアカウント取得とリポジトリ選択

1. 右上のリンクからGitHubアカウントでサインイン
2. テストしたいリポジトリをONに変更

テストコード

• tests/HogeTest.php
• tests/bootstrap.php
• Fuga.php

tests/HogeTest.php

1. 1 + 1 = 2のテスト結果を返す。
2. Fugaクラスのindexメソッドを呼び出してTrueを確認する。

tests/HogeTest.php

class HogeTest extends PHPUnit_Framework_TestCase {

    function testHoge() {
        $this->assertEquals(2, 1 + 1);
    }

    function testFuga() {
        $fuga = new Fuga();

        $this->assertTrue($fuga->index());
    }
}

tests/bootstrap.php

1. newされたクラスを呼び出すモジュール
2. phpunit.xmlでパスを指定

tests/bootstrap.php

function loader($class)
{
    $file = $class . '.php';
    if (file_exists($file)) {
        require $file;
    }
}

spl_autoload_register('loader');

Fuga.php

1. index()：trueを返す。

Fuga.php

class Fuga {

    public function index() {
        return true;
    }
}

設定ファイル

• tests/phpunit.xml
• composer.json
• .coveralls.yml
• .travis.yml

phpunit.xml

1. phpunit実行環境の設定ファイル

phpunit.xml

<?xml version="1.0" encoding="UTF-8"?>
<phpunit
    colors="true"
    bootstrap="bootstrap.php">
    <testsuite name="Hoge">
        <directory>./</directory>
    </testsuite>
    <logging>
        <log type="coverage-clover" target="build/logs/clover.xml"/>
    </logging>
</phpunit>

composer.json

1. coverallsの設定は php-coverallsを利用させて頂いた。

composer.json

{
    "require-dev": {
        "satooshi/php-coveralls": "dev-master"
    }
}

coveralls.yml

1. coverallsの設定ファイル
   

.coveralls.yml

src_dir: ./
coverage_clover: build/logs/clover.xml
json_path: build/logs/coveralls-upload.json

.travis.yml

1. Travis CIの設定ファイル
2. php: バージョン指定
3. before_script: 事前にcomposerをインストール
4. script: phpunitを実行
5. after_script: coveralls用モジュールを起動
6. notifications: slackへの通知設定

.travis.yml

language: php

php:
  - 5.3
  - 5.4
  - 5.5
  - hhvm

before_script:
  - curl -s http://getcomposer.org/installer | php
  - php composer.phar install --dev --prefer-source

script:
  - mkdir -p build/logs
  - phpunit --coverage-clover build/logs/clover.xml --configuration tests/phpunit.xml tests

after_script:
  - php vendor/bin/coveralls -v

notifications:
  slack:
    rooms:
      secure: your_token_key

• notificationの設定はConfiguring Build Notificationsを参照
• your_token_keyを暗号化する方法はEncryption keysを参照
  ※ rbenvを使ってる場合はrehashをお忘れなく

GitHubにPush

Travis CI

成功画面

1. .travis.ci.ymlで設定した各バージョンごとにテスト実行
2. テスト内容の詳細リンク
3. build passバッジの画像生成リンク
4. テスト再実行ボタン
5. テスト結果通知はメールではうっとうしいのでSlackで確認（後述）

テスト詳細画面

1. コマンドラインでPHPUnit実行したときと同じ画面結果
2. コードカバレッジは見えないので、CoverAllsを利用する

CoverAlls

1. 各バージョンごとのコードカバレッジを閲覧できる

Slack

1. Travic CIの実行結果へのリンク、GitHubコミット時のcompare画面へのリンク、テスト結果を通知