test_data 0.1.0 → 0.2.0

data/lib/test_data/version.rb

@@ -1,3 +1,3 @@
 module TestData
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/script/test

@@ -51,6 +51,7 @@ bin/rails test test/integration/transaction_committing_boops_test.rb
 
 # Run a test that prevents Rails fixtures for preloading and then loads them in a transaction
 bin/rails test test/integration/rails_fixtures_override_test.rb
+bundle exec rspec spec/requests/rails_fixtures_override_spec.rb
 
 # Run a test that forgets to prevent Rails fixtures but then tries to load them in a transaction
 bin/rails test test/integration/rails_fixtures_double_load_test.rb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_data
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-06-27 00:00:00.000000000 Z
+date: 2021-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -93,6 +93,7 @@ files:
 - example/public/robots.txt
 - example/spec/rails_helper.rb
 - example/spec/requests/boops_spec.rb
+- example/spec/requests/rails_fixtures_override_spec.rb
 - example/spec/spec_helper.rb
 - example/test/application_system_test_case.rb
 - example/test/factories.rb
@@ -129,18 +130,22 @@ files:
 - lib/test_data/configurators/initializer.rb
 - lib/test_data/configurators/secrets_yaml.rb
 - lib/test_data/configurators/webpacker_yaml.rb
+- lib/test_data/custom_loaders/abstract_base.rb
+- lib/test_data/custom_loaders/rails_fixtures.rb
 - lib/test_data/detects_database_emptiness.rb
 - lib/test_data/dumps_database.rb
 - lib/test_data/error.rb
 - lib/test_data/generator_support.rb
+- lib/test_data/inserts_test_data.rb
 - lib/test_data/installs_configuration.rb
 - lib/test_data/loads_database_dumps.rb
 - lib/test_data/log.rb
+- lib/test_data/manager.rb
 - lib/test_data/railtie.rb
 - lib/test_data/rake.rb
 - lib/test_data/save_point.rb
 - lib/test_data/statistics.rb
-- lib/test_data/transactional_data_loader.rb
+- lib/test_data/truncates_test_data.rb
 - lib/test_data/verifies_configuration.rb
 - lib/test_data/verifies_dumps_are_loadable.rb
 - lib/test_data/version.rb

data/lib/test_data/transactional_data_loader.rb

