Parent

Rcov::RcovTask

Create a task that runs a set of tests through rcov, generating code coverage reports.

Example:

require 'rcov/rcovtask'

Rcov::RcovTask.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 “RCOVOPTS=options” command line option, then the given options are passed to rcov.

If rake is invoked with a “RCOVPATH=path/to/rcov” command line option, then the given rcov executable will be used; otherwise the one in your PATH will be used.

Examples:

rake rcov                           # run tests normally
rake rcov TEST=just_one_file.rb     # run just one test file.
rake rcov RCOVOPTS="-p"             # run in profile mode
rake rcov RCOVOPTS="-T"             # generate text report

Attributes

libs[RW]

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

name[RW]

Name of test task. (default is :rcov)

output_dir[RW]

Output directory for the XHTML report.

pattern[RW]

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

rcov_opts[RW]

Array of commandline options to pass to rcov. An explicit RCOVOPTS=opts on the command line will override this. (default is ["--text-report"])

ruby_opts[RW]

Array of commandline options to pass to ruby when running the rcov 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=:rcov) click to toggle source

Create a testing task.

# File lib/rcov/rcovtask.rb, line 82
def initialize(name=:rcov)
  @name = name
  @libs = ["lib"]
  @pattern = nil
  @test_files = nil
  @verbose = false
  @warning = false
  @rcov_opts = ["--text-report"]
  @ruby_opts = []
  @ruby_opts << "--debug" if RUBY_PLATFORM == 'java'
  @output_dir = "coverage"
  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/rcov/rcovtask.rb, line 99
def define
  lib_path = @libs.join(File::PATH_SEPARATOR)
  actual_name = Hash === name ? name.keys.first : name
  unless Rake.application.last_comment
    desc "Analyze code coverage with tests" + 
      (@name==:rcov ? "" : " for #{actual_name}")
  end
  task @name do
    run_code = ''
    RakeFileUtils.verbose(@verbose) do
      run_code =
      case rcov_path
      when nil, ''
        "-S rcov"
      else %"#{rcov_path}"!
      end
      ruby_opts = @ruby_opts.clone
      ruby_opts.push( "-I#{lib_path}" )
      ruby_opts.push run_code
      ruby_opts.push( "-w" ) if @warning
      ruby ruby_opts.join(" ") + " " + option_list +
      %[ -o "#{@output_dir}" ] +
      file_list.collect { |fn| %["#{fn}"] }.join(' ')
    end
  end

  desc "Remove rcov products for #{actual_name}"
  task paste("clobber_", actual_name) do
    rm_r @output_dir rescue nil
  end

  clobber_task = paste("clobber_", actual_name)
  task :clobber => [clobber_task]

  task actual_name => clobber_task
  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 lib/rcov/rcovtask.rb, line 77
def test_files=(list)
  @test_files = list
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.