test_data 0.1.0 → 0.3.0

data/example/test/integration/mode_switching_demo_test.rb

@@ -1,29 +1,19 @@
 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.rollback(:before_data_load)
-        ActiveRecord::Base.connection.begin_transaction(joinable: false, _lazy: false)
-      end
-
-      teardown do
-        ActiveRecord::Base.connection.rollback_transaction
+        TestData.uses_clean_slate
       end
-
     elsif mode == :test_data
-      self.use_transactional_tests = false
-
       setup do
-        TestData.load
-      end
-
-      teardown do
-        TestData.rollback
+        TestData.uses_test_data
       end
     end
   end

data/example/test/integration/parallel_boops_with_fixtures_test.rb

@@ -6,11 +6,7 @@ class ParallelizedTransactionalFixturefullTestCase < ActiveSupport::TestCase
   fixtures :all
 
   setup do
-    TestData.load
-  end
-
-  teardown do
-    TestData.rollback
+    TestData.uses_test_data
   end
 end
 

data/example/test/integration/parallel_boops_without_fixtures_test.rb

@@ -5,11 +5,7 @@ class ParallelizedNonTransactionalFixturelessTestCase < ActiveSupport::TestCase
   self.use_transactional_tests = false
 
   setup do
-    TestData.load
-  end
-
-  teardown do
-    TestData.rollback
+    TestData.uses_test_data
   end
 end
 

data/example/test/integration/rails_fixtures_double_load_test.rb

@@ -3,8 +3,8 @@ require "test_helper"
 class FixturesUsingTest < ActiveSupport::TestCase
   def test_tries_to_load_rails_fixtures_with_test_data
     error = assert_raises(TestData::Error) do
-      TestData.load_rails_fixtures(self)
+      TestData.uses_rails_fixtures(self)
     end
-    assert_match "'TestData.load_rails_fixtures' 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
+    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

data/example/test/integration/rails_fixtures_override_test.rb

@@ -6,26 +6,23 @@ class FixtureFreeTestData < ActiveSupport::TestCase
   fixtures :boops # why not
 
   setup do
-    TestData.load
+    TestData.uses_test_data
   end
 
   def test_has_no_fixture_boops
     assert_equal 15, Boop.count
   end
-
-  teardown do
-    TestData.rollback
-  end
 end
 
 class FixturesUsingTest < ActiveSupport::TestCase
   fixtures :boops
 
   setup do
-    TestData.load_rails_fixtures(self)
+    TestData.uses_rails_fixtures(self)
   end
 
   def test_has_fixture_boops
+    assert boops(:boop_1).persisted?
     assert_equal 2, Boop.count
   end
 
@@ -34,29 +31,25 @@ class FixturesUsingTest < ActiveSupport::TestCase
   end
 
   def test_even_explicitly_loading_test_data_will_truncate_and_then_load_fixtures
-    TestData.load
-    TestData.load_rails_fixtures(self)
+    TestData.uses_test_data
+    TestData.uses_rails_fixtures(self)
 
     assert_equal 2, Boop.count
   end
 
   def test_load_and_rollback_leaves_them_as_is
     boop = Boop.first
-    original_created_at_time = boop.created_at
-    a_year_ago = 1.year.ago
+    original_created_on = boop.created_at.to_date
+    a_year_ago = 1.year.ago.to_date
 
     boop.update!(created_at: a_year_ago)
 
-    assert_equal Boop.find(boop.id).created_at, a_year_ago
+    assert_equal Boop.find(boop.id).created_at.to_date, a_year_ago
 
-    # Now after rollback
-    TestData.rollback(:after_load_rails_fixtures)
+    # Now trigger a rollback to the fixtures point
+    TestData.uses_rails_fixtures(self)
 
-    assert_equal Boop.find(boop.id).created_at, original_created_at_time
-  end
-
-  teardown do
-    TestData.rollback(:after_load_rails_fixtures)
+    assert_equal Boop.find(boop.id).created_at.to_date, original_created_on
   end
 end
 
@@ -65,35 +58,29 @@ class SomeFixturesAndSomeTestDataInOneClassTest < ActiveSupport::TestCase
   fixtures :all
 
   def test_fixtures_work
-    TestData.load_rails_fixtures(self)
+    TestData.uses_rails_fixtures(self)
 
     assert_equal Date.civil(2020, 1, 1), boops(:boop_1).updated_at.to_date
     assert_equal "Levi", pants(:pant_1).brand
