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)

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 392
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 = {})

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 407
def self.run reporter, options = {}
  pos = options[:filter]
  neg = options[:exclude]

  pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
  neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%

  filtered_methods = self.runnable_methods
    .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
    .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }

  return if filtered_methods.empty?

  t0 = name = nil

  @_info_handler = lambda do
    unless reporter.passed? then
      warn "Current results:"
      warn reporter.reporters.grep(SummaryReporter).first
    end

    warn "Current: %s#%s %.2fs" % [self, name, Minitest.clock_time - t0]
  end

  with_info_handler reporter do
    filtered_methods.each do |method_name|
      name = method_name
      t0 = Minitest.clock_time

      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)

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 447
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 ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 483
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 ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 490
def self.runnables
  @@runnables
end

Returns all subclasses of Runnable.

test_order ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 456
def self.test_order
  :random
end

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

Public Instance Methods

metadata ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 529
def metadata
  @metadata ||= {}
end

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!

metadata? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 541
def metadata?
  defined? @metadata
end

Returns true if metadata exists.

name ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 378
def name
  @NAME
end

Name of the run.

name= (o)

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 385
def name= o
  @NAME = o
end

Set the name of the run.

passed? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 558
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 ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 567
def result_code
  raise NotImplementedError, "subclass responsibility"
end

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

run ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 548
def run
  raise NotImplementedError, "subclass responsibility"
end

Runs a single method. Needs to return self.

skipped? ()

Source

# File vendor/bundle/ruby/3.4.0/gems/minitest-5.26.0/lib/minitest.rb, line 574
def skipped?
  raise NotImplementedError, "subclass responsibility"
end

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