class Minitest::Runnable - minitest: Ruby Standard Library Documentation

# 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.25.4/lib/minitest.rb, line 390
    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.25.4/lib/minitest.rb, line 405
    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

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.25.4/lib/minitest.rb, line 445
    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.25.4/lib/minitest.rb, line 481
    def self.runnable_methods
      raise NotImplementedError, "subclass responsibility"
    end

runnables() click to toggle source

Returns all subclasses of Runnable.

    # File minitest-5.25.4/lib/minitest.rb, line 488
    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.25.4/lib/minitest.rb, line 454
    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.25.4/lib/minitest.rb, line 527
    def metadata
      @metadata ||= {}
    end

metadata?() click to toggle source

Returns true if metadata exists.

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

name() click to toggle source

Name of the run.

    # File minitest-5.25.4/lib/minitest.rb, line 376
    def name
      @NAME
    end

name=(o) click to toggle source

Set the name of the run.

    # File minitest-5.25.4/lib/minitest.rb, line 383
    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.25.4/lib/minitest.rb, line 556
    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.25.4/lib/minitest.rb, line 565
    def result_code
      raise NotImplementedError, "subclass responsibility"
    end

run() click to toggle source

Runs a single method. Needs to return self.

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

skipped?() click to toggle source

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

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