Class: Rake::TestTask
Overview
Create a task that runs a set of tests.
Example:
require "rake/testtask"
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
Constant Summary
Constants included from FileUtilsExt
Constants included from FileUtils
FileUtils::LN_SUPPORTED, FileUtils::RUBY
Instance Attribute Summary collapse
-
#description ⇒ Object
Description of the test task.
-
#libs ⇒ Object
List of directories 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 command line 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:.
-
#file_list_string ⇒ Object
:nodoc:.
-
#find_dir(fn) ⇒ Object
:nodoc:.
-
#find_file(fn) ⇒ Object
:nodoc:.
-
#fix ⇒ Object
:nodoc:.
-
#initialize(name = :test) {|_self| ... } ⇒ TestTask
constructor
Create a testing task.
-
#lib_path ⇒ Object
:nodoc:.
-
#option_list ⇒ Object
:nodoc:.
-
#rake_include_arg ⇒ Object
:nodoc:.
-
#rake_lib_dir ⇒ Object
:nodoc:.
-
#rake_loader ⇒ Object
:nodoc:.
-
#ruby_opts_string ⇒ Object
:nodoc:.
-
#ruby_version ⇒ Object
:nodoc:.
-
#run_code ⇒ 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 FileUtilsExt
#nowrite, #rake_check_options, #rake_merge_option, #rake_output_message, #when_writing
Methods included from FileUtils
#ruby, #safe_ln, #sh, #split_all
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 95 |
# 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 = [] @description = "Run tests" + (@name == :test ? "" : " for #{@name}") yield self if block_given? @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil? define end |
Instance Attribute Details
#description ⇒ Object
Description of the test task. (default is ‘Run tests’)
70 71 72 |
# File 'lib/rake/testtask.rb', line 70 def description @description end |
#libs ⇒ Object
List of directories added to $LOAD_PATH before running the tests. (default is ‘lib’)
41 42 43 |
# File 'lib/rake/testtask.rb', line 41 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.
64 65 66 |
# File 'lib/rake/testtask.rb', line 64 def loader @loader end |
#name ⇒ Object
Name of test task. (default is :test)
37 38 39 |
# File 'lib/rake/testtask.rb', line 37 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)
49 50 51 |
# File 'lib/rake/testtask.rb', line 49 def @options end |
#pattern ⇒ Object
Glob pattern to match test files. (default is ‘test/test*.rb’)
56 57 58 |
# File 'lib/rake/testtask.rb', line 56 def pattern @pattern end |
#ruby_opts ⇒ Object
Array of command line options to pass to ruby when running test loader.
67 68 69 |
# File 'lib/rake/testtask.rb', line 67 def ruby_opts @ruby_opts end |
#verbose ⇒ Object
True if verbose test output desired. (default is false)
44 45 46 |
# File 'lib/rake/testtask.rb', line 44 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.
53 54 55 |
# File 'lib/rake/testtask.rb', line 53 def warning @warning end |
Instance Method Details
#define ⇒ Object
Create the tasks defined by this task lib.
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 |
# File 'lib/rake/testtask.rb', line 98 def define desc @description task @name do FileUtilsExt.verbose(@verbose) do args = "#{ruby_opts_string} #{run_code} " + "#{file_list_string} #{option_list}" ruby args do |ok, status| if !ok && status.respond_to?(:signaled?) && status.signaled? raise SignalException.new(status.termsig) elsif !ok fail "Command failed with status (#{status.exitstatus}): " + "[ruby #{args}]" end end end end self end |
#file_list ⇒ Object
:nodoc:
142 143 144 145 146 147 148 149 150 151 |
# File 'lib/rake/testtask.rb', line 142 def file_list # :nodoc: if ENV['TEST'] FileList[ENV['TEST']] else result = [] result += @test_files.to_a if @test_files result << @pattern if @pattern result end end |
#file_list_string ⇒ Object
:nodoc:
138 139 140 |
# File 'lib/rake/testtask.rb', line 138 def file_list_string # :nodoc: file_list.map { |fn| "\"#{fn}\"" }.join(' ') end |
#find_dir(fn) ⇒ Object
:nodoc:
204 205 206 207 208 209 210 |
# File 'lib/rake/testtask.rb', line 204 def find_dir(fn) # :nodoc: $LOAD_PATH.each do |path| file_path = File.join(path, "#{fn}.rb") return path if File.exist? file_path end nil end |
#find_file(fn) ⇒ Object
:nodoc:
182 183 184 185 186 187 188 |
# File 'lib/rake/testtask.rb', line 182 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:
153 154 155 156 157 158 159 160 |
# File 'lib/rake/testtask.rb', line 153 def fix # :nodoc: case ruby_version when '1.8.2' "\"#{find_file 'rake/ruby182_test_unit_fix'}\"" else nil end || '' end |
#lib_path ⇒ Object
:nodoc:
134 135 136 |
# File 'lib/rake/testtask.rb', line 134 def lib_path # :nodoc: @libs.join(File::PATH_SEPARATOR) end |
#option_list ⇒ Object
:nodoc:
118 119 120 121 122 123 124 125 |
# File 'lib/rake/testtask.rb', line 118 def option_list # :nodoc: (ENV['TESTOPTS'] || ENV['TESTOPT'] || ENV['TEST_OPTS'] || ENV['TEST_OPT'] || @options || "") end |
#rake_include_arg ⇒ Object
:nodoc:
190 191 192 193 194 195 196 197 |
# File 'lib/rake/testtask.rb', line 190 def rake_include_arg # :nodoc: spec = Gem.loaded_specs['rake'] if spec.respond_to?(:default_gem?) && spec.default_gem? "" else "-I\"#{rake_lib_dir}\"" end end |
#rake_lib_dir ⇒ Object
:nodoc:
199 200 201 202 |
# File 'lib/rake/testtask.rb', line 199 def rake_lib_dir # :nodoc: find_dir('rake') or fail "unable to find rake lib" end |
#rake_loader ⇒ Object
:nodoc:
177 178 179 180 |
# File 'lib/rake/testtask.rb', line 177 def rake_loader # :nodoc: find_file('rake/rake_test_loader') or fail "unable to find rake test loader" end |
#ruby_opts_string ⇒ Object
:nodoc:
127 128 129 130 131 132 |
# File 'lib/rake/testtask.rb', line 127 def ruby_opts_string # :nodoc: opts = @ruby_opts.dup opts.unshift("-I\"#{lib_path}\"") unless @libs.empty? opts.unshift("-w") if @warning opts.join(" ") end |
#ruby_version ⇒ Object
:nodoc:
162 163 164 |
# File 'lib/rake/testtask.rb', line 162 def ruby_version # :nodoc: RUBY_VERSION end |
#run_code ⇒ Object
:nodoc:
166 167 168 169 170 171 172 173 174 175 |
# File 'lib/rake/testtask.rb', line 166 def run_code # :nodoc: case @loader when :direct "-e \"ARGV.each{|f| require f}\"" when :testrb "-S testrb #{fix}" when :rake "#{rake_include_arg} \"#{rake_loader}\"" 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.
76 77 78 |
# File 'lib/rake/testtask.rb', line 76 def test_files=(list) @test_files = list end |