minitest 5.15.0 → 5.16.0

data/lib/minitest/test_task.rb

@@ -0,0 +1,305 @@
+require "shellwords"
+require "rbconfig"
+require "rake/tasklib"
+
+module Minitest # :nodoc:
+
+  ##
+  # Minitest::TestTask is a rake helper that generates several rake
+  # tasks under the main test task's name-space.
+  #
+  #   task <name>      :: the main test task
+  #   task <name>:cmd  :: prints the command to use
+  #   task <name>:deps :: runs each test file by itself to find dependency errors
+  #   task <name>:slow :: runs the tests and reports the slowest 25 tests.
+  #
+  # Examples:
+  #
+  #   Minitest::TestTask.create
+  #
+  # The most basic and default setup.
+  #
+  #   Minitest::TestTask.create :my_tests
+  #
+  # The most basic/default setup, but with a custom name
+  #
+  #   Minitest::TestTask.create :unit do |t|
+  #     t.test_globs = ["test/unit/**/*_test.rb"]
+  #     t.warning = false
+  #   end
+  #
+  # Customize the name and only run unit tests.
+
+  class TestTask < Rake::TaskLib
+    WINDOWS = RbConfig::CONFIG["host_os"] =~ /mswin|mingw/ # :nodoc:
+
+    ##
+    # Create several test-oriented tasks under +name+. Takes an
+    # optional block to customize variables.
+
+    def self.create name = :test, &block
+      task = new name
+      task.instance_eval(&block) if block
+      task.process_env
+      task.define
+      task
+    end
+
+    ##
+    # Extra arguments to pass to the tests. Defaults empty but gets
+    # populated by a number of enviroment variables:
+    #
+    # N (-n flag) :: a string or regexp of tests to run.
+    # X (-e flag) :: a string or regexp of tests to exclude.
+    # A (arg)     :: quick way to inject an arbitrary argument (eg A=--help).
+    #
+    # See #process_env
+
+    attr_accessor :extra_args
+
+    ##
+    # The code to load the framework. Defaults to requiring
+    # minitest/autorun...
+    #
+    # Why do I have this as an option?
+
+    attr_accessor :framework
+
+    ##
+    # Extra library directories to include. Defaults to %w[lib test
+    # .]. Also uses $MT_LIB_EXTRAS allowing you to dynamically
+    # override/inject directories for custom runs.
+
+    attr_accessor :libs
+
+    ##
+    # The name of the task and base name for the other tasks generated.
+
+    attr_accessor :name
+
+    ##
+    # File globs to find test files. Defaults to something sensible to
+    # find test files under the test directory.
+
+    attr_accessor :test_globs
+
+    ##
+    # Turn on ruby warnings (-w flag). Defaults to true.
+
+    attr_accessor :warning
+
+    ##
+    # Optional: Additional ruby to run before the test framework is loaded.
+
+    attr_accessor :test_prelude
+
+    ##
+    # Print out commands as they run. Defaults to Rake's +trace+ (-t
+    # flag) option.
+
+    attr_accessor :verbose
+
+    ##
+    # Use TestTask.create instead.
+
+    def initialize name = :test # :nodoc:
+      self.extra_args   = []
+      self.framework    = %(require "minitest/autorun")
+      self.libs         = %w[lib test .]
+      self.name         = name
+      self.test_globs   = ["test/**/test_*.rb",
+                           "test/**/*_test.rb"]
+      self.test_prelude = nil
+      self.verbose      = Rake.application.options.trace
+      self.warning      = true
+    end
+
+    ##
+    # Extract variables from the environment and convert them to
+    # command line arguments. See #extra_args.
+    #
+    # Environment Variables:
+    #
+    # MT_LIB_EXTRAS :: Extra libs to dynamically override/inject for custom runs.
+    # N             :: Tests to run (string or /regexp/).
+    # X             :: Tests to exclude (string or /regexp/).
+    # A             :: Any extra arguments. Honors shell quoting.
+    #
+    # Deprecated:
+    #
+    # TESTOPTS      :: For argument passing, use +A+.
+    # N             :: For parallel testing, use +MT_CPU+.
+    # FILTER        :: Same as +TESTOPTS+.
+
+    def process_env
+      warn "TESTOPTS is deprecated in Minitest::TestTask. Use A instead" if
+        ENV["TESTOPTS"]
+      warn "FILTER is deprecated in Minitest::TestTask. Use A instead" if
+        ENV["FILTER"]
+      warn "N is deprecated in Minitest::TestTask. Use MT_CPU instead" if
+        ENV["N"] && ENV["N"].to_i > 0
+
+      lib_extras = (ENV["MT_LIB_EXTRAS"] || "").split File::PATH_SEPARATOR
+      self.libs[0,0] = lib_extras
+
+      extra_args << "-n" << ENV["N"]                      if ENV["N"]
+      extra_args << "-e" << ENV["X"]                      if ENV["X"]
+      extra_args.concat Shellwords.split(ENV["TESTOPTS"]) if ENV["TESTOPTS"]
+      extra_args.concat Shellwords.split(ENV["FILTER"])   if ENV["FILTER"]
+      extra_args.concat Shellwords.split(ENV["A"])        if ENV["A"]
+
+      ENV.delete "N" if ENV["N"]
+
+      # TODO? RUBY_DEBUG = ENV["RUBY_DEBUG"]
+      # TODO? ENV["RUBY_FLAGS"]
+
+      extra_args.compact!
+    end
+
+    def define # :nodoc:
+      default_tasks = []
+
+      desc "Run the test suite. Use N, X, A, and TESTOPTS to add flags/args."
+      task name do
+        ruby make_test_cmd, verbose:verbose
+      end
+
+      desc "Print out the test command. Good for profiling and other tools."
+      task "#{name}:cmd" do
+        puts "ruby #{make_test_cmd}"
+      end
+
+      desc "Show which test files fail when run in isolation."
+      task "#{name}:isolated" do
+        tests = Dir[*self.test_globs].uniq
+
+        # 3 seems to be the magic number... (tho not by that much)
+        bad, good, n = {}, [], (ENV.delete("K") || 3).to_i
+        file = ENV.delete("F")
+        times = {}
+
+        tt0 = Time.now
+
+        n.threads_do tests.sort do |path|
+          t0 = Time.now
+          output = `#{Gem.ruby} #{make_test_cmd path} 2>&1`
+          t1 = Time.now - t0
+
+          times[path] = t1
+
+          if $?.success?
+            $stderr.print "."
+            good << path
+          else
+            $stderr.print "x"
+            bad[path] = output
+          end
+        end
+
+        puts "done"
+        puts "Ran in %.2f seconds" % [ Time.now - tt0 ]
+
+        if file then
+          require "json"
+          File.open file, "w" do |io|
+            io.puts JSON.pretty_generate times
+          end
+        end
+
+        unless good.empty?
+          puts
+          puts "# Good tests:"
+          puts
+          good.sort.each do |path|
+            puts "%.2fs: %s" % [times[path], path]
+          end
+        end
+
+        unless bad.empty?
+          puts
+          puts "# Bad tests:"
+          puts
+          bad.keys.sort.each do |path|
+            puts "%.2fs: %s" % [times[path], path]
+          end
+          puts
+          puts "# Bad Test Output:"
+          puts
+          bad.sort.each do |path, output|
+            puts
+            puts "# #{path}:"
+            puts output
+          end
+          exit 1
+        end
+      end
+
+      task "#{name}:deps" => "#{name}:isolated" # now just an alias
+
+      desc "Show bottom 25 tests wrt time."
+      task "#{name}:slow" do
+        sh ["rake #{name} TESTOPTS=-v",
+            "egrep '#test_.* s = .'",
+            "sort -n -k2 -t=",
+            "tail -25"].join " | "
+      end
+
+      default_tasks << name
+
+      desc "Run the default task(s)."
+      task :default => default_tasks
+    end
+
+    ##
+    # Generate the test command-line.
+
+    def make_test_cmd globs = test_globs
+      tests = []
+      tests.concat Dir[*globs].sort.shuffle # TODO: SEED -> srand first?
+      tests.map! { |f| %(require "#{f}") }
+
+      runner = []
+      runner << test_prelude if test_prelude
+      runner << framework
+      runner.concat tests
+      runner = runner.join "; "
+
+      args  = []
+      args << "-I#{libs.join(File::PATH_SEPARATOR)}" unless libs.empty?
+      args << "-w" if warning
+      args << '-e'
+      args << "'#{runner}'"
+      args << '--'
+      args << extra_args.map(&:shellescape)
+
+      args.join " "
+    end
+  end
+end
+
+class Work < Queue
+  def initialize jobs = []
+    super()
+
+    jobs.each do |job|
+      self << job
+    end
+
+    close
+  end
+end
+
+class Integer
+  def threads_do(jobs) # :nodoc:
+    require "thread"
+    q = Work.new jobs
+
+    self.times.map {
+      Thread.new do
+        while job = q.pop # go until quit value
+          yield job
+        end
+      end
+    }.each(&:join)
+  end
+end

