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.

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] untyped

Number of assertions executed in this run.

failures [RW] untyped

An assertion raised during the run, if any.

metadata [W] untyped

Sets metadata, mainly used for Result.from.

time [RW] untyped

The time it took to run.

Public Class Methods

filter_runnable_methods (options={})

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 434
def self.filter_runnable_methods options={}
  pos = options[:include]
  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%/(.*)/%

  # at most 1-2% slower than a 1-pass version, stop optimizing this
  self.runnable_methods
    .select { |m| !pos ||  pos === m || pos === "#{self}##{m}"  }
    .reject { |m|  neg && (neg === m || neg === "#{self}##{m}") }
end

Returns an array of filtered runnable_methods. Uses options (–include arguments) and options (–exclude arguments) values to filter.

inherited

(untyped klass) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 141
def self.inherited: (untyped klass) -> untyped

methods_matching (re)

(untyped re) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 419
def self.methods_matching re
  public_instance_methods(true).grep(re).map(&:to_s)
end

Returns all instance methods matching the pattern re.

new

(untyped name) → void

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 91
def initialize: (untyped name) -> void

on_signal

(untyped name, untyped action) { () → untyped } → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 70
def self.on_signal: (untyped name, untyped action) { () -> untyped } -> untyped

reset

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 39
def self.reset: () -> untyped

run (klass, method_name, reporter)

(untyped reporter, ?::Hash[untyped, untyped] options) → (nil | untyped)

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 484
def Runnable.run klass, method_name, reporter
  reporter.prerecord klass, method_name
  reporter.record klass.new(method_name).run
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.

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

(untyped klass, untyped method_name, untyped reporter) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 59
def self.run_one_method: (untyped klass, untyped method_name, untyped reporter) -> untyped

run_order ()

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 493
def self.run_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.

run_suite (reporter, options = {})

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 452
def Runnable.run_suite reporter, options = {}
  filtered_methods = filter_runnable_methods options

  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 do
    filtered_methods.each do |method_name|
      name = method_name
      t0 = Minitest.clock_time

      run 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.

runnable_methods ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 520
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 ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 527
def self.runnables
  @@runnables
end

Returns all subclasses of Runnable.

test_order

() → :random

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 68
def self.test_order: () -> :random

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

with_info_handler

(untyped reporter) { (?) → untyped } → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 69
def self.with_info_handler: (untyped reporter) { (?) -> untyped } -> untyped

Public Instance Methods

failure

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 90
def failure: () -> untyped

marshal_dump

() → ::Array[untyped]

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 88
def marshal_dump: () -> ::Array[untyped]

marshal_load

(untyped ary) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 89
def marshal_load: (untyped ary) -> untyped

metadata ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 550
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!

Sets metadata, mainly used for Result.from.

metadata? ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 562
def metadata?
  defined? @metadata
end

Returns true if metadata exists.

name ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 405
def name
  @NAME
end

Name of the run.

name= (o)

(untyped o) → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 412
def name= o
  @NAME = o
end

Set the name of the run.

passed? ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 579
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.

Did this run pass?

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

result_code ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 588
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 ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 569
def run
  raise NotImplementedError, "subclass responsibility"
end

Runs a single method. Needs to return self.

skipped? ()

() → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/minitest-6.0.6/lib/minitest.rb, line 595
def skipped?
  raise NotImplementedError, "subclass responsibility"
end

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

time_it

() { () → untyped } → untyped

Source

# File vendor/bundle/ruby/4.0.0/gems/rbs-4.1.1/stdlib/minitest/0/minitest/runnable.rbs, line 14
def time_it: () { () -> untyped } -> untyped