test_data 0.0.1 → 0.2.1

data/example/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/example/test/factories.rb

@@ -0,0 +1,4 @@
+FactoryBot.define do
+  factory :boop do
+  end
+end

data/example/test/integration/better_mode_switching_demo_test.rb

@@ -0,0 +1,41 @@
+require "test_helper"
+
+class ActiveSupport::TestCase
+  def self.test_data_mode(mode)
+    case mode
+    when :factory_bot
+      require "factory_bot_rails"
+      include FactoryBot::Syntax::Methods
+
+      setup do
+        TestData.uses_clean_slate
+      end
+    when :test_data
+      setup do
+        TestData.uses_test_data
+      end
+    end
+  end
+end
+
+class SomeFactoryUsingTest < ActiveSupport::TestCase
+  test_data_mode :factory_bot
+
+  def test_boops
+    create(:boop)
+
+    assert_equal 1, Boop.count
+  end
+end
+
+class SomeTestDataUsingTest < ActionDispatch::IntegrationTest
+  test_data_mode :test_data
+
+  def test_boops
+    assert_equal 10, Boop.count
+  end
+
+  def test_factory_bot_method_is_not_on_this_class
+    assert_raises(NameError) { method(:create) }
+  end
+end

data/example/test/integration/boops_that_boop_boops_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class BoopsThatBoopBoopsTest < SerializedNonTransactionalTestCase
+  def test_each_of_the_boops_has_a_boop
+    assert_equal 15, Boop.count
+
+    Boop.find_each do |boop|
+      assert_kind_of Boop, boop.other_boop
+    end
+  end
+
+  def test_it_wont_let_you_assign_a_nonsensical_boop
+    assert_raise {
+      Boop.last.update!(other_boop_id: 2138012)
+    }
+  end
+end

data/example/test/integration/dont_dump_tables_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class DontDumpTablesTest < SerializedNonTransactionalTestCase
+  def test_dump_includes_zero_chatty_audit_logs
+    assert_equal 0, ChattyAuditLog.count
+  end
+end

data/example/test/integration/load_rollback_truncate_test.rb