data/lib/minitest/unit.rb

@@ -1,5 +1,3 @@
-# :stopdoc:
-
 unless defined?(Minitest) then
   # all of this crap is just to avoid circular requires and is only
   # needed if a user requires "minitest/unit" directly instead of
@@ -10,17 +8,18 @@ unless defined?(Minitest) then
   warn %(Warning: or add 'gem "minitest"' before 'require "minitest/autorun"')
   warn "From:\n  #{from}"
 
-  module Minitest; end
-  MiniTest = Minitest # prevents minitest.rb from requiring back to us
+  module Minitest # :nodoc:
+  end
+  MiniTest = Minitest # :nodoc: # prevents minitest.rb from requiring back to us
   require "minitest"
 end
 
 MiniTest = Minitest unless defined?(MiniTest)
 
 module Minitest
-  class Unit
+  class Unit # :nodoc:
     VERSION = Minitest::VERSION
-    class TestCase < Minitest::Test
+    class TestCase < Minitest::Test # :nodoc:
       def self.inherited klass # :nodoc:
         from = caller.first
         warn "MiniTest::Unit::TestCase is now Minitest::Test. From #{from}"
@@ -41,5 +40,3 @@ module Minitest
     end
   end
 end
-
-# :startdoc:

data/lib/minitest.rb