-
-    TestData.rollback(:after_load_rails_fixtures)
   end
 
   def test_that_rewinds_to_test_data
-    TestData.load
+    TestData.uses_test_data
 
     assert_equal 15, Boop.count
-
-    TestData.rollback
   end
 
   def test_that_rewinds_to_the_very_start
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
 
     assert_equal 0, Boop.count
   end
 
   def test_fixtures_get_reloaded_because_cache_is_cleared
-    TestData.load_rails_fixtures(self)
+    TestData.uses_rails_fixtures(self)
 
     assert_equal Date.civil(2019, 1, 1), boops(:boop_2).updated_at.to_date
     assert_equal "Wrangler", pants(:pant_2).brand
-
-    TestData.rollback(:after_load_rails_fixtures)
   end
 end
 
@@ -101,11 +88,7 @@ class PantsFixturesTest < ActiveSupport::TestCase
   fixtures :pants
 
   setup do
-    TestData.load_rails_fixtures(self)
-  end
-
-  teardown do
-    TestData.rollback(:after_load_rails_fixtures)
+    TestData.uses_rails_fixtures(self)
   end
 
   def test_has_fixture_pants
@@ -120,8 +103,8 @@ end
 class FixtureTestPassingTheWrongThingTest < ActiveSupport::TestCase
   def test_doing_it_wrong
     error = assert_raises(TestData::Error) do
-      TestData.load_rails_fixtures(ActiveRecord::Base)
+      TestData.uses_rails_fixtures(ActiveRecord::Base)
     end
-    assert_match "'TestData.load_rails_fixtures' must be passed a test instance that has had ActiveRecord::TestFixtures mixed-in (e.g. `TestData.load_rails_fixtures(self)` in an ActiveSupport::TestCase `setup` block), but the provided argument does not respond to 'setup_fixtures'", error.message
+    assert_match "'TestData.uses_rails_fixtures(self)' must be passed a test instance that has had ActiveRecord::TestFixtures mixed-in (e.g. `TestData.uses_rails_fixtures(self)` in an ActiveSupport::TestCase `setup` block), but the provided argument does not respond to 'setup_fixtures'", error.message
   end
 end

data/example/test/integration/test_data_hooks_test.rb

@@ -0,0 +1,89 @@
+require "test_helper"
+
+TestData.config do |config|
+  config.after_test_data_load { MetaBoop.refresh_materialized_view }
+  config.after_test_data_truncate(-> { MetaBoop.refresh_materialized_view })
+  config.after_rails_fixture_load { MetaBoop.refresh_materialized_view }
+end
+
+TestData.prevent_rails_fixtures_from_loading_automatically!
+MetaBoop.refresh_materialized_view # count = 1
+
+class TestDataHooksTest < ActiveSupport::TestCase
+  fixtures :all
+  i_suck_and_my_tests_are_order_dependent!
+
+  def test_uses_test_data_hook
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    MetaBoop.reset_refresh_materialized_view_count
+
+    # Materialized view is refreshed and called 1 time
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    assert_equal 15, MetaBoop.count
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    MetaBoop.reset_refresh_materialized_view_count
+
+    # Rollbacks also rollback to materialized view changes without calling again
+    Boop.create!(other_boop: Boop.new)
+    assert_equal 16, Boop.count
+    assert_equal 15, MetaBoop.count
+    MetaBoop.refresh_materialized_view
+    assert_equal 16, MetaBoop.count
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    assert_equal 15, MetaBoop.count
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    MetaBoop.reset_refresh_materialized_view_count
+
+    # The same hook also works when cleaning slates
+    TestData.uses_clean_slate
+    assert_equal 0, Boop.count
+    assert_equal 0, MetaBoop.count
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    Boop.create!(other_boop: Boop.new)
+    MetaBoop.refresh_materialized_view
+    assert_equal 1, Boop.count
+    assert_equal 1, MetaBoop.count
+    assert_equal 2, MetaBoop.refresh_materialized_view_count
+    TestData.uses_clean_slate
+    assert_equal 0, Boop.count
+    assert_equal 0, MetaBoop.count
+    assert_equal 2, MetaBoop.refresh_materialized_view_count
+    MetaBoop.reset_refresh_materialized_view_count
+
+    # The same hook works with fixtures
+    TestData.uses_rails_fixtures(self)
+    assert_equal 2, Boop.count
+    assert_equal 2, MetaBoop.count
+    assert_equal 1, MetaBoop.refresh_materialized_view_count
+    Boop.first.delete
+    assert_equal 1, Boop.count
+    assert_equal 2, MetaBoop.count
+    MetaBoop.refresh_materialized_view
+    assert_equal 1, MetaBoop.count
+    assert_equal 2, MetaBoop.refresh_materialized_view_count
+    TestData.uses_rails_fixtures(self)
+    assert_equal 2, Boop.count
+    assert_equal 2, MetaBoop.count
+    assert_equal 2, MetaBoop.refresh_materialized_view_count
+    MetaBoop.reset_refresh_materialized_view_count
+
+    # Rewinding two steps will not call refresh materialized views
+    TestData.uses_test_data
+    assert_equal 15, Boop.count
+    assert_equal 15, MetaBoop.count
+    assert_equal 0, MetaBoop.refresh_materialized_view_count
+  end
+
+  def test_that_hooks_require_valid_settings
+    foo = Struct.new(:thing)
+    assert_raises(TestData::Error) { TestData.config.after_test_data_load(nil) }
+    assert_raises(TestData::Error) { TestData.config.after_test_data_truncate(nil) }
+    assert_raises(TestData::Error) { TestData.config.after_rails_fixture_load(nil) }
+    assert_raises(TestData::Error) { TestData.config.after_test_data_load(foo) }
+    assert_raises(TestData::Error) { TestData.config.after_test_data_truncate(foo) }
+    assert_raises(TestData::Error) { TestData.config.after_rails_fixture_load(foo) }
+  end
+end

