mirror of
https://github.com/rails/rails.git
synced 2022-11-09 12:12:34 -05:00
65f350166a
Reverts a change from
2327ebfdc6
which can overwrite `test_order` that may have been manually set in
config. This can cause a situation where the user is depending on a
particular `test_order` but is unknowingly forced into another.
163 lines
6.1 KiB
Ruby
163 lines
6.1 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
gem "minitest" # make sure we get the gem, not stdlib
|
|
require "minitest"
|
|
require "active_support/testing/tagged_logging"
|
|
require "active_support/testing/setup_and_teardown"
|
|
require "active_support/testing/assertions"
|
|
require "active_support/testing/deprecation"
|
|
require "active_support/testing/declarative"
|
|
require "active_support/testing/isolation"
|
|
require "active_support/testing/constant_lookup"
|
|
require "active_support/testing/time_helpers"
|
|
require "active_support/testing/file_fixtures"
|
|
require "active_support/testing/parallelization"
|
|
require "concurrent/utility/processor_counter"
|
|
|
|
module ActiveSupport
|
|
class TestCase < ::Minitest::Test
|
|
Assertion = Minitest::Assertion
|
|
|
|
class << self
|
|
# Sets the order in which test cases are run.
|
|
#
|
|
# ActiveSupport::TestCase.test_order = :random # => :random
|
|
#
|
|
# Valid values are:
|
|
# * +:random+ (to run tests in random order)
|
|
# * +:parallel+ (to run tests in parallel)
|
|
# * +:sorted+ (to run tests alphabetically by method name)
|
|
# * +:alpha+ (equivalent to +:sorted+)
|
|
def test_order=(new_order)
|
|
ActiveSupport.test_order = new_order
|
|
end
|
|
|
|
# Returns the order in which test cases are run.
|
|
#
|
|
# ActiveSupport::TestCase.test_order # => :random
|
|
#
|
|
# Possible values are +:random+, +:parallel+, +:alpha+, +:sorted+.
|
|
# Defaults to +:random+.
|
|
def test_order
|
|
ActiveSupport.test_order ||= :random
|
|
end
|
|
|
|
# Parallelizes the test suite.
|
|
#
|
|
# Takes a +workers+ argument that controls how many times the process
|
|
# is forked. For each process a new database will be created suffixed
|
|
# with the worker number.
|
|
#
|
|
# test-database-0
|
|
# test-database-1
|
|
#
|
|
# If <tt>ENV["PARALLEL_WORKERS"]</tt> is set the workers argument will be ignored
|
|
# and the environment variable will be used instead. This is useful for CI
|
|
# environments, or other environments where you may need more workers than
|
|
# you do for local testing.
|
|
#
|
|
# If the number of workers is set to +1+ or fewer, the tests will not be
|
|
# parallelized.
|
|
#
|
|
# If +workers+ is set to +:number_of_processors+, the number of workers will be
|
|
# set to the actual core count on the machine you are on.
|
|
#
|
|
# The default parallelization method is to fork processes. If you'd like to
|
|
# use threads instead you can pass <tt>with: :threads</tt> to the +parallelize+
|
|
# method. Note the threaded parallelization does not create multiple
|
|
# database and will not work with system tests at this time.
|
|
#
|
|
# parallelize(workers: :number_of_processors, with: :threads)
|
|
#
|
|
# The threaded parallelization uses minitest's parallel executor directly.
|
|
# The processes parallelization uses a Ruby DRb server.
|
|
def parallelize(workers: :number_of_processors, with: :processes)
|
|
workers = Concurrent.physical_processor_count if workers == :number_of_processors
|
|
workers = ENV["PARALLEL_WORKERS"].to_i if ENV["PARALLEL_WORKERS"]
|
|
|
|
return if workers <= 1 || ActiveSupport.test_parallelization_disabled
|
|
|
|
executor = case with
|
|
when :processes
|
|
Testing::Parallelization.new(workers)
|
|
when :threads
|
|
Minitest::Parallel::Executor.new(workers)
|
|
else
|
|
raise ArgumentError, "#{with} is not a supported parallelization executor."
|
|
end
|
|
|
|
self.lock_threads = false if defined?(self.lock_threads) && with == :threads
|
|
|
|
Minitest.parallel_executor = executor
|
|
|
|
parallelize_me!
|
|
end
|
|
|
|
# Set up hook for parallel testing. This can be used if you have multiple
|
|
# databases or any behavior that needs to be run after the process is forked
|
|
# but before the tests run.
|
|
#
|
|
# Note: this feature is not available with the threaded parallelization.
|
|
#
|
|
# In your +test_helper.rb+ add the following:
|
|
#
|
|
# class ActiveSupport::TestCase
|
|
# parallelize_setup do
|
|
# # create databases
|
|
# end
|
|
# end
|
|
def parallelize_setup(&block)
|
|
ActiveSupport::Testing::Parallelization.after_fork_hook do |worker|
|
|
yield worker
|
|
end
|
|
end
|
|
|
|
# Clean up hook for parallel testing. This can be used to drop databases
|
|
# if your app uses multiple write/read databases or other clean up before
|
|
# the tests finish. This runs before the forked process is closed.
|
|
#
|
|
# Note: this feature is not available with the threaded parallelization.
|
|
#
|
|
# In your +test_helper.rb+ add the following:
|
|
#
|
|
# class ActiveSupport::TestCase
|
|
# parallelize_teardown do
|
|
# # drop databases
|
|
# end
|
|
# end
|
|
def parallelize_teardown(&block)
|
|
ActiveSupport::Testing::Parallelization.run_cleanup_hook do |worker|
|
|
yield worker
|
|
end
|
|
end
|
|
end
|
|
|
|
alias_method :method_name, :name
|
|
|
|
include ActiveSupport::Testing::TaggedLogging
|
|
prepend ActiveSupport::Testing::SetupAndTeardown
|
|
include ActiveSupport::Testing::Assertions
|
|
include ActiveSupport::Testing::Deprecation
|
|
include ActiveSupport::Testing::TimeHelpers
|
|
include ActiveSupport::Testing::FileFixtures
|
|
extend ActiveSupport::Testing::Declarative
|
|
|
|
# test/unit backwards compatibility methods
|
|
alias :assert_raise :assert_raises
|
|
alias :assert_not_empty :refute_empty
|
|
alias :assert_not_equal :refute_equal
|
|
alias :assert_not_in_delta :refute_in_delta
|
|
alias :assert_not_in_epsilon :refute_in_epsilon
|
|
alias :assert_not_includes :refute_includes
|
|
alias :assert_not_instance_of :refute_instance_of
|
|
alias :assert_not_kind_of :refute_kind_of
|
|
alias :assert_no_match :refute_match
|
|
alias :assert_not_nil :refute_nil
|
|
alias :assert_not_operator :refute_operator
|
|
alias :assert_not_predicate :refute_predicate
|
|
alias :assert_not_respond_to :refute_respond_to
|
|
alias :assert_not_same :refute_same
|
|
|
|
ActiveSupport.run_load_hooks(:active_support_test_case, self)
|
|
end
|
|
end
|