Module: Test::Unit::Assertions
- Included in:
- TestCase
- Defined in:
- lib/test/unit/assertions.rb
Overview
Test::Unit::Assertions contains the standard Test::Unit assertions. Assertions is included in Test::Unit::TestCase.
To include it in your own code and use its functionality, you simply need to rescue Test::Unit::AssertionFailedError. Additionally you may override add_assertion to get notified whenever an assertion is made.
Notes:
-
The message to each assertion, if given, will be propagated with the failure.
-
It is easy to add your own assertions based on assert_block().
Example Custom Assertion
def deny(boolean, = nil)
= , '<?> is not false or nil.', boolean
assert_block do
not boolean
end
end
Defined Under Namespace
Classes: AssertExceptionHelper, AssertionMessage
Constant Summary collapse
- UncaughtThrow =
{ NameError => /^uncaught throw \`(.+)\'$/, ArgumentError => /^uncaught throw (.+)$/, ThreadError => /^uncaught throw \`(.+)\' in thread / }
Class Method Summary collapse
Instance Method Summary collapse
- #assert(boolean, message = nil) ⇒ Object
-
#assert_alias_method(object, alias_name, original_name, message = nil) ⇒ Object
Passes if
object
#alias_name
is an alias method ofobject
#original_name
. -
#assert_block(message = "assert_block failed.") ⇒ Object
:yields:.
-
#assert_boolean(actual, message = nil) ⇒ Object
Passes if
actual
is a boolean value. -
#assert_compare(expected, operator, actual, message = nil) ⇒ Object
Passes if expression “
expected
operator
actual
” is true. -
#assert_const_defined(object, constant_name, message = nil) ⇒ Object
Passes if
object
.const_defined?(constant_name
). - #assert_equal(expected, actual, message = nil) ⇒ Object
-
#assert_fail_assertion(message = nil) ⇒ Object
Passes if assertion is failed in block.
-
#assert_false(actual, message = nil) ⇒ Object
Passes if
actual
is false. - #assert_in_delta(expected_float, actual_float, delta, message = "") ⇒ Object
- #assert_instance_of(klass, object, message = "") ⇒ Object
- #assert_kind_of(klass, object, message = "") ⇒ Object
- #assert_match(pattern, string, message = "") ⇒ Object
- #assert_nil(object, message = "") ⇒ Object
- #assert_no_match(regexp, string, message = "") ⇒ Object
-
#assert_not_const_defined(object, constant_name, message = nil) ⇒ Object
Passes if !
object
.const_defined?(constant_name
). - #assert_not_equal(expected, actual, message = "") ⇒ Object
- #assert_not_nil(object, message = "") ⇒ Object
-
#assert_not_predicate(object, predicate, message = nil) ⇒ Object
Passes if
object
.predicate
. - #assert_not_same(expected, actual, message = "") ⇒ Object
- #assert_nothing_raised(*args) ⇒ Object
- #assert_nothing_thrown(message = "", &proc) ⇒ Object
- #assert_operator(object1, operator, object2, message = "") ⇒ Object
-
#assert_predicate(object, predicate, message = nil) ⇒ Object
Passes if
object
.predicate
. - #assert_raise(*args, &block) ⇒ Object
-
#assert_raise_kind_of(*args, &block) ⇒ Object
Passes if the block raises one of the given exceptions or sub exceptions of the given exceptions.
-
#assert_raise_message(expected, message = nil) ⇒ Object
Passes if an exception is raised in block and its message is
expected
. - #assert_raises(*args, &block) ⇒ Object
- #assert_respond_to(object, method, message = "") ⇒ Object
- #assert_same(expected, actual, message = "") ⇒ Object
- #assert_send(send_array, message = "") ⇒ Object
- #assert_throw(expected_object, message = "", &proc) ⇒ Object
-
#assert_throws(*args, &block) ⇒ Object
Alias of assert_throw.
-
#assert_true(actual, message = nil) ⇒ Object
Passes if
actual
is true. - #build_message(head, template = nil, *arguments) ⇒ Object
- #flunk(message = "Flunked") ⇒ Object
Class Method Details
.use_pp=(value) ⇒ Object
888 889 890 |
# File 'lib/test/unit/assertions.rb', line 888 def self.use_pp=(value) AssertionMessage.use_pp = value end |
Instance Method Details
#assert(boolean, message = nil) ⇒ Object
63 64 65 66 67 68 |
# File 'lib/test/unit/assertions.rb', line 63 def assert(boolean, =nil) _wrap_assertion do assert_block("assert should not be called with a block.") { !block_given? } assert_block((, "<?> is not true.", boolean)) { boolean } end end |
#assert_alias_method(object, alias_name, original_name, message = nil) ⇒ Object
Passes if object
#alias_name
is an alias method of object
#original_name
.
Example:
assert_alias_method([], :length, :size) # -> pass
assert_alias_method([], :size, :length) # -> pass
assert_alias_method([], :each, :size) # -> fail
809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 |
# File 'lib/test/unit/assertions.rb', line 809 def assert_alias_method(object, alias_name, original_name, =nil) _wrap_assertion do = Proc.new do |method_name| (, "<?>.? doesn't exist\n" + "(Class: <?>)", object, AssertionMessage.literal(method_name), object.class) end alias_method = original_method = nil assert_block(.call(alias_name)) do begin alias_method = object.method(alias_name) true rescue NameError false end end assert_block(.call(original_name)) do begin original_method = object.method(original_name) true rescue NameError false end end = (, "<?> is alias of\n" + "<?> expected", alias_method, original_method) assert_block() do alias_method == original_method end end end |
#assert_block(message = "assert_block failed.") ⇒ Object
:yields:
48 49 50 51 52 53 54 |
# File 'lib/test/unit/assertions.rb', line 48 def assert_block(="assert_block failed.") # :yields: _wrap_assertion do if (! yield) raise AssertionFailedError.new(.to_s) end end end |
#assert_boolean(actual, message = nil) ⇒ Object
Passes if actual
is a boolean value.
Example:
assert_boolean(true) # -> pass
assert_boolean(nil) # -> fail
585 586 587 588 589 590 591 592 593 |
# File 'lib/test/unit/assertions.rb', line 585 def assert_boolean(actual, =nil) _wrap_assertion do assert_block((, "<true> or <false> expected but was\n<?>", actual)) do [true, false].include?(actual) end end end |
#assert_compare(expected, operator, actual, message = nil) ⇒ Object
Passes if expression “expected
operator
actual
” is true.
Example:
assert_compare(1, "<", 10) # -> pass
assert_compare(1, ">=", 10) # -> fail
634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 |
# File 'lib/test/unit/assertions.rb', line 634 def assert_compare(expected, operator, actual, =nil) _wrap_assertion do assert_send([["<", "<=", ">", ">="], :include?, operator.to_s]) case operator.to_s when "<" operator_description = "less than" when "<=" operator_description = "less than or equal to" when ">" operator_description = "greater than" when ">=" operator_description = "greater than or equal to" end template = <<-EOT <?> #{operator} <?> should be true <?> expected #{operator_description} <?>. EOT = (, template, expected, actual, expected, actual) assert_block() do expected.send(operator, actual) end end end |
#assert_const_defined(object, constant_name, message = nil) ⇒ Object
Passes if object
.const_defined?(constant_name
)
Example:
assert_const_defined(Test, :Unit) # -> pass
assert_const_defined(Object, :Nonexistent) # -> fail
729 730 731 732 733 734 735 736 737 738 |
# File 'lib/test/unit/assertions.rb', line 729 def assert_const_defined(object, constant_name, =nil) _wrap_assertion do = (, "<?>.const_defined\\?(<?>) expected.", object, constant_name) assert_block() do object.const_defined?(constant_name) end end end |
#assert_equal(expected, actual, message = nil) ⇒ Object
81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 |
# File 'lib/test/unit/assertions.rb', line 81 def assert_equal(expected, actual, =nil) diff = AssertionMessage.delayed_diff(expected, actual) = (, <<EOT, expected, actual, diff) <?> expected but was <?>.? EOT begin assert_block() { expected == actual } rescue AssertionFailedError => failure failure.expected = expected failure.actual = actual failure.inspected_expected = AssertionMessage.convert(expected) failure.inspected_actual = AssertionMessage.convert(actual) failure. = raise end end |
#assert_fail_assertion(message = nil) ⇒ Object
Passes if assertion is failed in block.
Example:
assert_fail_assertion {assert_equal("A", "B")} # -> pass
assert_fail_assertion {assert_equal("A", "A")} # -> fail
667 668 669 670 671 672 673 674 675 676 677 678 679 680 |
# File 'lib/test/unit/assertions.rb', line 667 def assert_fail_assertion(=nil) _wrap_assertion do = (, "Failed assertion was expected.") assert_block() do begin yield false rescue AssertionFailedError true end end end end |
#assert_false(actual, message = nil) ⇒ Object
Passes if actual
is false.
Example:
assert_false(false) # -> pass
assert_false(nil) # -> fail
617 618 619 620 621 622 623 624 625 |
# File 'lib/test/unit/assertions.rb', line 617 def assert_false(actual, =nil) _wrap_assertion do assert_block((, "<false> expected but was\n<?>", actual)) do actual == false end end end |
#assert_in_delta(expected_float, actual_float, delta, message = "") ⇒ Object
540 541 542 543 544 545 546 547 548 549 550 551 552 553 |
# File 'lib/test/unit/assertions.rb', line 540 def assert_in_delta(expected_float, actual_float, delta, ="") _wrap_assertion do {expected_float => "first float", actual_float => "second float", delta => "delta"}.each do |float, name| assert_respond_to(float, :to_f, "The arguments must respond to to_f; the #{name} did not") end assert_operator(delta, :>=, 0.0, "The delta should not be negative") = (, <<EOT, expected_float, actual_float, delta) <?> and <?> expected to be within <?> of each other. EOT assert_block() { (expected_float.to_f - actual_float.to_f).abs <= delta.to_f } end end |
#assert_instance_of(klass, object, message = "") ⇒ Object
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 |
# File 'lib/test/unit/assertions.rb', line 176 def assert_instance_of(klass, object, ="") _wrap_assertion do klasses = nil klasses = klass if klass.is_a?(Array) assert_block("The first parameter to assert_instance_of should be " + "a Class or an Array of Class.") do if klasses klasses.all? {|k| k.is_a?(Class)} else klass.is_a?(Class) end end = AssertionMessage.maybe_container(klass) do |value| "<#{value}>" end = (, <<EOT, object, , object.class) <?> expected to be an instance of ? but was <?>. EOT assert_block() do if klasses klasses.any? {|k| object.instance_of?(k)} else object.instance_of?(klass) end end end end |
#assert_kind_of(klass, object, message = "") ⇒ Object
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 |
# File 'lib/test/unit/assertions.rb', line 231 def assert_kind_of(klass, object, ="") _wrap_assertion do klasses = nil klasses = klass if klass.is_a?(Array) assert_block("The first parameter to assert_kind_of should be " + "a kind_of Module or an Array of a kind_of Module.") do if klasses klasses.all? {|k| k.kind_of?(Module)} else klass.kind_of?(Module) end end = AssertionMessage.maybe_container(klass) do |value| "<#{value}>" end = (, "<?> expected to be kind_of\\?\n" + "? but was\n" + "<?>.", object, , object.class) assert_block() do if klasses klasses.any? {|k| object.kind_of?(k)} else object.kind_of?(klass) end end end end |
#assert_match(pattern, string, message = "") ⇒ Object
294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/test/unit/assertions.rb', line 294 def assert_match(pattern, string, ="") _wrap_assertion do pattern = case(pattern) when String Regexp.new(Regexp.escape(pattern)) else pattern end = (, "<?> expected to be =~\n<?>.", string, pattern) assert_block() { string =~ pattern } end end |
#assert_nil(object, message = "") ⇒ Object
213 214 215 216 217 218 |
# File 'lib/test/unit/assertions.rb', line 213 def assert_nil(object, ="") = (, <<EOT, object) <?> expected to be nil. EOT assert_block() { object.nil? } end |
#assert_no_match(regexp, string, message = "") ⇒ Object
440 441 442 443 444 445 446 |
# File 'lib/test/unit/assertions.rb', line 440 def assert_no_match(regexp, string, ="") _wrap_assertion do assert_instance_of(Regexp, regexp, "The first argument to assert_no_match should be a Regexp.") = (, "<?> expected to not match\n<?>.", regexp, string) assert_block() { regexp !~ string } end end |
#assert_not_const_defined(object, constant_name, message = nil) ⇒ Object
Passes if !object
.const_defined?(constant_name
)
Example:
assert_not_const_defined(Object, :Nonexistent) # -> pass
assert_not_const_defined(Test, :Unit) # -> fail
746 747 748 749 750 751 752 753 754 755 |
# File 'lib/test/unit/assertions.rb', line 746 def assert_not_const_defined(object, constant_name, =nil) _wrap_assertion do = (, "!<?>.const_defined\\?(<?>) expected.", object, constant_name) assert_block() do !object.const_defined?(constant_name) end end end |
#assert_not_equal(expected, actual, message = "") ⇒ Object
416 417 418 419 |
# File 'lib/test/unit/assertions.rb', line 416 def assert_not_equal(expected, actual, ="") = (, "<?> expected to be != to\n<?>.", expected, actual) assert_block() { expected != actual } end |
#assert_not_nil(object, message = "") ⇒ Object
428 429 430 431 |
# File 'lib/test/unit/assertions.rb', line 428 def assert_not_nil(object, ="") = (, "<?> expected to not be nil.", object) assert_block(){!object.nil?} end |
#assert_not_predicate(object, predicate, message = nil) ⇒ Object
Passes if object
.predicate
Example:
assert_not_predicate([1], :empty?) # -> pass
assert_not_predicate([], :empty?) # -> fail
785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 |
# File 'lib/test/unit/assertions.rb', line 785 def assert_not_predicate(object, predicate, =nil) _wrap_assertion do assert_respond_to(object, predicate, ) actual = object.send(predicate) = (, "<?>.? is false value expected but was\n" + "<?>", object, AssertionMessage.literal(predicate), actual) assert_block() do not actual end end end |
#assert_not_same(expected, actual, message = "") ⇒ Object
399 400 401 402 403 404 405 406 407 |
# File 'lib/test/unit/assertions.rb', line 399 def assert_not_same(expected, actual, ="") = (, <<EOT, expected, expected.__id__, actual, actual.__id__) <?> with id <?> expected to not be equal\\? to <?> with id <?>. EOT assert_block() { !actual.equal?(expected) } end |
#assert_nothing_raised(*args) ⇒ Object
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/test/unit/assertions.rb', line 357 def assert_nothing_raised(*args) _wrap_assertion do if args.last.is_a?(String) = args.pop else = "" end assert_exception_helper = AssertExceptionHelper.new(self, args) begin yield rescue Exception => e if ((args.empty? && !e.instance_of?(AssertionFailedError)) || assert_exception_helper.expected?(e)) = (, "Exception raised:\n?", e) assert_block() {false} else raise end end nil end end |
#assert_nothing_thrown(message = "", &proc) ⇒ Object
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 |
# File 'lib/test/unit/assertions.rb', line 514 def assert_nothing_thrown(="", &proc) _wrap_assertion do assert(block_given?, "Should have passed a block to assert_nothing_thrown") begin proc.call rescue NameError, ArgumentError, ThreadError => error raise unless UncaughtThrow[error.class] =~ error. tag = $1 tag = tag[1..-1].intern if tag[0, 1] == ":" = (, "<?> was thrown when nothing was expected", tag) flunk() end assert(true, "Expected nothing to be thrown") end end |
#assert_operator(object1, operator, object2, message = "") ⇒ Object
335 336 337 338 339 340 341 342 343 344 345 346 |
# File 'lib/test/unit/assertions.rb', line 335 def assert_operator(object1, operator, object2, ="") _wrap_assertion do = (nil, "<?>\ngiven as the operator for #assert_operator must be a Symbol or #respond_to\\?(:to_str).", operator) assert_block(){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)} = (, <<EOT, object1, AssertionMessage.literal(operator), object2) <?> expected to be ? <?>. EOT assert_block() { object1.__send__(operator, object2) } end end |
#assert_predicate(object, predicate, message = nil) ⇒ Object
Passes if object
.predicate
Example:
assert_predicate([], :empty?) # -> pass
assert_predicate([1], :empty?) # -> fail
763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 |
# File 'lib/test/unit/assertions.rb', line 763 def assert_predicate(object, predicate, =nil) _wrap_assertion do assert_respond_to(object, predicate, ) actual = object.send(predicate) = (, "<?>.? is true value expected but was\n" + "<?>", object, AssertionMessage.literal(predicate), actual) assert_block() do actual end end end |
#assert_raise(*args, &block) ⇒ Object
117 118 119 120 121 122 123 124 125 126 127 128 129 |
# File 'lib/test/unit/assertions.rb', line 117 def assert_raise(*args, &block) assert_expected_exception = Proc.new do |*_args| , assert_exception_helper, actual_exception = _args expected = assert_exception_helper.expected_exceptions = (, "<?> exception expected but was\n?", expected, actual_exception) assert_block() do expected == [] or assert_exception_helper.expected?(actual_exception) end end _assert_raise(assert_expected_exception, *args, &block) end |
#assert_raise_kind_of(*args, &block) ⇒ Object
Passes if the block raises one of the given exceptions or sub exceptions of the given exceptions.
Example:
assert_raise_kind_of(SystemCallError) do
raise Errno::EACCES
end
149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/test/unit/assertions.rb', line 149 def assert_raise_kind_of(*args, &block) assert_expected_exception = Proc.new do |*_args| , assert_exception_helper, actual_exception = _args expected = assert_exception_helper.expected_exceptions = (, "<?> family exception expected " + "but was\n?", expected, actual_exception) assert_block() do assert_exception_helper.expected?(actual_exception, :kind_of?) end end _assert_raise(assert_expected_exception, *args, &block) end |
#assert_raise_message(expected, message = nil) ⇒ Object
Passes if an exception is raised in block and its message is expected
.
Example:
("exception") {raise "exception"} # -> pass
(/exc/i) {raise "exception"} # -> pass
("exception") {raise "EXCEPTION"} # -> fail
("exception") {} # -> fail
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 |
# File 'lib/test/unit/assertions.rb', line 691 def (expected, =nil) _wrap_assertion do = (, "<?> exception message expected " + "but none was thrown.", expected) exception = nil assert_block() do begin yield false rescue Exception => exception true end end actual = exception. diff = AssertionMessage.delayed_diff(expected, actual) = (, "<?> exception message expected but was\n" + "<?>.?", expected, actual, diff) assert_block() do if expected.is_a?(Regexp) expected =~ actual else expected == actual end end end end |
#assert_raises(*args, &block) ⇒ Object
137 138 139 |
# File 'lib/test/unit/assertions.rb', line 137 def assert_raises(*args, &block) assert_raise(*args, &block) end |
#assert_respond_to(object, method, message = "") ⇒ Object
270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 |
# File 'lib/test/unit/assertions.rb', line 270 def assert_respond_to(object, method, ="") _wrap_assertion do = (, "<?>.kind_of\\?(Symbol) or\n" + "<?>.respond_to\\?(:to_str) expected", method, method) assert_block() do method.kind_of?(Symbol) or method.respond_to?(:to_str) end = (, "<?>.respond_to\\?(?) expected\n" + "(Class: <?>)", object, method, object.class) assert_block() {object.respond_to?(method)} end end |
#assert_same(expected, actual, message = "") ⇒ Object
316 317 318 319 320 321 322 323 324 |
# File 'lib/test/unit/assertions.rb', line 316 def assert_same(expected, actual, ="") = (, <<EOT, expected, expected.__id__, actual, actual.__id__) <?> with id <?> expected to be equal\\? to <?> with id <?>. EOT assert_block() { actual.equal?(expected) } end |
#assert_send(send_array, message = "") ⇒ Object
567 568 569 570 571 572 573 574 575 576 577 |
# File 'lib/test/unit/assertions.rb', line 567 def assert_send(send_array, ="") _wrap_assertion do assert_instance_of(Array, send_array, "assert_send requires an array of send information") assert(send_array.size >= 2, "assert_send requires at least a receiver and a message name") = (, <<EOT, send_array[0], AssertionMessage.literal(send_array[1].to_s), send_array[2..-1]) <?> expected to respond to <?(?)> with a true value. EOT assert_block() { send_array[0].__send__(send_array[1], *send_array[2..-1]) } end end |
#assert_throw(expected_object, message = "", &proc) ⇒ Object
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 |
# File 'lib/test/unit/assertions.rb', line 463 def assert_throw(expected_object, ="", &proc) _wrap_assertion do begin catch([]) {} rescue TypeError assert_instance_of(Symbol, expected_object, "assert_throws expects the symbol that should be thrown for its first argument") end assert_block("Should have passed a block to assert_throw.") do block_given? end caught = true begin catch(expected_object) do proc.call caught = false end = (, "<?> should have been thrown.", expected_object) assert_block() {caught} rescue NameError, ArgumentError, ThreadError => error raise unless UncaughtThrow[error.class] =~ error. tag = $1 tag = tag[1..-1].intern if tag[0, 1] == ":" = (, "<?> expected to be thrown but\n" + "<?> was thrown.", expected_object, tag) flunk() end end end |
#assert_throws(*args, &block) ⇒ Object
Alias of assert_throw.
Will be deprecated in 1.9, and removed in 2.0.
501 502 503 |
# File 'lib/test/unit/assertions.rb', line 501 def assert_throws(*args, &block) assert_throw(*args, &block) end |
#assert_true(actual, message = nil) ⇒ Object
Passes if actual
is true.
Example:
assert_true(true) # -> pass
assert_true(:true) # -> fail
601 602 603 604 605 606 607 608 609 |
# File 'lib/test/unit/assertions.rb', line 601 def assert_true(actual, =nil) _wrap_assertion do assert_block((, "<true> expected but was\n<?>", actual)) do actual == true end end end |
#build_message(head, template = nil, *arguments) ⇒ Object
854 855 856 857 |
# File 'lib/test/unit/assertions.rb', line 854 def (head, template=nil, *arguments) template &&= template.chomp return AssertionMessage.new(head, template, arguments) end |
#flunk(message = "Flunked") ⇒ Object
388 389 390 |
# File 'lib/test/unit/assertions.rb', line 388 def flunk(="Flunked") assert_block(()){false} end |