class Rake::TestTask - rake: Ruby Standard Library Documentation

# class Rake::TestTask

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

### Attributes

deps[RW]

`Task` prerequisites.

description[RW]

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

libs[RW]

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

loader[RW]

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[RW]

Name of test task. (default is :test)

options[RW]

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

pattern[RW]

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

ruby_opts[RW]

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

verbose[RW]

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

warning[RW]

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

### Public Class Methods

new(name=:test) { |self| ... } click to toggle source

Create a testing task.

    # File rake-13.2.1/lib/rake/testtask.rb, line 86
    def initialize(name=:test)
      @name = name
      @libs = ["lib"]
      @pattern = nil
      @options = nil
      @test_files = nil
      @verbose = false
      @warning = true
      @loader = :rake
      @ruby_opts = []
      @description = "Run tests" + (@name == :test ? "" : " for #{@name}")
      @deps = []
      if @name.is_a?(Hash)
        @deps = @name.values.first
        @name = @name.keys.first
      end
      yield self if block_given?
      @pattern = "test/test*.rb" if @pattern.nil? && @test_files.nil?
      define
    end

### Public Instance Methods

define() click to toggle source

Create the tasks defined by this task lib.

    # File rake-13.2.1/lib/rake/testtask.rb, line 108
    def define
      desc @description
      task @name => Array(deps) do
        FileUtilsExt.verbose(@verbose) do
          puts "Use TESTOPTS=\"--verbose\" to pass --verbose" \
            ", etc. to runners." if ARGV.include? "--verbose"
          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
              status  = "Command failed with status (#{status.exitstatus})"
              details = ": [ruby #{args}]"
              message =
                if Rake.application.options.trace or @verbose
                  status + details
                else
                  status
                end

              fail message
            end
          end
        end
      end
      self
    end

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-13.2.1/lib/rake/testtask.rb, line 81
    def test_files=(list)
      @test_files = list
    end