Module: Minitest::Assertions

Included in:
Test
Defined in:
lib/minitest/assertions.rb,
lib/minitest/mock.rb

Overview

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

Protocol: Nearly everything here boils up to assert, which expects to be able to increment an instance accessor named assertions. This is not provided by Assertions and must be provided by the thing including Assertions. See Minitest::Runnable for an example.

Constant Summary collapse

UNDEFINED =

:nodoc:

Object.new
E =

:nodoc:

""

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.diff ⇒ Object

Returns the diff command to use in #diff. Tries to intelligently figure out what diff to use.



29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/minitest/assertions.rb', line 29

def self.diff
  return @diff if defined? @diff

  @diff = if (RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ &&
              system("diff.exe", __FILE__, __FILE__)) then
            "diff.exe -u"
          elsif system("gdiff", __FILE__, __FILE__)
            "gdiff -u" # solaris and kin suck
          elsif system("diff", __FILE__, __FILE__)
            "diff -u"
          else
            nil
          end
end

.diff=(o) ⇒ Object

Set the diff command to use in #diff.



47
48
49
 
# File 'lib/minitest/assertions.rb', line 47

def self.diff= o
  @diff = o
end

Instance Method Details

#_synchronize ⇒ Object

:nodoc:



188
189
190
 
# File 'lib/minitest/assertions.rb', line 188

def _synchronize # :nodoc:
  yield
end

#assert(test, msg = nil) ⇒ Object

Fails unless test is truthy.



178
179
180
181
182
183
184
185
186
 
# File 'lib/minitest/assertions.rb', line 178

def assert test, msg = nil
  self.assertions += 1
  unless test then
    msg ||= "Expected #{mu_pp test} to be truthy."
    msg = msg.call if Proc === msg
    raise Minitest::Assertion, msg
  end
  true
end

#assert_empty(obj, msg = nil) ⇒ Object

Fails unless obj is empty.



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

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 printing the difference between the two, if possible.

If there is no visible difference but the assertion fails, you should suspect that your #== is buggy, or your inspect output is missing crucial details. For nicer structural diffing, set Minitest::Test.make_my_diffs_pretty!

For floats use assert_in_delta.

See also: Minitest::Assertions.diff



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/minitest/assertions.rb', line 216

def assert_equal exp, act, msg = nil
  msg = message(msg, E) { diff exp, act }
  result = assert exp == act, msg

  if nil == exp then
    if Minitest::VERSION =~ /^6/ then
      refute_nil exp, "Use assert_nil if expecting nil."
    else
      where = Minitest.filter_backtrace(caller).first
      where = where.split(/:in /, 2).first # clean up noise

      warn "DEPRECATED: Use assert_nil if expecting nil from #{where}. This will fail in Minitest 6."
    end
  end

  result
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



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

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(exp, act, epsilon = 0.001, msg = nil) ⇒ Object

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



252
253
254
 
# File 'lib/minitest/assertions.rb', line 252

def assert_in_epsilon exp, act, epsilon = 0.001, msg = nil
  assert_in_delta exp, act, [exp.abs, act.abs].min * epsilon, msg
end

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

Fails unless collection includes obj.



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

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 instance of cls.



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

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.



281
282
283
284
285
286
 
# File 'lib/minitest/assertions.rb', line 281

def assert_kind_of cls, obj, msg = nil
  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(matcher, obj, msg = nil) ⇒ Object

Fails unless matcher =~ obj.



291
292
293
294
295
296
297
298
 
# File 'lib/minitest/assertions.rb', line 291

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

  Regexp.last_match
end

#assert_mock(mock) ⇒ Object

Assert that the mock verifies correctly.



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

def assert_mock mock
  assert mock.verify
end

#assert_nil(obj, msg = nil) ⇒ Object

Fails unless obj is nil



303
304
305
306
 
# File 'lib/minitest/assertions.rb', line 303

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 = UNDEFINED, msg = nil) ⇒ Object

For testing with binary operators. Eg:

assert_operator 5, :<=, 4



313
314
315
316
317
 
# File 'lib/minitest/assertions.rb', line 313

