CSC/ECE 517 Fall 2011/ch2 2e gp

Testing Frameworks for Ruby

This page serves as a knowledge source for understanding the different Testing Frameworks available for Ruby.

Introduction

No code is perfect from the word go! Testing plays an important role in System Development Life Cycle. During testing, one follows a taxonomic procedure to uncover defects at various stages. A test framework provides various Test Types, Test Phases, Test Models, Test Metrics and acts as a guideline as to how to perform effective testing <ref> http://www.scribd.com/doc/15909730/Software-Testing-Framework </ref>. Various testing tools are available for Rubylanguage, each having some unique features over others. Here is a brief introduction and feature comparisons of popular testing frameworks.

Testing Approaches

flow of test driven developmental approach

Before delving into testing for Ruby, in general, these are the followed approaches in industry today

Test Driven Development

This strategy, (abbreviated as TDD) <ref> http://en.wikipedia.org/wiki/Test-driven_development </ref>, though cumbersome due to its methodology develops efficient code. First a unit test is written for a function, even before the code for that function is developed. Based on this test minimal code is developed to ensure the test succeeds; if not the code is modified until test run successfully. In this iterative approach, effort is made to ensure flawless code is developed.

Behavior Driven Development

BDD <ref> http://en.wikipedia.org/wiki/Behavior_Driven_Development </ref> as its popularly know, upholds the traditional iterative workflow of Test Driven Development, but it focuses on defining behaviors that is easy to understand to naive people (with no programming background) by writing tests in natural language. This approach focuses more on looking at code development from a behavioral abstraction. For example testing the code for a recipe belonging to a category of a cookbook, in BDD would be something like 'A recipe can't be without a category'

Unit Testing

Unit Testing is a method by which one can isolate and test a unit functionality of the program, typically individual methods during and long after the code is written.

Test::Unit

screen capture of TestUnit console in RubyMine IDE

The in-built, ready to use unit testing mechanism for Ruby is called Test::Unit.It belongs to the XUnit family unit testing framework. It has a setup method for initialization, a teardown method for cleanup and the actual test methods itself. The tests are bundled separately in a test class in the code it is aimed to test.

Features

This salient features of the Test::Unit Framework are:-

Assertions

One can use Test::Unit to make assertions. The test is successful if the assertion is true and fails if the assertion is false. All the assertion methods provided by test::unit can be found at Test::Unit::Assertions.