@@ -1,300 +0,0 @@
-module TestData
-  def self.load
-    @data_loader ||= TestData.config.use_transactional_data_loader ? TransactionalDataLoader.new : CommittingDataLoader.new
-    @data_loader.load
-  end
-
-  def self.ensure_we_dont_mix_transactional_and_non_transactional_data_loaders!(use_transactions)
-    unless @data_loader.nil? || use_transactions == @data_loader.transactional?
-      raise Error.new("There is already a #{@data_loader.transactional? ? "transactional" : "non-transactional"} data loader in use, and test_data does not support mixing both types of loaders in a single process.")
-    end
-  end
-
-  def self.rollback(save_point_name = :after_data_load)
-    unless TestData.config.use_transactional_data_loader
-      raise Error.new("TestData.rollback requires config.use_transactional_data_loader = true")
-    end
-    @data_loader ||= TransactionalDataLoader.new
-    case save_point_name
-    when :before_data_load
-      @data_loader.rollback_to_before_data_load
-    when :after_data_load
-      @data_loader.rollback_to_after_data_load
-    when :after_data_truncate
-      @data_loader.rollback_to_after_data_truncate
-    when :after_load_rails_fixtures
-      @data_loader.rollback_to_after_load_rails_fixtures
-    else
-      raise Error.new("No known save point named '#{save_point_name}'. Valid values are: [:before_data_load, :after_data_load, :after_data_truncate, :after_load_rails_fixtures]")
-    end
-  end
-
-  def self.truncate
-    @data_loader ||= TestData.config.use_transactional_data_loader ? TransactionalDataLoader.new : CommittingDataLoader.new
-    @data_loader.truncate
-  end
-
-  def self.load_rails_fixtures(test_instance)
-    if !test_instance.respond_to?(:setup_fixtures)
-      raise Error.new("'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'")
-    elsif !test_instance.respond_to?(:__test_data_gem_setup_fixtures)
-      raise Error.new("'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.")
-    elsif !TestData.config.use_transactional_data_loader
-      raise Error.new("'TestData.load_rails_fixtures' requires config.use_transactional_data_loader = true")
-    end
-    @data_loader ||= TransactionalDataLoader.new
-    @data_loader.load_rails_fixtures(test_instance)
-  end
-
-  class AbstractDataLoader
-    def initialize
-      @config = TestData.config
-      @statistics = TestData.statistics
-    end
-
-    protected
-
-    def execute_data_load
-      search_path = execute("show search_path").first["search_path"]
-      connection.disable_referential_integrity do
-        execute(File.read(@config.data_dump_full_path))
-      end
-      execute <<~SQL
-        select pg_catalog.set_config('search_path', '#{search_path}', false)
-      SQL
-      @statistics.count_load!
-    end
-
-    def execute_data_truncate
-      connection.disable_referential_integrity do
-        execute("TRUNCATE TABLE #{tables_to_truncate.map { |t| connection.quote_table_name(t) }.join(", ")} #{"CASCADE" unless @config.truncate_these_test_data_tables.present?}")
-      end
-      @statistics.count_truncate!
-    end
-
-    def execute_load_rails_fixtures(test_instance)
-      test_instance.pre_loaded_fixtures = false
-      test_instance.use_transactional_tests = false
-      test_instance.__test_data_gem_setup_fixtures
-      @already_loaded_rails_fixtures[test_instance.class] = test_instance.instance_variable_get(:@loaded_fixtures)
-      @statistics.count_load_rails_fixtures!
-    end
-
-    def tables_to_truncate
-      if @config.truncate_these_test_data_tables.present?
-        @config.truncate_these_test_data_tables
-      else
-        @tables_to_truncate ||= IO.foreach(@config.data_dump_path).grep(/^INSERT INTO/) { |line|
-          line.match(/^INSERT INTO ([^\s]+)/)&.captures&.first
-        }.compact.uniq
-      end
-    end
-
-    def connection
-      ActiveRecord::Base.connection
-    end
-
-    private
-
-    def execute(sql)
-      connection.execute(sql)
-    end
-  end
-
-  class CommittingDataLoader < AbstractDataLoader
-    def transactional?
-      false
-    end
-
-    def load
-      execute_data_load
-    end
-
-    def truncate
-      execute_data_truncate
-    end
-  end
-
-  class TransactionalDataLoader < AbstractDataLoader
-    def initialize
-      super
-      @save_points = []
-      @already_loaded_rails_fixtures = {}
-    end
-
-    def transactional?
-      true
-    end
-
-    def load
-      ensure_after_load_save_point_is_active_if_data_is_loaded!
-      return rollback_to_after_data_load if save_point_active?(:after_data_load)
-
-      create_save_point(:before_data_load)
-      execute_data_load
-      record_ar_internal_metadata_that_test_data_is_loaded
-      create_save_point(:after_data_load)
-    end
-
-    def rollback_to_before_data_load
-      if save_point_active?(:before_data_load)
-        rollback_save_point(:before_data_load)
-        # No need to recreate the save point -- TestData.load will if called
-      end
-    end
-
-    def rollback_to_after_data_load
-      if save_point_active?(:after_data_load)
-        rollback_save_point(:after_data_load)
-        create_save_point(:after_data_load)
-      end
-    end
-
-    def rollback_to_after_data_truncate
-      if save_point_active?(:after_data_truncate)
-        rollback_save_point(:after_data_truncate)
-        create_save_point(:after_data_truncate)
-      end
-    end
-
-    def rollback_to_after_load_rails_fixtures
-      if save_point_active?(:after_load_rails_fixtures)
-        rollback_save_point(:after_load_rails_fixtures)
-        create_save_point(:after_load_rails_fixtures)
-      end
-    end
-
-    def truncate
-      ensure_after_load_save_point_is_active_if_data_is_loaded!
-      ensure_after_truncate_save_point_is_active_if_data_is_truncated!
-      return rollback_to_after_data_truncate if save_point_active?(:after_data_truncate)
-
-      if save_point_active?(:after_data_load)
-        # If a test that uses the test data runs before a test that starts by
-        # calling truncate, tables in the database that would NOT be truncated
-        # may have been changed. To avoid this category of test pollution, start
-        # the truncation by rolling back to the known clean point
-        rollback_to_after_data_load
-      else
-        # Seems silly loading data when the user asked us to truncate, but
-        # it's important that the state of the transaction stack matches the
-        # mental model we advertise, because any _other_ test in their suite
-        # should expect that the existence of :after_data_truncate save point
-        # implies that it's safe to rollback to the :after_data_load save
-        # point; since tests run in random order, it's likely to happen
-        TestData.log.debug("TestData.truncate was called, but data was not loaded. Loading data before truncate to preserve the transaction save point ordering")
-        load
-      end
-
-      execute_data_truncate
-      record_ar_internal_metadata_that_test_data_is_truncated
-      create_save_point(:after_data_truncate)
-    end
-
-    # logic is beat-for-beat the same as #truncate just one step deeper down
-    # this rabbit hole…
-    def load_rails_fixtures(test_instance)
-      ensure_after_load_save_point_is_active_if_data_is_loaded!
-      ensure_after_truncate_save_point_is_active_if_data_is_truncated!
-      ensure_after_load_rails_fixtures_save_point_is_active_if_fixtures_are_loaded!
-      reset_rails_fixture_caches(test_instance)
-      return rollback_to_after_load_rails_fixtures if save_point_active?(:after_load_rails_fixtures) && @already_loaded_rails_fixtures[test_instance.class].present?
-
-      if save_point_active?(:after_data_truncate)
-        rollback_to_after_data_truncate
-      else
-        truncate
-      end
-
-      execute_load_rails_fixtures(test_instance)
-      record_ar_internal_metadata_that_rails_fixtures_are_loaded
-      create_save_point(:after_load_rails_fixtures)
-    end
-
-    private
-
-    def ensure_after_load_save_point_is_active_if_data_is_loaded!
-      if !save_point_active?(:after_data_load) && ar_internal_metadata_shows_test_data_is_loaded?
-        TestData.log.debug "Test data appears to be loaded, but the :after_data_load save point was rolled back (and not by this gem). Recreating the :after_data_load save point"
-        create_save_point(:after_data_load)
-      end
-    end
-
-    def record_ar_internal_metadata_that_test_data_is_loaded
-      if ar_internal_metadata_shows_test_data_is_loaded?
-        TestData.log.warn "Attempted to record that test data is loaded in ar_internal_metadata, but record already existed. Perhaps a previous test run committed your test data?"
-      else
-        ActiveRecord::InternalMetadata.create!(key: "test_data:loaded", value: "true")
-      end
-    end
-
-    def ar_internal_metadata_shows_test_data_is_loaded?
-      ActiveRecord::InternalMetadata.find_by(key: "test_data:loaded")&.value == "true"
-    end
-
-    def ensure_after_truncate_save_point_is_active_if_data_is_truncated!
-      if !save_point_active?(:after_data_truncate) && ar_internal_metadata_shows_test_data_is_truncated?
-        TestData.log.debug "Test data appears to be loaded, but the :after_data_truncate save point was rolled back (and not by this gem). Recreating the :after_data_truncate save point"
-        create_save_point(:after_data_truncate)
-      end
-    end
-
-    def record_ar_internal_metadata_that_test_data_is_truncated
-      if ar_internal_metadata_shows_test_data_is_truncated?
-        TestData.log.warn "Attempted to record that test data is truncated in ar_internal_metadata, but record already existed. Perhaps a previous test run committed the truncation of your test data?"
-      else
-        ActiveRecord::InternalMetadata.create!(key: "test_data:truncated", value: "true")
-      end
-    end
-
-    def ar_internal_metadata_shows_test_data_is_truncated?
-      ActiveRecord::InternalMetadata.find_by(key: "test_data:truncated")&.value == "true"
-    end
-
-    def ensure_after_load_rails_fixtures_save_point_is_active_if_fixtures_are_loaded!
-      if !save_point_active?(:after_load_rails_fixtures) && ar_internal_metadata_shows_rails_fixtures_are_loaded?
-        TestData.log.debug "Rails Fixtures appears to have been loaded by test_data, but the :after_load_rails_fixtures save point was rolled back (and not by this gem). Recreating the :after_load_rails_fixtures save point"
-        create_save_point(:after_load_rails_fixtures)
-      end
-    end
-
-    def record_ar_internal_metadata_that_rails_fixtures_are_loaded
-      if ar_internal_metadata_shows_rails_fixtures_are_loaded?
-        TestData.log.warn "Attempted to record that test_data had loaded your Rails fixtures in ar_internal_metadata, but record already existed. Perhaps a previous test run committed the loading of your Rails fixtures?"
-      else
-        ActiveRecord::InternalMetadata.create!(key: "test_data:rails_fixtures_loaded", value: "true")
-      end
-    end
-
-    def ar_internal_metadata_shows_rails_fixtures_are_loaded?
-      ActiveRecord::InternalMetadata.find_by(key: "test_data:rails_fixtures_loaded")&.value == "true"
-    end
-
-    def reset_rails_fixture_caches(test_instance)
-      ActiveRecord::FixtureSet.reset_cache
-      test_instance.instance_variable_set(:@loaded_fixtures, @already_loaded_rails_fixtures[test_instance.class])
-      test_instance.instance_variable_set(:@fixture_cache, {})
-    end
-
-    def save_point_active?(name)
-      purge_closed_save_points!
-      !!@save_points.find { |sp| sp.name == name }&.active?
-    end
-
-    def create_save_point(name)
-      raise Error.new("Could not create test_data savepoint '#{name}', because it was already active!") if save_point_active?(name)
-      @save_points << SavePoint.new(name)
-    end
-
-    def rollback_save_point(name)
-      @save_points.find { |sp| sp.name == name }&.rollback!
-      purge_closed_save_points!
-    end
-
-    def purge_closed_save_points!
-      @save_points = @save_points.select { |save_point|
-        save_point.active?
-      }
-    end
-  end
-end