def assert_operator o1, op, o2 = UNDEFINED, msg = nil
  return assert_predicate o1, op, msg if UNDEFINED == o2
  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. Pass in a regexp if you want to pattern match.

assert_output(/hey/) { method_with_output }

NOTE: this uses #capture_io, not #capture_subprocess_io.

See also: #assert_silent



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/minitest/assertions.rb', line 331

def assert_output stdout = nil, stderr = nil
  flunk "assert_output requires a block to capture output." unless
    block_given?

  out, err = capture_io do
    yield
  end

  err_msg = Regexp === stderr ? :assert_match : :assert_equal if stderr
  out_msg = Regexp === stdout ? :assert_match : :assert_equal if stdout

  y = send err_msg, stderr, err, "In stderr" if err_msg
  x = send out_msg, stdout, out, "In stdout" if out_msg

  (!stdout || x) && (!stderr || y)
rescue Assertion
  raise
rescue => e
  raise UnexpectedError, e
end

#assert_path_exists(path, msg = nil) ⇒ Object

Fails unless path exists.



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

def assert_path_exists path, msg = nil
  msg = message(msg) { "Expected path '#{path}' to exist" }
  assert File.exist?(path), msg
end

#assert_pattern ⇒ Object

For testing with pattern matching (only supported with Ruby 3.0 and later)

# pass
assert_pattern { [1,2,3] => [Integer, Integer, Integer] }

# fail "length mismatch (given 3, expected 1)"
assert_pattern { [1,2,3] => [Integer] }

The bare => pattern will raise a NoMatchingPatternError on failure, which would normally be counted as a test error. This assertion rescues NoMatchingPatternError and generates a test failure. Any other exception will be raised as normal and generate a test error.

Raises:

  • (NotImplementedError) 


374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/minitest/assertions.rb', line 374

def assert_pattern
  raise NotImplementedError, "only available in Ruby 3.0+" unless RUBY_VERSION >= "3.0"
  flunk "assert_pattern requires a block to capture errors." unless block_given?

  begin # TODO: remove after ruby 2.6 dropped
    yield
    pass
  rescue NoMatchingPatternError => e
    flunk e.message
  end
end

#assert_predicate(o1, op, msg = nil) ⇒ Object

For testing with predicates. Eg:

assert_predicate str, :empty?

This is really meant for specs and is front-ended by assert_operator:

str.must_be :empty?



395
396
397
398
 
# File 'lib/minitest/assertions.rb', line 395

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

#assert_raises(*exp) ⇒ Object

Fails unless the block raises one of exp. Returns the exception matched so you can check the message, attributes, etc.

exp takes an optional message on the end to help explain failures and defaults to StandardError if no exception class is passed. Eg:

assert_raises(CustomError) { method_with_custom_error }

With custom error message:

assert_raises(CustomError, 'This should have raised CustomError') { method_with_custom_error }

Using the returned object:

error = assert_raises(CustomError) do
  raise CustomError, 'This is really bad'
end

assert_equal 'This is really bad', error.message



422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/minitest/assertions.rb', line 422

def assert_raises *exp
  flunk "assert_raises requires a block to capture errors." unless
    block_given?

  msg = "#{exp.pop}.\n" if String === exp.last
  exp << StandardError if exp.empty?

  begin
    yield
  rescue *exp => e
    pass # count assertion
    return e
  rescue Minitest::Assertion # incl Skip & UnexpectedError
    # don't count assertion
    raise
  rescue SignalException, SystemExit
    raise
  rescue Exception => e
    flunk proc {
      exception_details(e, "#{msg}#{mu_pp(exp)} exception expected, not")
    }
  end

  exp = exp.first if exp.size == 1

  flunk "#{msg}#{mu_pp(exp)} expected but nothing was raised."
end

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

Fails unless obj responds to meth.



453
454
455
456
457
458
 
# File 'lib/minitest/assertions.rb', line 453

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?



463
464
465
466
467
468
469
 
# File 'lib/minitest/assertions.rb', line 463

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



476
477
478
479
480
481
482
483
484
485
 
# File 'lib/minitest/assertions.rb', line 476