@@ -9,45 +9,55 @@ require "etc"
 # :include: README.rdoc
 
 module Minitest
-  VERSION = "5.15.0" # :nodoc:
-  ENCS = "".respond_to? :encoding # :nodoc:
+  VERSION = "5.16.0" # :nodoc:
 
   @@installed_at_exit ||= false
   @@after_run = []
   @extensions = []
 
-  mc = (class << self; self; end)
+  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
 
-  mc.send :attr_accessor, :parallel_executor
+  cattr_accessor :parallel_executor
 
   warn "DEPRECATED: use MT_CPU instead of N for parallel test runs" if ENV["N"]
   n_threads = (ENV["MT_CPU"] || ENV["N"] || Etc.nprocessors).to_i
+
   self.parallel_executor = Parallel::Executor.new n_threads
 
   ##
   # Filter object for backtraces.
 
-  mc.send :attr_accessor, :backtrace_filter
+  cattr_accessor :backtrace_filter
 
   ##
   # Reporter object to be used for all runs.
   #
   # NOTE: This accessor is only available during setup, not during runs.
 
-  mc.send :attr_accessor, :reporter
+  cattr_accessor :reporter
 
   ##
   # Names of known extension plugins.
 
-  mc.send :attr_accessor, :extensions
+  cattr_accessor :extensions
 
   ##
   # The signal to use for dumping information to STDERR. Defaults to "INFO".
 
-  mc.send :attr_accessor, :info_signal
+  cattr_accessor :info_signal
   self.info_signal = "INFO"
 
   ##
@@ -132,6 +142,9 @@ module Minitest
 
     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)
@@ -158,7 +171,7 @@ module Minitest
   # sub-classes to run.
 
   def self.__run reporter, options
-    suites = Runnable.runnables.reject { |s| s.runnable_methods.empty? }.shuffle
+    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
@@ -196,6 +209,10 @@ module Minitest
         options[:verbose] = 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
@@ -237,8 +254,6 @@ module Minitest
       orig_args << "--seed" << options[:seed].to_s
     end
 
-    srand options[:seed]
-
     options[:args] = orig_args.map { |s|
       s =~ /[\s|&<>$()]/ ? s.inspect : s
     }.join " "
@@ -793,7 +808,8 @@ module Minitest
 
     def aggregated_results io # :nodoc:
       filtered_results = results.dup
-      filtered_results.reject!(&:skipped?) unless options[:verbose]
+      filtered_results.reject!(&:skipped?) unless
+        options[:verbose] or options[:show_skips]
 
       skip = options[:skip] || []
 
@@ -814,7 +830,8 @@ module Minitest
       extra = ""
 
       extra = "\n\nYou have skipped tests. Run with --verbose for details." if