@@ -0,0 +1,190 @@
+require "test_helper"
+
+class LoadRollbackTruncateTest < ActiveSupport::TestCase
+  LogMessage = Struct.new(:message, :level, keyword_init: true)
+
+  def setup
+    @last_log = nil
+    TestData.log.level = :debug
+    TestData.log.writer = ->(message, level) {
+      @last_log = LogMessage.new(message: message, level: level)
+    }
+  end
+
+  def teardown
+    TestData.log.reset
+    TestData.statistics.reset
+  end
+
+  def test_loads_data_then_truncates_then_rolls_back_etc
+    # Check default state
+    assert_equal 0, Boop.count
+
+    # Now load the dump
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    Boop.create!
+    assert_equal 16, Boop.count
+
+    # Next, truncate the boops
+    TestData.uses_clean_slate
+    assert_equal 0, Boop.count
+    Boop.create!
+    assert_equal 1, Boop.count
+
+    # Now roll back to _just after truncate_
+    TestData.uses_clean_slate
+    assert_equal 0, Boop.count
+    Boop.create!
+    assert_equal 1, Boop.count
+
+    # Verify default rollback works after truncate
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+
+    # Verify touching non-test-data tables will also be first rollbacked when truncate is called
+    TestData.uninitialize
+    good = ChattyAuditLog.create!(message: "I do belong here, because now we're at the start, prior to test_data's purview")
+    TestData.uses_test_data
+    bad = ChattyAuditLog.create!(message: "I won't belong here after truncate because I'm data that the truncate-calling test wouldn't expect")
+    assert_equal 2, ChattyAuditLog.count
+
+    TestData.uses_clean_slate
+
+    assert_equal 1, ChattyAuditLog.count
+    refute_nil ChattyAuditLog.find_by(id: good.id)
+    assert_nil ChattyAuditLog.find_by(id: bad.id)
+
+    # Warn but load anyway if rolled back to the start and then truncated
+    TestData.uninitialize
+    TestData.uses_clean_slate
+    assert_equal :debug, @last_log.level
+    assert_match "TestData.uses_clean_slate was called, but data was not loaded. Loading data", @last_log.message
+    assert_equal 0, Boop.count
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+
+    # Chaos: try rolling back outside the gem (one level of extraneous rollback) and verify load recovers
+    TestData.uninitialize
+    TestData.statistics.reset
+    assert_equal 0, TestData.statistics.load_count
+    TestData.uses_test_data
+    assert_equal 1, TestData.statistics.load_count
+    TestData.uses_test_data # Smart enough to not load again
+    assert_equal 1, TestData.statistics.load_count
+    ActiveRecord::Base.connection.rollback_transaction # Someone might do this!
+    TestData.uses_test_data # Still smart enough to not do this
+    assert_equal 1, TestData.statistics.load_count
+    TestData.uses_test_data # after load savepoint should have been healed with subsequent load call
+    assert_equal 15, Boop.count
+
+    # Chaos: try rolling back outside the gem (one level of extraneous rollback) and verify truncate recovers
+    TestData.uninitialize
+    TestData.statistics.reset
+    assert_equal 0, TestData.statistics.truncate_count
+    TestData.uses_test_data
+    TestData.uses_clean_slate
+    assert_equal 1, TestData.statistics.truncate_count
+    TestData.uses_clean_slate
+    assert_equal 1, TestData.statistics.truncate_count
+    ActiveRecord::Base.connection.rollback_transaction # Someone might do this!
+    TestData.uses_clean_slate # Will recover, not take the bait
+    assert_equal 1, TestData.statistics.truncate_count
+    TestData.uses_clean_slate # after truncate savepoint should have been healed with subsequent truncate call
+    assert_equal 0, Boop.count
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+
+    # Chaos: load data then call rollback two times and ensure we're still in a good spot
+    TestData.uninitialize
+    TestData.statistics.reset
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    2.times do # Two rollbacks means we're back at before_data_load
+      ActiveRecord::Base.connection.rollback_transaction
+    end
+    assert_equal 0, Boop.count
+    TestData.uses_test_data # It should successfully load again a second time
+    assert_equal 15, Boop.count
+    assert_equal 2, TestData.statistics.load_count
+
+    # Chaos: truncate data then call rollback two times and ensure we're still in a good spot
+    TestData.uninitialize
+    TestData.statistics.reset
+    TestData.uses_clean_slate # will warn-and-load and then truncate
+    assert_equal 0, Boop.count
+    2.times do # Two rollbacks means data is loaded but after_data_load savepoint has been lost
+      ActiveRecord::Base.connection.rollback_transaction
+    end
+    assert_equal 15, Boop.count
+    assert_equal 1, TestData.statistics.load_count
+    assert_equal 1, TestData.statistics.truncate_count
+    TestData.uses_clean_slate # should restore the lost after_data_load savepoint and re-truncate
+    3.times do # Three rollbacks means we are at before_data_load again
+      ActiveRecord::Base.connection.rollback_transaction
+    end
+    assert_equal 0, Boop.count
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    TestData.uses_clean_slate
+    assert_equal 0, Boop.count
+    assert_equal 3, TestData.statistics.truncate_count
+    assert_equal 2, TestData.statistics.load_count
+  end
+
+  def test_suite_runs_different_tests_in_whatever_order
+    # Imagine a test-datay test runs
+    test_data_using_test = -> do
+      TestData.uses_test_data # before each
+      Boop.create!
+      assert_equal 16, Boop.count
+    end
+
+    test_data_avoiding_test = -> do
+      TestData.uses_clean_slate # before each
+      Boop.create!
+      assert_equal 1, Boop.count
+    end
+
+    # Run the tests separately:
+    3.times { test_data_using_test.call }
+    3.times { test_data_avoiding_test.call }
+
+    # Mix and match the tests:
+    test_data_using_test.call
+    test_data_avoiding_test.call
+    test_data_using_test.call
+    test_data_avoiding_test.call
+    test_data_using_test.call
+    test_data_avoiding_test.call
+  end
+
+  def test_calling_truncate_multiple_times_will_return_you_to_truncated_state
+    # In the interest of behaving similarly to .load, rollback in case the
+    # previous test doesn't have an after_each as you might hope/expect
+    3.times do
+      TestData.uses_clean_slate
+      Boop.create!
+      assert_equal 1, Boop.count
+    end
+  end
+
+  def test_other_rollbacks_mess_with_transaction_state_will_debug_you
+    TestData.uninitialize
+    TestData.statistics.reset
+    TestData.uses_test_data
+    ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_load save point destroyed
+    TestData.uses_test_data
+    assert_equal :debug, @last_log.level # debug only b/c rails fixtures will do this on every after_each if enabled
+    assert_match "Recreating the :after_data_load save point", @last_log.message
+    assert_equal 1, TestData.statistics.load_count
+
+    TestData.uses_clean_slate
+    ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_truncate save point destroyed
+    TestData.uses_clean_slate
+    assert_equal :debug, @last_log.level # debug only b/c rails fixtures will do this on every after_each if enabled
+    assert_match "Recreating the :after_data_truncate save point", @last_log.message
+    assert_equal 1, TestData.statistics.load_count
+    assert_equal 1, TestData.statistics.truncate_count
+  end
+end

