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_lockObject

Returns the value of attribute io_lock



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

def io_lock
  @io_lock
end

Instance Attribute Details

#timeObject

The time it took to run this test.



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

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.



26
27
28
29
30
31
# File 'lib/minitest/test.rb', line 26

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.



39
40
41
42
43
# File 'lib/minitest/test.rb', line 39

def self.make_my_diffs_pretty!
  require "pp"

  define_method :mu_pp, &:pretty_inspect
end

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



50
51
52
53
# File 'lib/minitest/test.rb', line 50

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

.runnable_methodsObject

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



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

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_orderObject

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



78
79
80
# File 'lib/minitest/test.rb', line 78

def self.test_order
  :random
end

Instance Method Details

#capture_exceptionsObject

LifecycleHooks



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

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)


216
217
218
# File 'lib/minitest/test.rb', line 216

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

#locationObject

The location identifier of this test.



223
224
225
226
# File 'lib/minitest/test.rb', line 223

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

#marshal_dumpObject

:nodoc:



87
88
89
# File 'lib/minitest/test.rb', line 87

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

#marshal_load(ary) ⇒ Object

:nodoc:



91
92
93
94
# File 'lib/minitest/test.rb', line 91

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)


234
235
236
# File 'lib/minitest/test.rb', line 234

def passed?
  not self.failure
end

#result_codeObject

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



241
242
243
# File 'lib/minitest/test.rb', line 241

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

#runObject

Runs a single test with setup/teardown hooks.



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

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)


248
249
250
# File 'lib/minitest/test.rb', line 248

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

#time_itObject

:nodoc:



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

def time_it # :nodoc:
  t0 = Minitest.clock_time

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

#to_sObject

:nodoc:



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

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:



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

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