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

Constant Summary

Constant Summary

Constants included from FileUtilsExt

FileUtilsExt::DEFAULT

Constants included from FileUtils

FileUtils::LN_SUPPORTED, FileUtils::RUBY

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods inherited from TaskLib

#paste

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

#clone, #dup

Constructor Details

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

Create a testing task.

Yields:

  • (_self)

Yield Parameters:



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
  @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
# File 'lib/rake/testtask.rb', line 95

def define
  desc "Run tests" + (@name==:test ? "" : " for #{@name}")
  task @name do
    FileUtilsExt.verbose(@verbose) do
      ruby "#{ruby_opts_string} #{run_code} #{file_list_string} #{option_list}"
    end
  end
  self
end

- (Object) file_list

:nodoc:



129
130
131
132
133
134
135
136
137
138
# File 'lib/rake/testtask.rb', line 129

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

- (Object) file_list_string



125
126
127
# File 'lib/rake/testtask.rb', line 125

def file_list_string
  file_list.collect { |fn| "\"#{fn}\"" }.join(' ')
end

- (Object) find_dir(fn)

:nodoc:



182
183
184
185
186
187
188
# File 'lib/rake/testtask.rb', line 182

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

- (Object) find_file(fn)

:nodoc:



169
170
171
172
173
174
175
# File 'lib/rake/testtask.rb', line 169

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) fix

:nodoc:



140
141
142
143
144
145
146
147
# File 'lib/rake/testtask.rb', line 140

def fix # :nodoc:
  case ruby_version
  when '1.8.2'
    "\"#{find_file 'rake/ruby182_test_unit_fix'}\""
  else
    nil
  end || ''
end

- (Object) lib_path



121
122
123
# File 'lib/rake/testtask.rb', line 121

def lib_path
  @libs.join(File::PATH_SEPARATOR)
end

- (Object) option_list

:nodoc:



105
106
107
108
109
110
111
112
# File 'lib/rake/testtask.rb', line 105

def option_list # :nodoc:
  (ENV['TESTOPTS'] ||
    ENV['TESTOPT'] ||
    ENV['TEST_OPTS'] ||
    ENV['TEST_OPT'] ||
    @options ||
    "")
end

- (Object) rake_lib_dir

:nodoc:



177
178
179
180
# File 'lib/rake/testtask.rb', line 177

def rake_lib_dir # :nodoc:
  find_dir('rake') or
    fail "unable to find rake lib"
end

- (Object) rake_loader

:nodoc:



164
165
166
167
# File 'lib/rake/testtask.rb', line 164

def rake_loader # :nodoc:
  find_file('rake/rake_test_loader') or
    fail "unable to find rake test loader"
end

- (Object) ruby_opts_string



114
115
116
117
118
119
# File 'lib/rake/testtask.rb', line 114

def ruby_opts_string
  opts = @ruby_opts.dup
  opts.unshift( "-I\"#{lib_path}\"" ) unless @libs.empty?
  opts.unshift( "-w" ) if @warning
  opts.join(" ")
end

- (Object) ruby_version



149
150
151
# File 'lib/rake/testtask.rb', line 149

def ruby_version
  RUBY_VERSION
end

- (Object) run_code



153
154
155
156
157
158
159
160
161
162
# File 'lib/rake/testtask.rb', line 153

def run_code
  case @loader
  when :direct
    "-e \"ARGV.each{|f| require f}\""
  when :testrb
    "-S testrb #{fix}"
  when :rake
    "-I\"#{rake_lib_dir}\" \"#{rake_loader}\""
  end
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