mirror of
https://github.com/ruby/ruby.git
synced 2022-11-09 12:17:21 -05:00
c02de30efb
by using ObjectSpace.trace_object_allocations. `make test-all LEAK_CHECKER_TRACE_OBJECT_ALLOCATION=true` will print not only leaked fds but also where it was created.
1434 lines
36 KiB
Ruby
1434 lines
36 KiB
Ruby
# encoding: utf-8
|
|
# frozen_string_literal: true
|
|
|
|
require "optparse"
|
|
require "rbconfig"
|
|
require "leakchecker"
|
|
|
|
##
|
|
# Minimal (mostly drop-in) replacement for test-unit.
|
|
#
|
|
# :include: README.txt
|
|
|
|
module MiniTest
|
|
|
|
def self.const_missing name # :nodoc:
|
|
case name
|
|
when :MINI_DIR then
|
|
msg = "MiniTest::MINI_DIR was removed. Don't violate other's internals."
|
|
warn "WAR\NING: #{msg}"
|
|
warn "WAR\NING: Used by #{caller.first}."
|
|
const_set :MINI_DIR, "bad value"
|
|
else
|
|
super
|
|
end
|
|
end
|
|
|
|
##
|
|
# Assertion base class
|
|
|
|
class Assertion < Exception; end
|
|
|
|
##
|
|
# Assertion raised when skipping a test
|
|
|
|
class Skip < Assertion; end
|
|
|
|
class << self
|
|
##
|
|
# Filter object for backtraces.
|
|
|
|
attr_accessor :backtrace_filter
|
|
end
|
|
|
|
class BacktraceFilter # :nodoc:
|
|
def filter bt
|
|
return ["No backtrace"] unless bt
|
|
|
|
new_bt = []
|
|
|
|
unless $DEBUG then
|
|
bt.each do |line|
|
|
break if line =~ /lib\/minitest/
|
|
new_bt << line
|
|
end
|
|
|
|
new_bt = bt.reject { |line| line =~ /lib\/minitest/ } if new_bt.empty?
|
|
new_bt = bt.dup if new_bt.empty?
|
|
else
|
|
new_bt = bt.dup
|
|
end
|
|
|
|
new_bt
|
|
end
|
|
end
|
|
|
|
self.backtrace_filter = BacktraceFilter.new
|
|
|
|
def self.filter_backtrace bt # :nodoc:
|
|
backtrace_filter.filter bt
|
|
end
|
|
|
|
##
|
|
# MiniTest Assertions. All assertion methods accept a +msg+ which is
|
|
# printed if the assertion fails.
|
|
|
|
module Assertions
|
|
##
|
|
# Returns the diff command to use in #diff. Tries to intelligently
|
|
# figure out what diff to use.
|
|
|
|
def self.diff
|
|
unless defined? @diff
|
|
exe = RbConfig::CONFIG['EXEEXT']
|
|
@diff = %W"gdiff#{exe} diff#{exe}".find do |diff|
|
|
if system(diff, "-u", __FILE__, __FILE__)
|
|
break "#{diff} -u"
|
|
end
|
|
end
|
|
end
|
|
|
|
@diff
|
|
end
|
|
|
|
##
|
|
# Set the diff command to use in #diff.
|
|
|
|
def self.diff= o
|
|
@diff = o
|
|
end
|
|
|
|
##
|
|
# 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.
|
|
|
|
def diff exp, act
|
|
require "tempfile"
|
|
|
|
expect = mu_pp_for_diff exp
|
|
butwas = mu_pp_for_diff act
|
|
result = nil
|
|
|
|
need_to_diff =
|
|
MiniTest::Assertions.diff &&
|
|
(expect.include?("\n") ||
|
|
butwas.include?("\n") ||
|
|
expect.size > 30 ||
|
|
butwas.size > 30 ||
|
|
expect == butwas)
|
|
|
|
return "Expected: #{mu_pp exp}\n Actual: #{mu_pp act}" unless
|
|
need_to_diff
|
|
|
|
tempfile_a = nil
|
|
tempfile_b = nil
|
|
|
|
Tempfile.open("expect") do |a|
|
|
tempfile_a = a
|
|
a.puts expect
|
|
a.flush
|
|
|
|
Tempfile.open("butwas") do |b|
|
|
tempfile_b = 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
|
|
ensure
|
|
tempfile_a.close! if tempfile_a
|
|
tempfile_b.close! if tempfile_b
|
|
end
|
|
|
|
##
|
|
# This returns a human-readable version of +obj+. By default
|
|
# #inspect is called. You can override this to use #pretty_print
|
|
# if you want.
|
|
|
|
def mu_pp obj
|
|
s = obj.inspect
|
|
s = s.encode Encoding.default_external if defined? Encoding
|
|
s
|
|
end
|
|
|
|
##
|
|
# This returns a diff-able human-readable version of +obj+. This
|
|
# differs from the regular mu_pp because it expands escaped
|
|
# newlines and makes hex-values generic (like object_ids). This
|
|
# uses mu_pp to do the first pass and then cleans it up.
|
|
|
|
def mu_pp_for_diff obj
|
|
mu_pp(obj).gsub(/(?<!\\)(?:\\\\)*\K\\n/, "\n").gsub(/:0x[a-fA-F0-9]{4,}/m, ':0xXXXXXX')
|
|
end
|
|
|
|
def _assertions= n # :nodoc:
|
|
@_assertions = n
|
|
end
|
|
|
|
def _assertions # :nodoc:
|
|
@_assertions ||= 0
|
|
end
|
|
|
|
##
|
|
# Fails unless +test+ is a true value.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless +obj+ is empty.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless <tt>exp == act</tt> 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 floats use assert_in_delta.
|
|
#
|
|
# See also: MiniTest::Assertions.diff
|
|
|
|
def assert_equal exp, act, msg = nil
|
|
msg = message(msg, "") { diff exp, act }
|
|
assert exp == act, msg
|
|
end
|
|
|
|
##
|
|
# 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
|
|
|
|
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
|
|
|
|
##
|
|
# For comparing Floats. Fails unless +exp+ and +act+ have a relative
|
|
# error less than +epsilon+.
|
|
|
|
def assert_in_epsilon a, b, epsilon = 0.001, msg = nil
|
|
assert_in_delta a, b, [a.abs, b.abs].min * epsilon, msg
|
|
end
|
|
|
|
##
|
|
# Fails unless +collection+ includes +obj+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless +obj+ is an instance of +cls+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless +obj+ is a kind of +cls+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless +matcher+ <tt>=~</tt> +obj+.
|
|
|
|
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
|
|
end
|
|
|
|
##
|
|
# Fails unless +obj+ is nil
|
|
|
|
def assert_nil obj, msg = nil
|
|
msg = message(msg) { "Expected #{mu_pp(obj)} to be nil" }
|
|
assert obj.nil?, msg
|
|
end
|
|
|
|
##
|
|
# For testing with binary operators.
|
|
#
|
|
# assert_operator 5, :<=, 4
|
|
|
|
def assert_operator o1, op, o2 = (predicate = true; nil), msg = nil
|
|
return assert_predicate o1, op, msg if predicate
|
|
msg = message(msg) { "Expected #{mu_pp(o1)} to be #{op} #{mu_pp(o2)}" }
|
|
assert o1.__send__(op, o2), msg
|
|
end
|
|
|
|
##
|
|
# 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.
|
|
#
|
|
# NOTE: this uses #capture_io, not #capture_subprocess_io.
|
|
#
|
|
# See also: #assert_silent
|
|
|
|
def assert_output stdout = nil, stderr = nil
|
|
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)
|
|
end
|
|
|
|
##
|
|
# For testing with predicates.
|
|
#
|
|
# assert_predicate str, :empty?
|
|
#
|
|
# This is really meant for specs and is front-ended by assert_operator:
|
|
#
|
|
# str.must_be :empty?
|
|
|
|
def assert_predicate o1, op, msg = nil
|
|
msg = message(msg) { "Expected #{mu_pp(o1)} to be #{op}" }
|
|
assert o1.__send__(op), msg
|
|
end
|
|
|
|
##
|
|
# Fails unless the block raises one of +exp+. Returns the
|
|
# exception matched so you can check the message, attributes, etc.
|
|
|
|
def assert_raises *exp
|
|
msg = "#{exp.pop}.\n" if String === exp.last
|
|
|
|
begin
|
|
yield
|
|
rescue MiniTest::Skip => e
|
|
return e if exp.include? MiniTest::Skip
|
|
raise e
|
|
rescue Exception => e
|
|
expected = exp.any? { |ex|
|
|
if ex.instance_of? Module then
|
|
e.kind_of? ex
|
|
else
|
|
e.instance_of? ex
|
|
end
|
|
}
|
|
|
|
assert expected, proc {
|
|
exception_details(e, "#{msg}#{mu_pp(exp)} exception expected, not")
|
|
}
|
|
|
|
return e
|
|
end
|
|
|
|
exp = exp.first if exp.size == 1
|
|
|
|
flunk "#{msg}#{mu_pp(exp)} expected but nothing was raised."
|
|
end
|
|
|
|
##
|
|
# Fails unless +obj+ responds to +meth+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails unless +exp+ and +act+ are #equal?
|
|
|
|
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
|
|
|
|
##
|
|
# +send_ary+ is a receiver, message and arguments.
|
|
#
|
|
# Fails unless the call returns a true value
|
|
# TODO: I should prolly remove this from specs
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if the block outputs anything to stderr or stdout.
|
|
#
|
|
# See also: #assert_output
|
|
|
|
def assert_silent
|
|
assert_output "", "" do
|
|
yield
|
|
end
|
|
end
|
|
|
|
##
|
|
# Fails unless the block throws +sym+
|
|
|
|
def assert_throws sym, msg = nil
|
|
default = "Expected #{mu_pp(sym)} to have been thrown"
|
|
caught = true
|
|
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
|
|
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
|
|
|
|
##
|
|
# 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.
|
|
|
|
def capture_io
|
|
require 'stringio'
|
|
|
|
captured_stdout, captured_stderr = StringIO.new, StringIO.new
|
|
|
|
synchronize do
|
|
orig_stdout, orig_stderr = $stdout, $stderr
|
|
$stdout, $stderr = captured_stdout, captured_stderr
|
|
|
|
begin
|
|
yield
|
|
ensure
|
|
$stdout = orig_stdout
|
|
$stderr = orig_stderr
|
|
end
|
|
end
|
|
|
|
return captured_stdout.string, captured_stderr.string
|
|
end
|
|
alias capture_output capture_io
|
|
|
|
##
|
|
# 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.
|
|
|
|
def capture_subprocess_io
|
|
require 'tempfile'
|
|
|
|
captured_stdout, captured_stderr = Tempfile.new("out"), Tempfile.new("err")
|
|
|
|
synchronize do
|
|
orig_stdout, orig_stderr = $stdout.dup, $stderr.dup
|
|
$stdout.reopen captured_stdout
|
|
$stderr.reopen captured_stderr
|
|
|
|
begin
|
|
yield
|
|
|
|
$stdout.rewind
|
|
$stderr.rewind
|
|
|
|
[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
|
|
|
|
##
|
|
# Returns details for exception +e+
|
|
|
|
def exception_details e, msg
|
|
[
|
|
"#{msg}",
|
|
"Class: <#{e.class}>",
|
|
"Message: <#{e.message.inspect}>",
|
|
"---Backtrace---",
|
|
"#{MiniTest::filter_backtrace(e.backtrace).join("\n")}",
|
|
"---------------",
|
|
].join "\n"
|
|
end
|
|
|
|
##
|
|
# Fails with +msg+
|
|
|
|
def flunk msg = nil
|
|
msg ||= "Epic Fail!"
|
|
assert false, msg
|
|
end
|
|
|
|
##
|
|
# Returns a proc that will output +msg+ along with the default message.
|
|
|
|
def message msg = nil, ending = ".", &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
|
|
|
|
##
|
|
# used for counting assertions
|
|
|
|
def pass msg = nil
|
|
assert true
|
|
end
|
|
|
|
##
|
|
# Fails if +test+ is a true value
|
|
|
|
def refute test, msg = nil
|
|
msg ||= "Failed refutation, no message given"
|
|
not assert(! test, msg)
|
|
end
|
|
|
|
##
|
|
# Fails if +obj+ is empty.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if <tt>exp == act</tt>.
|
|
#
|
|
# For floats use refute_in_delta.
|
|
|
|
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
|
|
|
|
##
|
|
# For comparing Floats. Fails if +exp+ is within +delta+ of +act+.
|
|
#
|
|
# refute_in_delta Math::PI, (22.0 / 7.0)
|
|
|
|
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
|
|
|
|
##
|
|
# For comparing Floats. Fails if +exp+ and +act+ have a relative error
|
|
# less than +epsilon+.
|
|
|
|
def refute_in_epsilon a, b, epsilon = 0.001, msg = nil
|
|
refute_in_delta a, b, a * epsilon, msg
|
|
end
|
|
|
|
##
|
|
# Fails if +collection+ includes +obj+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if +obj+ is an instance of +cls+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if +obj+ is a kind of +cls+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if +matcher+ <tt>=~</tt> +obj+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if +obj+ is nil.
|
|
|
|
def refute_nil obj, msg = nil
|
|
msg = message(msg) { "Expected #{mu_pp(obj)} to not be nil" }
|
|
refute obj.nil?, msg
|
|
end
|
|
|
|
##
|
|
# Fails if +o1+ is not +op+ +o2+. Eg:
|
|
#
|
|
# refute_operator 1, :>, 2 #=> pass
|
|
# refute_operator 1, :<, 2 #=> fail
|
|
|
|
def refute_operator o1, op, o2 = (predicate = true; nil), msg = nil
|
|
return refute_predicate o1, op, msg if predicate
|
|
msg = message(msg) { "Expected #{mu_pp(o1)} to not be #{op} #{mu_pp(o2)}"}
|
|
refute o1.__send__(op, o2), msg
|
|
end
|
|
|
|
##
|
|
# 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?
|
|
|
|
def refute_predicate o1, op, msg = nil
|
|
msg = message(msg) { "Expected #{mu_pp(o1)} to not be #{op}" }
|
|
refute o1.__send__(op), msg
|
|
end
|
|
|
|
##
|
|
# Fails if +obj+ responds to the message +meth+.
|
|
|
|
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
|
|
|
|
##
|
|
# Fails if +exp+ is the same (by object identity) as +act+.
|
|
|
|
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
|
|
|
|
##
|
|
# Skips the current test. Gets listed at the end of the run but
|
|
# doesn't cause a failure exit code.
|
|
|
|
def skip msg = nil, bt = caller
|
|
msg ||= "Skipped, no message given"
|
|
@skip = true
|
|
raise MiniTest::Skip, msg, bt
|
|
end
|
|
|
|
alias omit skip
|
|
|
|
##
|
|
# Was this testcase skipped? Meant for #teardown.
|
|
|
|
def skipped?
|
|
defined?(@skip) and @skip
|
|
end
|
|
|
|
##
|
|
# Takes a block and wraps it with the runner's shared mutex.
|
|
|
|
def synchronize
|
|
Minitest::Unit.runner.synchronize do
|
|
yield
|
|
end
|
|
end
|
|
end
|
|
|
|
class Unit # :nodoc:
|
|
VERSION = "4.7.5" # :nodoc:
|
|
|
|
attr_accessor :report, :failures, :errors, :skips # :nodoc:
|
|
attr_accessor :assertion_count # :nodoc:
|
|
attr_writer :test_count # :nodoc:
|
|
attr_accessor :start_time # :nodoc:
|
|
attr_accessor :help # :nodoc:
|
|
attr_accessor :verbose # :nodoc:
|
|
attr_writer :options # :nodoc:
|
|
|
|
##
|
|
# :attr:
|
|
#
|
|
# if true, installs an "INFO" signal handler (only available to BSD and
|
|
# OS X users) which prints diagnostic information about the test run.
|
|
#
|
|
# This is auto-detected by default but may be overridden by custom
|
|
# runners.
|
|
|
|
attr_accessor :info_signal
|
|
|
|
##
|
|
# Lazy accessor for options.
|
|
|
|
def options
|
|
@options ||= {}
|
|
end
|
|
|
|
@@installed_at_exit ||= false
|
|
@@out = $stdout
|
|
@@after_tests = []
|
|
|
|
##
|
|
# A simple hook allowing you to run a block of code after _all_ of
|
|
# the tests are done. Eg:
|
|
#
|
|
# MiniTest::Unit.after_tests { p $debugging_info }
|
|
|
|
def self.after_tests &block
|
|
@@after_tests << block
|
|
end
|
|
|
|
##
|
|
# Registers MiniTest::Unit to run tests at process exit
|
|
|
|
def self.autorun
|
|
at_exit {
|
|
# don't run if there was a non-exit exception
|
|
next if $! and not $!.kind_of? SystemExit
|
|
|
|
# the order here is important. The at_exit handler must be
|
|
# installed before anyone else gets a chance to install their
|
|
# own, that way we can be assured that our exit will be last
|
|
# to run (at_exit stacks).
|
|
exit_code = nil
|
|
|
|
at_exit {
|
|
@@after_tests.reverse_each(&:call)
|
|
exit false if exit_code && exit_code != 0
|
|
}
|
|
|
|
exit_code = MiniTest::Unit.new.run ARGV
|
|
} unless @@installed_at_exit
|
|
@@installed_at_exit = true
|
|
end
|
|
|
|
##
|
|
# Returns the stream to use for output.
|
|
|
|
def self.output
|
|
@@out
|
|
end
|
|
|
|
##
|
|
# Sets MiniTest::Unit to write output to +stream+. $stdout is the default
|
|
# output
|
|
|
|
def self.output= stream
|
|
@@out = stream
|
|
end
|
|
|
|
##
|
|
# Tells MiniTest::Unit to delegate to +runner+, an instance of a
|
|
# MiniTest::Unit subclass, when MiniTest::Unit#run is called.
|
|
|
|
def self.runner= runner
|
|
@@runner = runner
|
|
end
|
|
|
|
##
|
|
# Returns the MiniTest::Unit subclass instance that will be used
|
|
# to run the tests. A MiniTest::Unit instance is the default
|
|
# runner.
|
|
|
|
def self.runner
|
|
@@runner ||= self.new
|
|
end
|
|
|
|
##
|
|
# Return all plugins' run methods (methods that start with "run_").
|
|
|
|
def self.plugins
|
|
@@plugins ||= (["run_tests"] +
|
|
public_instance_methods(false).
|
|
grep(/^run_/).map { |s| s.to_s }).uniq
|
|
end
|
|
|
|
##
|
|
# Return the IO for output.
|
|
|
|
def output
|
|
self.class.output
|
|
end
|
|
|
|
def puts *a # :nodoc:
|
|
output.puts(*a)
|
|
end
|
|
|
|
def print *a # :nodoc:
|
|
output.print(*a)
|
|
end
|
|
|
|
def test_count # :nodoc:
|
|
@test_count ||= 0
|
|
end
|
|
|
|
##
|
|
# Runner for a given +type+ (eg, test vs bench).
|
|
|
|
def _run_anything type
|
|
suites = TestCase.send "#{type}_suites"
|
|
return if suites.empty?
|
|
|
|
puts
|
|
puts "# Running #{type}s:"
|
|
puts
|
|
|
|
@test_count, @assertion_count = 0, 0
|
|
test_count = assertion_count = 0
|
|
sync = output.respond_to? :"sync=" # stupid emacs
|
|
old_sync, output.sync = output.sync, true if sync
|
|
|
|
count = 0
|
|
begin
|
|
start = Time.now
|
|
|
|
results = _run_suites suites, type
|
|
|
|
@test_count = results.inject(0) { |sum, (tc, _)| sum + tc }
|
|
@assertion_count = results.inject(0) { |sum, (_, ac)| sum + ac }
|
|
test_count += @test_count
|
|
assertion_count += @assertion_count
|
|
t = Time.now - start
|
|
count += 1
|
|
unless @repeat_count
|
|
puts
|
|
puts
|
|
end
|
|
puts "Finished%s %ss in %.6fs, %.4f tests/s, %.4f assertions/s.\n" %
|
|
[(@repeat_count ? "(#{count}/#{@repeat_count}) " : ""), type,
|
|
t, @test_count.fdiv(t), @assertion_count.fdiv(t)]
|
|
end while @repeat_count && count < @repeat_count &&
|
|
report.empty? && failures.zero? && errors.zero?
|
|
|
|
output.sync = old_sync if sync
|
|
|
|
report.each_with_index do |msg, i|
|
|
puts "\n%3d) %s" % [i + 1, msg]
|
|
end
|
|
|
|
puts
|
|
@test_count = test_count
|
|
@assertion_count = assertion_count
|
|
|
|
status
|
|
end
|
|
|
|
##
|
|
# Runs all the +suites+ for a given +type+.
|
|
#
|
|
|
|
def _run_suites suites, type
|
|
suites.map { |suite| _run_suite suite, type }
|
|
end
|
|
|
|
##
|
|
# Run a single +suite+ for a given +type+.
|
|
|
|
def _run_suite suite, type
|
|
header = "#{type}_suite_header"
|
|
puts send(header, suite) if respond_to? header
|
|
|
|
filter = options[:filter] || '/./'
|
|
filter = Regexp.new $1 if filter =~ /\/(.*)\//
|
|
|
|
all_test_methods = suite.send "#{type}_methods"
|
|
|
|
filtered_test_methods = all_test_methods.find_all { |m|
|
|
filter === m || filter === "#{suite}##{m}"
|
|
}
|
|
|
|
leakchecker = LeakChecker.new
|
|
|
|
continuation = proc do
|
|
assertions = filtered_test_methods.map { |method|
|
|
inst = suite.new method
|
|
inst._assertions = 0
|
|
|
|
print "#{suite}##{method} = " if @verbose
|
|
|
|
start_time = Time.now if @verbose
|
|
result = inst.run self
|
|
|
|
print "%.2f s = " % (Time.now - start_time) if @verbose
|
|
print result
|
|
puts if @verbose
|
|
$stdout.flush
|
|
|
|
unless defined?(RubyVM::MJIT) && RubyVM::MJIT.enabled? # compiler process is wrongly considered as leak
|
|
leakchecker.check("#{inst.class}\##{inst.__name__}")
|
|
end
|
|
|
|
inst._assertions
|
|
}
|
|
return assertions.size, assertions.inject(0) { |sum, n| sum + n }
|
|
end
|
|
|
|
if ENV["LEAK_CHECKER_TRACE_OBJECT_ALLOCATION"]
|
|
require "objspace"
|
|
ObjectSpace.trace_object_allocations(&continuation)
|
|
else
|
|
continuation.call
|
|
end
|
|
end
|
|
|
|
##
|
|
# Record the result of a single test. Makes it very easy to gather
|
|
# information. Eg:
|
|
#
|
|
# class StatisticsRecorder < MiniTest::Unit
|
|
# def record suite, method, assertions, time, error
|
|
# # ... record the results somewhere ...
|
|
# end
|
|
# end
|
|
#
|
|
# MiniTest::Unit.runner = StatisticsRecorder.new
|
|
#
|
|
# NOTE: record might be sent more than once per test. It will be
|
|
# sent once with the results from the test itself. If there is a
|
|
# failure or error in teardown, it will be sent again with the
|
|
# error or failure.
|
|
|
|
def record suite, method, assertions, time, error
|
|
end
|
|
|
|
def location e # :nodoc:
|
|
last_before_assertion = ""
|
|
|
|
return '<empty>' unless e.backtrace # SystemStackError can return nil.
|
|
|
|
e.backtrace.reverse_each do |s|
|
|
break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
|
|
last_before_assertion = s
|
|
end
|
|
last_before_assertion.sub(/:in .*$/, '')
|
|
end
|
|
|
|
##
|
|
# Writes status for failed test +meth+ in +klass+ which finished with
|
|
# exception +e+
|
|
|
|
def puke klass, meth, e
|
|
e = case e
|
|
when MiniTest::Skip then
|
|
@skips += 1
|
|
return "S" unless @verbose
|
|
"Skipped:\n#{klass}##{meth} [#{location e}]:\n#{e.message}\n"
|
|
when MiniTest::Assertion then
|
|
@failures += 1
|
|
"Failure:\n#{klass}##{meth} [#{location e}]:\n#{e.message}\n"
|
|
else
|
|
@errors += 1
|
|
bt = MiniTest::filter_backtrace(e.backtrace).join "\n "
|
|
"Error:\n#{klass}##{meth}:\n#{e.class}: #{e.message.b}\n #{bt}\n"
|
|
end
|
|
@report << e
|
|
e[0, 1]
|
|
end
|
|
|
|
def initialize # :nodoc:
|
|
@report = []
|
|
@errors = @failures = @skips = 0
|
|
@verbose = false
|
|
@mutex = Thread::Mutex.new
|
|
@info_signal = Signal.list['INFO']
|
|
@repeat_count = nil
|
|
end
|
|
|
|
def synchronize # :nodoc:
|
|
if @mutex then
|
|
@mutex.synchronize { yield }
|
|
else
|
|
yield
|
|
end
|
|
end
|
|
|
|
def process_args args = [] # :nodoc:
|
|
options = {}
|
|
orig_args = args.dup
|
|
|
|
OptionParser.new do |opts|
|
|
opts.banner = 'minitest options:'
|
|
opts.version = MiniTest::Unit::VERSION
|
|
|
|
opts.on '-h', '--help', 'Display this help.' do
|
|
puts opts
|
|
exit
|
|
end
|
|
|
|
opts.on '-s', '--seed SEED', Integer, "Sets random seed" do |m|
|
|
options[:seed] = m.to_i
|
|
end
|
|
|
|
opts.on '-v', '--verbose', "Verbose. Show progress processing files." do
|
|
options[:verbose] = true
|
|
end
|
|
|
|
opts.on '-n', '--name PATTERN', "Filter test names on pattern (e.g. /foo/)" do |a|
|
|
options[:filter] = a
|
|
end
|
|
|
|
opts.parse! args
|
|
orig_args -= args
|
|
end
|
|
|
|
unless options[:seed] then
|
|
srand
|
|
options[:seed] = srand % 0xFFFF
|
|
orig_args << "--seed" << options[:seed].to_s
|
|
end
|
|
|
|
srand options[:seed]
|
|
|
|
self.verbose = options[:verbose]
|
|
@help = orig_args.map { |s| s =~ /[\s|&<>$()]/ ? s.inspect : s }.join " "
|
|
|
|
options
|
|
end
|
|
|
|
##
|
|
# Begins the full test run. Delegates to +runner+'s #_run method.
|
|
|
|
def run args = []
|
|
self.class.runner._run(args)
|
|
end
|
|
|
|
##
|
|
# Top level driver, controls all output and filtering.
|
|
|
|
def _run args = []
|
|
args = process_args args # ARGH!! blame test/unit process_args
|
|
self.options.merge! args
|
|
|
|
puts "Run options: #{help}"
|
|
|
|
self.class.plugins.each do |plugin|
|
|
send plugin
|
|
break unless report.empty?
|
|
end
|
|
|
|
return failures + errors if self.test_count > 0 # or return nil...
|
|
rescue Interrupt
|
|
abort 'Interrupted'
|
|
end
|
|
|
|
##
|
|
# Runs test suites matching +filter+.
|
|
|
|
def run_tests
|
|
_run_anything :test
|
|
end
|
|
|
|
##
|
|
# Writes status to +io+
|
|
|
|
def status io = self.output
|
|
format = "%d tests, %d assertions, %d failures, %d errors, %d skips"
|
|
io.puts format % [test_count, assertion_count, failures, errors, skips]
|
|
end
|
|
|
|
##
|
|
# Provides a simple set of guards that you can use in your tests
|
|
# to skip execution if it is not applicable. These methods are
|
|
# mixed into TestCase as both instance and class methods so you
|
|
# can use them inside or outside of the test methods.
|
|
#
|
|
# def test_something_for_mri
|
|
# skip "bug 1234" if jruby?
|
|
# # ...
|
|
# end
|
|
#
|
|
# if windows? then
|
|
# # ... lots of test methods ...
|
|
# end
|
|
|
|
module Guard
|
|
|
|
##
|
|
# Is this running on jruby?
|
|
|
|
def jruby? platform = RUBY_PLATFORM
|
|
"java" == platform
|
|
end
|
|
|
|
##
|
|
# Is this running on mri?
|
|
|
|
def maglev? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
|
|
"maglev" == platform
|
|
end
|
|
|
|
module_function :maglev?
|
|
|
|
##
|
|
# Is this running on mri?
|
|
|
|
def mri? platform = RUBY_DESCRIPTION
|
|
/^ruby/ =~ platform
|
|
end
|
|
|
|
##
|
|
# Is this running on rubinius?
|
|
|
|
def rubinius? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
|
|
"rbx" == platform
|
|
end
|
|
|
|
##
|
|
# Is this running on windows?
|
|
|
|
def windows? platform = RUBY_PLATFORM
|
|
/mswin|mingw/ =~ platform
|
|
end
|
|
|
|
##
|
|
# Is this running on mingw?
|
|
|
|
def mingw? platform = RUBY_PLATFORM
|
|
/mingw/ =~ platform
|
|
end
|
|
|
|
end
|
|
|
|
##
|
|
# Provides before/after hooks for setup and teardown. These are
|
|
# meant for library writers, NOT for regular test authors. See
|
|
# #before_setup for an example.
|
|
|
|
module LifecycleHooks
|
|
##
|
|
# Runs before every test, after setup. This hook is meant for
|
|
# libraries to extend minitest. It is not meant to be used by
|
|
# test developers.
|
|
#
|
|
# See #before_setup for an example.
|
|
|
|
def after_setup; end
|
|
|
|
##
|
|
# Runs before every test, before setup. This hook is meant for
|
|
# libraries to extend minitest. It is not meant to be used by
|
|
# test developers.
|
|
#
|
|
# As a simplistic example:
|
|
#
|
|
# module MyMinitestPlugin
|
|
# def before_setup
|
|
# super
|
|
# # ... stuff to do before setup is run
|
|
# end
|
|
#
|
|
# def after_setup
|
|
# # ... stuff to do after setup is run
|
|
# super
|
|
# end
|
|
#
|
|
# def before_teardown
|
|
# super
|
|
# # ... stuff to do before teardown is run
|
|
# end
|
|
#
|
|
# def after_teardown
|
|
# # ... stuff to do after teardown is run
|
|
# super
|
|
# end
|
|
# end
|
|
#
|
|
# class MiniTest::Unit::TestCase
|
|
# include MyMinitestPlugin
|
|
# end
|
|
|
|
def before_setup; end
|
|
|
|
##
|
|
# Runs after every test, before teardown. This hook is meant for
|
|
# libraries to extend minitest. It is not meant to be used by
|
|
# test developers.
|
|
#
|
|
# See #before_setup for an example.
|
|
|
|
def before_teardown; end
|
|
|
|
##
|
|
# Runs after every test, after teardown. This hook is meant for
|
|
# libraries to extend minitest. It is not meant to be used by
|
|
# test developers.
|
|
#
|
|
# See #before_setup for an example.
|
|
|
|
def after_teardown; end
|
|
end
|
|
|
|
##
|
|
# Subclass TestCase to create your own tests. Typically you'll want a
|
|
# TestCase subclass per implementation class.
|
|
#
|
|
# See MiniTest::Assertions
|
|
|
|
class TestCase
|
|
include LifecycleHooks
|
|
include Guard
|
|
extend Guard
|
|
|
|
attr_reader :__name__ # :nodoc:
|
|
|
|
PASSTHROUGH_EXCEPTIONS = [NoMemoryError, SignalException,
|
|
Interrupt, SystemExit] # :nodoc:
|
|
|
|
##
|
|
# Runs the tests reporting the status to +runner+
|
|
|
|
def run runner
|
|
trap "INFO" do
|
|
runner.report.each_with_index do |msg, i|
|
|
warn "\n%3d) %s" % [i + 1, msg]
|
|
end
|
|
warn ''
|
|
time = runner.start_time ? Time.now - runner.start_time : 0
|
|
warn "Current Test: %s#%s %.2fs" % [self.class, self.__name__, time]
|
|
runner.status $stderr
|
|
end if runner.info_signal
|
|
|
|
start_time = Time.now
|
|
|
|
result = ""
|
|
begin
|
|
@passed = nil
|
|
self.before_setup
|
|
self.setup
|
|
self.after_setup
|
|
self.run_test self.__name__
|
|
result = "." unless io?
|
|
time = Time.now - start_time
|
|
runner.record self.class, self.__name__, self._assertions, time, nil
|
|
@passed = true
|
|
rescue *PASSTHROUGH_EXCEPTIONS
|
|
raise
|
|
rescue Exception => e
|
|
@passed = Skip === e
|
|
time = Time.now - start_time
|
|
runner.record self.class, self.__name__, self._assertions, time, e
|
|
result = runner.puke self.class, self.__name__, e
|
|
ensure
|
|
%w{ before_teardown teardown after_teardown }.each do |hook|
|
|
begin
|
|
self.send hook
|
|
rescue *PASSTHROUGH_EXCEPTIONS
|
|
raise
|
|
rescue Exception => e
|
|
@passed = false
|
|
runner.record self.class, self.__name__, self._assertions, time, e
|
|
result = runner.puke self.class, self.__name__, e
|
|
end
|
|
end
|
|
trap 'INFO', 'DEFAULT' if runner.info_signal
|
|
end
|
|
result
|
|
end
|
|
|
|
alias :run_test :__send__
|
|
|
|
def initialize name # :nodoc:
|
|
@__name__ = name
|
|
@__io__ = nil
|
|
@passed = nil
|
|
@@current = self # FIX: make thread local
|
|
end
|
|
|
|
def self.current # :nodoc:
|
|
@@current # FIX: make thread local
|
|
end
|
|
|
|
##
|
|
# Return the output IO object
|
|
|
|
def io
|
|
@__io__ = true
|
|
MiniTest::Unit.output
|
|
end
|
|
|
|
##
|
|
# Have we hooked up the IO yet?
|
|
|
|
def io?
|
|
@__io__
|
|
end
|
|
|
|
def self.reset # :nodoc:
|
|
@@test_suites = {}
|
|
end
|
|
|
|
reset
|
|
|
|
##
|
|
# Make diffs for this TestCase use #pretty_inspect so that diff
|
|
# in assert_equal can be more details. NOTE: this is much slower
|
|
# than the regular inspect but much more usable for complex
|
|
# objects.
|
|
|
|
def self.make_my_diffs_pretty!
|
|
require 'pp'
|
|
|
|
define_method :mu_pp do |o|
|
|
o.pretty_inspect
|
|
end
|
|
end
|
|
|
|
def self.inherited klass # :nodoc:
|
|
@@test_suites[klass] = true
|
|
super
|
|
end
|
|
|
|
def self.test_order # :nodoc:
|
|
:random
|
|
end
|
|
|
|
def self.test_suites # :nodoc:
|
|
@@test_suites.keys.sort_by { |ts| ts.name.to_s }
|
|
end
|
|
|
|
def self.test_methods # :nodoc:
|
|
methods = public_instance_methods(true).grep(/^test/).map { |m| m.to_s }
|
|
|
|
case self.test_order
|
|
when :parallel
|
|
max = methods.size
|
|
ParallelEach.new methods.sort.sort_by { rand max }
|
|
when :random then
|
|
max = methods.size
|
|
methods.sort.sort_by { rand max }
|
|
when :alpha, :sorted then
|
|
methods.sort
|
|
else
|
|
raise "Unknown test_order: #{self.test_order.inspect}"
|
|
end
|
|
end
|
|
|
|
##
|
|
# Returns true if the test passed.
|
|
|
|
def passed?
|
|
@passed
|
|
end
|
|
|
|
##
|
|
# Runs before every test. Use this to set up before each test
|
|
# run.
|
|
|
|
def setup; end
|
|
|
|
##
|
|
# Runs after every test. Use this to clean up after each test
|
|
# run.
|
|
|
|
def teardown; end
|
|
|
|
include MiniTest::Assertions
|
|
end # class TestCase
|
|
end # class Unit
|
|
|
|
Test = Unit::TestCase
|
|
end # module MiniTest
|
|
|
|
Minitest = MiniTest # :nodoc: because ugh... I typo this all the time
|