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.

Public Class Methods

methods_matching(re) Show source

Returns all instance methods matching the pattern re.

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

run(reporter, options = {}) Show 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 lib/minitest.rb, line 291
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

run_one_method(klass, method_name, reporter) Show 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 lib/minitest.rb, line 321
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() Show source

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

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

runnables() Show source

Returns all subclasses of Runnable.

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

Public Instance Methods

name() Show source

Name of the run.

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

name=(o) Show source

Set the name of the run.

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

passed?() Show source

Did this run pass?

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

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

result_code() Show source

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

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

run() Show source

Runs a single method. Needs to return self.

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

skipped?() Show source

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

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