W3cubDocs

/Ruby / Minitest

class Minitest::Runnable

Parent:: Object

Represents anything “runnable”, like Test, Spec, Benchmark, or whatever you can dream up.

Subclasses of this are automatically registered and available in ::runnables.

Attributes

assertions[RW]

Number of assertions executed in this run.

failures[RW]

An assertion raised during the run, if any.

time[RW]

The time it took to run.

Public Class Methods

methods_matching(re) Show source

# File lib/minitest.rb, line 287
def self.methods_matching re
  public_instance_methods(true).grep(re).map(&:to_s)
end

Returns all instance methods matching the pattern re.

run(reporter, options = {}) Show source

# File lib/minitest.rb, line 302
def self.run reporter, options = {}
  filter = options[:filter] || "/./"
  filter = Regexp.new $1 if filter =~ %r%/(.*)/%

  filtered_methods = self.runnable_methods.find_all { |m|
    filter === m || filter === "#{self}##{m}"
  }

  exclude = options[:exclude]
  exclude = Regexp.new $1 if exclude =~ %r%/(.*)/%

  filtered_methods.delete_if { |m|
    exclude === m || exclude === "#{self}##{m}"
  }

  return if filtered_methods.empty?

  with_info_handler reporter do
    filtered_methods.each do |method_name|
      run_one_method self, method_name, reporter
    end
  end
end

Responsible for running all runnable methods in a given class, each in its own instance. Each instance is passed to the reporter to record.

run_one_method(klass, method_name, reporter) Show source

# File lib/minitest.rb, line 332
def self.run_one_method klass, method_name, reporter
  reporter.prerecord klass, method_name
  reporter.record Minitest.run_one_method(klass, method_name)
end

Runs a single method and has the reporter record the result. This was considered internal API but is factored out of run so that subclasses can specialize the running of an individual test. See Minitest::ParallelTest::ClassMethods for an example.

runnable_methods() Show source

# File lib/minitest.rb, line 369
def self.runnable_methods
  raise NotImplementedError, "subclass responsibility"
end

Each subclass of Runnable is responsible for overriding this method to return all runnable methods. See methods_matching.

runnables() Show source

# File lib/minitest.rb, line 376
def self.runnables
  @@runnables
end

Returns all subclasses of Runnable.

Public Instance Methods

name() Show source

# File lib/minitest.rb, line 273
def name
  @NAME
end

Name of the run.

name=(o) Show source

# File lib/minitest.rb, line 280
def name= o
  @NAME = o
end

Set the name of the run.

passed?() Show source

# File lib/minitest.rb, line 419
def passed?
  raise NotImplementedError, "subclass responsibility"
end

Did this run pass?

Note: skipped runs are not considered passing, but they don't cause the process to exit non-zero.

result_code() Show source

# File lib/minitest.rb, line 427
def result_code
  raise NotImplementedError, "subclass responsibility"
end

Returns a single character string to print based on the result of the run. Eg “.”, “F”, or “E”.

run() Show source

# File lib/minitest.rb, line 409
def run
  raise NotImplementedError, "subclass responsibility"
end

Runs a single method. Needs to return self.

skipped?() Show source

# File lib/minitest.rb, line 434
def skipped?
  raise NotImplementedError, "subclass responsibility"
end

Was this run skipped? See passed? for more information.