Introduction to guard + rspec

Guard Rspec + Spork による自動テスト

小崎玄顕

平成23年10月1日(土)

KOZAKI Tsuneaki Slippy on github
Blog Forever Undecided Twitter @koko_u

自己紹介
名前 : 小崎玄顕 (こざきつねあき )
こざき
ついった : @koko_u
職業 : SIer, COBOL-er, Excel-er, いろいろ …
趣味 : 読書 (読むだけ )、音楽 (聞くだけ )、プログラミング (パクるだけ )
読む、音楽聞く、プログパク
興味 (soft): Ruby, Rails, Scala, Play!, ...
興味 (hard): Sony Reader, Android, ThinkPad, Happy Hacking
Keyboard, ...


今日のお題
自動テストの環境として Guard + Spork を紹介します
実際に簡単なサンプルプロジェクトを作ります


アンケート
guard を知っている？
spork を知っている？


そもそもなぜテストが必要なのか？


実行しないと正しいことを確かめられないからですね


例えば ...
01 # wrong_hello.rb
02 def wrong_hello(name)
03 if name.nil?
04 puts "you are nil boy"
05 elseif name.empty?
06 puts "you are empty girl"
07 else
08 puts "hello #{name}"
09 end
10 end


普段は何ごともなく動く
1 require './wrong_hello'
2 wrong_hello 'koko_u'
3
4 # => hello koko_u


でも実は間違えている
2 wrong_hello ''
3
4 # => hello

...あれ？ empty girl は？


すごく間違えてる ...
2 wrong_hello nil
3
4 # => `wrong_hello': undefined method `empty?' for nil:NilClass
(NoMethodError)

例外が飛んできたよ！


ささいな typo でもその行が実行されるまでエラーが発見できな
でもその行が実行される
い
テストするしかないですね


なぜ Guard + Spork なのか？
なるべくストレスなくテストを実行したい
テスト結果が notify などで表示されると、なんとなくデキる気がする

他の選択肢は
autotest (Zentest)
よくわからなかった
watchr
新規にファイルを追加した時にうまく動かなかった


デモ
実際に guard と spork が動いている所をまず見せます
1. デモプロジェクトの直下で guard を起動すると、まずは全
てのテストが実行されます
2. その後、テストファイルもしくはソースを変更する度に対応
するテストが実行されます


Spork の利点
自動的にテストを実行しているのは Guard の機能です
ただ、ご存知のように Rails のテストの実行早くありません。
自動テストで頻繁にテストを実行する時、「すぐに」結果が返ってこない
とイライラしてしまう
そこで、 Spork があらかじめ Rails の環境ロードまでを済ませておいて、
リクエストに応じてテストを実行します

どのくらい実行時間に差があるかも確認してみましょう


能書きが長すぎた。実際にやってみましょう


前提とする環境
OS : Ubuntu 11.04
Ruby : 1.9.2-p180
Rails : 3.1.0
Testing Framework : RSpec
Mac の人は自力で頑張って下さい。多分 growl に使う gem が違うくら
い？

Windows の人はごめんなさい。
Rails 3.0.x でも動くはず。せっかくリリースされたので 3.1.0 でやります
が、 3.1の新機能は一切でてきません。
の新機能は
Testing Framework は RSpec。 Test::Unit でも gem を差し替えるなど
。
すればできるはずですが、時間がなくてフォローできませんでした。


お品書き
1. サンプルの Rails プロジェクトを作成します (6ページ )
ペー
2. Spork でテストを素早く実行できるよう設定します (4ページ )
ペー
3. Guard を使ってテストが自動的に実行されるよう設定します (4ページ )
ペー


サンプルとする Rails プロジェクトを作成します(1/6)
ます
$ rails new guard_demo -T --skip-bundle
create
create README
create Rakefile
create config.ru
create .gitignore
create Gemfile
create app
...

Testing Framework をデフォルトの Test::Unit ではなく RSpec に差し
替えるので、 -T オプションで test ディレクトリの作成を抑止しています
Rails 3.1.0 から自動的に bundle install されてしまうので、これも抑止
しています。
Gemfile を修正して bundle install するので、このタイミングですること
ないんじゃ？


ます
Gemfile の最後に下記のコードを追加
1 group :test, :development do
2 gem 'rspec-rails'
3 gem 'spork', '~> 0.9.0.rc'
4 gem 'guard-rspec'
5 gem 'guard-spork'
6 gem 'rb-inotify'
7 gem 'libnotify'
8 end

