Module: MiniTest::Assertions

Included in:
Unit::TestCase
Defined in:
lib/minitest/unit.rb

Overview

MiniTest Assertions. All assertion methods accept a msg which is printed if the assertion fails.

Instance Method Summary collapse

Instance Method Details

#_assertions ⇒ Object

:nodoc:



76
77
78
 
# File 'lib/minitest/unit.rb', line 76

def _assertions # :nodoc:
  @_assertions ||= 0
end

#_assertions=(n) ⇒ Object

:nodoc:



72
73
74
 
# File 'lib/minitest/unit.rb', line 72

def _assertions= n # :nodoc:
  @_assertions = n
end

#assert(test, msg = nil) ⇒ Object

Fails unless test is a true value.



83
84
85
86
87
88
89
90
91
 
# File 'lib/minitest/unit.rb', line 83

def assert test, msg = nil
  msg ||= "Failed assertion, no message given."
  self._assertions += 1
  unless test then
    msg = msg.call if Proc === msg
    raise MiniTest::Assertion, msg
  end
  true
end

#assert_block(msg = nil) ⇒ Object

Fails unless the block returns a true value.



96
97
98
99
 
# File 'lib/minitest/unit.rb', line 96

def assert_block msg = nil
  msg = message(msg) { "Expected block to return true value" }
  assert yield, msg
end

#assert_empty(obj, msg = nil) ⇒ Object

Fails unless obj is empty.



104
105
106
107
108
 
# File 'lib/minitest/unit.rb', line 104

def assert_empty obj, msg = nil
  msg = message(msg) { "Expected #{mu_pp(obj)} to be empty" }
  assert_respond_to obj, :empty?
  assert obj.empty?, msg
end

#assert_equal(exp, act, msg = nil) ⇒ Object

Fails unless exp == act.

For floats use assert_in_delta



115
116
117
118
 
# File 'lib/minitest/unit.rb', line 115

def assert_equal exp, act, msg = nil
  msg = message(msg) { "Expected #{mu_pp(exp)}, not #{mu_pp(act)}" }
  assert(exp == act, msg)
end

#assert_in_delta(exp, act, delta = 0.001, msg = nil) ⇒ Object

For comparing Floats. Fails unless exp and act are within delta of each other.

assert_in_delta Math::PI, (22.0 / 7.0), 0.01



126
127
128
129
130
 
# File 'lib/minitest/unit.rb', line 126

def assert_in_delta exp, act, delta = 0.001, msg = nil
  n = (exp - act).abs
  msg = message(msg) { "Expected #{exp} - #{act} (#{n}) to be < #{delta}" }
  assert delta >= n, msg
end

#assert_in_epsilon(a, b, epsilon = 0.001, msg = nil) ⇒ Object

For comparing Floats. Fails unless exp and act have a relative error less than epsilon.



136
137
138
 
# File 'lib/minitest/unit.rb', line 136

def assert_in_epsilon a, b, epsilon = 0.001, msg = nil
  assert_in_delta a, b, [a, b].min * epsilon, msg
end

#assert_includes(collection, obj, msg = nil) ⇒ Object

Fails unless collection includes obj.



143
144
145
146
147
148
149
 
# File 'lib/minitest/unit.rb', line 143

def assert_includes collection, obj, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(collection)} to include #{mu_pp(obj)}"
  }
  assert_respond_to collection, :include?
  assert collection.include?(obj), msg
end

#assert_instance_of(cls, obj, msg = nil) ⇒ Object

Fails unless obj is an instace of cls.



154
155
156
157
158
159
160
 
# File 'lib/minitest/unit.rb', line 154

def assert_instance_of cls, obj, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(obj)} to be an instance of #{cls}, not #{obj.class}"
  }

  assert obj.instance_of?(cls), msg
end

#assert_kind_of(cls, obj, msg = nil) ⇒ Object

Fails unless obj is a kind of cls.



165
166
167
168
169
170
 
# File 'lib/minitest/unit.rb', line 165

def assert_kind_of cls, obj, msg = nil # TODO: merge with instance_of
  msg = message(msg) {
    "Expected #{mu_pp(obj)} to be a kind of #{cls}, not #{obj.class}" }

  assert obj.kind_of?(cls), msg
end