data/example/test/integration/transaction_committing_boops_test.rb

@@ -1,13 +1,11 @@
 require "test_helper"
 
-TestData.config.use_transactional_data_loader = false
-
 class TransactionCommittingTestCase < ActiveSupport::TestCase
   self.use_transactional_tests = false
 
   setup do
     Noncommittal.stop!
-    TestData.load
+    TestData.insert_test_data_dump
   end
 
   teardown do
@@ -26,11 +24,4 @@ class TransactionCommittingBoopsTest < TransactionCommittingTestCase
   def test_finds_the_boops_via_another_process
     assert_equal 15, `RAILS_ENV=test bin/rails runner "puts Boop.count"`.chomp.to_i
   end
-
-  def test_cant_have_it_both_ways
-    error = assert_raise(TestData::Error) do
-      TestData.config.use_transactional_data_loader = true
-    end
-    assert_match "There is already a non-transactional data loader", error.message
-  end
 end

data/example/test/test_helper.rb

@@ -9,10 +9,6 @@ class SerializedNonTransactionalTestCase < ActiveSupport::TestCase
   self.use_transactional_tests = false
 
   setup do
-    TestData.load
-  end
-
-  teardown do
-    TestData.rollback
+    TestData.uses_test_data
   end
 end

data/lib/generators/test_data/environment_file_generator.rb

@@ -9,6 +9,10 @@ module TestData
         require_relative "development"
 
         Rails.application.configure do
+          # Rails creates secret key base for only "development" and "test"
+          #   For more info, see: https://github.com/testdouble/test_data/issues/2
+          self.secrets.secret_key_base ||= Rails.application.send(:generate_development_secret)
+
           # Don't persist schema.rb or structure.sql after test_data is migrated
           config.active_record.dump_schema_after_migration = false
         end

data/lib/generators/test_data/initializer_generator.rb

@@ -8,14 +8,17 @@ module TestData
         return unless defined?(TestData)
 
         TestData.config do |config|
-          # Where to store SQL dumps of the test_data database schema
-          # config.schema_dump_path = "test/support/test_data/schema.sql"
+          # Hook run after test data is loaded by `TestData.uses_test_data`,
+          #   but before a savepoint is taken
+          # config.after_test_data_load { }
 
-          # Where to store SQL dumps of the test_data database test data
-          # config.data_dump_path = "test/support/test_data/data.sql"
+          # Hook run after test data is truncated by `TestData.uses_clean_slate`,
+          #   but before a savepoint is taken
+          # config.after_test_data_truncate { }
 
