对Ruby on Rails进行高效的单元测试的教程

$ sudo gem install rspec v = 1.3.0
$ sudo gem install rspec-rails v = 1.3.2

$ script/generate rspec     
  exists lib/tasks
 identical lib/tasks/rspec.rake
 identical script/autospec
 identical script/spec
  exists spec
 identical spec/rcov.opts
 identical spec/spec.opts
 identical spec/spec_helper.rb

$ sudo gem install rspec v = 1.3.0
$ sudo gem install rspec-rails v = 1.3.2

$ script/generate rspec     
  exists lib/tasks
 identical lib/tasks/rspec.rake
 identical script/autospec
 identical script/spec
  exists spec
 identical spec/rcov.opts
 identical spec/spec.opts
 identical spec/spec_helper.rb

$ sudo gem install factory-girl

config.gem "factory_girl"

$ sudo gem install ZenTest
$ sudo gem install autotest-rails

$ sudo gem install autotest-growl
$ sudo gem install autotest-fsevent
$ sudo gem install redgreen

require 'autotest/growl' 
require 'autotest/fsevent' 
require 'redgreen/autotest' 

Autotest.add_hook :initialize do |autotest|
 %w{.git .svn .hg .DS_Store ._* vendor tmp log doc}.each do |exception|
  autotest.add_exception(exception)
 end
end

describe "User absence or not during [start_time,end_time]" do
 before :each do 
  @user = Factory(:user)
 end

 it "should return false when user not absence " do
  start_time = Time.utc(2010,11,9,12,0,0,0)
  end_time = Time.utc(2010,11,9,12,30,0) 
  @user.absence_at(start_time,end_time).should be_false
 end

 it "should return true when user absence " do
  start_time = Time.utc(2010,11,9,13,0,0,0)
  end_time = Time.utc(2010,11,9,13,30,0) 
  @user.absence_at(start_time,end_time).should be_ture
 end
end

class User < ActiveRecord::Base
 def absence_at(start_time,end_time)  
  return false if have_connection_or_review"htmlcode">

before(:each) do
 @user = User.new
end