#assert_match(exp, act, msg = nil) ⇒ Object

Fails unless exp is =~ act.



175
176
177
178
179
180
 
# File 'lib/minitest/unit.rb', line 175

def assert_match exp, act, msg = nil
  msg = message(msg) { "Expected #{mu_pp(exp)} to match #{mu_pp(act)}" }
  assert_respond_to act, :"=~"
  exp = Regexp.new Regexp.escape exp if String === exp and String === act
  assert exp =~ act, msg
end

#assert_nil(obj, msg = nil) ⇒ Object

Fails unless obj is nil



185
186
187
188
 
# File 'lib/minitest/unit.rb', line 185

def assert_nil obj, msg = nil
  msg = message(msg) { "Expected #{mu_pp(obj)} to be nil" }
  assert obj.nil?, msg
end

#assert_operator(o1, op, o2, msg = nil) ⇒ Object

For testing equality operators and so-forth.

assert_operator 5, :<=, 4



195
196
197
198
 
# File 'lib/minitest/unit.rb', line 195

def assert_operator o1, op, o2, msg = nil
  msg = message(msg) { "Expected #{mu_pp(o1)} to be #{op} #{mu_pp(o2)}" }
  assert o1.__send__(op, o2), msg
end

#assert_output(stdout = nil, stderr = nil) ⇒ Object

Fails if stdout or stderr do not output the expected results. Pass in nil if you don’t care about that streams output. Pass in “” if you require it to be silent.

See also: #assert_silent



207
208
209
210
211
212
213
214
215
216
 
# File 'lib/minitest/unit.rb', line 207

def assert_output stdout = nil, stderr = nil
  out, err = capture_io do
    yield
  end

  x = assert_equal stdout, out, "In stdout" if stdout
  y = assert_equal stderr, err, "In stderr" if stderr

  (!stdout || x) && (!stderr || y)
end

#assert_raises(*exp) ⇒ Object

Fails unless the block raises one of exp



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/minitest/unit.rb', line 221

def assert_raises *exp
  msg = "#{exp.pop}\n" if String === exp.last

  should_raise = false
  begin
    yield
    should_raise = true
  rescue MiniTest::Skip => e
    details = "#{msg}#{mu_pp(exp)} exception expected, not"

    if exp.include? MiniTest::Skip then
      return e
    else
      raise e
    end
  rescue Exception => e
    details = "#{msg}#{mu_pp(exp)} exception expected, not"
    assert(exp.any? { |ex|
             ex.instance_of?(Module) ? e.kind_of?(ex) : ex == e.class
           }, exception_details(e, details))

    return e
  end

  exp = exp.first if exp.size == 1
  flunk "#{msg}#{mu_pp(exp)} expected but nothing was raised." if
    should_raise
end

#assert_respond_to(obj, meth, msg = nil) ⇒ Object

Fails unless obj responds to meth.



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

def assert_respond_to obj, meth, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(obj)} (#{obj.class}) to respond to ##{meth}"
  }
  assert obj.respond_to?(meth), msg
end

#assert_same(exp, act, msg = nil) ⇒ Object

Fails unless exp and act are #equal?



263
264
265
266
267
268
269
 
# File 'lib/minitest/unit.rb', line 263

def assert_same exp, act, msg = nil
  msg = message(msg) {
    data = [mu_pp(act), act.object_id, mu_pp(exp), exp.object_id]
    "Expected %s (oid=%d) to be the same as %s (oid=%d)" % data
  }
  assert exp.equal?(act), msg
end

#assert_send(send_ary, m = nil) ⇒ Object

send_ary is a receiver, message and arguments.

Fails unless the call returns a true value TODO: I should prolly remove this from specs



277
278
279
280
281
282
 
# File 'lib/minitest/unit.rb', line 277

def assert_send send_ary, m = nil
  recv, msg, *args = send_ary
  m = message(m) {
    "Expected #{mu_pp(recv)}.#{msg}(*#{mu_pp(args)}) to return true" }
  assert recv.__send__(msg, *args), m
end

#assert_silent ⇒ Object

Fails if the block outputs anything to stderr or stdout.

See also: #assert_output



289
290
291
292
293
 
# File 'lib/minitest/unit.rb', line 289