assert( boolean, [message] )	True if boolean
assert_equal( expected, actual, [message] ) assert_not_equal( expected, actual, [message] )	True if expected == actual
assert_raise( Exception,... ) {block} assert_nothing_raised( Exception,...) {block}	True if the block raises (or doesn't) one of the listed exceptions.

Test-Fixtures

Using a test fixture, one can initialize (and cleanup) the common set of data for two or more tests hence eliminating unnecessary duplication. Fixtures are written in the setup() and teardown() methods.

Test-Suite

As unit tests increase in number for a given project, it becomes tough running them one at a time. It is hence useful to combine a bunch of related test cases and run them as batch. Test::Unit provides a class called TestSuite for this purpose<ref>http://www.ensta-paristech.fr/~diam/ruby/online/ruby-doc-stdlib/libdoc/test/unit/rdoc/classes/Test/Unit/TestSuite.html</ref>.

Example Test

The Test::Unit::TestCase class is the main class and the BinarySearchTest is the subclass, it overrides setup and teardown methods. All test methods start with 'test_' prefix thus differentiating helper methods from main methods. The Test::Unit::TestCase class makes the test methods into tests, wrapping them into a suite and running the individual tests. The results are collected into Test::Unit::TestResult object.

   require 'test/unit'
   require 'english_french'
   class EnglishFrenchTest < Test::Unit::TestCase
   include EnglishFrenchTranslator
   def test_simple_word
       s = translate("house")
       assert_equal("mason", s)
   end
   def test_word_beginning_with_vowel
       s = translate("apple")
       assert_equal("pomme", s)
   end
   def test_two_consonant_word
       s = translate("stupid")
       assert_equal("stupides", s)
   end
  end

The tests are run by running the file test_english_french.rb.Sample results for the above test is shown below.

 $ ruby test_english_french.rb
 Loaded suite test_english_french
 Started
 FFF
 Finished in 0.01091 seconds.
 
 3 tests, 3 assertions, 0 failures, 0 errors

Shoulda

Shoulda is a library rather than a framework which gives the flexibility to write better and easy to understand tests for the Ruby application being tested. Shoulda compliments Test::Unit and RSpec in the sense that it can be used within both of them. Using Shoulda one can provide context to tests so that, tests can be grouped according to a specific feature or scenario.

Features

components of Shoulda

Shoulda consist of matchers, test-helpers and assertions<ref>http://rubydoc.info/gems/shoulda/2.11.3/frames</ref> -

Matchers
Matchers (or more popularly simply macros) are Test::Unit- and RSpec-compatible one-liners that test common Rails functionality. The task of developing cumbersome, complex and often erroneous code is made simple with the help of matchers.

Helpers
Helpers like #context and #should not only gives RSpec like test blocks in Test::Unit but also in addition to these, one gets nested contexts and a much more readable syntax.

Assertions
Many common Rails testing idioms have been distilled into a set of useful assertions.

Installation

Shoulda for can be installed for Rails 3.0 version by including the following in the Gemfile

 group :test do
   gem "shoulda"
   gem "rspec-rails", "2.0.0.beta.12"
 end

Example

As far as usage of shoulda is concerned, one can write matchers as follows-

Suppose one is testing for the class Post on a blog, heres how it is achieved using shoulda::Macthers

 class Post_Test < Test::Unit::TestCase
   should belong_to(:user)
   should have_many(:tags).through(:taggings)

   should validate_uniqueness_of(:title)
   should validate_presence_of(:title)
   should validate_numericality_of(:user_id)
 end

Similarly the test for class Users can be

 class Users_Test < Test::Unit::TestCase
   should have_many(:posts)
    #checking validity of e-mail id

   should_not allow_value("blah").for(:email)
   should allow_value("a@b.com").for(:email)
   should_not allow_mass_assignment_of(:password)
 end

As can be seen, writing test case for TDD becomes much more elegant and less error prone.

Similarly shoulda::helpers can be written as shown -

Suppose one wants to check the validity of getter method presence for an object, simply an should_have helper can be written like

 context "the create action" do
   setup do
     @attributes = Posts.attributes_for(:item)
     post :create, :item => @attributes
   end

   should_create_row Item do |item|
     assert_has_attributes @attributes, item  #assert_has_attributes -  simply a helper method that makes sure the object has getter methods and values corresponding to the key/value pairs in the hash.
   end
 end

When this tests are run one gets the some similar following results

   Loaded suite C:/Users/Girish/Desktop/CSC517/Workspace/Ruby/Wikiexample
     Started
     ...F...
     Finished in 0.001000 seconds.

     1) Failure:
       test: Users_Test Functions should Fail Test. (Post Test) [C:/Users/Girish/Desktop/CSC517/Workspace/Ruby/Wikiexample.rb:33]:
      <1> expected but was
      <nil>.

     1 tests, 1 assertions, 1 failures, 0 errors, 0 skips 

     Test run options: --seed 25476    

The most interesting part of shoulda is the assertions which make writing test code efficient. An example of shoulda::Assertion can be seen as below

 assert_same_elements([:a, :b, :c], [:c, :a, :b]) #checks whether array has same entries
 assert_contains(['a', '1'], /\d/) #checks for presence of a digit
 assert_contains(['a', '1'], 'a') #checks for presence of letter a

RSpec

flow of logic in R-Spec

