Class: Minitest::Runnable

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses: BenchSpec, Benchmark, Result, Spec, Test, Unit::TestCase
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 398
```
Signal.list
```

Class Method Summary

.methods_matching(re)

Returns all instance methods matching the pattern re.
.run(reporter, options = {})

Responsible for running all runnable methods in a given class, each in its own instance.
.run_one_method(klass, method_name, reporter)

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

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

Returns all subclasses of Runnable.
.test_order

Defines the order to run tests (:random by default).
.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, &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
#marshal_dump Internal use only
#marshal_load(ary) 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 448


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

Class Method Details

.inherited(klass)

This method is for internal use only.

[ GitHub ]

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


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 321


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 400


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 325


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

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


def self.run reporter, options = {}
  filtered_methods = if options[:filter]
    filter = options[:filter]
    filter = Regexp.new $1 if filter.is_a?(String) && filter =~ %r%/(.*)/%

    self.runnable_methods.find_all { |m|
      filter === m || filter === "#{self}##{m}"
    }
  else
    self.runnable_methods
  end

  if options[:exclude]
    exclude = options[:exclude]
    exclude = Regexp.new $1 if exclude =~ %r%/(.*)/%

    filtered_methods.delete_if { |m|
      exclude === m || exclude === "#{self}##{m}"
    }
  end

  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)

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 372


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

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 417


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

.runnables

Returns all subclasses of Runnable.

[ GitHub ]

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


def self.runnables
  @@runnables
end

.test_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 381


def self.test_order
  :random
end

.with_info_handler(reporter, &block)

This method is for internal use only.

[ GitHub ]

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


def self.with_info_handler reporter, &block # :nodoc:
  handler = lambda do
    unless reporter.passed? then
      warn "Current results:"
      warn ""
      warn reporter.reporters.first
      warn ""
    end
  end

  on_signal ::Minitest.info_signal, handler, &block
end

Instance Attribute Details

#assertions (rw)

Number of assertions executed in this run.

[ GitHub ]

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


attr_accessor :assertions

#failures (rw)

An assertion raised during the run, if any.

[ GitHub ]

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


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 463


def metadata
  @metadata ||= {}
end

#metadata=(value) (rw)

Sets metadata, mainly used for Result.from.

[ GitHub ]

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


attr_writer :metadata

#metadata? ⇒ `Boolean` (rw)

Returns true if metadata exists.

[ GitHub ]

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


def metadata?
  defined? @metadata
end

#name (rw)

Name of the run.

[ GitHub ]

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


def name
  @NAME
end

#name=(o) (rw)

Set the name of the run.

[ GitHub ]

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


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 492


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 508


def skipped?
  raise NotImplementedError, "subclass responsibility"
end

#time (rw)

The time it took to run.

[ GitHub ]

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


attr_accessor :time

Instance Method Details

#failure

This method is for internal use only.

[ GitHub ]

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


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

#marshal_dump

This method is for internal use only.

[ GitHub ]

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


def marshal_dump # :nodoc:
  unless @@marshal_dump_warned then
    warn ["Minitest::Runnable#marshal_dump is deprecated.",
          "You might be violating internals. From", caller.first].join " "
    @@marshal_dump_warned = true
  end

  [self.name, self.failures, self.assertions, self.time]
end

#marshal_load(ary)

This method is for internal use only.

[ GitHub ]

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


def marshal_load ary # :nodoc:
  self.name, self.failures, self.assertions, self.time = ary
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 501


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 482


def run
  raise NotImplementedError, "subclass responsibility"
end

#time_it

This method is for internal use only.

[ GitHub ]

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


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

.inherited(klass)

.methods_matching(re)

.on_signal(name, action)

.reset

.run(reporter, options = {})

.run_one_method(klass, method_name, reporter)

.runnable_methods

.runnables

.test_order

.with_info_handler(reporter, &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

#marshal_dump

#marshal_load(ary)

#result_code

#run

#time_it

.new(name) ⇒ `Runnable`

#metadata? ⇒ `Boolean` (rw)

#passed? ⇒ `Boolean` (readonly)

#skipped? ⇒ `Boolean` (readonly)