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)
-
- (Object) libs
List of directories to added to $LOAD_PATH before running the tests.
-
- (Object) loader
Style of test loader to use.
-
- (Object) name
Name of test task.
-
- (Object) options
Test options passed to the test suite.
-
- (Object) pattern
Glob pattern to match test files.
-
- (Object) ruby_opts
Array of commandline options to pass to ruby when running test loader.
-
- (Object) verbose
True if verbose test output desired.
-
- (Object) warning
Request that the tests be run with the warning flag set.
Instance Method Summary (collapse)
-
- (Object) define
Create the tasks defined by this task lib.
-
- (Object) file_list
:nodoc:.
-
- (Object) find_file(fn)
:nodoc:.
-
- (TestTask) initialize(name = :test) {|_self| ... }
constructor
Create a testing task.
-
- (Object) option_list
:nodoc:.
-
- (Object) rake_loader
:nodoc:.
-
- (Object) test_files=(list)
Explicitly define the list of test files to be included in a test.
Methods inherited from TaskLib
Methods included from Cloneable
Constructor Details
- (TestTask) initialize(name = :test) {|_self| ... }
Create a testing task.
79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/rake/testtask.rb', line 79 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
- (Object) libs
List of directories to added to $LOAD_PATH before running the tests. (default is 'lib')
42 43 44 |
# File 'lib/rake/testtask.rb', line 42 def libs @libs end |
- (Object) loader
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.
65 66 67 |
# File 'lib/rake/testtask.rb', line 65 def loader @loader end |
- (Object) name
Name of test task. (default is :test)
38 39 40 |
# File 'lib/rake/testtask.rb', line 38 def name @name end |
- (Object) options
Test options passed to the test suite. An explicit TESTOPTS=opts on the command line will override this. (default is NONE)
50 51 52 |
# File 'lib/rake/testtask.rb', line 50 def @options end |
- (Object) pattern
Glob pattern to match test files. (default is 'test/test*.rb')
57 58 59 |
# File 'lib/rake/testtask.rb', line 57 def pattern @pattern end |
- (Object) ruby_opts
Array of commandline options to pass to ruby when running test loader.
68 69 70 |
# File 'lib/rake/testtask.rb', line 68 def ruby_opts @ruby_opts end |
- (Object) verbose
True if verbose test output desired. (default is false)
45 46 47 |
# File 'lib/rake/testtask.rb', line 45 def verbose @verbose end |
- (Object) warning
Request that the tests be run with the warning flag set. E.g. warning=true implies "ruby -w" used to run the tests.
54 55 56 |
# File 'lib/rake/testtask.rb', line 54 def warning @warning end |
Instance Method Details
- (Object) define
Create the tasks defined by this task lib.
95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/rake/testtask.rb', line 95 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" 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 |
- (Object) file_list
:nodoc:
125 126 127 128 129 130 131 132 133 134 |
# File 'lib/rake/testtask.rb', line 125 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 |
- (Object) find_file(fn)
:nodoc:
141 142 143 144 145 146 147 |
# File 'lib/rake/testtask.rb', line 141 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 |
- (Object) option_list
:nodoc:
121 122 123 |
# File 'lib/rake/testtask.rb', line 121 def option_list # :nodoc: ENV['TESTOPTS'] || @options || "" end |
- (Object) rake_loader
:nodoc:
136 137 138 139 |
# File 'lib/rake/testtask.rb', line 136 def rake_loader # :nodoc: find_file('rake/rake_test_loader') or fail "unable to find rake test loader" end |
- (Object) test_files=(list)
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.
74 75 76 |
# File 'lib/rake/testtask.rb', line 74 def test_files=(list) @test_files = list end |