1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 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 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 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 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 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 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 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 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 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 449 450 451 452 453 454 455 456 457 458 459 460 461 462 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 496 497 498 499 500 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 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 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 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 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 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 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 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 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 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238
|
require "optparse"
require "stringio"
require "etc"
require_relative "minitest/parallel"
require_relative "minitest/compress"
##
# The top-level namespace for Minitest. Also the location of the main
# runtime. See +Minitest.run+ for more information.
module Minitest
VERSION = "5.26.1" # :nodoc:
@@installed_at_exit ||= false
@@after_run = []
@extensions = []
def self.cattr_accessor name # :nodoc:
(class << self; self; end).attr_accessor name
end
##
# The random seed used for this run. This is used to srand at the
# start of the run and between each +Runnable.run+.
#
# Set via Minitest.run after processing args.
cattr_accessor :seed
##
# Parallel test executor
cattr_accessor :parallel_executor
warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"] && ENV["N"].to_i > 0
n_threads = (ENV["MT_CPU"] || ENV["N"] || Etc.nprocessors).to_i
self.parallel_executor = Parallel::Executor.new n_threads if n_threads > 1
##
# Filter object for backtraces.
cattr_accessor :backtrace_filter
##
# Reporter object to be used for all runs.
#
# NOTE: This accessor is only available during setup, not during runs.
cattr_accessor :reporter
##
# Names of known extension plugins.
cattr_accessor :extensions
##
# The signal to use for dumping information to STDERR. Defaults to "INFO".
cattr_accessor :info_signal
self.info_signal = "INFO"
cattr_accessor :allow_fork
self.allow_fork = false
##
# Registers Minitest to run at process exit
def self.autorun
Warning[:deprecated] = true if
Object.const_defined?(:Warning) && Warning.respond_to?(:[]=)
at_exit {
next if $! and not ($!.kind_of? SystemExit and $!.success?)
exit_code = nil
pid = Process.pid
at_exit {
next if !Minitest.allow_fork && Process.pid != pid
@@after_run.reverse_each(&:call)
exit exit_code || false
}
exit_code = Minitest.run ARGV
} unless @@installed_at_exit
@@installed_at_exit = true
end
##
# A simple hook allowing you to run a block of code after everything
# is done running. Eg:
#
# Minitest.after_run { p $debugging_info }
def self.after_run &block
@@after_run << block
end
##
# Register a plugin to be used. Does NOT require / load it.
def self.register_plugin name_or_mod
self.extensions << name_or_mod
nil
end
def self.load_plugins # :nodoc:
return unless defined? Gem
seen = {}
Gem.find_files("minitest/*_plugin.rb").each do |plugin_path|
name = File.basename plugin_path, "_plugin.rb"
next if seen[name]
seen[name] = true
require plugin_path
self.extensions << name
end
end
def self.init_plugins options # :nodoc:
self.extensions.each do |mod_or_meth|
case mod_or_meth
when Symbol, String then
name = mod_or_meth
msg = "plugin_#{name}_init"
next unless self.respond_to? msg
send msg, options
when Module then
recv = mod_or_meth
next unless recv.respond_to? :minitest_plugin_init
recv.minitest_plugin_init options
else
raise ArgumentError, "plugin is %p, but it must be a symbol, string or module" % [mod_or_meth]
end
end
end
def self.process_args args = [] # :nodoc:
options = {
:io => $stdout,
}
orig_args = args.dup
OptionParser.new do |opts|
opts.banner = "minitest options:"
opts.version = Minitest::VERSION
opts.on "-h", "--help", "Display this help." do
puts opts
exit
end
opts.on "--no-plugins", "Bypass minitest plugin auto-loading (or set $MT_NO_PLUGINS)."
desc = "Sets random seed. Also via env. Eg: SEED=n rake"
opts.on "-s", "--seed SEED", Integer, desc do |m|
options[:seed] = m.to_i
end
opts.on "-v", "--verbose", "Verbose. Show progress processing files." do
options[:verbose] = true
end
opts.on "-q", "--quiet", "Quiet. Show no progress processing files." do
options[:quiet] = true
end
opts.on "--show-skips", "Show skipped at the end of run." do
options[:show_skips] = true
end
opts.on "-n", "--name PATTERN", "Filter run on /regexp/ or string." do |a|
options[:filter] = a
end
opts.on "-e", "--exclude PATTERN", "Exclude /regexp/ or string from run." do |a|
options[:exclude] = a
end
opts.on "-S", "--skip CODES", String, "Skip reporting of certain types of results (eg E)." do |s|
options[:skip] = s.chars.to_a
end
ruby27plus = ::Warning.respond_to? :[]=
opts.on "-W[error]", String, "Turn Ruby warnings into errors" do |s|
options[:Werror] = true
case s
when "error", "all", nil then
require "minitest/error_on_warning"
$VERBOSE = true
::Warning[:deprecated] = true if ruby27plus
else
::Warning[s.to_sym] = true if ruby27plus # check validity of category
end
end
unless extensions.empty?
opts.separator ""
opts.separator "Known extensions: #{extensions.join ", "}"
extensions.each do |mod_or_meth|
case mod_or_meth
when Symbol, String then
meth = mod_or_meth
msg = "plugin_#{meth}_options"
send msg, opts, options if respond_to? msg
when Module
recv = mod_or_meth
next unless recv.respond_to? :minitest_plugin_options
recv.minitest_plugin_options opts, options
else
raise ArgumentError, "plugin is %p, but it must be a symbol, string or module" % [mod_or_meth]
end
end
end
begin
opts.parse! args
rescue OptionParser::InvalidOption => e
puts
puts e
puts
puts opts
exit 1
end
orig_args -= args
end
unless options[:seed] then
srand
options[:seed] = (ENV["SEED"] || srand).to_i % 0xFFFF
orig_args << "--seed" << options[:seed].to_s
end
options[:args] = orig_args.map { |s|
s.match?(/[\s|&<>$()]/) ? s.inspect : s
}.join " "
options
end
##
# This is the top-level run method. Everything starts from here. It
# tells each Runnable sub-class to run, and each of those are
# responsible for doing whatever they do.
#
# The overall structure of a run looks like this:
#
# Minitest.autorun
# Minitest.run(args)
# Minitest.load_plugins
# Minitest.process_args
# Minitest.init_plugins
# Minitest.__run(reporter, options)
# Runnable.runnables.each |runnable_klass|
# runnable_klass.run(reporter, options)
# filtered_methods = runnable_methods.select {...}.reject {...}
# filtered_methods.each |runnable_method|
# runnable_klass.run_one_method(self, runnable_method, reporter)
# Minitest.run_one_method(runnable_klass, runnable_method)
# runnable_klass.new(runnable_method).run
def self.run args = []
self.load_plugins unless args.delete("--no-plugins") || ENV["MT_NO_PLUGINS"]
options = process_args args
Minitest.seed = options[:seed]
srand Minitest.seed
reporter = CompositeReporter.new
reporter << SummaryReporter.new(options[:io], options)
reporter << ProgressReporter.new(options[:io], options) unless options[:quiet]
self.reporter = reporter # this makes it available to plugins
self.init_plugins options
self.reporter = nil # runnables shouldn't depend on the reporter, ever
self.parallel_executor.start if parallel_executor.respond_to? :start
reporter.start
begin
__run reporter, options
finished = true
rescue Interrupt
warn "Interrupted. Exiting..."
end
self.parallel_executor.shutdown if parallel_executor.respond_to? :shutdown
# might have been removed/replaced during init_plugins:
summary = reporter.reporters.grep(SummaryReporter).first
reporter.report
return empty_run! options if finished && summary && summary.count == 0
finished and reporter.passed?
end
def self.empty_run! options # :nodoc:
filter = options[:filter]
return true unless filter # no filter, but nothing ran == success
warn "Nothing ran for filter: %s" % [filter]
require "did_you_mean" # soft dependency, punt if it doesn't load
ms = Runnable.runnables.flat_map(&:runnable_methods)
cs = DidYouMean::SpellChecker.new(dictionary: ms).correct filter
warn DidYouMean::Formatter.message_for cs unless cs.empty?
rescue LoadError
# do nothing
end
##
# Internal run method. Responsible for telling all Runnable
# sub-classes to run.
def self.__run reporter, options
suites = Runnable.runnables.shuffle
parallel, serial = suites.partition { |s| s.test_order == :parallel }
# If we run the parallel tests before the serial tests, the parallel tests
# could run in parallel with the serial tests. This would be bad because
# the serial tests won't lock around Reporter#record. Run the serial tests
# first, so that after they complete, the parallel tests will lock when
# recording results.
serial.map { |suite| suite.run reporter, options } +
parallel.map { |suite| suite.run reporter, options }
end
def self.filter_backtrace bt # :nodoc:
result = backtrace_filter.filter bt
result = bt.dup if result.empty?
result
end
##
# Represents anything "runnable", like Test, Spec, Benchmark, or
# whatever you can dream up.
#
# Subclasses of this are automatically registered and available in
# Runnable.runnables.
class Runnable
##
# Number of assertions executed in this run.
attr_accessor :assertions
##
# An assertion raised during the run, if any.
attr_accessor :failures
##
# The time it took to run.
attr_accessor :time
def time_it # :nodoc:
t0 = Minitest.clock_time
yield
ensure
self.time = Minitest.clock_time - t0
end
##
# Name of the run.
def name
@NAME
end
##
# Set the name of the run.
def name= o
@NAME = o
end
##
# Returns all instance methods matching the pattern +re+.
def self.methods_matching re
public_instance_methods(true).grep(re).map(&:to_s)
end
def self.reset # :nodoc:
@@runnables = []
end
reset
##
# Responsible for running all runnable methods in a given class,
# each in its own instance. Each instance is passed to the
# reporter to record.
def self.run reporter, options = {}
pos = options[:filter]
neg = options[:exclude]
pos = Regexp.new $1 if pos.kind_of?(String) && pos =~ %r%/(.*)/%
neg = Regexp.new $1 if neg.kind_of?(String) && neg =~ %r%/(.*)/%
# at most 1-2% slower than a 1-pass version, stop optimizing this
filtered_methods = self.runnable_methods
.select { |m| !pos || pos === m || pos === "#{self}##{m}" }
.reject { |m| neg && (neg === m || neg === "#{self}##{m}") }
return if filtered_methods.empty?
t0 = name = nil
@_info_handler = lambda do
unless reporter.passed? then
warn "Current results:"
warn reporter.reporters.grep(SummaryReporter).first
end
warn "Current: %s#%s %.2fs" % [self, name, Minitest.clock_time - t0]
end
with_info_handler reporter do
filtered_methods.each do |method_name|
name = method_name
t0 = Minitest.clock_time
run_one_method self, method_name, reporter
end
end
end
##
# Runs a single method and has the reporter record the result.
# This was considered internal API but is factored out of run so
# that subclasses can specialize the running of an individual
# test. See Minitest::ParallelTest::ClassMethods for an example.
def self.run_one_method klass, method_name, reporter
reporter.prerecord klass, method_name
reporter.record Minitest.run_one_method(klass, method_name)
end
##
# Defines the order to run tests (:random by default). Override
# this or use a convenience method to change it for your tests.
def self.test_order
:random
end
def self.with_info_handler reporter, &block # :nodoc:
on_signal ::Minitest.info_signal, @_info_handler, &block
end
SIGNALS = Signal.list # :nodoc:
def self.on_signal name, action # :nodoc:
supported = SIGNALS[name]
old_trap = trap name do
old_trap.call if old_trap.respond_to? :call
action.call
end if supported
yield
ensure
trap name, old_trap if supported
end
##
# Each subclass of Runnable is responsible for overriding this
# method to return all runnable methods. See #methods_matching.
def self.runnable_methods
raise NotImplementedError, "subclass responsibility"
end
##
# Returns all subclasses of Runnable.
def self.runnables
@@runnables
end
@@marshal_dump_warned = false
def marshal_dump # :nodoc:
unless @@marshal_dump_warned then
warn ["Minitest::Runnable#marshal_dump is deprecated.",
"You might be violating internals. From", caller(1..1).first].join " "
@@marshal_dump_warned = true
end
[self.name, self.failures, self.assertions, self.time]
end
def marshal_load ary # :nodoc:
self.name, self.failures, self.assertions, self.time = ary
end
def failure # :nodoc:
self.failures.first
end
def initialize name # :nodoc:
self.name = name
self.failures = []
self.assertions = 0
# lazy initializer for metadata
end
##
# Metadata you attach to the test results that get sent to the reporter.
#
# Lazily initializes to a hash, to keep memory down.
#
# NOTE: this data *must* be plain (read: marshal-able) data!
# Hashes! Arrays! Strings!
def metadata
@metadata ||= {}
end
##
# Sets metadata, mainly used for +Result.from+.
attr_writer :metadata
##
# Returns true if metadata exists.
def metadata?
defined? @metadata
end
##
# Runs a single method. Needs to return self.
def run
raise NotImplementedError, "subclass responsibility"
end
##
# Did this run pass?
#
# Note: skipped runs are not considered passing, but they don't
# cause the process to exit non-zero.
def passed?
raise NotImplementedError, "subclass responsibility"
end
##
# Returns a single character string to print based on the result
# of the run. One of <tt>"."</tt>, <tt>"F"</tt>,
# <tt>"E"</tt> or <tt>"S"</tt>.
def result_code
raise NotImplementedError, "subclass responsibility"
end
##
# Was this run skipped? See #passed? for more information.
def skipped?
raise NotImplementedError, "subclass responsibility"
end
end # Runnable
##
# Shared code for anything that can get passed to a Reporter. See
# Minitest::Test & Minitest::Result.
module Reportable
##
# Did this run pass?
#
# Note: skipped runs are not considered passing, but they don't
# cause the process to exit non-zero.
def passed?
not self.failure
end
BASE_DIR = "#{Dir.pwd}/" # :nodoc:
##
# The location identifier of this test. Depends on a method
# existing called class_name.
def location
loc = " [#{self.failure.location.delete_prefix BASE_DIR}]" unless passed? or error?
"#{self.class_name}##{self.name}#{loc}"
end
def class_name # :nodoc:
raise NotImplementedError, "subclass responsibility"
end
##
# Returns ".", "F", or "E" based on the result of the run.
def result_code
self.failure and self.failure.result_code or "."
end
##
# Was this run skipped?
def skipped?
self.failure and Skip === self.failure
end
##
# Did this run error?
def error?
self.failures.any? UnexpectedError
end
end # Reportable
##
# This represents a test result in a clean way that can be
# marshalled over a wire. Tests can do anything they want to the
# test instance and can create conditions that cause Marshal.dump to
# blow up. By using Result.from(a_test) you can be reasonably sure
# that the test result can be marshalled.
class Result < Runnable
include Minitest::Reportable
undef_method :marshal_dump
undef_method :marshal_load
##
# The class name of the test result.
attr_accessor :klass
##
# The location of the test method.
attr_accessor :source_location
##
# Create a new test result from a Runnable instance.
def self.from runnable
o = runnable
r = self.new o.name
r.klass = o.class.name
r.assertions = o.assertions
r.failures = o.failures.dup
r.time = o.time
r.metadata = o.metadata if o.metadata?
r.source_location = o.method(o.name).source_location rescue ["unknown", -1]
r
end
def class_name # :nodoc:
self.klass # for Minitest::Reportable
end
def to_s # :nodoc:
return location if passed? and not skipped?
failures.map { |failure|
"#{failure.result_label}:\n#{self.location}:\n#{failure.message}\n"
}.join "\n"
end
end # Result
##
# Defines the API for Reporters. Subclass this and override whatever
# you want. Go nuts.
class AbstractReporter
def initialize # :nodoc:
@mutex = Mutex.new
end
##
# Starts reporting on the run.
def start
end
##
# About to start running a test. This allows a reporter to show
# that it is starting or that we are in the middle of a test run.
def prerecord klass, name
end
##
# Output and record the result of the test. Call
# {result#result_code}[rdoc-ref:Runnable#result_code] to get the
# result character string. Stores the result of the run if the run
# did not pass.
def record result
end
##
# Outputs the summary of the run.
def report
end
##
# Did this run pass?
def passed?
true
end
def synchronize &block # :nodoc:
@mutex.synchronize(&block)
end
end # AbstractReportera
class Reporter < AbstractReporter # :nodoc:
##
# The IO used to report.
attr_accessor :io
##
# Command-line options for this run.
attr_accessor :options
def initialize io = $stdout, options = {} # :nodoc:
super()
self.io = io
self.options = options
end
end
##
# A very simple reporter that prints the "dots" during the run.
#
# This is added to the top-level CompositeReporter at the start of
# the run. If you want to change the output of minitest via a
# plugin, pull this out of the composite and replace it with your
# own.
class ProgressReporter < Reporter
def prerecord klass, name # :nodoc:
return unless options[:verbose]
io.print "%s#%s = " % [klass.name, name]
io.flush
end
def record result # :nodoc:
io.print "%.2f s = " % [result.time] if options[:verbose]
io.print result.result_code
io.puts if options[:verbose]
end
end
##
# A reporter that gathers statistics about a test run. Does not do
# any IO because meant to be used as a parent class for a reporter
# that does.
#
# If you want to create an entirely different type of output (eg,
# CI, HTML, etc), this is the place to start.
#
# Example:
#
# class JenkinsCIReporter < StatisticsReporter
# def report
# super # Needed to calculate some statistics
#
# print "<testsuite "
# print "tests='#{count}' "
# print "failures='#{failures}' "
# # Remaining XML...
# end
# end
class StatisticsReporter < Reporter
##
# Total number of assertions.
attr_accessor :assertions
##
# Total number of test cases.
attr_accessor :count
##
# An +Array+ of test cases that failed or were skipped.
attr_accessor :results
##
# Time the test run started. If available, the monotonic clock is
# used and this is a +Float+, otherwise it's an instance of
# +Time+.
attr_accessor :start_time
##
# Test run time. If available, the monotonic clock is used and
# this is a +Float+, otherwise it's an instance of +Time+.
attr_accessor :total_time
##
# Total number of tests that failed.
attr_accessor :failures
##
# Total number of tests that erred.
attr_accessor :errors
##
# Total number of tests that warned.
attr_accessor :warnings
##
# Total number of tests that where skipped.
attr_accessor :skips
def initialize io = $stdout, options = {} # :nodoc:
super
self.assertions = 0
self.count = 0
self.results = []
self.start_time = nil
self.total_time = nil
self.failures = nil
self.errors = nil
self.warnings = nil
self.skips = nil
end
def passed? # :nodoc:
results.all?(&:skipped?)
end
def start # :nodoc:
self.start_time = Minitest.clock_time
end
def record result # :nodoc:
self.count += 1
self.assertions += result.assertions
results << result if not result.passed? or result.skipped?
end
##
# Report on the tracked statistics.
def report
aggregate = results.group_by { |r| r.failure.class }
aggregate.default = [] # dumb. group_by should provide this
self.total_time = Minitest.clock_time - start_time
self.failures = aggregate[Assertion].size
self.errors = aggregate[UnexpectedError].size
self.warnings = aggregate[UnexpectedWarning].size
self.skips = aggregate[Skip].size
end
end # StatisticsReporter
##
# A reporter that prints the header, summary, and failure details at
# the end of the run.
#
# This is added to the top-level CompositeReporter at the start of
# the run. If you want to change the output of minitest via a
# plugin, pull this out of the composite and replace it with your
# own.
class SummaryReporter < StatisticsReporter
attr_accessor :sync # :nodoc:
attr_accessor :old_sync # :nodoc:
def start # :nodoc:
super
io.puts "Run options: #{options[:args]}"
io.puts
io.puts "# Running:"
io.puts
self.sync = io.respond_to? :"sync="
self.old_sync, io.sync = io.sync, true if self.sync
end
def report # :nodoc:
super
io.sync = self.old_sync
io.puts unless options[:verbose] # finish the dots
io.puts
io.puts statistics
aggregated_results io
io.puts summary
end
def statistics # :nodoc:
"Finished in %.6fs, %.4f runs/s, %.4f assertions/s." %
[total_time, count / total_time, assertions / total_time]
end
def aggregated_results io # :nodoc:
filtered_results = results.dup
filtered_results.reject!(&:skipped?) unless
options[:verbose] or options[:show_skips]
skip = options[:skip] || []
filtered_results.each_with_index { |result, i|
next if skip.include? result.result_code
io.puts "\n%3d) %s" % [i+1, result]
}
io.puts
io
end
def to_s # :nodoc:
aggregated_results(StringIO.new("".b)).string
end
def summary # :nodoc:
extra = []
extra << ", %d warnings" % [warnings] if options[:Werror]
extra << "\n\nYou have skipped tests. Run with --verbose for details." if
results.any?(&:skipped?) unless
options[:verbose] or
options[:show_skips] or
ENV["MT_NO_SKIP_MSG"]
"%d runs, %d assertions, %d failures, %d errors, %d skips%s" %
[count, assertions, failures, errors, skips, extra.join]
end
end # SummaryReporter
##
# Dispatch to multiple reporters as one.
class CompositeReporter < AbstractReporter
##
# The list of reporters to dispatch to.
attr_accessor :reporters
def initialize *reporters # :nodoc:
super()
self.reporters = reporters
end
def io # :nodoc:
reporters.first.io
end
##
# Add another reporter to the mix.
def << reporter
self.reporters << reporter
end
def passed? # :nodoc:
self.reporters.all?(&:passed?)
end
def start # :nodoc:
self.reporters.each(&:start)
end
def prerecord klass, name # :nodoc:
self.reporters.each do |reporter|
# TODO: remove conditional for minitest 6
reporter.prerecord klass, name if reporter.respond_to? :prerecord
end
end
def record result # :nodoc:
self.reporters.each do |reporter|
reporter.record result
end
end
def report # :nodoc:
self.reporters.each(&:report)
end
end # CompositeReporter
##
# Represents run failures.
class Assertion < Exception
RE = /in [`'](?:[^']+[#.])?(?:assert|refute|flunk|pass|fail|raise|must|wont)/ # :nodoc:
def error # :nodoc:
self
end
##
# Where was this run before an assertion was raised?
def location
bt = Minitest.filter_backtrace self.backtrace
idx = bt.rindex { |s| s.match? RE } || -1 # fall back to first item
loc = bt[idx+1] || bt.last || "unknown:-1"
loc.sub(/:in .*$/, "")
end
def result_code # :nodoc:
result_label[0, 1]
end
def result_label # :nodoc:
"Failure"
end
end
##
# Assertion raised when skipping a run.
class Skip < Assertion
def result_label # :nodoc:
"Skipped"
end
end
##
# Assertion wrapping an unexpected error that was raised during a run.
class UnexpectedError < Assertion
include Minitest::Compress
# TODO: figure out how to use `cause` instead
attr_accessor :error # :nodoc:
def initialize error # :nodoc:
super "Unexpected exception"
if SystemStackError === error then
bt = error.backtrace
new_bt = compress bt
error = error.exception "#{bt.size} -> #{new_bt.size}"
error.set_backtrace new_bt
end
self.error = error
end
def backtrace # :nodoc:
self.error.backtrace
end
BASE_RE = %r%#{Regexp.escape Dir.pwd}/% # :nodoc:
def message # :nodoc:
bt = Minitest.filter_backtrace(self.backtrace).join("\n ")
.gsub(BASE_RE, "")
"#{self.error.class}: #{self.error.message}\n #{bt}"
end
def result_label # :nodoc:
"Error"
end
end
##
# Assertion raised on warning when running in -Werror mode.
class UnexpectedWarning < Assertion
def result_label # :nodoc:
"Warning"
end
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 Test 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 maglev?
def maglev? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
where = Minitest.filter_backtrace(caller).first
where = where.split(":in ", 2).first # clean up noise
warn "DEPRECATED: `maglev?` called from #{where}. This will fail in Minitest 6."
"maglev" == platform
end
##
# Is this running on mri?
def mri? platform = RUBY_DESCRIPTION
platform.start_with? "ruby"
end
##
# Is this running on macOS?
def osx? platform = RUBY_PLATFORM
platform.include? "darwin"
end
##
# Is this running on rubinius?
def rubinius? platform = defined?(RUBY_ENGINE) && RUBY_ENGINE
where = Minitest.filter_backtrace(caller).first
where = where.split(":in ", 2).first # clean up noise
warn "DEPRECATED: `rubinius?` called from #{where}. This will fail in Minitest 6."
"rbx" == platform
end
##
# Is this running on windows?
def windows? platform = RUBY_PLATFORM
/mswin|mingw/.match? platform
end
end
##
# The standard backtrace filter for minitest.
#
# See Minitest.backtrace_filter=.
class BacktraceFilter
MT_RE = %r%lib/minitest|internal:warning% # :nodoc:
##
# The regular expression to use to filter backtraces. Defaults to +MT_RE+.
attr_accessor :regexp
def initialize regexp = MT_RE # :nodoc:
self.regexp = regexp
end
##
# Filter +bt+ to something useful. Returns the whole thing if
# $DEBUG (ruby) or $MT_DEBUG (env).
def filter bt
return ["No backtrace"] unless bt
return bt.dup if $DEBUG || ENV["MT_DEBUG"]
new_bt = bt.take_while { |line| !regexp.match? line.to_s }
new_bt = bt.select { |line| !regexp.match? line.to_s } if new_bt.empty?
new_bt = bt.dup if new_bt.empty?
new_bt
end
end
self.backtrace_filter = BacktraceFilter.new
def self.run_one_method klass, method_name # :nodoc:
result = klass.new(method_name).run
raise "#{klass}#run _must_ return a Result" unless Result === result
result
end
# :stopdoc:
if defined? Process::CLOCK_MONOTONIC # :nodoc:
def self.clock_time
Process.clock_gettime Process::CLOCK_MONOTONIC
end
else
def self.clock_time
Time.now
end
end
class Runnable # re-open
def self.inherited klass # :nodoc:
self.runnables << klass
super
end
end
# :startdoc:
end
require "minitest/test"
|