def assert_silent
  assert_output "", "" do
    yield
  end
end

#assert_throws(sym, msg = nil) ⇒ Object

Fails unless the block throws sym



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/minitest/unit.rb', line 298

def assert_throws sym, msg = nil
  default = "Expected #{mu_pp(sym)} to have been thrown"
  caught = true
  catch(sym) do
    begin
      yield
    rescue ArgumentError => e     # 1.9 exception
      default += ", not #{e.message.split(/ /).last}"
    rescue NameError => e         # 1.8 exception
      default += ", not #{e.name.inspect}"
    end
    caught = false
  end

  assert caught, message(msg) { default }
end

#capture_io ⇒ Object

Captures $stdout and $stderr into strings:

out, err = capture_io do
  warn "You did a bad thing"
end

assert_match %r%bad%, err



324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/minitest/unit.rb', line 324

def capture_io
  require 'stringio'

  orig_stdout, orig_stderr         = $stdout, $stderr
  captured_stdout, captured_stderr = StringIO.new, StringIO.new
  $stdout, $stderr                 = captured_stdout, captured_stderr

  yield

  return captured_stdout.string, captured_stderr.string
ensure
  $stdout = orig_stdout
  $stderr = orig_stderr
end

#exception_details(e, msg) ⇒ Object

Returns details for exception e



342
343
344
345
346
347
348
349
350
351
 
# File 'lib/minitest/unit.rb', line 342

def exception_details e, msg
  [
   "#{msg}",
   "Class: <#{e.class}>",
   "Message: <#{e.message.inspect}>",
   "---Backtrace---",
   "#{MiniTest::filter_backtrace(e.backtrace).join("\n")}",
   "---------------",
  ].join "\n"
end

#flunk(msg = nil) ⇒ Object

Fails with msg



356
357
358
359
 
# File 'lib/minitest/unit.rb', line 356

def flunk msg = nil
  msg ||= "Epic Fail!"
  assert false, msg
end

#message(msg = nil, &default) ⇒ Object

Returns a proc that will output msg along with the default message.



364
365
366
367
368
369
 
# File 'lib/minitest/unit.rb', line 364

def message msg = nil, &default
  proc {
    custom_message = "#{msg}.\n" unless msg.nil? or msg.to_s.empty?
    "#{custom_message}#{default.call}."
  }
end

#mu_pp(obj) ⇒ Object

mu_pp gives a human-readable version of obj. By default #inspect is called. You can override this to use #pretty_print if you want.



66
67
68
69
70
 
# File 'lib/minitest/unit.rb', line 66

def mu_pp obj
  s = obj.inspect
  s = s.force_encoding Encoding.default_external if defined? Encoding
  s
end

#pass(msg = nil) ⇒ Object

used for counting assertions



374
375
376
 
# File 'lib/minitest/unit.rb', line 374

def pass msg = nil
  assert true
end

#refute(test, msg = nil) ⇒ Object

Fails if test is a true value



381
382
383
384
 
# File 'lib/minitest/unit.rb', line 381

def refute test, msg = nil
  msg ||= "Failed refutation, no message given"
  not assert(! test, msg)
end

#refute_empty(obj, msg = nil) ⇒ Object

Fails if obj is empty.



389
390
391
392
393
 
# File 'lib/minitest/unit.rb', line 389

def refute_empty obj, msg = nil
  msg = message(msg) { "Expected #{obj.inspect} to not be empty" }
  assert_respond_to obj, :empty?
  refute obj.empty?, msg
end

#refute_equal(exp, act, msg = nil) ⇒ Object

Fails if exp == act.

For floats use refute_in_delta.



400
401
402
403
404
405
 
# File 'lib/minitest/unit.rb', line 400

def refute_equal exp, act, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(act)} to not be equal to #{mu_pp(exp)}"
  }
  refute exp == act, msg
end

#refute_in_delta(exp, act, delta = 0.001, msg = nil) ⇒ Object

For comparing Floats. Fails if exp is within delta of act

refute_in_delta Math::PI, (22.0 / 7.0)



412
413
414
415
416
417
418
 
# File 'lib/minitest/unit.rb', line 412

def refute_in_delta exp, act, delta = 0.001, msg = nil
  n = (exp - act).abs
  msg = message(msg) {
    "Expected #{exp} - #{act} (#{n}) to not be < #{delta}"
  }
  refute delta > n, msg