describe "method <absence_at(start_time,end_time)>" do 
 s = Time.now
 e = s + 30.minutes
 # example one
 it "should be false when user have interaction or review" do
  @user.stub!(:have_connection_or_review"should be true when user has no interaction and he no waiting at platform" do
  @user.stub!(:have_connection_or_review"should be false when user has no interaction and he waiting at platform" do
  @user.stub!(:have_connection_or_review"htmlcode">

class A < ActiveRecord::Base
 has_many :records
 def tech_finish"htmlcode">

describe "tech_finish" do
 it "should return true when A's records have five files" do
  record = Factory(:record)
  app = Factory(:a,:records=>[record])
  record.stub!(:files).and_return([1,2,3,4,5])   
  app.tech_finish"should return false when A's records have less five files" do
  record = Factory(:record)
  app = Factory(:a,:records=>[record])
  record.stub!(:files).and_return([1,2,3,5])   
  app.tech_finish"htmlcode">

Factory.define :user_absence_example,:class => User do |user|
 user.login "test"
 class << user
  def default_history_records
   [Factory.build(:history_record,:started_at=>Time.now),
    Factory.build(:history_record,:started_at=>Time.now)]
  end
  def default_calendars
   [Factory.build(:calendar),
    Factory.build(:calendar)]      
   end
   def default_loggings
   [Factory.build(:logging,:started_at=>1.days.ago),
    Factory.build(:logging,:started_at=>1.days.ago)]
   end
  end
  user.history_records {default_history_records}
  user.calendars {default_calendars}
  user.loggings {default_loggings}
end




这个测试数据的构造工厂，可以放在factories.rb文件中，方便其他测试用例使用，也可以直接放到测试文件的before中，仅供本测试文件使用。通过factory的构造，不仅可以为多个测试用例共享同一组测试数据，而且测试代码也简洁明了。


before :each do
 @user = Factory.create(:user_absence_example)
end




Readonly的测试
在笔者的系统中，大量使用了acts_as_readonly，从另外一个数据库来读取数据。由于这些model并不在本系统中，所以当用Factory构造测试数据的时候，总会有问题。虽然也可以使用mock来达到这个目的，但是由于mock的局限性，还是无法灵活的满足构造测试数据的需要。为此，扩展了一些代码，使得这些model依然可以测试。核心思想则是，根据配置文件的设置，将对应的readonly的表创建在测试数据库，这个操作在运行测试之前执行，这样就达到与其他model一样的效果。site_config配置文件中，关于readonly的配置格式如下：


readonly_for_test:
 logings:
  datetime: created_at
  string: status
  integer: trainer_id




Gem的测试
Gem在Rails中被广泛使用，而且是最基础的东西，因此它的准确无误就显得更加重要。在不断实践的基础上，笔者所在的团队总结出一种用spec测试gem的方法。假设我们要测试的gem是platform_base，步骤如下：
1. 在gem的根目录下创建一个目录spec（路径为platform_base/spec）。
2. 在gem的根目录下创建文件Rakefile（路径为platform_base/Rakefile），内容如下：


require 'rubygems'
require 'rake'

require 'spec/rake/spectask'

Spec::Rake::SpecTask.new('spec') do |t|
 t.spec_opts = ['--options', "spec/spec.opts"]
 t.spec_files = FileList['spec/**/*_spec.rb']
end




3. 文件在spec目录下创建spec.opts（路径为platform_base/spec/spec.opts），内容如下：
复制代码 代码如下: --colour

--format progress

--loadby mtime

--reverse
4. 在spec目录下，创建一个Rails app，名为test_app。这个新应用需要有spec目录和spec_helper.rb文件。
5. 为了保持简化，把这个新app（test_app）整理一下，删除vendor和public目录，最终的结构如下：
复制代码 代码如下:test_app

   |- app

   |- config

   |   |- environments

   |   |- initializers

   |   |- app_config.yml

   |   |- boot.rb

   |   |- database.yml

   |   |- environment.rb

   |   \- routes.rb

   |- db

   |   \- test.sqlite3

   |- log

   \- spec

       \- spec_helper.rb
6. 在config/environment.rb配置文件中，增加如下代码：


Rails::Initializer.run do |config|
 config.gem 'rails_platform_base'
end




7. 在platform_base/spec/目录下增加helpers_spec.rb文件，内容如下：
require File.join(File.dirname(__FILE__), 'test_app/spec/spec_helper')


describe "helpers" do
 describe "url_of" do
  before do
   Rails.stub!(:env).and_return("development")
   @controller = ActionController::Base.new
  end

  it "should get url from app's configration" do
   @controller.url_of(:article, :comments, :article_id => 1).should == "http://www.idapted.com/article/articles/1/comments"
   @controller.url_of(:article, :comments, :article_id => 1, :params=>{:category=>"good"}).should == "http://www.idapted.com/article/articles/1/comments"
  end
 end
end




至此，准备工作已经就绪，可以在platform_base目录下，运行rake spec来进行测试，当然现在什么都不会发生，因为还没有测试代码呢。本方法中，最关键的就是下面的require语句，不仅加载了Rails environment，而且把gem在test_app中使用并测试。
require File.join(File.dirname(__FILE__), 'test_app/spec/spec_helper')
Controller的测试
对于controller的测试，一般来说比较简单，基本是三段式：初始化参数、请求方法、返回render或者redirect_to。如下例中，对某个controller的index方法的测试：


describe "index action" do
 it "should render report page with the current month report" do
  controller.stub!(:current_user).and_return(@user)
  get :index,{:flag => “test”}
  response.should render_template("index")
 end
end




有些controller会设置session或者flash，这时的测试代码就一定要检查这个值设置的是否正确，而且还需要增加测试用例来覆盖不同的值，这样才能对方法进行全面的测试。如下例：


describe "create action" do
 it "should donot create new user with wrong params" do
  post :create
  response.should redirect_to(users_path)
  flash[:notice].should == "Create Fail!"
 end

 it "should create a new user with right params" do
  post :create, {:email => "abc@eleutian.com"}
  response.should redirect_to(users_path)
  flash[:notice].should == "Create Successful!"
 end
end




同时，也需要对controller的assigns进行测试，以保证返回正确的数据。如下例：


before(:each) do
 @course = Factory(:course)
end 

describe "show action" do
 it "should render show page when flag != assess and success" do 
  get :show, :id => @course.id, :flag =>"test"
  response.should render_template("show")
  assigns[:test_paper].should == @course
  assigns[:flag].should == "test"
 end

 it "should render show page when flag == assess and success" do
  get :show, :id => @course.id, :flag =>"assess"
  response.should render_template("show")
  assigns[:test_paper].should == @course
  assigns[:flag].should == "assess"
 end  
end




View的测试
View的测试代码写的比较少，基本上是把核心的view部分集成到controller中来测试。主要用integrate_views方法。如下例：


describe AccountsController do
 integrate_views
 describe "index action" do
  it "should render index.rhtml" do
   get :index
   response.should render_template("index")
   response.should have_tag("a[href=",new_account_path)
   response.should have_tag("a[href=",new_session_path)
  end
 end
end




总结展望
在写测试代码的时候，并不一定要事无巨细，有些比较简单的方法以及Rails的内部的方法，如named_scope，就完全没有必要测试。本文中，只介绍了用rspec写单元测试的代码，对于集成测试没有涉及，这也是今后努力的一个方向。
另外，用cumumber + rspec + webrat的BDD开发模式也是相当不错的。尤其是cumumber对需求的描述，完全可以用它来做需求分析。



                                
                                

                                    Ruby 
                                

                                    标签：
                                        
Ruby