Module: Megatest::Assertions

Included in:
Test
Defined in:
lib/megatest/assertions.rb

Instance Method Summary collapse

Instance Method Details

#assert(result, msg = nil, message: nil) ⇒ Object 



45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/megatest/assertions.rb', line 45

def assert(result, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    return if result

    if message
      @__m.fail(message)
    else
      @__m.fail(message, "Expected", @__m.pp(result), "to be truthy")
    end
  end
end

#assert_empty(object, msg = nil, message: nil) ⇒ Object 



138
139
140
141
142
143
144
145
 
# File 'lib/megatest/assertions.rb', line 138

def assert_empty(object, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless object.empty?
      @__m.fail message, "Expected", @__m.pp(object), "to be empty"
    end
  end
end

#assert_equal(expected, actual, msg = nil, message: nil, allow_nil: false) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/megatest/assertions.rb', line 89

def assert_equal(expected, actual, msg = nil, message: nil, allow_nil: false)
  message = @__m.msg(msg, message)
  @__m.assert do
    if !allow_nil && nil == expected
      @__m.fail(nil, "Use assert_nil if expecting nil, or pass `allow_nil: true`")
    end

    if expected != actual
      @__m.fail(
        message,
        @__m.diff(expected, actual) ||
        "Expected: #{@__m.pp(expected)}\n" \
        "  Actual: #{@__m.pp(actual)}",
      )
    end
  end
end

#assert_in_delta(expected, actual, delta = 0.001, msg = nil, message: nil) ⇒ Object 



371
372
373
374
375
376
377
378
379
 
# File 'lib/megatest/assertions.rb', line 371

def assert_in_delta(expected, actual, delta = 0.001, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    diff = (expected - actual).abs
    unless delta >= diff
      @__m.fail(message, "Expected", "|#{@__m.pp(expected)} - #{@__m.pp(actual)}| (#{diff})", "to be <= #{delta}")
    end
  end
end

#assert_in_epsilon(expected, actual, epsilon = 0.001, msg = nil, message: nil) ⇒ Object 



391
392
393
394
395
396
397
398
399
400
 
# File 'lib/megatest/assertions.rb', line 391

def assert_in_epsilon(expected, actual, epsilon = 0.001, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    diff = (expected - actual).abs
    delta = [expected.abs, actual.abs].min * epsilon
    unless delta >= diff
      @__m.fail(message, "Expected", "|#{@__m.pp(expected)} - #{@__m.pp(actual)}| (#{diff})", "to be <= #{delta}")
    end
  end
end

#assert_includes(collection, object, msg = nil, message: nil) ⇒ Object 



120
121
122
123
124
125
126
127
 
# File 'lib/megatest/assertions.rb', line 120

def assert_includes(collection, object, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless collection.include?(object)
      @__m.fail message, "Expected", @__m.pp(collection), "to include", @__m.pp(object)
    end
  end
end

#assert_instance_of(klass, actual, msg = nil, message: nil) ⇒ Object 



156
157
158
159
160
161
162
163
 
# File 'lib/megatest/assertions.rb', line 156

def assert_instance_of(klass, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless actual.instance_of?(klass)
      @__m.fail(message, "Expected", @__m.pp(actual), "to be an instance of", @__m.pp(klass), "not", @__m.pp(actual.class))
    end
  end
end

#assert_kind_of(klass, actual, msg = nil, message: nil) ⇒ Object 



174
175
176
177
178
179
180
181
 
# File 'lib/megatest/assertions.rb', line 174

def assert_kind_of(klass, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless actual.kind_of?(klass)
      @__m.fail(message, "Expected", @__m.pp(actual), "to be a kind of", @__m.pp(klass), "not", @__m.pp(actual.class))
    end
  end
end

#assert_match(original_matcher, obj, msg = nil, message: nil) ⇒ Object 



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/megatest/assertions.rb', line 210

def assert_match(original_matcher, obj, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    matcher = if ::String === original_matcher
      ::Regexp.new(::Regexp.escape(original_matcher))
    else
      original_matcher
    end

    unless match = matcher.match(obj)
      @__m.fail(message, "Expected", @__m.pp(original_matcher), "to match", @__m.pp(obj))
    end

    match
  end
end

#assert_nil(actual, msg = nil, message: nil) ⇒ Object 



71
72
73
74
75
76
77
78
 
# File 'lib/megatest/assertions.rb', line 71

def assert_nil(actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless nil.equal?(actual)
      @__m.fail(message, "Expected", @__m.pp(actual), "to be nil")
    end
  end
end

#assert_operator(left, operator, right, msg = nil, message: nil) ⇒ Object 



353
354
355
356
357
358
359
360
 
# File 'lib/megatest/assertions.rb', line 353

def assert_operator(left, operator, right, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless left.__send__(operator, right)
      @__m.fail(message, "Expected", @__m.pp(left), "to be #{operator}", @__m.pp(right))
    end
  end
end

#assert_output(expected_stdout = nil, expected_stderr = nil, &block) ⇒ Object 



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

def assert_output(expected_stdout = nil, expected_stderr = nil, &block)
  @__m.assert do
    @__m.fail("assert_output requires a block to capture output.") unless block_given?

    actual_stdout, actual_stderr = @__m.expect_no_failures do
      capture_io(&block)
    end

    if expected_stderr
      if Regexp === expected_stderr
        assert_match(expected_stderr, actual_stderr, message: "In stderr")
      else
        assert_equal(expected_stderr, actual_stderr, message: "In stderr")
      end
    end

    if expected_stdout
      if Regexp === expected_stdout
        assert_match(expected_stdout, actual_stdout, message: "In stdout")
      else
        assert_equal(expected_stdout, actual_stdout, message: "In stdout")
      end
    end
  end
end

#assert_predicate(actual, predicate, msg = nil, message: nil) ⇒ Object 



192
193
194
195
196
197
198
199
 
# File 'lib/megatest/assertions.rb', line 192

def assert_predicate(actual, predicate, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless @__m.expect_no_failures { actual.__send__(predicate) }
      @__m.fail(message, "Expected", @__m.pp(actual), "to be #{predicate}")
    end
  end
end

#assert_raises(expected = StandardError, *expected_exceptions, message: nil) ⇒ Object 



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/megatest/assertions.rb', line 298

def assert_raises(expected = StandardError, *expected_exceptions, message: nil)
  msg = expected_exceptions.pop if expected_exceptions.last.is_a?(String)
  message = @__m.msg(msg, message)
  @__m.assert do
    @__m.fail("assert_raises requires a block to capture errors.") unless block_given?

    begin
      yield
    rescue expected, *expected_exceptions => exception
      return exception
    rescue ::Megatest::Assertion, *::Megatest::IGNORED_ERRORS
      raise # Pass through
    rescue ::Exception => unexepected_exception
      error = @__m.strip_backtrace(unexepected_exception, __FILE__, __LINE__ - 6, 0)

      expected_pp = if expected_exceptions.empty?
        @__m.pp(expected)
      else
        expected_exceptions.map { |e| @__m.pp(e) }.join(", ") << " or #{@__m.pp(expected)}"
      end

      @__m.fail(message, "#{expected_pp} exception expected, not:\n#{@__m.pp(error)}")
    end

    expected_pp = if expected_exceptions.empty?
      @__m.pp(expected)
    else
      expected_exceptions.map { |e| @__m.pp(e) }.join(", ") << " or #{@__m.pp(expected)}"
    end

    @__m.fail(message, "Expected", expected_pp, "but nothing was raised.")
  end
end

#assert_respond_to(object, method, msg = nil, message: nil, include_all: false) ⇒ Object 



242
243
244
245
246
247
248
249
 
# File 'lib/megatest/assertions.rb', line 242

def assert_respond_to(object, method, msg = nil, message: nil, include_all: false)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless object.respond_to?(method, include_all)
      @__m.fail(message, "Expected", @__m.pp(object), "to respond to :#{method}")
    end
  end
end

#assert_same(expected, actual, msg = nil, message: nil) ⇒ Object 



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/megatest/assertions.rb', line 260

def assert_same(expected, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    unless expected.equal?(actual)
      @__m.fail message, begin
        actual_pp = @__m.pp(actual)
        expected_pp = @__m.pp(expected)
        if actual_pp == expected_pp
          actual_pp += " (id: #{actual.object_id})"
          expected_pp += " (id: #{expected.object_id})"
        end

        "Expected          #{actual_pp}\n" \
        "To be the same as #{expected_pp}"
      end
    end
  end
end

#assert_silent(&block) ⇒ Object 



451
452
453
454
455
 
# File 'lib/megatest/assertions.rb', line 451

def assert_silent(&block)
  @__m.assert do
    assert_output("", "", &block)
  end
end

#assert_throws(thrown_object, msg = nil, message: nil) ⇒ Object 



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

def assert_throws(thrown_object, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    caught = true
    value = catch(thrown_object) do
      @__m.expect_no_failures do
        yield
      rescue UncaughtThrowError => error
        @__m.fail(message, "Expected", @__m.pp(thrown_object), "to have been thrown, not:", @__m.pp(error.tag))
      end
      caught = false
    end

    unless caught
      @__m.fail(message, "Expected", @__m.pp(thrown_object), "to have been thrown, but it wasn't")
    end

    value
  end
end

#capture_io ⇒ Object 



457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/megatest/assertions.rb', line 457

def capture_io
  require "stringio" unless defined?(::StringIO)
  captured_stdout, captured_stderr = ::StringIO.new, ::StringIO.new

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

  begin
    yield

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

#flunk(msg = nil, message: nil) ⇒ Object 



418
419
420
421
422
423
 
# File 'lib/megatest/assertions.rb', line 418

def flunk(msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    @__m.fail(message || "Failed")
  end
end

#pass ⇒ Object 



41
42
43
 
# File 'lib/megatest/assertions.rb', line 41

def pass
  @__m.assert {}
end

#refute(result, msg = nil, message: nil) ⇒ Object 



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

def refute(result, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    return unless result

    if message
      @__m.fail(message)
    else
      @__m.fail(message, "Expected", @__m.pp(result), "to be falsy")
    end
  end
end

#refute_empty(object, msg = nil, message: nil) ⇒ Object 



147
148
149
150
151
152
153
154
 
# File 'lib/megatest/assertions.rb', line 147

def refute_empty(object, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if object.empty?
      @__m.fail message, "Expected", @__m.pp(object), "to not be empty"
    end
  end
end

#refute_equal(expected, actual, msg = nil, message: nil, allow_nil: false) ⇒ Object 



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/megatest/assertions.rb', line 107

def refute_equal(expected, actual, msg = nil, message: nil, allow_nil: false)
  message = @__m.msg(msg, message)
  @__m.assert do
    if !allow_nil && nil == expected && !@__m.minitest_compatibility?
      @__m.fail(nil, "Use refute_nil if expecting to not be nil, or pass `allow_nil: true`")
    end

    if expected == actual
      @__m.fail(message, "Expected", @__m.pp(expected), "to not equal", @__m.pp(actual))
    end
  end
end

#refute_in_delta(expected, actual, delta = 0.001, msg = nil, message: nil) ⇒ Object 



381
382
383
384
385
386
387
388
389
 
# File 'lib/megatest/assertions.rb', line 381

def refute_in_delta(expected, actual, delta = 0.001, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    diff = (expected - actual).abs
    if delta >= diff
      @__m.fail(message, "Expected", "|#{@__m.pp(expected)} - #{@__m.pp(actual)}| (#{diff})", "to not be <= #{delta}")
    end
  end
end

#refute_in_epsilon(expected, actual, epsilon = 0.001, msg = nil, message: nil) ⇒ Object 



402
403
404
405
406
407
408
409
410
411
 
# File 'lib/megatest/assertions.rb', line 402

def refute_in_epsilon(expected, actual, epsilon = 0.001, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    diff = (expected - actual).abs
    delta = [expected.abs, actual.abs].min * epsilon
    if delta >= diff
      @__m.fail(message, "Expected", "|#{@__m.pp(expected)} - #{@__m.pp(actual)}| (#{diff})", "to not be <= #{delta}")
    end
  end
end

#refute_includes(collection, object, msg = nil, message: nil) ⇒ Object 



129
130
131
132
133
134
135
136
 
# File 'lib/megatest/assertions.rb', line 129

def refute_includes(collection, object, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if collection.include?(object)
      @__m.fail message, "Expected", @__m.pp(collection), "to not include", @__m.pp(object)
    end
  end
end

#refute_instance_of(klass, actual, msg = nil, message: nil) ⇒ Object 



165
166
167
168
169
170
171
172
 
# File 'lib/megatest/assertions.rb', line 165

def refute_instance_of(klass, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if actual.instance_of?(klass)
      @__m.fail(message, "Expected", @__m.pp(actual), "to not be an instance of", @__m.pp(klass))
    end
  end
end

#refute_kind_of(klass, actual, msg = nil, message: nil) ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'lib/megatest/assertions.rb', line 183

def refute_kind_of(klass, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if actual.kind_of?(klass)
      @__m.fail(message, "Expected", @__m.pp(actual), "to not be a kind of", @__m.pp(klass))
    end
  end
end

#refute_match(original_matcher, obj, msg = nil, message: nil) ⇒ Object 



227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/megatest/assertions.rb', line 227

def refute_match(original_matcher, obj, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    matcher = if ::String === original_matcher
      ::Regexp.new(::Regexp.escape(original_matcher))
    else
      original_matcher
    end

    if matcher.match?(obj)
      @__m.fail(message, "Expected", @__m.pp(original_matcher), "to not match", @__m.pp(obj))
    end
  end
end

#refute_nil(actual, msg = nil, message: nil) ⇒ Object 



80
81
82
83
84
85
86
87
 
# File 'lib/megatest/assertions.rb', line 80

def refute_nil(actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if nil.equal?(actual)
      @__m.fail(message, "Expected", @__m.pp(actual), "to not be nil")
    end
  end
end

#refute_operator(left, operator, right, msg = nil, message: nil) ⇒ Object 



362
363
364
365
366
367
368
369
 
# File 'lib/megatest/assertions.rb', line 362

def refute_operator(left, operator, right, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if left.__send__(operator, right)
      @__m.fail(message, "Expected", @__m.pp(left), "to not be #{operator}", @__m.pp(right))
    end
  end
end

#refute_predicate(actual, predicate, msg = nil, message: nil) ⇒ Object 



201
202
203
204
205
206
207
208
 
# File 'lib/megatest/assertions.rb', line 201

def refute_predicate(actual, predicate, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if @__m.expect_no_failures { actual.__send__(predicate) }
      @__m.fail(message, "Expected", @__m.pp(actual), "to not be #{predicate}")
    end
  end
end

#refute_respond_to(object, method, msg = nil, message: nil, include_all: false) ⇒ Object 



251
252
253
254
255
256
257
258
 
# File 'lib/megatest/assertions.rb', line 251

def refute_respond_to(object, method, msg = nil, message: nil, include_all: false)
  message = @__m.msg(msg, message)
  @__m.assert do
    if object.respond_to?(method, include_all)
      @__m.fail(message, "Expected", @__m.pp(object), "to not respond to :#{method}")
    end
  end
end

#refute_same(expected, actual, msg = nil, message: nil) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/megatest/assertions.rb', line 279

def refute_same(expected, actual, msg = nil, message: nil)
  message = @__m.msg(msg, message)
  @__m.assert do
    if expected.equal?(actual)
      @__m.fail message, begin
        actual_pp = @__m.pp(actual)
        expected_pp = @__m.pp(expected)
        if actual_pp == expected_pp
          actual_pp += " (id: #{actual.object_id})"
          expected_pp += " (id: #{expected.object_id})"
        end

        "Expected              #{actual_pp}\n" \
        "To not be the same as #{expected_pp}"
      end
    end
  end
end

#skip(message = nil) ⇒ Object 



413
414
415
416
 
# File 'lib/megatest/assertions.rb', line 413

def skip(message = nil)
  message ||= "Skipped, no message given"
  ::Kernel.raise(::Megatest::Skip, message, nil)
end