def assert_send send_ary, m = nil
  where = Minitest.filter_backtrace(caller).first
  where = where.split(/:in /, 2).first # clean up noise
  warn "DEPRECATED: assert_send. From #{where}"

  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



492
493
494
495
496
 
# File 'lib/minitest/assertions.rb', line 492

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

#assert_throws(sym, msg = nil) ⇒ Object

Fails unless the block throws sym



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
 
# File 'lib/minitest/assertions.rb', line 501

def assert_throws sym, msg = nil
  default = "Expected #{mu_pp(sym)} to have been thrown"
  caught = true
  value = catch(sym) do
    begin
      yield
    rescue ThreadError => e       # wtf?!? 1.8 + threads == suck
      default += ", not \:#{e.message[/uncaught throw \`(\w+?)\'/, 1]}"
    rescue ArgumentError => e     # 1.9 exception
      raise e unless e.message.include?("uncaught throw")
      default += ", not #{e.message.split(/ /).last}"
    rescue NameError => e         # 1.8 exception
      raise e unless e.name == sym
      default += ", not #{e.name.inspect}"
    end
    caught = false
  end

  assert caught, message(msg) { default }
  value
rescue Assertion
  raise
rescue => e
  raise UnexpectedError, e
end

#capture_io ⇒ Object

Captures $stdout and $stderr into strings:

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

assert_match %r%info%, out
assert_match %r%bad%, err

NOTE: For efficiency, this method uses StringIO and does not capture IO for subprocesses. Use #capture_subprocess_io for that.



542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/minitest/assertions.rb', line 542

def capture_io
  _synchronize do
    begin
      captured_stdout, captured_stderr = StringIO.new, StringIO.new

      orig_stdout, orig_stderr = $stdout, $stderr
      $stdout, $stderr         = captured_stdout, captured_stderr

      yield

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

#capture_subprocess_io ⇒ Object

Captures $stdout and $stderr into strings, using Tempfile to ensure that subprocess IO is captured as well.

out, err = capture_subprocess_io do
  system "echo Some info"
  system "echo You did a bad thing 1>&2"
end

assert_match %r%info%, out
assert_match %r%bad%, err

NOTE: This method is approximately 10x slower than #capture_io so only use it when you need to test the output of a subprocess.



575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
 
# File 'lib/minitest/assertions.rb', line 575

def capture_subprocess_io
  _synchronize do
    begin
      require "tempfile"

      captured_stdout, captured_stderr = Tempfile.new("out"), Tempfile.new("err")

      orig_stdout, orig_stderr = $stdout.dup, $stderr.dup
      $stdout.reopen captured_stdout
      $stderr.reopen captured_stderr

      yield

      $stdout.rewind
      $stderr.rewind

      return captured_stdout.read, captured_stderr.read
    ensure
      $stdout.reopen orig_stdout
      $stderr.reopen orig_stderr

      orig_stdout.close
      orig_stderr.close
      captured_stdout.close!
      captured_stderr.close!
    end
  end
end

#diff(exp, act) ⇒ Object

Returns a diff between exp and act. If there is no known diff command or if it doesn’t make sense to diff the output (single line, short output), then it simply returns a basic comparison between the two.

See things_to_diff for more info.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/minitest/assertions.rb', line 59

def diff exp, act
  result = nil

  expect, butwas = things_to_diff(exp, act)

  return "Expected: #{mu_pp exp}\n  Actual: #{mu_pp act}" unless
    expect

  Tempfile.open("expect") do |a|
    a.puts expect
    a.flush

    Tempfile.open("butwas") do |b|
      b.puts butwas
      b.flush

      result = `#{Minitest::Assertions.diff} #{a.path} #{b.path}`
      result.sub!(/^\-\-\- .+/, "--- expected")
      result.sub!(/^\+\+\+ .+/, "+++ actual")

      if result.empty? then
        klass = exp.class
        result = [
                  "No visible difference in the #{klass}#inspect output.\n",
                  "You should look at the implementation of #== on ",
                  "#{klass} or its members.\n",
                  expect,
                 ].join
      end
    end
  end

  result
end

#exception_details(e, msg) ⇒ Object

Returns details for exception e



607
608
609
610
611
612
613
614
615
616
 
