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: self, `Testing::FileFixtures`, `Testing::TimeHelpers`, `Testing::ConstantStubbing`, `Testing::Deprecation`, `Testing::NotificationAssertions`, `Testing::ErrorReporterAssertions`, `Testing::Assertions`, `Testing::TestsWithoutAssertions`, `Testing::SetupAndTeardown`, `Testing::TaggedLogging`, Minitest::Test
Inherits:	Minitest::Test `::Object` Minitest::Test ActiveSupport::TestCase
Defined in:	activesupport/lib/active_support/test_case.rb

Constant Summary

Assertion =
# File 'activesupport/lib/active_support/test_case.rb', line 23
```
Minitest::Assertion
```

`Testing::Assertions` - Included

UNTRACKED

`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

test	Helper to define a test method using a `::String`.

Instance Attribute Summary

`Testing::TimeHelpers` - Included

#in_block

`Testing::TaggedLogging` - Included

#tagged_logger=, #tagged_logger

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
#inspect Internal use only

`Testing::FileFixtures` - Included

#file_fixture

Returns a ::Pathname to the fixture file named fixture_name.

`Testing::TimeHelpers` - Included

#after_teardown,
#freeze_time	Calls `travel_to` with `Time.now`.
#travel	Changes current time to the time in the future or in the past by a given time difference by stubbing `Time.now`, `Date.today`, and `DateTime.now`.
#travel_back	Returns the current time back to its original state, by removing the stubs added by `travel`, `travel_to`, and `freeze_time`.
#travel_to	Changes current time to the given time by stubbing `Time.now`, `Time.new`, `Date.today`, and `DateTime.now` to return the time or date passed into this method.
#unfreeze_time	Alias for Testing::TimeHelpers#travel_back.
#simple_stubs

`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::NotificationAssertions` - Included

#assert_no_notifications	Assert no notifications were emitted for a given `pattern`.
#assert_notification	Assert a notification was emitted with a given `pattern` and optional `payload`.
#assert_notifications_count	Assert the number of notifications emitted with a given `pattern`.
#capture_notifications	Capture emitted notifications, optionally filtered by a `pattern`.

`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 `exp`.
#_assert_nothing_raised_or_warn, #_callable_to_source_string

`Testing::TestsWithoutAssertions` - Included

#after_teardown

`Testing::SetupAndTeardown` - Included

#after_teardown, #before_setup

`Testing::TaggedLogging` - Included

#before_setup

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.

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 45


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)

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 35


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".

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 127


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".

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 133


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.

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 82


def parallelize(workers: :number_of_processors, with: :processes, threshold: ActiveSupport.test_parallelization_threshold)
  case
  when ENV["PARALLEL_WORKERS"]
    workers = ENV["PARALLEL_WORKERS"].to_i
  when workers == :number_of_processors
    workers = (Concurrent.available_processor_count || Concurrent.processor_count).floor
  end

  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

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 106


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

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 123


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

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 239


rdoc_method :method: assert_no_match

#assert_not_empty(obj, msg = nil)

Alias for: refute_empty

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 162


rdoc_method :method: assert_not_empty

#assert_not_equal(exp, act, msg = nil)

Alias for: refute_equal

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 173


rdoc_method :method: assert_not_equal

#assert_not_in_delta(exp, act, delta = 0.001, msg = nil)

Alias for: refute_in_delta

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 184


rdoc_method :method: assert_not_in_delta

#assert_not_in_epsilon(a, b, epsilon = 0.001, msg = nil)

Alias for: refute_in_epsilon

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 195


rdoc_method :method: assert_not_in_epsilon

#assert_not_includes(collection, obj, msg = nil)

Alias for: refute_includes

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 206


rdoc_method :method: assert_not_includes

#assert_not_instance_of(cls, obj, msg = nil)

Alias for: refute_instance_of

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 217


rdoc_method :method: assert_not_instance_of

#assert_not_kind_of(cls, obj, msg = nil)

Alias for: refute_kind_of

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 228


