Module: MiniTest::Assertions

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

- (Object) _assertions

:nodoc:



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

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

- (Object) _assertions=(n)

:nodoc:



69
70
71
# File 'lib/minitest/unit.rb', line 69

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

- (Object) assert(test, msg = nil)

Fails unless test is a true value.



80
81
82
83
84
85
86
87
88
# File 'lib/minitest/unit.rb', line 80

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

- (Object) assert_block(msg = nil)

Fails unless the block returns a true value.



93
94
95
# File 'lib/minitest/unit.rb', line 93

def assert_block msg = nil
  assert yield, "Expected block to return true value."
end

- (Object) assert_empty(obj, msg = nil)

Fails unless obj is empty.



100
101
102
103
104
# File 'lib/minitest/unit.rb', line 100

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

- (Object) assert_equal(exp, act, msg = nil)

Fails unless exp == act.

For floats use assert_in_delta



111
112
113
114
# File 'lib/minitest/unit.rb', line 111

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

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

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


122
123
124
125
126
# File 'lib/minitest/unit.rb', line 122

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

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

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



132
133
134
# File 'lib/minitest/unit.rb', line 132

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

- (Object) assert_includes(collection, obj, msg = nil)

Fails unless collection includes obj.



139
140
141
142
143
144
145
# File 'lib/minitest/unit.rb', line 139

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

- (Object) assert_instance_of(cls, obj, msg = nil)

Fails unless obj is an instace of cls.



150
151
152
153
154
155
156
# File 'lib/minitest/unit.rb', line 150

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

- (Object) assert_kind_of(cls, obj, msg = nil)

Fails unless obj is a kind of cls.



161
162
163
164
165
166
# File 'lib/minitest/unit.rb', line 161

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

- (Object) assert_match(exp, act, msg = nil)

Fails unless exp is =~ act.



171
172
173
174
175
176
# File 'lib/minitest/unit.rb', line 171

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.escape exp}/ if String === exp && String === act
  assert exp =~ act, msg
end

- (Object) assert_nil(obj, msg = nil)

Fails unless obj is nil



181
182
183
184
# File 'lib/minitest/unit.rb', line 181

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

- (Object) assert_operator(o1, op, o2, msg = nil)

For testing equality operators and so-forth.

assert_operator 5, :<=, 4


191
192
193
194
# File 'lib/minitest/unit.rb', line 191

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

- (Object) assert_raises(*exp)

Fails unless the block raises one of exp



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
# File 'lib/minitest/unit.rb', line 199

def assert_raises *exp
  msg = String === exp.last ? exp.pop : nil
  msg = msg.to_s + "\n" if msg
  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

- (Object) assert_respond_to(obj, meth, msg = nil)

Fails unless obj responds to meth.



231
232
233
234
235
236
# File 'lib/minitest/unit.rb', line 231

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

- (Object) assert_same(exp, act, msg = nil)

Fails unless exp and act are #equal?



241
242
243
244
245
246
247
# File 'lib/minitest/unit.rb', line 241

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

- (Object) assert_send(send_ary, m = nil)

send_ary is a receiver, message and arguments.

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



255
256
257
258
259
260
# File 'lib/minitest/unit.rb', line 255

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

- (Object) assert_throws(sym, msg = nil)

Fails unless the block throws sym



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/minitest/unit.rb', line 265

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

- (Object) capture_io

Captures $stdout and $stderr into strings:

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

assert_match %r%bad%, err


291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/minitest/unit.rb', line 291

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

- (Object) exception_details(e, msg)

Returns details for exception e



309
310
311
# File 'lib/minitest/unit.rb', line 309

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

- (Object) flunk(msg = nil)

Fails with msg



316
317
318
319
# File 'lib/minitest/unit.rb', line 316

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

- (Object) message(msg = nil, &default)

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



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

def message msg = nil, &default
  proc {
    if msg then
      msg = msg.to_s unless String === msg
      msg += '.' unless msg.empty?
      msg += "\n#{default.call}."
      msg.strip
    else
      "#{default.call}."
    end
  }
end

- (Object) mu_pp(obj)

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.



63
64
65
66
67
# File 'lib/minitest/unit.rb', line 63

def mu_pp obj
  s = obj.inspect
  s = s.encode(Encoding.default_external) if defined? Encoding
  s
end

- (Object) pass(msg = nil)

used for counting assertions



340
341
342
# File 'lib/minitest/unit.rb', line 340

def pass msg = nil
  assert true
end

- (Object) refute(test, msg = nil)

Fails if test is a true value



347
348
349
350
# File 'lib/minitest/unit.rb', line 347

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

- (Object) refute_empty(obj, msg = nil)

Fails if obj is empty.



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

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

- (Object) refute_equal(exp, act, msg = nil)

Fails if exp == act.

For floats use refute_in_delta.



366
367
368
369
370
371
# File 'lib/minitest/unit.rb', line 366

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

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

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

refute_in_delta Math::PI, (22.0 / 7.0)


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

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

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

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



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

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

- (Object) refute_includes(collection, obj, msg = nil)

Fails if collection includes obj



397
398
399
400
401
402
403
# File 'lib/minitest/unit.rb', line 397

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

- (Object) refute_instance_of(cls, obj, msg = nil)

Fails if obj is an instance of cls



408
409
410
411
412
413
# File 'lib/minitest/unit.rb', line 408

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

- (Object) refute_kind_of(cls, obj, msg = nil)

Fails if obj is a kind of cls



418
419
420
421
# File 'lib/minitest/unit.rb', line 418

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

- (Object) refute_match(exp, act, msg = nil)

Fails if exp =~ act



426
427
428
429
430
431
# File 'lib/minitest/unit.rb', line 426

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

- (Object) refute_nil(obj, msg = nil)

Fails if obj is nil.



436
437
438
439
# File 'lib/minitest/unit.rb', line 436

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

- (Object) refute_operator(o1, op, o2, msg = nil)

Fails if o1 is not op o2 nil. eg:

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


447
448
449
450
451
452
# File 'lib/minitest/unit.rb', line 447

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

- (Object) refute_respond_to(obj, meth, msg = nil)

Fails if obj responds to the message meth.



457
458
459
460
461
# File 'lib/minitest/unit.rb', line 457

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

- (Object) refute_same(exp, act, msg = nil)

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



466
467
468
469
470
471
472
# File 'lib/minitest/unit.rb', line 466

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

- (Object) skip(msg = nil, bt = caller)

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

Raises:



478
479
480
481
# File 'lib/minitest/unit.rb', line 478

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