spork は 0.9.0.rc 以上でないと Rails 3.0 以降で動かないようです
Mac をお使いの人は最後の 2行を下記のように変更すればいいらしい
1 group :test, :development do
2 gem 'rspec-rails'
3 gem 'spork', '~> 0.9.0.rc'
4 gem 'guard-rspec'
5 gem 'guard-spork'
6 gem 'rb-fsevent'
7 gem 'growl_notify'
8 end

ます
やっと bundle install します
$ bundle install --path=vendor/bundle
Fetching source index for http://rubygems.org/
Installing rake (0.9.2)
Installing multi_json (1.0.3)
Installing activesupport (3.1.0)
Installing bcrypt-ruby (3.0.0) with native extensions
Installing builder (3.0.0)
Installing i18n (0.6.0)
Installing activemodel (3.1.0)
...

ここで --path オプションを付けないと、最初に --skip-bundle した意味
がなくなるよ


ます
RSpec を使うためのおまじないを実行
$ rails generate rspec:install
create .rspec
create spec
create spec/spec_helper.rb


ます
デモ用のアプリケーションをでっち上げます
$ rails generate scaffold Article name:string title:string content:text
invoke active_record
create db/migrate/20110905165645_create_articles.rb
create app/models/article.rb
invoke rspec
create spec/models/article_spec.rb
route resources :articles
invoke scaffold_controller
...
RSpec でテストの雛形が作られます


ます
データベースを作って
tent:text $ rake db:migrate RAILS_ENV=test
テストが動くことを確認
$ bundle exec rspec spec
........................**....
Pending:
Article add some examples to (or delete) /home/kozaki/minamirb/intro_guard_r
# Not Yet Implemented
# ./spec/models/article_spec.rb:4
ArticlesHelper add some examples to (or delete) /home/kozaki/minamirb/intro_
# ./spec/helpers/articles_helper_spec.rb:14
Finished in 0.35449 seconds
30 examples, 0 failures, 2 pending


Spork でテストを素早く実行できるよう設定します(1/4)
ます
spork を使うためのおまじないを実行
tent:text $ bundle exec spork --bootstrap
Using RSpec
Bootstrapping /home/kozaki/minamirb/intro_guard_rspec/guard_demo/spec/spec_hel
Done. Edit /home/kozaki/minamirb/intro_guard_rspec/guard_demo/spec/spec_helper

rb/intro_guard_r

/minamirb/intro_


ます
spec_helper.rb を編集しろ、と言われるので言われるままに編集
tent:text 01 Spork.prefork do
02 # Loading more in this block will cause your tests to run
mo/spec/spec_helyou change any configuration or code from libraries l
03 # if
spec/spec_helper to restart spork for it take effect.
04 # need
05
06 !! ここいら辺にすべてのコードをぶちこむ !!
07 end
08
rb/intro_guard_r
09 Spork.each_run do
10 # This code will be run each time you run your specs.
11
12 end
/minamirb/intro_


ます
spork の稼動確認をします
tent:text 1. 別のターミナルを立ち上げて、 spork サーバーを起動します
$ bundle exec spork
Using RSpec
mo/spec/spec_hel
Preloading Rails environment
spec/spec_helper
Loading Spork.prefork block...
Spork is ready and listening on 8989!

2. rspec
rb/intro_guard_r でテストを実行してみます
$ bundle exec rspec spec --drb
/minamirb/intro_ オプションを付けると spork サーバー側でテストを実行してくれま
--drb
す
spork サーバーを起動している側のターミナルに Running tests with
... と出力されていれば OK


ます
いちいちオプション --drb 付けるの面倒ですよね。
tent:text .rspec ファイルに書いておきましょう
1 --colour
mo/spec/spec_hel
2 --drb
spec/spec_helper
--colour オプションは既に rails g rspec:install した時点で書かれています
/usr/bin/time -p bundle exec rspec spec/model/article_spec.rb を実
行してみて、時間が早くなっていることも確かめましょう
rb/intro_guard_r

/minamirb/intro_


Guard を使ってテストが自動的に実行されるようします(1/4)
ます
ようやく guard の設定です。でもすることは簡単
tent:text $ bundle exec guard init spork
Writing new Guardfile to /home/kozaki/minamirb/intro_guard_rspec/guard_demo/Guardfile
mo/spec/spec_helguard added to Guardfile, feel free to edit it
spork
spec/spec_helper
$ bundle exec guard init rspec
rspec guard added to Guardfile, feel free to edit it
rb/intro_guard_r spork を先に実行して下さい。
guard init
実行した順に設定が適用されるので、逆順で Guardfile を作成した場合は適
当に順番を入れ替えましょう。
/minamirb/intro_


