Class: Minitest::Test

Inherits:
Runnable show all
Extended by:
Guard
Includes:
Assertions, Guard, LifecycleHooks
Defined in:
lib/minitest/test.rb,
lib/minitest/hell.rb

Overview

Subclass Test to create your own tests. Typically you’ll want a Test subclass per implementation class.

See Minitest::Assertions

Direct Known Subclasses

Benchmark, Spec, Unit::TestCase

Defined Under Namespace

Modules: LifecycleHooks

Constant Summary collapse

PASSTHROUGH_EXCEPTIONS =

:nodoc:

[NoMemoryError, SignalException, SystemExit]
TEARDOWN_METHODS =

:nodoc:

%w[ before_teardown teardown after_teardown ]

Constants included from Assertions

Assertions::E, Assertions::UNDEFINED

Constants inherited from Runnable

Runnable::SIGNALS

Class Attribute Summary collapse

Instance Attribute Summary collapse

Attributes inherited from Runnable

#assertions, #failures

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Guard

jruby?, maglev?, mri?, rubinius?, windows?

Methods included from LifecycleHooks

#after_setup, #after_teardown, #before_setup, #before_teardown, #setup, #teardown

Methods included from Assertions

#_synchronize, #assert, #assert_empty, #assert_equal, #assert_in_delta, #assert_in_epsilon, #assert_includes, #assert_instance_of, #assert_kind_of, #assert_match, #assert_mock, #assert_nil, #assert_operator, #assert_output, #assert_predicate, #assert_raises, #assert_respond_to, #assert_same, #assert_send, #assert_silent, #assert_throws, #capture_io, #capture_subprocess_io, #diff, diff, diff=, #exception_details, #flunk, #message, #mu_pp, #mu_pp_for_diff, #pass, #refute, #refute_empty, #refute_equal, #refute_in_delta, #refute_in_epsilon, #refute_includes, #refute_instance_of, #refute_kind_of, #refute_match, #refute_nil, #refute_operator, #refute_predicate, #refute_respond_to, #refute_same, #skip

Methods inherited from Runnable

#failure, inherited, #initialize, methods_matching, #name, #name=, on_signal, reset, run, run_one_method, runnables, with_info_handler

Constructor Details

This class inherits a constructor from Minitest::Runnable

Class Attribute Details

.io_lock ⇒ Object

Returns the value of attribute io_lock.



16
17
18
 
# File 'lib/minitest/test.rb', line 16

def io_lock
  @io_lock
end

Instance Attribute Details

#time ⇒ Object

The time it took to run this test.



83
84
85
 
# File 'lib/minitest/test.rb', line 83

def time
  @time
end

Class Method Details

.i_suck_and_my_tests_are_order_dependent! ⇒ Object

Call this at the top of your tests when you absolutely positively need to have ordered tests. In doing so, you’re admitting that you suck and your tests are weak.



24
25
26
27
28
29
 
# File 'lib/minitest/test.rb', line 24

def self.i_suck_and_my_tests_are_order_dependent!
  class << self
    undef_method :test_order if method_defined? :test_order
    define_method :test_order do :alpha end
  end
end

.make_my_diffs_pretty! ⇒ Object

Make diffs for this Test use #pretty_inspect so that diff in assert_equal can have more details. NOTE: this is much slower than the regular inspect but much more usable for complex objects.



37
38
39
40
41
 
# File 'lib/minitest/test.rb', line 37

def self.make_my_diffs_pretty!
  require "pp"

  define_method :mu_pp, &:pretty_inspect
end

.old_test_order ⇒ Object

:nodoc:



5
 
# File 'lib/minitest/hell.rb', line 5

alias :old_test_order :test_order

.parallelize_me! ⇒ Object

Call this at the top of your tests when you want to run your tests in parallel. In doing so, you’re admitting that you rule and your tests are awesome.



48
49
50
51
 
# File 'lib/minitest/test.rb', line 48

def self.parallelize_me!
  include Minitest::Parallel::Test
  extend Minitest::Parallel::Test::ClassMethods