RSpec is a Behavioral Driven development tool,created by Dave Astels and Steven Bake <ref>http://blog.emson.co.uk/2008/06/understanding-rspec-stories-a-tutorial</ref> aimed as test driven development.

RSpec is merging of two projects into one -

application level behaviour described by a Story Framework
object level behaviour described by a Spec Framework

The primary aim of RSpec is to drift the focus from unit testing to behavioral testing, i.e. to check if the desired functionality is achieved. It is also used to check for redundancy in code and helps refactoring our code without having to re-write every test.

Installation

In order to install RSpec, open a command shell, go to /bin folder in Ruby directory and type

> gem install rspec

Features

RSpec Story

A Story describes the functionality of a specific software feature, and it describes it in a way that is easy to understand from the point of view of a client. In fact a story can be thought of as a conversation between a client and a programmer over some feature of the software. The key points of a story are:- Title, Narrative, Scenario, Givens, Details^[1]

Message Expectations

A message expectation (a.k.a. mock method)<ref>http://rspec.info</ref> is an expectation that an object should receive a specific message during the execution of an example. This is similar to "Assertions" in test::unit.

Group

More than one executable example can be grouped into one file.

Spec File

A spec file is a file that contains one or more group examples.

describe() and it() methods

The describe() method takes an arbitrary number of arguments and returns a sub-class of Spec::Example::ExampleGroup. The it() method takes a single String, an optional Hash and an optional block.

Example Test

The below code is an example for testing using rspec. The spec file, ruby file and the output are shown. It can be seen that code can be added to the spec file for different test conditions and expectations.

 # archery_spec.rb
 require 'archery'
 describe Archery, "#score" do
  it "returns 0 for all mock games" do
   archery = Archery.new
   20.times { archery.hit(0) }
   archery.score.should == 0
   end
 end

  # archery.rb
    class Archery
    def hit(arrows)
    end
    def score
     0
    end
  end

 $ spec archery_spec.rb --format nested
   Archery#score
   returns 0 for all mock games
   Finished in 0.006535 seconds
   1 example, 0 failures

Cucumber

Cucumber is a testing tool that follows the BDD approach of testing. Cucumber written itself in Ruby programming language allows the execution of feature documentation written in natural language often termed as user stories

Features of Cucumber

Terminology of Cucumber

There are few taxonomy terms related to Cucumber <ref>http://cuke4ninja.com/sec_cucumber_jargon.html</ref> as follows-

major components of Cucumber

Stakeholder - A person who gets some value out of the system like an administrator
Feature - A feature is a piece of system functionality that delivers value to one or more stakeholders
User story - It is a rough description of scope for future work used as planning tools. Most common format for the stories are - "in order to...","as a...","I want"
Feature file - It describes a feature or a part of feature with illustrative example of expected results
Key Example - Each feature is illustrated with Key Examples which show what are expected in a given test case
Scenario - Scenario captures one key example for a feature file. It represents how stakeholder gets some value from that system. Example of good scenarios for checking login module includes user not signed up, password has expired
Step - Steps are domain language phrases which can be combined to write scenarios. They combine a GWT directive with a regular expression to evaluate something and add a simple ruby code which tells the step what should be done further.

Pattern

Cucumber follows a GWT (Given-When-Then) pattern for developing test cases. In the scenarios written for Cucumber, one states what a given scenario is, when one is presented with information and then what should happen so that the logic of information can be validated.

Example

Cucumber is a high-level testing tool that defines the feature specs. An typical [example] for a Cucumber Scenario is shown below - First one need to install the Cucumber gem on Ruby using this simple command

     $gem install cucumber-rails
         Successfully installed cucumber-rails-1.0.6
         1 gem installed
         Installing ri documentation for cucumber-rails-1.0.6...
         Installing RDoc documentation for cucumber-rails-1.0.6...

