Class: Minitest::Runnable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: BenchSpec, Benchmark, Result, Spec, Test
Inherits:	Object
Defined in:	lib/minitest.rb, lib/minitest.rb

Overview

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

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

Constant Summary

SIGNALS = Internal use only
# File 'lib/minitest.rb', line 495
```
Signal.list
```

Class Method Summary

.filter_runnable_methods(options = {})

Returns an array of filtered .runnable_methods.
.methods_matching(re)

Returns all instance methods matching the pattern re.
.run(klass, method_name, reporter)

Runs a single method and has the reporter record the result.
.run_order

Defines the order to run tests (:random by default).
.run_suite(reporter, options = {})

Responsible for running all runnable methods in a given class, each in its own instance.
.runnable_methods

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

Returns all subclasses of Runnable.
.inherited(klass) Internal use only
.new(name) ⇒ Runnable constructor Internal use only
.on_signal(name, action) Internal use only
.reset Internal use only
.with_info_handler(_reporter = nil, &block) Internal use only

Instance Attribute Summary

#assertions rw

Number of assertions executed in this run.
#failures rw

An assertion raised during the run, if any.
#metadata rw

Metadata you attach to the test results that get sent to the reporter.
#metadata=(value) rw

Sets metadata, mainly used for Result.from.
#metadata? ⇒ Boolean rw

Returns true if metadata exists.
#name rw

Name of the run.
#name=(o) rw

Set the name of the run.
#passed? ⇒ Boolean readonly

Did this run pass?
#skipped? ⇒ Boolean readonly

Was this run skipped? See #passed? for more information.
#time rw

The time it took to run.

Instance Method Summary

#result_code

Returns a single character string to print based on the result of the run.
#run

Runs a single method.
#failure Internal use only
#time_it Internal use only

Constructor Details

.new(name) ⇒ `Runnable`

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 529


def initialize name # :nodoc:
  self.name       = name
  self.failures   = []
  self.assertions = 0
  # lazy initializer for metadata
end

Class Method Details

.filter_runnable_methods(options = {})

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

[ GitHub ]

# File 'lib/minitest.rb', line 428


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

.inherited(klass)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 1213


def self.inherited klass # :nodoc:
  self.runnables << klass
  super
end

.methods_matching(re)

Returns all instance methods matching the pattern re.

[ GitHub ]

# File 'lib/minitest.rb', line 413


def self.methods_matching re
  public_instance_methods(true).grep(re).map(&:to_s)
end

.on_signal(name, action)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 497


def self.on_signal name, action # :nodoc:
  supported = SIGNALS[name]

  old_trap = trap name do
    old_trap.call if old_trap.respond_to? :call
    action.call
  end if supported

  yield
ensure
  trap name, old_trap if supported
end

.reset

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 417


def self.reset # :nodoc:
  @@runnables = []
end

.run(klass, method_name, reporter)

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.

[ GitHub ]

# File 'lib/minitest.rb', line 478


def Runnable.run klass, method_name, reporter
  reporter.prerecord klass, method_name
  reporter.record klass.new(method_name).run
end

.run_order

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

[ GitHub ]

# File 'lib/minitest.rb', line 487


def self.run_order
  :random
end

.run_suite(reporter, options = {})

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

[ GitHub ]

# File 'lib/minitest.rb', line 446


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

.runnable_methods

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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/minitest.rb', line 514


def self.runnable_methods
  raise NotImplementedError, "subclass responsibility"
end

.runnables

Returns all subclasses of Runnable.

[ GitHub ]

# File 'lib/minitest.rb', line 521


def self.runnables
  @@runnables
end

.with_info_handler(_reporter = nil, &block)

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 491


def self.with_info_handler _reporter=nil, &block # :nodoc:
  on_signal ::Minitest.info_signal, @_info_handler, &block
end

Instance Attribute Details

#assertions (rw)

Number of assertions executed in this run.

[ GitHub ]

# File 'lib/minitest.rb', line 376


attr_accessor :assertions

#failures (rw)

An assertion raised during the run, if any.

[ GitHub ]

# File 'lib/minitest.rb', line 381


attr_accessor :failures

#metadata (rw)

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!

[ GitHub ]

# File 'lib/minitest.rb', line 544


def metadata
  @metadata ||= {}
end

#metadata=(value) (rw)

Sets metadata, mainly used for Result.from.

[ GitHub ]

# File 'lib/minitest.rb', line 551


attr_writer :metadata

#metadata? ⇒ `Boolean` (rw)

Returns true if metadata exists.

[ GitHub ]

# File 'lib/minitest.rb', line 556


def metadata?
  defined? @metadata
end

#name (rw)

Name of the run.

[ GitHub ]

# File 'lib/minitest.rb', line 399


def name
  @NAME
end

#name=(o) (rw)

Set the name of the run.

[ GitHub ]

# File 'lib/minitest.rb', line 406


def name= o
  @NAME = o
end

#passed? ⇒ `Boolean` (readonly)

Did this run pass?

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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/minitest.rb', line 573


def passed?
  raise NotImplementedError, "subclass responsibility"
end

#skipped? ⇒ `Boolean` (readonly)

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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/minitest.rb', line 589


def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time (rw)

The time it took to run.

[ GitHub ]

# File 'lib/minitest.rb', line 386


attr_accessor :time

Instance Method Details

#failure

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 525


def failure # :nodoc:
  self.failures.first
end

#result_code

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

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/minitest.rb', line 582


def result_code
  raise NotImplementedError, "subclass responsibility"
end

#run

Runs a single method. Needs to return self.

Raises:

(NotImplementedError)

[ GitHub ]

# File 'lib/minitest.rb', line 563


def run
  raise NotImplementedError, "subclass responsibility"
end

#time_it

This method is for internal use only.

[ GitHub ]

# File 'lib/minitest.rb', line 388


def time_it # :nodoc:
  t0 = Minitest.clock_time

  yield
ensure
  self.time = Minitest.clock_time - t0
end

Class: Minitest::Runnable

Overview

Constant Summary

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(name) ⇒ Runnable

Class Method Details

.filter_runnable_methods(options = {})

.inherited(klass)

.methods_matching(re)

.on_signal(name, action)

.reset

.run(klass, method_name, reporter)

.run_order

.run_suite(reporter, options = {})

.runnable_methods

.runnables

.with_info_handler(_reporter = nil, &block)

Instance Attribute Details

#assertions (rw)

#failures (rw)

#metadata (rw)

#metadata=(value) (rw)

#metadata? ⇒ Boolean (rw)

#name (rw)

#name=(o) (rw)

#passed? ⇒ Boolean (readonly)

#skipped? ⇒ Boolean (readonly)

#time (rw)

Instance Method Details

#failure

#result_code

#run

#time_it

.new(name) ⇒ `Runnable`

#metadata? ⇒ `Boolean` (rw)

#passed? ⇒ `Boolean` (readonly)

#skipped? ⇒ `Boolean` (readonly)