123456789_123456789_123456789_123456789_123456789_

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::Assertions, Testing::SetupAndTeardown, Minitest::Test
Inherits: Minitest::Test
  • ::Object
Defined in: activesupport/lib/active_support/test_case.rb

Constant Summary

Testing::FileFixtures - Attributes & Methods

Class Attribute Summary

Class Method Summary

Testing::Declarative - Extended

test

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

Instance Method Summary

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, Date.today, and DateTime.now to return the time or date passed into this method.
#unfreeze_time

Alias for Testing::TimeHelpers#travel_back.

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.

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 41



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 31



def test_order=(new_order)
  ActiveSupport.test_order = new_order
end


  







Class Method Details



  

    .parallelize(workers: :number_of_processors, with: :processes)  
  



  

    

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


  



  [ GitHub ]


  

  


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



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

  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


  








  

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



def parallelize_setup(&block)
  ActiveSupport::Testing::Parallelization.after_fork_hook do |worker|
    yield worker
  end
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 128



def parallelize_teardown(&block)
  ActiveSupport::Testing::Parallelization.run_cleanup_hook do |worker|
    yield worker
  end
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  
  

  [ GitHub ]


  

  


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



alias :assert_no_match :refute_match


  








  

    #assert_not_empty  
  

  [ GitHub ]


  

  


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



alias :assert_not_empty :refute_empty


  








  

    #assert_not_equal  
  

  [ GitHub ]


  

  


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



alias :assert_not_equal :refute_equal


  








  

    #assert_not_in_delta  
  

  [ GitHub ]


  

  


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



alias :assert_not_in_delta :refute_in_delta


  








  

    #assert_not_in_epsilon  
  

  [ GitHub ]


  

  


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



alias :assert_not_in_epsilon :refute_in_epsilon


  








  

    #assert_not_includes  
  

  [ GitHub ]


  

  


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



alias :assert_not_includes :refute_includes


  








  

    #assert_not_instance_of  
  

  [ GitHub ]


  

  


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



alias :assert_not_instance_of :refute_instance_of


  








  

    #assert_not_kind_of  
  

  [ GitHub ]


  

  


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



alias :assert_not_kind_of :refute_kind_of


  








  

    #assert_not_nil  
  

  [ GitHub ]


  

  


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



alias :assert_not_nil :refute_nil


  








  

    #assert_not_operator  
  

  [ GitHub ]


  

  


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



alias :assert_not_operator :refute_operator


  








  

    #assert_not_predicate  
  

  [ GitHub ]


  

  


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



alias :assert_not_predicate :refute_predicate


  








  

    #assert_not_respond_to  
  

  [ GitHub ]


  

  


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



alias :assert_not_respond_to :refute_respond_to


  








  

    #assert_not_same  
  

  [ GitHub ]


  

  


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



alias :assert_not_same :refute_same


  








  

    #assert_raise  
  



  

    

test/unit backwards compatibility methods


  



  [ GitHub ]


  

  


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



alias :assert_raise :assert_raises


  








  

    #method_name  
  

  [ GitHub ]


  

  


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



alias_method :method_name, :name