Class: Rake::TestTask
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
-
#libs ⇒ Object
List of directories to added to $LOAD_PATH before running the tests.
-
#loader ⇒ Object
Style of test loader to use.
-
#name ⇒ Object
Name of test task.
-
#options ⇒ Object
Test options passed to the test suite.
-
#pattern ⇒ Object
Glob pattern to match test files.
-
#ruby_opts ⇒ Object
Array of commandline options to pass to ruby when running test loader.
-
#verbose ⇒ Object
True if verbose test output desired.
-
#warning ⇒ Object
Request that the tests be run with the warning flag set.
Instance Method Summary collapse
-
#define ⇒ Object
Create the tasks defined by this task lib.
-
#file_list ⇒ Object
:nodoc:.
-
#find_file(fn) ⇒ Object
:nodoc:.
-
#fix ⇒ Object
:nodoc:.
-
#initialize(name = :test) {|_self| ... } ⇒ TestTask
constructor
Create a testing task.
-
#option_list ⇒ Object
:nodoc:.
-
#rake_loader ⇒ Object
:nodoc:.
-
#test_files=(list) ⇒ Object
Explicitly define the list of test files to be included in a test.
Methods inherited from TaskLib
Methods included from Cloneable
Constructor Details
#initialize(name = :test) {|_self| ... } ⇒ TestTask
Create a testing task.
81 82 83 84 85 86 87 88 89 90 91 92 93 94 |
# File 'lib/rake/testtask.rb', line 81 def initialize(name=:test) @name = name @libs = ["lib"] @pattern = nil @options = nil @test_files = nil @verbose = false @warning = false @loader = :rake @ruby_opts = [] 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 |
#loader ⇒ Object
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.
67 68 69 |
# File 'lib/rake/testtask.rb', line 67 def loader @loader 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. An explicit TESTOPTS=opts on the command line will override this. (default is NONE)
52 53 54 |
# File 'lib/rake/testtask.rb', line 52 def @options end |
#pattern ⇒ Object
Glob pattern to match test files. (default is ‘test/test*.rb’)
59 60 61 |
# File 'lib/rake/testtask.rb', line 59 def pattern @pattern end |
#ruby_opts ⇒ Object
Array of commandline options to pass to ruby when running test loader.
70 71 72 |
# File 'lib/rake/testtask.rb', line 70 def ruby_opts @ruby_opts 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 |
#warning ⇒ Object
Request that the tests be run with the warning flag set. E.g. warning=true implies “ruby -w” used to run the tests.
56 57 58 |
# File 'lib/rake/testtask.rb', line 56 def warning @warning end |
Instance Method Details
#define ⇒ Object
Create the tasks defined by this task lib.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/rake/testtask.rb', line 97 def define lib_path = @libs.join(File::PATH_SEPARATOR) desc "Run tests" + (@name==:test ? "" : " for #{@name}") task @name do run_code = '' RakeFileUtils.verbose(@verbose) do run_code = case @loader when :direct "-e 'ARGV.each{|f| load f}'" when :testrb "-S testrb #{fix}" when :rake rake_loader end @ruby_opts.unshift( "-I#{lib_path}" ) @ruby_opts.unshift( "-w" ) if @warning ruby @ruby_opts.join(" ") + " \"#{run_code}\" " + file_list.collect { |fn| "\"#{fn}\"" }.join(' ') + " #{option_list}" end end self end |
#file_list ⇒ Object
:nodoc:
127 128 129 130 131 132 133 134 135 136 |
# File 'lib/rake/testtask.rb', line 127 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 |
#find_file(fn) ⇒ Object
:nodoc:
152 153 154 155 156 157 158 |
# File 'lib/rake/testtask.rb', line 152 def find_file(fn) # :nodoc: $LOAD_PATH.each do |path| file_path = File.join(path, "#{fn}.rb") return file_path if File.exist? file_path end nil end |
#fix ⇒ Object
:nodoc:
138 139 140 141 142 143 144 145 |
# File 'lib/rake/testtask.rb', line 138 def fix # :nodoc: case RUBY_VERSION when '1.8.2' find_file 'rake/ruby182_test_unit_fix' else nil end || '' end |
#option_list ⇒ Object
:nodoc:
123 124 125 |
# File 'lib/rake/testtask.rb', line 123 def option_list # :nodoc: ENV['TESTOPTS'] || @options || "" end |
#rake_loader ⇒ Object
:nodoc:
147 148 149 150 |
# File 'lib/rake/testtask.rb', line 147 def rake_loader # :nodoc: find_file('rake/rake_test_loader') or fail "unable to find rake test loader" 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.
76 77 78 |
# File 'lib/rake/testtask.rb', line 76 def test_files=(list) @test_files = list end |