Class: Rake::TestTask

Class | Rake::TestTask
In: | lib/rake/testtask.rb
Parent: | TaskLib

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

### Methods

define new test_files=

### Attributes

libs | [RW] | List of directories to 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 commandline 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.

### Public Class methods

new(name=:test) {|self if block_given?| ...}

Create a testing task.

[Source]

        # File lib/rake/testtask.rb, line 81
    81:     def initialize(name=:test)
    82:       @name = name
    83:       @libs = ["lib"]
    84:       @pattern = nil
    85:       @options = nil
    86:       @test_files = nil
    87:       @verbose = false
    88:       @warning = false
    89:       @loader = :rake
    90:       @ruby_opts = []
    91:       yield self if block_given?
    92:       @pattern = 'test/test*.rb' if @pattern.nil? && @test_files.nil?
    93:       define
    94:     end

### Public Instance methods

define()

Create the tasks defined by this task lib.

[Source]

         # File lib/rake/testtask.rb, line 97
     97:     def define
     98:       lib_path = @libs.join(File::PATH_SEPARATOR)
     99:       desc "Run tests" + (@name==:test ? "" : " for #{@name}")
    100:       task @name do
    101:         run_code = ''
    102:         RakeFileUtils.verbose(@verbose) do
    103:           run_code =
    104:             case @loader
    105:             when :direct
    106:               "-e 'ARGV.each{|f| load f}'"
    107:             when :testrb
    108:               "-S testrb #{fix}"
    109:             when :rake
    110:               rake_loader
    111:             end
    112:           @ruby_opts.unshift( "-I#{lib_path}" )
    113:           @ruby_opts.unshift( "-w" ) if @warning
    114:           ruby @ruby_opts.join(" ") +
    115:             " \"#{run_code}\" " +
    116:             file_list.collect { |fn| "\"#{fn}\"" }.join(' ') +
    117:             " #{option_list}"
    118:         end
    119:       end
    120:       self
    121:     end

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.

[Source]

        # File lib/rake/testtask.rb, line 76
    76:     def test_files=(list)
    77:       @test_files = list
    78:     end

[Validate]