Class: Rake::TestTask

Inherits:
TaskLib show all
Defined in:
lib/rake/testtask.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from TaskLib

#clone, #paste

Constructor Details

#initialize(name = :test) {|_self| ... } ⇒ TestTask

Create a testing task.

Yields:

  • (_self)

Yield Parameters:



64
65
66
67
68
69
70
71
72
73
 
# File 'lib/rake/testtask.rb', line 64

def initialize(name=:test)
  @name = name
  @libs = ["lib"]
  @pattern = nil
  @test_files = nil
  @verbose = false
  yield self if block_given?
  @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
  define
end

Instance Attribute Details

#libs ⇒ Object

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



44
45
46
 
# File 'lib/rake/testtask.rb', line 44

def libs
  @libs
end

#name ⇒ Object

Name of test task. (default is :test)



40
41
42
 
# File 'lib/rake/testtask.rb', line 40

def name
  @name
end

#options ⇒ Object

Test options passed to the test suite. (default is NONE)



50
51
52
 
# File 'lib/rake/testtask.rb', line 50

def options
  @options
end

#pattern ⇒ Object

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



53
54
55
 
# File 'lib/rake/testtask.rb', line 53

def pattern
  @pattern
end

#verbose ⇒ Object

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



47
48
49
 
# File 'lib/rake/testtask.rb', line 47

def verbose
  @verbose
end

Instance Method Details

#define ⇒ Object

Create the tasks defined by this task lib.



76
77
78
79
80
81
82
83
84
85
 
# File 'lib/rake/testtask.rb', line 76

def define
  lib_path = @libs.join(File::PATH_SEPARATOR)
  desc "Run tests" + (@name==:test ? "" : " for #{@name}")
  task @name do
	RakeFileUtils.verbose(@verbose) do
	  ruby %{-I#{lib_path} -S testrb #{file_list.join(' ')} #{option_list}}
	end
  end
  self
end

#file_list ⇒ Object

:nodoc:



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rake/testtask.rb', line 99

def file_list # :nodoc:
  if ENV['TEST']
	FileList[ ENV['TEST'] ]
  else
	result = []
	result += @test_files.to_a if @test_files
	result += FileList[ @pattern ].to_a if @pattern
	FileList[result]
  end
end

#get_options ⇒ Object

:nodoc:



95
96
97
 
# File 'lib/rake/testtask.rb', line 95

def get_options # :nodoc:
  ENV['TESTOPTS'] || @options
end

#option_list ⇒ Object

:nodoc:



87
88
89
90
91
92
93
 
# File 'lib/rake/testtask.rb', line 87

def option_list # :nodoc:
  if get_options
	testoptions = " -- #{get_options}"
  else
	testoptions = ''
  end
end

#test_files=(list) ⇒ Object

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.



59
60
61
 
# File 'lib/rake/testtask.rb', line 59

def test_files=(list)
  @test_files = list
end