Capistranoで簡単デプロイ -開発用サーバー編-

cakePHPを使って開発しているサービス(Nb4u)で、リリース周りを楽にしたいなと思いCapistranoを使ってみました。

　やりたいこと

今までの流れは以下のとおりでした。

• [1]ローカルマシンで開発＆テスト
• [2]ソースをコミット
• [3]開発用のサーバーにログインしソースを最新にする

上記だと面倒＆ダサい。
というわけで、上記の[3]の箇所を以下のように変更。

• [3]Jenkinsでソースをチェックし開発用のサーバーのソースを最新にする

今回は開発用のサーバーなので、常に最新のソースになるようにしています。
本番用は開発用とは違って、コマンドを叩いて最新のソースにするようにしてます。

　環境説明

今回、利用したのは以下の2つ

• Capistrano
• Jenkins

Jenkinsのインストールは以下を参考にしてください。

• さくらのVPS編
• Windows編

　やったこと

　Capistrano側

以下のようにファイルを用意

#基本定義
set :user,         "sshでログインするユーザー"
set :password,     "パスワード"
set :svn_repo,     "svnのリポジトリパス"
set :svn_pass,     "svnのパスワード"
set :checkout_dir, "チェックアウトしたソースを置く場所(例:/home/checkout)"
set :deploy_dir,   "ソースを設置する場所(例:/home/sample)"
set :deploy_user,   "ソースを設置している場所の権限(apacheが良い)"
set :deploy_group,  "ソースを設置している場所の権限(apacheが良い)"
# サーバ定義
role :dev, "localhost"
default_run_options[:pty] = true
# checkoutタスク
task :checkout_, :roles => [:dev] do
    sudo "rm -rf #{checkout_dir}"
    sudo "mkdir #{checkout_dir}"
    sudo "svn co --username #{user} --password #{svn_pass} #{svn_repo} #{checkout_dir}"
    sudo "chown -R #{user} #{checkout_dir}"
    sudo "find #{checkout_dir} -name ".svn" -type d | xargs rm -rf"
end
//svnからチェックアウトする1行を書き忘れてました[2012/06/13]。
# uploadタスク
task :upload_, :roles => [:dev] do
    sudo "rm -rf #{deploy_dir}"
    sudo "cp -rp #{checkout_dir} #{deploy_dir}"
    sudo "chown -R #{deploy_user}:#{deploy_group} #{deploy_dir}"
end
# phpcsタスク
task :phpcs_, :roles => [:dev] do
 sudo "phpcs --report=summary --report-checkstyle=checkstyleの結果ファイルを置く場所 --standard=Zend --extensions=php コーディング規約対象の場所(例:/home/sample/app/controllers) | id"
end
task :deploy_, :roles => [:dev] do
 checkout_
 upload_
 phpcs_
end

簡単に説明すると以下のようなことをやってます(参考サイト[1]をかなり参考にしてます)。

• checkout_タスク
  • SVNからソースをチェックアウト
  • チェックアウトした際に出来る.svn関連を全て削除
• upload_タスク
  • 最新ソースを指定した場所にコピー
• phpcs_タスク
  • PHP用コーディング規約ツールでチェック
    • ただしエラー、警告があっても止まらないようにするために|idをつけている

　Jenkins側

設定で以下の箇所を記述

• ビルド・トリガ
  • SCMをボーリング(毎時5分にチェック)
• ビルド(シェルの実行)
  • Capistranoを呼び出すように記述
  • (例)cap -f sample.rb deploy_
• ビルド後の処理
  • Checkstyle警告の集計(出力ファイルを指定)

これで、ソースをコミットしたらJenkinsがCapistranoを呼び出して開発用サーバーを最新の状態にしてくれています。
ちなみに、今回は仮にCheckstyleで警告が出ていようがスルーさせています。

　参考サイト

• [1]Capistrano（カピストラーノ）でPHPプロジェクトをデプロイ – yamada6789の日記
• [2]簡単＆便利 Capistranoのススメ （導入編）