data/example/test/integration/mode_switching_demo_test.rb

@@ -0,0 +1,38 @@
+require "test_helper"
+
+class ModeSwitchingTestCase < ActiveSupport::TestCase
+  self.use_transactional_tests = false
+
+  def self.test_data_mode(mode)
+    if mode == :factory_bot
+      require "factory_bot_rails"
+      include FactoryBot::Syntax::Methods
+
+      setup do
+        TestData.uses_clean_slate
+      end
+    elsif mode == :test_data
+      setup do
+        TestData.uses_test_data
+      end
+    end
+  end
+end
+
+class FactoryModeTest < ModeSwitchingTestCase
+  test_data_mode :factory_bot
+
+  def test_boops
+    create(:boop)
+
+    assert_equal 1, Boop.count
+  end
+end
+
+class TestDataModeTest < ModeSwitchingTestCase
+  test_data_mode :test_data
+
+  def test_boops
+    assert_equal 10, Boop.count
+  end
+end

data/example/test/integration/parallel_boops_with_fixtures_test.rb

@@ -1,5 +1,15 @@
 require "test_helper"
 
+class ParallelizedTransactionalFixturefullTestCase < ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+  self.use_transactional_tests = true
+  fixtures :all
+
+  setup do
+    TestData.uses_test_data
+  end
+end
+
 class ParallelBoopsWithFixturesTest < ParallelizedTransactionalFixturefullTestCase
   100.times do |i|
     test "that boops don't change ##{i}" do

data/example/test/integration/parallel_boops_without_fixtures_test.rb

@@ -1,5 +1,14 @@
 require "test_helper"
 
+class ParallelizedNonTransactionalFixturelessTestCase < ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+  self.use_transactional_tests = false
+
+  setup do
+    TestData.uses_test_data
+  end
+end
+
 class ParallelBoopsWithoutFixturesTest < ParallelizedNonTransactionalFixturelessTestCase
   100.times do |i|
     test "that boops don't change ##{i}" do

data/example/test/integration/rails_fixtures_double_load_test.rb

@@ -0,0 +1,10 @@
+require "test_helper"
+
+class FixturesUsingTest < ActiveSupport::TestCase
+  def test_tries_to_load_rails_fixtures_with_test_data
+    error = assert_raises(TestData::Error) do
+      TestData.uses_rails_fixtures(self)
+    end
+    assert_match "'TestData.uses_rails_fixtures(self)' depends on Rails' default fixture-loading behavior being disabled by calling 'TestData.prevent_rails_fixtures_from_loading_automatically!' as early as possible (e.g. near the top of your test_helper.rb), but it looks like it was never called", error.message
+  end
+end