class Minitest::Runnable

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

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

Attributes

assertions[RW]

Number of assertions executed in this run.

failures[RW]

An assertion raised during the run, if any.

metadata[W]

Sets metadata, mainly used for Result.from.

time[RW]

The time it took to run.

Public Class Methods

methods_matching(re) click to toggle source

Returns all instance methods matching the pattern re.

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

run(reporter, options = {}) click to toggle source

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

# File minitest-5.20.0/lib/minitest.rb, line 336
def self.run reporter, options = {}
  filtered_methods = if options[:filter]
    filter = options[:filter]
    filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%

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

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

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

  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

run_one_method(klass, method_name, reporter) click to toggle source

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.

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

runnable_methods() click to toggle source

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

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

runnables() click to toggle source

Returns all subclasses of Runnable.

# File minitest-5.20.0/lib/minitest.rb, line 424
def self.runnables
  @@runnables
end

test_order() click to toggle source

Defines the order to run tests (:random by default). Override this or use a convenience method to change it for your tests.

# File minitest-5.20.0/lib/minitest.rb, line 381
def self.test_order
  :random
end

Public Instance Methods

metadata() click to toggle source

Metadata you attach to the test results that get sent to the reporter.

Lazily initializes to a hash, to keep memory down.

NOTE: this data must be plain (read: marshal-able) data! Hashes! Arrays! Strings!

# File minitest-5.20.0/lib/minitest.rb, line 463
def metadata
  @metadata ||= {}
end

metadata?() click to toggle source

Returns true if metadata exists.

# File minitest-5.20.0/lib/minitest.rb, line 475
def metadata?
  defined? @metadata
end

name() click to toggle source

Name of the run.

# File minitest-5.20.0/lib/minitest.rb, line 307
def name
  @NAME
end

name=(o) click to toggle source

Set the name of the run.

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

passed?() click to toggle source

Did this run pass?

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

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

result_code() click to toggle source

Returns a single character string to print based on the result of the run. One of ".", "F", "E" or "S".

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

run() click to toggle source

Runs a single method. Needs to return self.

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

skipped?() click to toggle source

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

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