December 13, 2013

Dockerで継続的インテグレーション

Dockerで複数バージョンのrubyがインストールされたイメージを作るを使って，ローカルでTravis CI的なビルドテストを実現する方法を書く．

準備 (OS X)

Vagrantを使う．バージョン1.4からはDockerのprovisioningに対応してるのでそれを使う． Download Vagrant - Vagrantより.dmgをダウンロードしてきてインストール.

インストールしたら，rubyプロジェクトに移動して以下を実行する．

vagrant init precise64 http://files.vagrantup.com/precise64.box

Vagrantfileを以下のように編集する．ここでは，docker-rbenvで作成した，複数バージョンのruby (1.8,7と1.9.3，2.0.0)とそれぞれにbundlerがインストールされたDockerイメージtcnksm/rbenv-rubygemsを用いる．

Vagrant.configure("2") do |config|
    config.vm.box = "precise64"
    config.vm.provision :docker do |d|
        d.pull_images "tcnksm/rbenv"
    end
end

あらかじめ仮想サーバを起動しておく．

vagrant up

Dockerの実行は仮想サーバーへのssh経由で行う．

vagrant ssh-config --host docker-host >> ~/.ssh/config

(注: Vagrant1.4のバグでsshの設定以外の出力をすることがあるので，適宜~/.ssh/configを編集してそれを消す)

実行したいテストの記述

プロジェクトのルートに実行したいテストをシェルスクリプトで記述する．

# docker.sh

for v in 1.8.7-p371 1.9.3-p392 2.0.0-p353
do
    rbenv global $v
    bundle
    rspec
done

記述しているのはバージョンをそれぞれ1.8.7，1.9.3，2.0.0と切り替えて，それぞれに対してrubygemsをインストールして，rspecテストを実行している．(毎回bunldeを実行するのがたるい場合は，あらかじめbundleを実行してそれをコミットしてイメージを作ってしまえばよい，例えば，Using Docker and Vagrant on Mac OS X with a Ruby on Rails applicationも同様のことをしている)

テストの実行

OS X

ssh docker-host docker run -v '/vagrant:/work' -w /work tcnksm/rbenv-rubygems sh -ex docker.sh

ssh経由で，dockerを実行する．

Linux

docker run -v "$PWD:/work" -w /work tcnksm/rbenv-rubygems sh -ex docker.sh

-vでプロジェクトのディレクトリをdockerのイメージ内にマウントする．-wでカレントディレクトリをマウントしたディレクトリに変更．後は，上で記述したテストを実行するだけ．コンテナは破棄されるのでこれらは何度も実行できる．しかもイメージのpullなどは済んでいるため，起動などの時間がない．テストの時間のみ．

git-hook

git pushもしくはgit commitするたびにテストを走らせるには，.git/hooks内のファイルを編集すればよい．例えば，git pushする度にテストを行いたい場合は，.git/hooks/pre-pushを作成する．例えば, OSXの場合は以下のように記述する．

# pre-push
ssh docker-host docker run -v '/vagrant:/work' -w /work tcnksm/rbenv-rubygems sh -ex docker.sh

Guard

Guardと連携して，.rbファイルが更新される度にテストを実行する場合は，Guardfileを以下のように編集する．

guard :rspec do
  watch(%r{^spec/.+_spec\.rb$}) { `ssh docker-host docker run -v '/vagrant:/work' -w /work tcnksm/rbenv sh -ex docker.sh` }
end

まとめ

上記を簡単なプロジェクトを作成してやってみたが，爆速．guardを使っても勝手に走ってるので気にならない．これらを作るのはとても簡単だった．これは，rubyはノウハウが溜まっていて，これするときにはこれというのがほとんど定型的になっているからだと思う．コードに落としやすい．

今後の課題

.travis.ymlのような設定ファイルを準備するだけにしたい（シェルスクリプトを書くのはたるい）
テストの実行結果を巧くキャッチしたい