ます
ひとまずこれでおっけー。動かしてみましょう
tent:text $ bundle exec guard
ec/guard_demo/Guardfilewatching at '/home/kozaki/minamirb/intro_guard_rspec/guard_demo'
Guard is now
mo/spec/spec_hel
Starting Spork for RSpec
spec/spec_helperRSpec
Using
Preloading Rails environment
Loading Spork.prefork block...
Spork is ready and listening on 8989!
rb/intro_guard_rserver for RSpec successfully started
Spork
Guard::RSpec is running, with RSpec 2!
Running all specs
/minamirb/intro_ tests with args ["--color", "--format", "progress", "--format", "Guard"
Running
...........................*....
Pending:
ArticlesHelper add some examples to (or delete) /home/kozaki/minamirb/intro
# ./spec/helpers/articles_helper_spec.rb:14

Finished in 0.47565 seconds
32 examples,0 failures, 1 pending
Done.

ます
テストを書くと、自動的に実行されることを確認しましょう。
tent:text 01 # -*- coding: utf-8 -*-
pec/guard_demo'
ec/guard_demo/Guardfile
02 # spec/models/article_spec.rb
mo/spec/spec_hel 'spec_helper'
03 require
04
spec/spec_helper
05 describe Article do
06 context "は name と title が必須" do
07 subject { Article.new }
08 it { should be_invalid }
rb/intro_guard_r should have(1).error_on(:title) }
09 it {
10 it { should have(1).error_on(:name) }
11 end
-format", 12 end
/minamirb/intro_
"Guard"
自動的に実行されて、テスト失敗しましたか？
RSpec の書き方はこちらでどうぞ RSpec を使い始める人が読むべき N 個の
ドキュメント
/minamirb/intro


ます
モデルに適当なバリデーションを追加しましょう
tent:text 1 # app/models/article.rb
pec/guard_demo' Article < ActiveRecord::Base
2 class
mo/spec/spec_hel
3 validates :title, :name, :presence => true
4 end
spec/spec_helper
やはりテストが自動的に実行され、今度はパスしましたか？
モデルのテストしかしていないことに注意して下さい。全部のテストを実行(エン
ターするだけ)するとコントローラ側でエラーになっていることがわかります
rb/intro_guard_r

/minamirb/intro_
-format", "Guard"

/minamirb/intro



お疲れさまでした
tent:text
pec/guard_demo'
mo/spec/spec_hel
spec/spec_helper

rb/intro_guard_r

/minamirb/intro_
-format", "Guard"

/minamirb/intro


参考にしたサイト
guard のサイト
spork のサイト
tent:text Curiosity Drives Me 基本このサイトをまる写し
pec/guard_demo'
mo/spec/spec_hel
spec/spec_helper

rb/intro_guard_r

/minamirb/intro_
-format", "Guard"

/minamirb/intro


その他便利そうな Guard-xxx
guard-annotate
tent:text モデルのスキーマを変更すると、自動的にモデルクラスにその内容をコメントとして書いてくれる
guard-livereload
pec/guard_demo'
ビューが変更された時に、自動的にブラウザでページをリロードしてくれる。あらかじめ、chrome な
mo/spec/spec_hel
どにadd-onを追加しておく必要あり
spec/spec_helper
そのほか色々あるらしい List of avairable guards

rb/intro_guard_r

/minamirb/intro_
-format", "Guard"

/minamirb/intro


課題
Guardfile の修正について
tent:text 結局自動的に作成された Guardfile を修正することなくここまで来まし
た
pec/guard_demo'
mo/spec/spec_hel ァイルを増やしたり、変更したい場合は適当に修正しましょう
監視フ
Spork の設定
spec/spec_helper
spork の設定も全然変更していません
実際には Spork.each_run { } に適当に設定を追加する必要がありま
しょう
rb/intro_guard_r さっきの参考サイトを見てね
詳細は
困ったら再起動でもわりとイけます。手動で再起動するのが面倒になっ
たり、不可解なエラーが頻繁に出てから考えても遅くはない
/minamirb/intro_
-format", "Guard"

/minamirb/intro


おしまい

tent:text
pec/guard_demo'
mo/spec/spec_hel
spec/spec_helper

rb/intro_guard_r

/minamirb/intro_
-format", "Guard"

/minamirb/intro

Introduction to guard + rspec

Recommended

Recommended

More Related Content

What's hot

What's hot (7)

Similar to Introduction to guard + rspec

Similar to Introduction to guard + rspec (20)

Recently uploaded

Recently uploaded (8)

Introduction to guard + rspec