-        results.any?(&:skipped?) unless options[:verbose] or ENV["MT_NO_SKIP_MSG"]
+        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]

data/test/minitest/metametameta.rb

@@ -129,7 +129,7 @@ class MetaMetaMetaTestCase < Minitest::Test
 
   def setup
     super
-    srand 42
+    Minitest.seed = 42
     Minitest::Test.reset
     @tu = nil
   end

data/test/minitest/test_minitest_assertions.rb

@@ -354,7 +354,7 @@ class TestMinitestAssertions < Minitest::Test
           @@ -1,3 +1,3 @@
           -# encoding: UTF-8
           -#    valid: false
-          +# encoding: ASCII-8BIT
+          +# encoding: #{Encoding::BINARY.name}
           +#    valid: true
            "bad-utf8-\\xF1.txt"
           EOM
@@ -373,7 +373,7 @@ class TestMinitestAssertions < Minitest::Test
           @@ -1,3 +1,3 @@
           -# encoding: US-ASCII
           -#    valid: false
-          +# encoding: ASCII-8BIT
+          +# encoding: #{Encoding::BINARY.name}
           +#    valid: true
            "bad-utf8-\\xF1.txt"
           EOM
@@ -484,7 +484,10 @@ class TestMinitestAssertions < Minitest::Test
 
   def test_assert_match
     @assertion_count = 2
-    @tc.assert_match(/\w+/, "blah blah blah")
+    m = @tc.assert_match(/\w+/, "blah blah blah")
+
+    assert_kind_of MatchData, m
+    assert_equal "blah", m[0]
   end
 
   def test_assert_match_matchee_to_str
@@ -804,7 +807,7 @@ class TestMinitestAssertions < Minitest::Test
   # *sigh* This is quite an odd scenario, but it is from real (albeit
   # ugly) test code in ruby-core:
 
-  # http://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=29259
+  # https://svn.ruby-lang.org/cgi-bin/viewvc.cgi?view=rev&revision=29259
 
   def test_assert_raises_skip
     @assertion_count = 0
@@ -1528,14 +1531,14 @@ class TestMinitestAssertionHelpers < Minitest::Test
 
   def test_mu_pp_for_diff_str_encoding
     str = "A\nB".b
-    exp = "# encoding: ASCII-8BIT\n#    valid: true\n\"A\nB\""
+    exp = "# encoding: #{Encoding::BINARY.name}\n#    valid: true\n\"A\nB\""
 
     assert_mu_pp_for_diff exp, str, :raw
   end
 
   def test_mu_pp_for_diff_str_encoding_both
     str = "A\\n\nB".b
-    exp = "# encoding: ASCII-8BIT\n#    valid: true\n\"A\\\\n\\nB\""
+    exp = "# encoding: #{Encoding::BINARY.name}\n#    valid: true\n\"A\\\\n\\nB\""
 
     assert_mu_pp_for_diff exp, str, :raw
   end
@@ -1575,7 +1578,7 @@ class TestMinitestAssertionHelpers < Minitest::Test
 
   def test_mu_pp_str_encoding
     str = "A\nB".b
-    exp = "# encoding: ASCII-8BIT\n#    valid: true\n\"A\\nB\""
+    exp = "# encoding: #{Encoding::BINARY.name}\n#    valid: true\n\"A\\nB\""
 
     assert_mu_pp exp, str, :raw
   end

data/test/minitest/test_minitest_benchmark.rb

@@ -3,7 +3,7 @@ require "minitest/benchmark"
 
 ##
 # Used to verify data:
-# http://www.wolframalpha.com/examples/RegressionAnalysis.html
+# https://www.wolframalpha.com/examples/RegressionAnalysis.html
 
 class TestMinitestBenchmark < Minitest::Test
   def test_cls_bench_exp
@@ -110,7 +110,7 @@ class TestMinitestBenchmark < Minitest::Test
     assert_fit :power, x, y, 0.90, 2.6217, 1.4556
 
     # income to % of households below income amount
-    # http://library.wolfram.com/infocenter/Conferences/6461/PowerLaws.nb
+    # https://library.wolfram.com/infocenter/Conferences/6461/PowerLaws.nb
     x = [15_000, 25_000, 35_000, 50_000, 75_000, 100_000]
     y = [0.154, 0.283, 0.402, 0.55, 0.733, 0.843]