In Files

  • rake/testtask.rb


Create a task that runs a set of tests.

Example: do |t|
  t.libs << "test"
  t.test_files = FileList['test/test*.rb']
  t.verbose = true

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.


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



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


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


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.


Name of test task. (default is :test)


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


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


Array of command line options to pass to ruby when running test loader.


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


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

Public Class Methods

new(name=:test) click to toggle source

Create a testing task.

               # File 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?

Public Instance Methods

define() click to toggle source

Create the tasks defined by this task lib.

               # File 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?
        elsif !ok
          fail "Command failed with status (#{status.exitstatus}): " +
            "[ruby #{args}]"
test_files=(list) click to toggle source

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.

               # File rake/testtask.rb, line 75
def test_files=(list)
  @test_files = list

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please visit

blog comments powered by Disqus