Rake::TestTask

Create a task that runs a set of tests.

Example:

 
  Rake::TestTask.new do |t|
    t.libs << "test"
    t.test_files = FileList['test/test*.rb']
    t.verbose = true
  end

If rake is invoked with a “TEST=filename” command line option, then the list of test files will be overridden to include only the filename specified on the command line. This provides an easy way to run just one test.

If rake is invoked with a “TESTOPTS=options” command line option, then the given options are passed to the test process after a ’—’. This allows Test::Unit options to be passed to the test suite.

Examples:

  rake test                           # run tests normally
  rake test TEST=just_one_file.rb     # run just one test file.
  rake test TESTOPTS="-v"             # run in verbose mode
  rake test TESTOPTS="--runner=fox"   # use the fox test runner

Attributes

name[RW]

Name of test task. (default is :test)

libs[RW]

List of directories to added to $LOAD_PATH before running the tests. (default is ‘lib’)

verbose[RW]

True if verbose test output desired. (default is false)

options[RW]

Test options passed to the test suite. An explicit TESTOPTS=opts on the command line will override this. (default is NONE)

warning[RW]

Request that the tests be run with the warning flag set. E.g. warning=true implies “ruby -w” used to run the tests.

pattern[RW]

Glob pattern to match test files. (default is ‘test/test*.rb’)

loader[RW]

Style of test loader to use. Options are:

:rake — Rake provided test loading script (default).
:testrb — Ruby provided test loading script.
:direct — Load tests using command line loader.

ruby_opts[RW]

Array of commandline options to pass to ruby when running test loader.

Public Class Methods

new(name=:test) click to toggle source

Create a testing task.

    # File lib/rake/testtask.rb, line 81
81:     def initialize(name=:test)
82:       @name = name
83:       @libs = ["lib"]
84:       @pattern = nil
85:       @options = nil
86:       @test_files = nil
87:       @verbose = false
88:       @warning = false
89:       @loader = :rake
90:       @ruby_opts = []
91:       yield self if block_given?
92:       @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
93:       define
94:     end

Public Instance Methods

define() click to toggle source

Create the tasks defined by this task lib.

     # File lib/rake/testtask.rb, line 97
 97:     def define
 98:       desc "Run tests" + (@name==:test ? "" : " for #{@name}")
 99:       task @name do
100:         FileUtilsExt.verbose(@verbose) do
101:           ruby "#{ruby_opts_string} #{run_code} #{file_list_string} #{option_list}"
102:         end
103:       end
104:       self
105:     end

file_list_string() click to toggle source

     # File lib/rake/testtask.rb, line 122
122:     def file_list_string
123:       file_list.collect { |fn| "\"#{fn}\"" }.join(' ')
124:     end

lib_path() click to toggle source

     # File lib/rake/testtask.rb, line 118
118:     def lib_path
119:       @libs.join(File::PATH_SEPARATOR)
120:     end

ruby_opts_string() click to toggle source

     # File lib/rake/testtask.rb, line 111
111:     def ruby_opts_string
112:       opts = @ruby_opts.dup
113:       opts.unshift( "-I\"#{lib_path}\"" ) unless @libs.empty?
114:       opts.unshift( "-w" ) if @warning
115:       opts.join(" ")
116:     end

ruby_version() click to toggle source

     # File lib/rake/testtask.rb, line 146
146:     def ruby_version
147:       RUBY_VERSION
148:     end

run_code() click to toggle source

     # File lib/rake/testtask.rb, line 150
150:     def run_code
151:       case @loader
152:       when :direct
153:         "-e \"ARGV.each{|f| load f}\""
154:       when :testrb
155:         "-S testrb #{fix}"
156:       when :rake
157:         "-I\"#{rake_lib_dir}\" \"#{rake_loader}\""
158:       end
159:     end

test_files=(list) click to toggle source

Explicitly define the list of test files to be included in a test. list is expected to be an array of file names (a FileList is acceptable). If both pattern and test_files are used, then the list of test files is the union of the two.

    # File lib/rake/testtask.rb, line 76
76:     def test_files=(list)
77:       @test_files = list
78:     end

Home Classes Methods

In Files

Parent

Methods

Files

Class Index

Rake::TestTask

Attributes

Public Class Methods

Public Instance Methods