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

#initialize_copy

Constructor Details

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

Create a testing task.

Yields:

  • (_self)

Yield Parameters:



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
# File 'lib/rake/testtask.rb', line 80

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

#descriptionObject

Description of the test task. (default is 'Run tests')



69
70
71
# File 'lib/rake/testtask.rb', line 69

def description
  @description
end

#libsObject

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



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

def libs
  @libs
end

#loaderObject

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.



63
64
65
# File 'lib/rake/testtask.rb', line 63

def loader
  @loader
end

#nameObject

Name of test task. (default is :test)



36
37
38
# File 'lib/rake/testtask.rb', line 36

def name
  @name
end

#optionsObject

Test options passed to the test suite. An explicit TESTOPTS=opts on the command line will override this. (default is NONE)



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

def options
  @options
end

#patternObject

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



55
56
57
# File 'lib/rake/testtask.rb', line 55

def pattern
  @pattern
end

#ruby_optsObject

Array of commandline options to pass to ruby when running test loader.



66
67
68
# File 'lib/rake/testtask.rb', line 66

def ruby_opts
  @ruby_opts
end

#verboseObject

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



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

def verbose
  @verbose
end

#warningObject

Request that the tests be run with the warning flag set. E.g. warning=true implies “ruby -w” used to run the tests.



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

def warning
  @warning
end

Instance Method Details

#defineObject

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

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_listObject

:nodoc:



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

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_stringObject

:nodoc:



137
138
139
# File 'lib/rake/testtask.rb', line 137

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

#find_dir(fn) ⇒ Object

:nodoc:



203
204
205
206
207
208
209
# File 'lib/rake/testtask.rb', line 203

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:



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

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

#fixObject

:nodoc:



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

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

#lib_pathObject

:nodoc:



133
134
135
# File 'lib/rake/testtask.rb', line 133

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

#option_listObject

:nodoc:



117
118
119
120
121
122
123
124
# File 'lib/rake/testtask.rb', line 117

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

#rake_include_argObject

:nodoc:



189
190
191
192
193
194
195
196
# File 'lib/rake/testtask.rb', line 189

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_dirObject

:nodoc:



198
199
200
201
# File 'lib/rake/testtask.rb', line 198

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

#rake_loaderObject

:nodoc:



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

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

#ruby_opts_stringObject

:nodoc:



126
127
128
129
130
131
# File 'lib/rake/testtask.rb', line 126

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_versionObject

:nodoc:



161
162
163
# File 'lib/rake/testtask.rb', line 161

def ruby_version # :nodoc:
  RUBY_VERSION
end

#run_codeObject

:nodoc:



165
166
167
168
169
170
171
172
173
174
# File 'lib/rake/testtask.rb', line 165

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.



75
76
77
# File 'lib/rake/testtask.rb', line 75

def test_files=(list)
  @test_files = list
end