Class: ActiveSupport::TestCase
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Subclasses:
ActionCable::TestCase, ActionController::TestCase, ActionDispatch::IntegrationTest, ActionDispatch::SystemTestCase, ActionMailbox::TestCase, ActionMailer::TestCase, ActionView::TestCase, ActiveJob::TestCase, ActionCable::Channel::TestCase, ActionCable::Connection::TestCase, Rails::Generators::TestCase
|
|
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
Testing::Declarative ,
Minitest::Test
|
|
Instance Chain:
|
|
Inherits: |
Minitest::Test
|
Defined in: | activesupport/lib/active_support/test_case.rb |
Constant Summary
Testing::FileFixtures
- Attributes & Methods
- .file_fixture_path rw
- #file_fixture_path readonly
- .file_fixture_path? ⇒ Boolean rw
- #file_fixture_path? ⇒ Boolean readonly
Class Attribute Summary
-
.test_order
rw
Returns the order in which test cases are run.
-
.test_order=(new_order)
rw
Sets the order in which test cases are run.
Class Method Summary
-
.fixture_paths
Returns the
::ActiveRecord::FixtureSet
collection. -
.fixture_paths=(fixture_paths)
Sets the given path to the fixture set.
-
.parallelize(workers: :number_of_processors, with: :processes, threshold: ActiveSupport.test_parallelization_threshold)
Parallelizes the test suite.
-
.parallelize_setup(&block)
Set up hook for parallel testing.
-
.parallelize_teardown(&block)
Clean up hook for parallel testing.
Testing::Declarative
- Extended
Instance Method Summary
-
#assert_no_match(matcher, obj, msg = nil)
Alias for: refute_match.
-
#assert_not_empty(obj, msg = nil)
Alias for: refute_empty.
-
#assert_not_equal(exp, act, msg = nil)
Alias for: refute_equal.
-
#assert_not_in_delta(exp, act, delta = 0.001, msg = nil)
Alias for: refute_in_delta.
-
#assert_not_in_epsilon(a, b, epsilon = 0.001, msg = nil)
Alias for: refute_in_epsilon.
-
#assert_not_includes(collection, obj, msg = nil)
Alias for: refute_includes.
-
#assert_not_instance_of(cls, obj, msg = nil)
Alias for: refute_instance_of.
-
#assert_not_kind_of(cls, obj, msg = nil)
Alias for: refute_kind_of.
-
#assert_not_nil(obj, msg = nil)
Alias for: refute_nil.
-
#assert_not_operator(o1, op, o2 = UNDEFINED, msg = nil)
Alias for: refute_operator.
-
#assert_not_predicate(o1, op, msg = nil)
Alias for: refute_predicate.
-
#assert_not_respond_to(obj, meth, msg = nil)
Alias for: refute_respond_to.
-
#assert_not_same(exp, act, msg = nil)
Alias for: refute_same.
- #method_name
Testing::FileFixtures
- Included
#file_fixture | Returns a |
Testing::TimeHelpers
- Included
#after_teardown, | |
#freeze_time | Calls |
#travel | Changes current time to the time in the future or in the past by a given time difference by stubbing |
#travel_back | Returns the current time back to its original state, by removing the stubs added by |
#travel_to | Changes current time to the given time by stubbing |
#unfreeze_time | Alias for Testing::TimeHelpers#travel_back. |
Testing::ConstantStubbing
- Included
#stub_const | Changes the value of a constant for the duration of a block. |
Testing::Deprecation
- Included
#assert_deprecated | Asserts that a matching deprecation warning was emitted by the given deprecator during the execution of the yielded block. |
#assert_not_deprecated | Asserts that no deprecation warnings are emitted by the given deprecator during the execution of the yielded block. |
#collect_deprecations | Returns the return value of the block and an array of all the deprecation warnings emitted by the given deprecator during the execution of the yielded block. |
Testing::ErrorReporterAssertions
- Included
#assert_error_reported | Assertion that the block should cause at least one exception to be reported to Rails.error. |
#assert_no_error_reported | Assertion that the block should not cause an exception to be reported to Rails.error. |
Testing::Assertions
- Included
#assert_changes | Assertion that the result of evaluating an expression is changed before and after invoking the passed in block. |
#assert_difference | Test numeric difference between the return value of an expression as a result of what is evaluated in the yielded block. |
#assert_no_changes | Assertion that the result of evaluating an expression is not changed before and after invoking the passed in block. |
#assert_no_difference | Assertion that the numeric result of evaluating an expression is not changed before and after invoking the passed in block. |
#assert_not | Asserts that an expression is not truthy. |
#assert_nothing_raised | Assertion that the block should not raise an exception. |
#assert_raise | Alias for Testing::Assertions#assert_raises. |
#assert_raises | Asserts that a block raises one of |
Class Attribute Details
.file_fixture_path (rw)
[ GitHub ]# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20
class_attribute :file_fixture_path, instance_writer: false
.file_fixture_path? ⇒ Boolean
(rw)
[ GitHub ]
# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20
class_attribute :file_fixture_path, instance_writer: false
.test_order (rw)
Returns the order in which test cases are run.
ActiveSupport::TestCase.test_order # => :random
Possible values are :random
, :parallel
, :alpha
, :sorted
. Defaults to :random
.
# File 'activesupport/lib/active_support/test_case.rb', line 43
def test_order ActiveSupport.test_order ||= :random end
.test_order=(new_order) (rw)
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
)
# File 'activesupport/lib/active_support/test_case.rb', line 33
def test_order=(new_order) ActiveSupport.test_order = new_order end
Class Method Details
.fixture_paths
Returns the ::ActiveRecord::FixtureSet
collection.
In your test_helper.rb
you must have require "rails/test_help"
.
# File 'activesupport/lib/active_support/test_case.rb', line 121
RDoc directive :singleton-method: fixture_paths
.fixture_paths=(fixture_paths)
Sets the given path to the fixture set.
Can also append multiple paths.
ActiveSupport::TestCase.fixture_paths << "component1/test/fixtures"
In your test_helper.rb
you must have require "rails/test_help"
.
# File 'activesupport/lib/active_support/test_case.rb', line 127
RDoc directive :singleton-method: fixture_paths=
.parallelize(workers: :number_of_processors, with: :processes, threshold: ActiveSupport.test_parallelization_threshold)
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 ENV["PARALLEL_WORKERS"]
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 with: :threads
to the parallelize
method. Note the threaded parallelization does not create multiple databases and will not work with system tests.
parallelize(workers: :number_of_processors, with: :threads)
The threaded parallelization uses minitest’s parallel executor directly. The processes parallelization uses a Ruby DRb server.
Because parallelization presents an overhead, it is only enabled when the number of tests to run is above the threshold
param. The default value is 50, and it’s configurable via config.active_support.test_parallelization_threshold
.
# File 'activesupport/lib/active_support/test_case.rb', line 80
def parallelize(workers: :number_of_processors, with: :processes, threshold: ActiveSupport.test_parallelization_threshold) workers = Concurrent.physical_processor_count if workers == :number_of_processors workers = ENV["PARALLEL_WORKERS"].to_i if ENV["PARALLEL_WORKERS"] Minitest.parallel_executor = ActiveSupport::Testing::ParallelizeExecutor.new(size: workers, with: with, threshold: threshold) end
.parallelize_setup(&block)
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
# File 'activesupport/lib/active_support/test_case.rb', line 100
def parallelize_setup(&block) ActiveSupport::Testing::Parallelization.after_fork_hook(&block) end
.parallelize_teardown(&block)
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
# File 'activesupport/lib/active_support/test_case.rb', line 117
def parallelize_teardown(&block) ActiveSupport::Testing::Parallelization.run_cleanup_hook(&block) end
Instance Attribute Details
#file_fixture_path (readonly)
[ GitHub ]# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20
class_attribute :file_fixture_path, instance_writer: false
#file_fixture_path? ⇒ Boolean
(readonly)
[ GitHub ]
# File 'activesupport/lib/active_support/testing/file_fixtures.rb', line 20
class_attribute :file_fixture_path, instance_writer: false
Instance Method Details
#assert_no_match(matcher, obj, msg = nil)
Alias for: refute_match
# File 'activesupport/lib/active_support/test_case.rb', line 231
rdoc_method :method: assert_no_match
#assert_not_empty(obj, msg = nil)
Alias for: refute_empty
# File 'activesupport/lib/active_support/test_case.rb', line 154
rdoc_method :method: assert_not_empty
#assert_not_equal(exp, act, msg = nil)
Alias for: refute_equal
# File 'activesupport/lib/active_support/test_case.rb', line 165
rdoc_method :method: assert_not_equal
#assert_not_in_delta(exp, act, delta = 0.001, msg = nil)
Alias for: refute_in_delta
# File 'activesupport/lib/active_support/test_case.rb', line 176
rdoc_method :method: assert_not_in_delta
#assert_not_in_epsilon(a, b, epsilon = 0.001, msg = nil)
Alias for: refute_in_epsilon
# File 'activesupport/lib/active_support/test_case.rb', line 187
rdoc_method :method: assert_not_in_epsilon
#assert_not_includes(collection, obj, msg = nil)
Alias for: refute_includes
# File 'activesupport/lib/active_support/test_case.rb', line 198
rdoc_method :method: assert_not_includes
#assert_not_instance_of(cls, obj, msg = nil)
Alias for: refute_instance_of
# File 'activesupport/lib/active_support/test_case.rb', line 209
rdoc_method :method: assert_not_instance_of
#assert_not_kind_of(cls, obj, msg = nil)
Alias for: refute_kind_of
# File 'activesupport/lib/active_support/test_case.rb', line 220
rdoc_method :method: assert_not_kind_of
#assert_not_nil(obj, msg = nil)
Alias for: refute_nil
# File 'activesupport/lib/active_support/test_case.rb', line 242
rdoc_method :method: assert_not_nil
#assert_not_operator(o1, op, o2 = UNDEFINED, msg = nil)
Alias for: refute_operator
# File 'activesupport/lib/active_support/test_case.rb', line 253
rdoc_method :method: assert_not_operator
#assert_not_predicate(o1, op, msg = nil)
Alias for: refute_predicate
# File 'activesupport/lib/active_support/test_case.rb', line 264
rdoc_method :method: assert_not_predicate
#assert_not_respond_to(obj, meth, msg = nil)
Alias for: refute_respond_to
# File 'activesupport/lib/active_support/test_case.rb', line 275
rdoc_method :method: assert_not_respond_to
#assert_not_same(exp, act, msg = nil)
Alias for: refute_same
# File 'activesupport/lib/active_support/test_case.rb', line 286
rdoc_method :method: assert_not_same
#method_name
[ GitHub ]# File 'activesupport/lib/active_support/test_case.rb', line 141
alias_method :method_name, :name