# File 'lib/minitest/assertions.rb', line 607

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

#fail_after(y, m, d, msg) ⇒ Object

Fails after a given date (in the local time zone). This allows you to put time-bombs in your tests if you need to keep something around until a later date lest you forget about it.



623
624
625
 
# File 'lib/minitest/assertions.rb', line 623

def fail_after y,m,d,msg
  flunk msg if Time.now > Time.local(y, m, d)
end

#flunk(msg = nil) ⇒ Object

Fails with msg.



630
631
632
633
 
# File 'lib/minitest/assertions.rb', line 630

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

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

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



638
639
640
641
642
643
644
 
# File 'lib/minitest/assertions.rb', line 638

def message msg = nil, ending = nil, &default
  proc {
    msg = msg.call.chomp(".") if Proc === msg
    custom_message = "#{msg}.\n" unless msg.nil? or msg.to_s.empty?
    "#{custom_message}#{default.call}#{ending || "."}"
  }
end

#mu_pp(obj) ⇒ Object

This returns a human-readable version of obj. By default #inspect is called. You can override this to use #pretty_inspect if you want.

See Minitest::Test.make_my_diffs_pretty!



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/minitest/assertions.rb', line 129

def mu_pp obj
  s = obj.inspect

  if defined? Encoding then
    s = s.encode Encoding.default_external

    if String === obj && (obj.encoding != Encoding.default_external ||
                          !obj.valid_encoding?) then
      enc = "# encoding: #{obj.encoding}"
      val = "#    valid: #{obj.valid_encoding?}"
      s = "#{enc}\n#{val}\n#{s}"
    end
  end

  s
end

#mu_pp_for_diff(obj) ⇒ Object

This returns a diff-able more human-readable version of obj. This differs from the regular mu_pp because it expands escaped newlines and makes hex-values (like object_ids) generic. This uses mu_pp to do the first pass and then cleans it up.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
 
# File 'lib/minitest/assertions.rb', line 152

def mu_pp_for_diff obj
  str = mu_pp obj

  # both '\n' & '\\n' (_after_ mu_pp (aka inspect))
  single = !!str.match(/(?<!\\|^)\\n/)
  double = !!str.match(/(?<=\\|^)\\n/)

  process =
    if single ^ double then
      if single then
        lambda { |s| s == "\\n"   ? "\n"    : s } # unescape
      else
        lambda { |s| s == "\\\\n" ? "\\n\n" : s } # unescape a bit, add nls
      end
    else
      :itself                                     # leave it alone
    end

  str.
    gsub(/\\?\\n/, &process).
    gsub(/:0x[a-fA-F0-9]{4,}/m, ":0xXXXXXX") # anonymize hex values
end

#pass(_msg = nil) ⇒ Object

used for counting assertions



649
650
651
 
# File 'lib/minitest/assertions.rb', line 649

def pass _msg = nil
  assert true
end

#refute(test, msg = nil) ⇒ Object

Fails if test is truthy.



656
657
658
659
 
# File 'lib/minitest/assertions.rb', line 656

def refute test, msg = nil
  msg ||= message { "Expected #{mu_pp(test)} to not be truthy" }
  assert !test, msg
end

#refute_empty(obj, msg = nil) ⇒ Object

Fails if obj is empty.



664
665
666
667
668
 
# File 'lib/minitest/assertions.rb', line 664

def refute_empty obj, msg = nil
  msg = message(msg) { "Expected #{mu_pp(obj)} 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.



675
676
677
678
679
680
 
# File 'lib/minitest/assertions.rb', line 675

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)



687
688
689
690
691
692
693
 
# File 'lib/minitest/assertions.rb', line 687

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.



699
700
701
 
# File 'lib/minitest/assertions.rb', line 699

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.



706
707
708
709
710
711
712
 
# File 'lib/minitest/assertions.rb', line 706

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.



717
718
719
720
721
722
 
# File 'lib/minitest/assertions.rb', line 717

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.



727
728
729
730
 
# File 'lib/minitest/assertions.rb', line 727

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

#refute_match(matcher, obj, msg = nil) ⇒ Object

Fails if matcher =~ obj.



