Class: Rake::TestTask

### Home Classes Methods

### In Files

- lib/rake/testtask.rb

### Parent

Rake::TaskLib

### Methods

- ::new
- #define
- #file_list_string
- #lib_path
- #ruby_opts_string
- #ruby_version
- #run_code
- #test_files=

### Files

- MIT-LICENSE
- README.rdoc
- TODO
- command_line_usage.rdoc
- glossary.rdoc
- proto_rake.rdoc
- rakefile.rdoc
- rational.rdoc
- rake-0.4.14.rdoc
- rake-0.4.15.rdoc
- rake-0.5.0.rdoc
- rake-0.5.3.rdoc
- rake-0.5.4.rdoc
- rake-0.6.0.rdoc
- rake-0.7.0.rdoc
- rake-0.7.1.rdoc
- rake-0.7.2.rdoc
- rake-0.7.3.rdoc
- rake-0.8.0.rdoc
- rake-0.8.4.rdoc
- rake-0.8.5.rdoc
- rake-0.8.6.rdoc
- rake-0.8.7.rdoc

### Class/Module Index

Quicksearch

- Rake
- Rake::AltSystem
- Rake::Application
- Rake::Backtrace
- Rake::Cloneable
- Rake::CompositePublisher
- Rake::DSL
- Rake::DefaultLoader
- Rake::EarlyTime
- Rake::FileCreationTask
- Rake::FileList
- Rake::FileTask
- Rake::FileUtilsExt
- Rake::FtpFile
- Rake::FtpUploader
- Rake::InvocationChain
- Rake::InvocationChain::EmptyInvocationChain
- Rake::InvocationExceptionMixin
- Rake::MakefileLoader
- Rake::MultiTask
- Rake::NameSpace
- Rake::PackageTask
- Rake::PseudoStatus
- Rake::RubyForgePublisher
- Rake::RuleRecursionOverflowError
- Rake::SshDirPublisher
- Rake::SshFilePublisher
- Rake::SshFreshDirPublisher
- Rake::Task
- Rake::TaskArgumentError
- Rake::TaskArguments
- Rake::TaskLib
- Rake::TaskManager
- Rake::TestTask
- Rake::TraceOutput
- Rake::Win32
- Rake::Win32::Win32HomeError
- CompositePublisher
- FileUtils
- Module
- Object
- SshDirPublisher
- SshFilePublisher
- SshFreshDirPublisher
- String
- Time

No matching classes.

# Rake::TestTask

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

### 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) click to toggle source

Create a testing task.

    # 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

### Public Instance Methods

define() click to toggle source

Create the tasks defined by this task lib.

    # File lib/rake/testtask.rb, line 95
    def define
      desc "Run tests" + (@name==:test ? "" : " for #{@name}")
      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_list_string() click to toggle source

    # File lib/rake/testtask.rb, line 132
    def file_list_string
      file_list.collect { |fn| "\"#{fn}\"" }.join(' ')
    end

lib_path() click to toggle source

    # File lib/rake/testtask.rb, line 128
    def lib_path
      @libs.join(File::PATH_SEPARATOR)
    end

ruby_opts_string() click to toggle source

    # File lib/rake/testtask.rb, line 121
    def ruby_opts_string
      opts = @ruby_opts.dup
      opts.unshift( "-I\"#{lib_path}\"" ) unless @libs.empty?
      opts.unshift( "-w" ) if @warning
      opts.join(" ")
    end

ruby_version() click to toggle source

    # File lib/rake/testtask.rb, line 156
    def ruby_version
      RUBY_VERSION
    end

run_code() click to toggle source

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

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

[Validate]

Generated with the Darkfish Rdoc Generator 2.