end

.runnable_methods ⇒ Object

Returns all instance methods starting with “test_”. Based on #test_order, the methods are either sorted, randomized (default), or run in parallel.



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/minitest/test.rb', line 58

def self.runnable_methods
  methods = methods_matching(/^test_/)

  case self.test_order
  when :random, :parallel then
    max = methods.size
    methods.sort.sort_by { rand max }
  when :alpha, :sorted then
    methods.sort
  else
    raise "Unknown test_order: #{self.test_order.inspect}"
  end
end

.test_order ⇒ Object

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



7
8
9
 
# File 'lib/minitest/hell.rb', line 7

def test_order # :nodoc:
  :parallel
end

Instance Method Details

#capture_exceptions ⇒ Object

LifecycleHooks



201
202
203
204
205
206
207
208
209
 
# File 'lib/minitest/test.rb', line 201

def capture_exceptions # :nodoc:
  yield
rescue *PASSTHROUGH_EXCEPTIONS
  raise
rescue Assertion => e
  self.failures << e
rescue Exception => e
  self.failures << UnexpectedError.new(e)
end

#error? ⇒ Boolean

Did this run error?

Returns:

  • (Boolean) 


214
215
216
 
# File 'lib/minitest/test.rb', line 214

def error?
  self.failures.any? { |f| UnexpectedError === f }
end

#location ⇒ Object

The location identifier of this test.



221
222
223
224
 
# File 'lib/minitest/test.rb', line 221

def location
  loc = " [#{self.failure.location}]" unless passed? or error?
  "#{self.class}##{self.name}#{loc}"
end

#marshal_dump ⇒ Object

:nodoc:



85
86
87
 
# File 'lib/minitest/test.rb', line 85

def marshal_dump # :nodoc:
  super << self.time
end

#marshal_load(ary) ⇒ Object

:nodoc:



89
90
91
92
 
# File 'lib/minitest/test.rb', line 89

def marshal_load ary # :nodoc:
  self.time = ary.pop
  super
end

#passed? ⇒ Boolean

Did this run pass?

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

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/minitest/test.rb', line 232

def passed?
  not self.failure
end

#result_code ⇒ Object

Returns “.”, “F”, or “E” based on the result of the run.



239
240
241
 
# File 'lib/minitest/test.rb', line 239

def result_code
  self.failure and self.failure.result_code or "."
end

#run ⇒ Object

Runs a single test with setup/teardown hooks.



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/minitest/test.rb', line 99

def run
  with_info_handler do
    time_it do
      capture_exceptions do
        before_setup; setup; after_setup

        self.send self.name
      end

      TEARDOWN_METHODS.each do |hook|
        capture_exceptions do
          self.send hook
        end
      end
    end
  end

  self # per contract
end

#skipped? ⇒ Boolean

Was this run skipped?

Returns:

  • (Boolean) 


246
247
248
 
# File 'lib/minitest/test.rb', line 246

def skipped?
  self.failure and Skip === self.failure
end

#time_it ⇒ Object

:nodoc:



250
251
252
253
254
255
256
 
# File 'lib/minitest/test.rb', line 250

def time_it # :nodoc:
  t0 = Minitest.clock_time

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

#to_s ⇒ Object

:nodoc:



258
259
260
261
262
263
264
 
# File 'lib/minitest/test.rb', line 258

def to_s # :nodoc:
  return location if passed? and not skipped?

  failures.map { |failure|
    "#{failure.result_label}:\n#{self.location}:\n#{failure.message}\n"
  }.join "\n"
end

#with_info_handler(&block) ⇒ Object

:nodoc:



266
267
268
269
270
271
272
273
274
 
# File 'lib/minitest/test.rb', line 266

def with_info_handler &block # :nodoc:
  t0 = Minitest.clock_time

  handler = lambda do
    warn "\nCurrent: %s#%s %.2fs" % [self.class, self.name, Minitest.clock_time - t0]
  end

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