735
736
737
738
739
740
 
# File 'lib/minitest/assertions.rb', line 735

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

#refute_nil(obj, msg = nil) ⇒ Object

Fails if obj is nil.



745
746
747
748
 
# File 'lib/minitest/assertions.rb', line 745

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 = UNDEFINED, msg = nil) ⇒ Object

Fails if o1 is not op o2. Eg:

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



780
781
782
783
784
 
# File 'lib/minitest/assertions.rb', line 780

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

#refute_path_exists(path, msg = nil) ⇒ Object

Fails if path exists.



789
790
791
792
 
# File 'lib/minitest/assertions.rb', line 789

def refute_path_exists path, msg = nil
  msg = message(msg) { "Expected path '#{path}' to not exist" }
  refute File.exist?(path), msg
end

#refute_pattern ⇒ Object

For testing with pattern matching (only supported with Ruby 3.0 and later)

# pass
refute_pattern { [1,2,3] => [String] }

# fail "NoMatchingPatternError expected, but nothing was raised."
refute_pattern { [1,2,3] => [Integer, Integer, Integer] }

This assertion expects a NoMatchingPatternError exception, and will fail if none is raised. Any other exceptions will be raised as normal and generate a test error.

Raises:

  • (NotImplementedError) 


762
763
764
765
766
767
768
769
770
771
772
 
# File 'lib/minitest/assertions.rb', line 762

def refute_pattern
  raise NotImplementedError, "only available in Ruby 3.0+" unless RUBY_VERSION >= "3.0"
  flunk "refute_pattern requires a block to capture errors." unless block_given?

  begin
    yield
    flunk("NoMatchingPatternError expected, but nothing was raised.")
  rescue NoMatchingPatternError
    pass
  end
end

#refute_predicate(o1, op, msg = nil) ⇒ Object

For testing with predicates.

refute_predicate str, :empty?

This is really meant for specs and is front-ended by refute_operator:

str.wont_be :empty?



803
804
805
806
 
# File 'lib/minitest/assertions.rb', line 803

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

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

Fails if obj responds to the message meth.



811
812
813
814
815
 
# File 'lib/minitest/assertions.rb', line 811

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.



820
821
822
823
824
825
826
 
# File 'lib/minitest/assertions.rb', line 820

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 run. If run in verbose-mode, the skipped run gets listed at the end of the run but doesn’t cause a failure exit code.

Raises:



833
834
835
836
837
 
# File 'lib/minitest/assertions.rb', line 833

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

#skip_until(y, m, d, msg) ⇒ Object

Skips the current run until a given date (in the local time zone). This allows you to put some fixes on hold until a later date, but still holds you accountable and prevents you from forgetting it.



845
846
847
848
849
 
# File 'lib/minitest/assertions.rb', line 845

def skip_until y,m,d,msg
  skip msg if Time.now < Time.local(y, m, d)
  where = caller.first.rpartition(':in').reject(&:empty?).first
  warn "Stale skip_until %p at %s" % [msg, where]
end

#skipped? ⇒ Boolean

Was this testcase skipped? Meant for #teardown.

Returns:

  • (Boolean) 


854
855
856
 
# File 'lib/minitest/assertions.rb', line 854

def skipped?
  defined?(@skip) and @skip
end

#things_to_diff(exp, act) ⇒ Object

Returns things to diff [expect, butwas], or [nil, nil] if nothing to diff.

Criterion:

  1. Strings include newlines or escaped newlines, but not both.

  2. or: String lengths are > 30 characters.

  3. or: Strings are equal to each other (but maybe different encodings?).

  4. and: we found a diff executable.



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

def things_to_diff exp, act
  expect = mu_pp_for_diff exp
  butwas = mu_pp_for_diff act

  e1, e2 = expect.include?("\n"), expect.include?("\\n")
  b1, b2 = butwas.include?("\n"), butwas.include?("\\n")

  need_to_diff =
    (e1 ^ e2                  ||
     b1 ^ b2                  ||
     expect.size > 30         ||
     butwas.size > 30         ||
     expect == butwas)        &&
    Minitest::Assertions.diff

  need_to_diff && [expect, butwas]
end