When installed, a basic Cucumber test is generated using generator script

     $script/generate rspec
     $script/generate cucumber
           force  config/database.yml 
           create  config/cucumber.yml 
           create  config/environments/cucumber.rb 
           create  script/cucumber 
           create  features/step_definitions 
           create  features/step_definitions/web_steps.rb 
           create  features/support 
           create  features/support/paths.rb 
           create  features/support/env.rb 
           exists  lib/tasks 
           create  lib/tasks/cucumber.rake

A feature file is next created with name feature_name.featrue . the Feature is described in the Feature: directive, followed by the story. The story is written in the format shown in the code: As a <role> , I want <feature> , So that <business Value>.

     $ nano tasklist.feature
 
     Feature: Tasks

     In order to keep track of tasks
     People should be able to
     Create a list of tasks

Each feature can have multiple scenario. One such scenario for the login feature is as shown below

     Scenario: List Tasks
     Given that I have created a task "task 1"
     When I go to the tasks page
     Then I should see "task 1"

When a scenario is ready following command is issued

     $script/cucumber features/tasklist.feature
           0 scenarios
           0 steps

Steps can be added to scenarios, which are combination of a GWT directive, a regular expression and a block of ruby code which states what this step does

     /features/step_definitions$nano tasklist_steps.rb

           Given /^that I have created a task "(.*)"$/ do |desc|
             Task.create!(:description => desc)
           end
           When /^I go to the tasks page$/ do
             visit "/tasks"
           end

For more elaborated examples one can refer to the Cucumber site.

Other Testing Frameworks

This sections lists more tools that are available for testing in Ruby. The frameworks and the relevant links to reading material are listed below:-

Riot

Riot is a unit testing framework that results in terse tests and tries to strike a balance between Shoulda and RSpec. Riot

Capybara

Capybara is an integration testing framework for Rack applications. Capybara

Minitest

It is part of test::unit, but including minitest::unit has a contextual RSpec-esque syntax. Minitest

Jasmine

Jasmine gem is a developer package used to develop Ruby web-based projects(eg. Rails, Sinatra, etc.). Jasmine.

Minispec

Minispec is a unit testing framework. Minispec

Comparison

Now that the major frameworks have been explained briefly, here is a comparison among them based on few criteria/metrics

Metric	Test::Unit	Shoulda	RSpec	Cucumber
Framework	Test Driven Development framework.	It is an extension to Test::Unit. It has more capabilities and simpler readable syntax compared to Test::Unit.	Behavior Driven Development framework.	Behavior Driven Development framework.
Version<ref>http://ruby-toolbox.com/categories/testing_frameworks.html</ref>	1.2.3	2.11.3	2.6.0	1.0.6
Website	Test::Unit	Github -Shoulda	RSpec	Cucumber
Base Library <ref>http://en.wikipedia.org/wiki/Unit-testing_frameworks_for_Ruby_(programming_language)</ref>	Yes	No	No	No
Allows nested setup <ref>http://nested-layouts.rubyforge.org/</ref>	No	Yes	Yes	Yes
Opaqueness/Expressiveness	Opaque to a certain extent, low level coding required	More descriptive	More expressive compared to Unit::test and shoulda.	More expressive compared to Unit::test and shoulda
Run Times	Faster than RSpec because it has fewer features and hence lesser code to run	Faster than RSpec because it has fewer features and hence lesser code to run	More features but comes at a cost, run time slower than shoulda and test::unit.	More features but comes at a cost, run time slower than shoulda and test::unit.
General Use	Unit testing	Unit testing especially on the Rails framework [2]	Unit testing	Integration testing

Conclusion

The case as to which is the best framework, depends on scenario for which that testing framework is used. In general,stats based on number of Github views suggests, Cucumber is the industry favored testing framework for Ruby. The reason to this accounts for easy-to-use and easy-to-understand syntax and the ability to focus on only one test at a time. RSpec comes second (again in terms of popularity and Github views) followed by others.

References

<references/>