Class: Minitest::Runnable
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
|
|
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 413Signal.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
# File 'lib/minitest.rb', line 463
def initialize name # :nodoc: self.name = name self.failures = [] self.assertions = 0 # lazy initializer for metadata end
Class Method Details
.inherited(klass)
# File 'lib/minitest.rb', line 1156
def self.inherited klass # :nodoc: self.runnables << klass super end
.methods_matching(re)
Returns all instance methods matching the pattern re
.
# File 'lib/minitest.rb', line 346
def self.methods_matching re public_instance_methods(true).grep(re).map(&:to_s) end
.on_signal(name, action)
.reset
# File 'lib/minitest.rb', line 350
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.
# File 'lib/minitest.rb', line 361
def self.run reporter, = {} pos = [:filter] neg = [:exclude] pos = Regexp.new $1 if pos.is_a?(String) && pos =~ %r%/(.*)/% neg = Regexp.new $1 if neg.is_a?(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? 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.
# File 'lib/minitest.rb', line 387
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
.
# File 'lib/minitest.rb', line 432
def self.runnable_methods raise NotImplementedError, "subclass responsibility" end
.runnables
Returns all subclasses of Runnable
.
# File 'lib/minitest.rb', line 439
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.
# File 'lib/minitest.rb', line 396
def self.test_order :random end
.with_info_handler(reporter, &block)
Instance Attribute Details
#assertions (rw)
Number of assertions executed in this run.
# File 'lib/minitest.rb', line 309
attr_accessor :assertions
#failures (rw)
An assertion raised during the run, if any.
# File 'lib/minitest.rb', line 314
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!
# File 'lib/minitest.rb', line 478
def @metadata ||= {} end
#metadata=(value) (rw)
Sets metadata, mainly used for Result.from.
# File 'lib/minitest.rb', line 485
attr_writer :
#metadata? ⇒ Boolean
(rw)
Returns true if metadata exists.
# File 'lib/minitest.rb', line 490
def defined? @metadata end
#name (rw)
Name of the run.
# File 'lib/minitest.rb', line 332
def name @NAME end
#name=(o) (rw)
Set the name of the run.
# File 'lib/minitest.rb', line 339
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.
# File 'lib/minitest.rb', line 507
def passed? raise NotImplementedError, "subclass responsibility" end
#skipped? ⇒ Boolean
(readonly)
Was this run skipped? See #passed? for more information.
# File 'lib/minitest.rb', line 523
def skipped? raise NotImplementedError, "subclass responsibility" end
#time (rw)
The time it took to run.
# File 'lib/minitest.rb', line 319
attr_accessor :time
Instance Method Details
#failure
# File 'lib/minitest.rb', line 459
def failure # :nodoc: self.failures.first end
#marshal_dump
# File 'lib/minitest.rb', line 445
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)
# File 'lib/minitest.rb', line 455
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"
.
# File 'lib/minitest.rb', line 516
def result_code raise NotImplementedError, "subclass responsibility" end
#run
Runs a single method. Needs to return self.
# File 'lib/minitest.rb', line 497
def run raise NotImplementedError, "subclass responsibility" end
#time_it
# File 'lib/minitest.rb', line 321
def time_it # :nodoc: t0 = Minitest.clock_time yield ensure self.time = Minitest.clock_time - t0 end