end

#refute_in_epsilon(a, b, epsilon = 0.001, msg = nil) ⇒ Object

For comparing Floats. Fails if exp and act have a relative error less than epsilon.



424
425
426
 
# File 'lib/minitest/unit.rb', line 424

def refute_in_epsilon a, b, epsilon = 0.001, msg = nil
  refute_in_delta a, b, a * epsilon, msg
end

#refute_includes(collection, obj, msg = nil) ⇒ Object

Fails if collection includes obj



431
432
433
434
435
436
437
 
# File 'lib/minitest/unit.rb', line 431

def refute_includes collection, obj, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(collection)} to not include #{mu_pp(obj)}"
  }
  assert_respond_to collection, :include?
  refute collection.include?(obj), msg
end

#refute_instance_of(cls, obj, msg = nil) ⇒ Object

Fails if obj is an instance of cls



442
443
444
445
446
447
 
# File 'lib/minitest/unit.rb', line 442

def refute_instance_of cls, obj, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(obj)} to not be an instance of #{cls}"
  }
  refute obj.instance_of?(cls), msg
end

#refute_kind_of(cls, obj, msg = nil) ⇒ Object

Fails if obj is a kind of cls



452
453
454
455
 
# File 'lib/minitest/unit.rb', line 452

def refute_kind_of cls, obj, msg = nil # TODO: merge with instance_of
  msg = message(msg) { "Expected #{mu_pp(obj)} to not be a kind of #{cls}" }
  refute obj.kind_of?(cls), msg
end

#refute_match(exp, act, msg = nil) ⇒ Object

Fails if exp =~ act



460
461
462
463
464
465
 
# File 'lib/minitest/unit.rb', line 460

def refute_match exp, act, msg = nil
  msg = message(msg) { "Expected #{mu_pp(exp)} to not match #{mu_pp(act)}" }
  assert_respond_to act, :"=~"
  exp = (/#{Regexp.escape exp}/) if String === exp and String === act
  refute exp =~ act, msg
end

#refute_nil(obj, msg = nil) ⇒ Object

Fails if obj is nil.



470
471
472
473
 
# File 'lib/minitest/unit.rb', line 470

def refute_nil obj, msg = nil
  msg = message(msg) { "Expected #{mu_pp(obj)} to not be nil" }
  refute obj.nil?, msg
end

#refute_operator(o1, op, o2, msg = nil) ⇒ Object

Fails if o1 is not op o2 nil. eg:

refute_operator 1, :>, 2 #=> pass
refute_operator 1, :<, 2 #=> fail



481
482
483
484
485
486
 
# File 'lib/minitest/unit.rb', line 481

def refute_operator o1, op, o2, msg = nil
  msg = message(msg) {
    "Expected #{mu_pp(o1)} to not be #{op} #{mu_pp(o2)}"
  }
  refute o1.__send__(op, o2), msg
end

#refute_respond_to(obj, meth, msg = nil) ⇒ Object

Fails if obj responds to the message meth.



491
492
493
494
495
 
# File 'lib/minitest/unit.rb', line 491

def refute_respond_to obj, meth, msg = nil
  msg = message(msg) { "Expected #{mu_pp(obj)} to not respond to #{meth}" }

  refute obj.respond_to?(meth), msg
end

#refute_same(exp, act, msg = nil) ⇒ Object

Fails if exp is the same (by object identity) as act.



500
501
502
503
504
505
506
 
# File 'lib/minitest/unit.rb', line 500

def refute_same exp, act, msg = nil
  msg = message(msg) {
    data = [mu_pp(act), act.object_id, mu_pp(exp), exp.object_id]
    "Expected %s (oid=%d) to not be the same as %s (oid=%d)" % data
  }
  refute exp.equal?(act), msg
end

#skip(msg = nil, bt = caller) ⇒ Object

Skips the current test. Gets listed at the end of the run but doesn’t cause a failure exit code.

Raises:



512
513
514
515
 
# File 'lib/minitest/unit.rb', line 512

def skip msg = nil, bt = caller
  msg ||= "Skipped, no message given"
  raise MiniTest::Skip, msg, bt
end