-          # Where to store SQL dumps of the test_data database non-test data
-          # config.non_test_data_dump_path = "test/support/test_data/non_test_data.sql"
+          # Hook run after test data is truncated by `TestData.uses_rails_fixtures`,
+          #   but before a savepoint is taken
+          # config.after_rails_fixture_load { }
 
           # Tables whose data shouldn't be loaded into tests.
           #   ("ar_internal_metadata" and "schema_migrations" are always excluded)
@@ -24,17 +27,20 @@ module TestData
           # Tables whose data should be excluded from SQL dumps (still dumps their schema DDL)
           # config.dont_dump_these_tables = []
 
-          # Tables whose data should be truncated by TestData.truncate
+          # Where to store SQL dumps of the test_data database schema
+          # config.schema_dump_path = "test/support/test_data/schema.sql"
+
+          # Where to store SQL dumps of the test_data database test data
+          # config.data_dump_path = "test/support/test_data/data.sql"
+
+          # Where to store SQL dumps of the test_data database non-test data
+          # config.non_test_data_dump_path = "test/support/test_data/non_test_data.sql"
+
+          # Tables whose data should be truncated by TestData.uses_clean_slate
           #   If left as `nil`, all tables inserted into by the SQL file at
           #   `data_dump_path` will be truncated
           # config.truncate_these_test_data_tables = nil
 
-          # Perform TestData.load and TestData.truncate inside nested
-          #   transactions for increased test isolation and speed. Setting this
-          #   to false will disable several features that depend on transactions
-          #   being used
-          # config.use_transactional_data_loader = true
-
           # Log level (valid values: [:debug, :info, :warn, :error, :quiet])
           #   Can also be set with env var TEST_DATA_LOG_LEVEL
           # config.log_level = :info

data/lib/test_data/config.rb

@@ -29,18 +29,9 @@ module TestData
     # Tables to exclude from all dumps
     attr_accessor :dont_dump_these_tables
 
-    # Tables to truncate when TestData.truncate is called
+    # Tables to truncate when TestData.uses_clean_slate is called
     attr_accessor :truncate_these_test_data_tables
 
-    # Perform TestData.load and TestData.truncate inside nested
-    # transactions for increased test isolation and speed. Setting this to false
-    # will disable several features that depend on transactions being used
-    attr_reader :use_transactional_data_loader
-    def use_transactional_data_loader=(use_transactions)
-      TestData.ensure_we_dont_mix_transactional_and_non_transactional_data_loaders!(use_transactions)
-      @use_transactional_data_loader = use_transactions
-    end
-
     # Log level (valid values: [:debug, :info, :warn, :error, :quiet])
     def log_level
       TestData.log.level
@@ -50,7 +41,8 @@ module TestData
       TestData.log.level = level
     end
 
-    attr_reader :pwd, :cable_yaml_path, :database_yaml_path, :secrets_yaml_path
+    attr_reader :pwd, :cable_yaml_path, :database_yaml_path, :secrets_yaml_path,
+      :after_test_data_load_hook, :after_test_data_truncate_hook, :after_rails_fixture_load_hook
 
     def self.full_path_reader(*relative_path_readers)
       relative_path_readers.each do |relative_path_reader|
@@ -73,7 +65,33 @@ module TestData
       @non_test_data_tables = []
       @dont_dump_these_tables = []
       @truncate_these_test_data_tables = nil
-      @use_transactional_data_loader = true
+      @after_test_data_load_hook = -> {}
+      @after_test_data_truncate_hook = -> {}
+      @after_rails_fixture_load_hook = -> {}
+    end
+
+    def after_test_data_load(callable = nil, &blk)
+      hook = callable || blk
+      if !hook.respond_to?(:call)
+        raise Error.new("after_test_data_load must be passed a callable (e.g. a Proc) or called with a block")
+      end
+      @after_test_data_load_hook = hook
+    end
+
+    def after_test_data_truncate(callable = nil, &blk)
+      hook = callable || blk
+      if !hook.respond_to?(:call)
+        raise Error.new("after_test_data_truncate must be passed a callable (e.g. a Proc) or called with a block")
+      end
+      @after_test_data_truncate_hook = hook
+    end
+
+    def after_rails_fixture_load(callable = nil, &blk)
+      hook = callable || blk
+      if !hook.respond_to?(:call)
+        raise Error.new("after_rails_fixture_load must be passed a callable (e.g. a Proc) or called with a block")
+      end
+      @after_rails_fixture_load_hook = hook
     end
 
     def database_yaml