rdoc_method :method: assert_not_kind_of

#assert_not_nil(obj, msg = nil)

Alias for: refute_nil

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 250


rdoc_method :method: assert_not_nil

#assert_not_operator(o1, op, o2 = UNDEFINED, msg = nil)

Alias for: refute_operator

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 261


rdoc_method :method: assert_not_operator

#assert_not_predicate(o1, op, msg = nil)

Alias for: refute_predicate

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 272


rdoc_method :method: assert_not_predicate

#assert_not_respond_to(obj, meth, msg = nil)

Alias for: refute_respond_to

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 283


rdoc_method :method: assert_not_respond_to

#assert_not_same(exp, act, msg = nil)

Alias for: refute_same

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 294


rdoc_method :method: assert_not_same

#inspect

This method is for internal use only.

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 306


def inspect # :nodoc:
  Object.instance_method(:to_s).bind_call(self)
end

#method_name

[ GitHub ]

# File 'activesupport/lib/active_support/test_case.rb', line 147


alias_method :method_name, :name

Class: ActiveSupport::TestCase

Constant Summary

Testing::Assertions - Included

Testing::FileFixtures - Attributes & Methods

Class Attribute Summary

Class Method Summary

Testing::Declarative - Extended

Instance Attribute Summary

Testing::TimeHelpers - Included

Testing::TaggedLogging - Included

Instance Method Summary

Testing::FileFixtures - Included

Testing::TimeHelpers - Included

Testing::ConstantStubbing - Included

Testing::Deprecation - Included

Testing::NotificationAssertions - Included

Testing::ErrorReporterAssertions - Included

Testing::Assertions - Included

Testing::TestsWithoutAssertions - Included

Testing::SetupAndTeardown - Included

Testing::TaggedLogging - Included

Class Attribute Details

.file_fixture_path (rw)

.file_fixture_path? ⇒ Boolean (rw)

.test_order (rw)

.test_order=(new_order) (rw)

Class Method Details

.fixture_paths

.fixture_paths=(fixture_paths)

.parallelize(workers: :number_of_processors, with: :processes, threshold: ActiveSupport.test_parallelization_threshold)

.parallelize_setup(&block)

.parallelize_teardown(&block)

Instance Attribute Details

#file_fixture_path (readonly)

#file_fixture_path? ⇒ Boolean (readonly)

Instance Method Details

#assert_no_match(matcher, obj, msg = nil)

#assert_not_empty(obj, msg = nil)

#assert_not_equal(exp, act, msg = nil)

#assert_not_in_delta(exp, act, delta = 0.001, msg = nil)

#assert_not_in_epsilon(a, b, epsilon = 0.001, msg = nil)

#assert_not_includes(collection, obj, msg = nil)

#assert_not_instance_of(cls, obj, msg = nil)

#assert_not_kind_of(cls, obj, msg = nil)

#assert_not_nil(obj, msg = nil)

#assert_not_operator(o1, op, o2 = UNDEFINED, msg = nil)

#assert_not_predicate(o1, op, msg = nil)

#assert_not_respond_to(obj, meth, msg = nil)

#assert_not_same(exp, act, msg = nil)

#inspect

#method_name

`Testing::Assertions` - Included

`Testing::FileFixtures` - Attributes & Methods

`Testing::Declarative` - Extended

`Testing::TimeHelpers` - Included

`Testing::TaggedLogging` - Included

`Testing::FileFixtures` - Included

`Testing::TimeHelpers` - Included

`Testing::ConstantStubbing` - Included

`Testing::Deprecation` - Included

`Testing::NotificationAssertions` - Included

`Testing::ErrorReporterAssertions` - Included

`Testing::Assertions` - Included

`Testing::TestsWithoutAssertions` - Included

`Testing::SetupAndTeardown` - Included

`Testing::TaggedLogging` - Included

.file_fixture_path? ⇒ `Boolean` (rw)

#file_fixture_path? ⇒ `Boolean` (readonly)