| Module | Test::Unit::Assertions |
| In: |
test/unit/assertions.rb
|
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:
def deny(boolean, message = nil)
message = build_message message, '<?> is not false or nil.', boolean
assert_block message do
not boolean
end
end
| UncaughtThrow | = | {NameError => /^uncaught throw \`(.+)\'$/, ThreadError => /^uncaught throw \`(.+)\' in thread /} |
Select whether or not to use the pretty-printer. If this option is set to false before any assertions are made, pp.rb will not be required.
# File test/unit/assertions.rb, line 525 def self.use_pp=(value) AssertionMessage.use_pp = value end
Asserts that boolean is not false or nil.
Example:
assert [1, 2].include?(5)
# File test/unit/assertions.rb, line 60 def assert(boolean, message=nil) _wrap_assertion do assert_block("assert should not be called with a block.") { !block_given? } assert_block(build_message(message, "<?> is not true.", boolean)) { boolean } end end
The assertion upon which all other assertions are based. Passes if the block yields true.
Example:
assert_block "Couldn't do the thing" do
do_the_thing
end
# File test/unit/assertions.rb, line 45 def assert_block(message="assert_block failed.") # :yields: _wrap_assertion do if (! yield) raise AssertionFailedError.new(message.to_s) end end end
Passes if expected == +actual.
Note that the ordering of arguments is important, since a helpful error message is generated when this one fails that tells you the values of expected and actual.
Example:
assert_equal 'MY STRING', 'my string'.upcase
# File test/unit/assertions.rb, line 78 def assert_equal(expected, actual, message=nil) full_message = build_message(message, "<?> expected but was\n<?>.\n", expected, actual) assert_block(full_message) { expected == actual } end
Passes if expected_float and actual_float are equal within delta tolerance.
Example:
assert_in_delta 0.05, (50000.0 / 10**6), 0.00001
# File test/unit/assertions.rb, line 445 def assert_in_delta(expected_float, actual_float, delta, message="") _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") full_message = build_message(message, "<?> and\n<?> expected to be within\n<?> of each other.\n", expected_float, actual_float, delta) assert_block(full_message) { (expected_float.to_f - actual_float.to_f).abs <= delta.to_f } end end
Passes if object .instance_of? klass
Example:
assert_instance_of String, 'foo'
# File test/unit/assertions.rb, line 153 def assert_instance_of(klass, object, message="") _wrap_assertion do assert_equal(Class, klass.class, "assert_instance_of takes a Class as its first argument") full_message = build_message(message, "<?> expected to be an instance of\n<?> but was\n<?>.\n", object, klass, object.class) assert_block(full_message){object.instance_of?(klass)} end end
Passes if object .kind_of? klass
Example:
assert_kind_of Object, 'foo'
# File test/unit/assertions.rb, line 184 def assert_kind_of(klass, object, message="") _wrap_assertion do assert(klass.kind_of?(Module), "The first parameter to assert_kind_of should be a kind_of Module.") full_message = build_message(message, "<?>\nexpected to be kind_of\\?\n<?> but was\n<?>.", object, klass, object.class) assert_block(full_message){object.kind_of?(klass)} end end
Passes if string =~ pattern.
Example:
assert_match(/\d+/, 'five, 6, seven')
# File test/unit/assertions.rb, line 223 def assert_match(pattern, string, message="") _wrap_assertion do pattern = case(pattern) when String Regexp.new(Regexp.escape(pattern)) else pattern end full_message = build_message(message, "<?> expected to be =~\n<?>.", string, pattern) assert_block(full_message) { string =~ pattern } end end
Passes if object is nil.
Example:
assert_nil [1, 2].uniq!
# File test/unit/assertions.rb, line 173 def assert_nil(object, message="") assert_equal(nil, object, message) end
Passes if regexp !~ string
Example:
assert_no_match(/two/, 'one 2 three')
# File test/unit/assertions.rb, line 370 def assert_no_match(regexp, string, message="") _wrap_assertion do assert_instance_of(Regexp, regexp, "The first argument to assert_no_match should be a Regexp.") full_message = build_message(message, "<?> expected to not match\n<?>.", regexp, string) assert_block(full_message) { regexp !~ string } end end
Passes if expected != actual
Example:
assert_not_equal 'some string', 5
# File test/unit/assertions.rb, line 346 def assert_not_equal(expected, actual, message="") full_message = build_message(message, "<?> expected to be != to\n<?>.", expected, actual) assert_block(full_message) { expected != actual } end
Passes if ! object .nil?
Example:
assert_not_nil '1 two 3'.sub!(/two/, '2')
# File test/unit/assertions.rb, line 358 def assert_not_nil(object, message="") full_message = build_message(message, "<?> expected to not be nil.", object) assert_block(full_message){!object.nil?} end
Passes if ! actual .equal? expected
Example:
assert_not_same Object.new, Object.new
# File test/unit/assertions.rb, line 328 def assert_not_same(expected, actual, message="") full_message = build_message(message, "<?>\nwith id <?> expected to not be equal\\\\? to\n<?>\nwith id <?>.\n", expected, expected.__id__, actual, actual.__id__) assert_block(full_message) { !actual.equal?(expected) } end
Passes if block does not raise an exception.
Example:
assert_nothing_raised do
[1, 2].uniq
end
# File test/unit/assertions.rb, line 288 def assert_nothing_raised(*args) _wrap_assertion do if Module === args.last message = "" else message = args.pop end exceptions, modules = _check_exception_class(args) begin yield rescue Exception => e if ((args.empty? && !e.instance_of?(AssertionFailedError)) || _expected_exception?(e, exceptions, modules)) assert_block(build_message(message, "Exception raised:\n?", e)){false} else raise end end nil end end
Passes if block does not throw anything.
Example:
assert_nothing_thrown do [1, 2].uniq end
# File test/unit/assertions.rb, line 421 def assert_nothing_thrown(message="", &proc) _wrap_assertion do assert(block_given?, "Should have passed a block to assert_nothing_thrown") begin proc.call rescue NameError, ThreadError => error if UncaughtThrow[error.class] !~ error.message raise error end full_message = build_message(message, "<?> was thrown when nothing was expected", $1.intern) flunk(full_message) end assert(true, "Expected nothing to be thrown") end end
Compares the +object1+ with +object2+ using operator.
Passes if object1.send(operator, object2) is true.
Example:
assert_operator 5, :>=, 4
# File test/unit/assertions.rb, line 265 def assert_operator(object1, operator, object2, message="") _wrap_assertion do full_message = build_message(nil, "<?>\ngiven as the operator for #assert_operator must be a Symbol or #respond_to\\?(:to_str).", operator) assert_block(full_message){operator.kind_of?(Symbol) || operator.respond_to?(:to_str)} full_message = build_message(message, "<?> expected to be\n?\n<?>.\n", object1, AssertionMessage.literal(operator), object2) assert_block(full_message) { object1.__send__(operator, object2) } end end
Passes if the block raises one of the given exceptions.
Example:
assert_raise RuntimeError, LoadError do
raise 'Boom!!!'
end
# File test/unit/assertions.rb, line 111 def assert_raise(*args) _wrap_assertion do if Module === args.last message = "" else message = args.pop end exceptions, modules = _check_exception_class(args) expected = args.size == 1 ? args.first : args actual_exception = nil full_message = build_message(message, "<?> exception expected but none was thrown.", expected) assert_block(full_message) do begin yield rescue Exception => actual_exception break end false end full_message = build_message(message, "<?> exception expected but was\n?", expected, actual_exception) assert_block(full_message) {_expected_exception?(actual_exception, exceptions, modules)} actual_exception end end
Alias of assert_raise.
Will be deprecated in 1.9, and removed in 2.0.
# File test/unit/assertions.rb, line 142 def assert_raises(*args, &block) assert_raise(*args, &block) end
Passes if object .respond_to? method
Example:
assert_respond_to 'bugbear', :slice
# File test/unit/assertions.rb, line 199 def assert_respond_to(object, method, message="") _wrap_assertion do full_message = build_message(nil, "<?>\ngiven as the method name argument to #assert_respond_to must be a Symbol or #respond_to\\?(:to_str).", method) assert_block(full_message) do method.kind_of?(Symbol) || method.respond_to?(:to_str) end full_message = build_message(message, "<?>\nof type <?>\nexpected to respond_to\\\\?<?>.\n", object, object.class, method) assert_block(full_message) { object.respond_to?(method) } end end
Passes if actual .equal? expected (i.e. they are the same instance).
Example:
o = Object.new assert_same o, o
# File test/unit/assertions.rb, line 245 def assert_same(expected, actual, message="") full_message = build_message(message, "<?>\nwith id <?> expected to be equal\\\\? to\n<?>\nwith id <?>.\n", expected, expected.__id__, actual, actual.__id__) assert_block(full_message) { actual.equal?(expected) } end
Passes if the method send returns a true value.
send_array is composed of:
Example:
assert_send [[1, 2], :include?, 4]
# File test/unit/assertions.rb, line 473 def assert_send(send_array, message="") _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") full_message = build_message(message, "<?> expected to respond to\n<?(?)> with a true value.\n", send_array[0], AssertionMessage.literal(send_array[1].to_s), send_array[2..-1]) assert_block(full_message) { send_array[0].__send__(send_array[1], *send_array[2..-1]) } end end
Passes if the block throws expected_symbol
Example:
assert_throws :done do
throw :done
end
# File test/unit/assertions.rb, line 390 def assert_throws(expected_symbol, message="", &proc) _wrap_assertion do assert_instance_of(Symbol, expected_symbol, "assert_throws expects the symbol that should be thrown for its first argument") assert_block("Should have passed a block to assert_throws."){block_given?} caught = true begin catch(expected_symbol) do proc.call caught = false end full_message = build_message(message, "<?> should have been thrown.", expected_symbol) assert_block(full_message){caught} rescue NameError, ThreadError => error if UncaughtThrow[error.class] !~ error.message raise error end full_message = build_message(message, "<?> expected to be thrown but\n<?> was thrown.", expected_symbol, $1.intern) flunk(full_message) end end end
Builds a failure message. head is added before the template and arguments replaces the ’?’s positionally in the template.
# File test/unit/assertions.rb, line 491 def build_message(head, template=nil, *arguments) template &&= template.chomp return AssertionMessage.new(head, template, arguments) end
ruby-doc.org is hosted and maintained by James Britt and Neurogami, LLC, a Ruby consulting company. The site was created in 2002 as part of the Ruby Documentation Project to promote the Ruby language and to help other Ruby hackers.
Documentation content on ruby-doc.org is provided by remarkable members of the Ruby community.
For more information on the Ruby programming language, visit ruby-lang.org.
For information about this site or Neurogami, contact james@neurogami.com.