test_data 0.0.1 → 0.0.2

data/lib/test_data/rake.rb

@@ -24,9 +24,9 @@ desc "Verifies test_data environment looks good"
 task "test_data:verify_config" do
   config = TestData::VerifiesConfiguration.new.call
   unless config.looks_good?
-    puts "The test_data gem is not configured correctly. Try 'rake test_data:install'?\n"
+    TestData.log.warn "The test_data gem is not configured correctly. Try 'rake test_data:configure'?\n"
     config.problems.each do |problem|
-      puts "  - #{problem}"
+      TestData.log.warn "  - #{problem}"
     end
     fail
   end
@@ -54,11 +54,13 @@ desc "Initialize test_data Rails environment & configure database"
 task "test_data:install" => ["test_data:configure", "test_data:initialize"]
 
 desc "Dumps the interactive test_data database"
-task "test_data:dump" => "test_data:verify_config" do
+task "test_data:dump" => ["test_data:verify_config", :environment] do
+  next run_in_test_data_env("test_data:dump") if wrong_env?
+
   TestData::DumpsDatabase.new.call
 end
 
-desc "Dumps the interactive test_data database"
+desc "Loads the schema and data SQL dumps into the test_data database"
 task "test_data:load" => ["test_data:verify_config", :environment] do
   next run_in_test_data_env("test_data:load") if wrong_env?
 
@@ -71,7 +73,7 @@ task "test_data:load" => ["test_data:verify_config", :environment] do
   TestData::LoadsDatabaseDumps.new.call
 
   if ActiveRecord::Base.connection.migration_context.needs_migration?
-    warn "Warning: There are pending migrations for database '#{TestData.config.database_name}'. To run them, run:\n\n  RAILS_ENV=test_data bin/rake db:migrate\n\n"
+    TestData.log.warn "There are pending migrations for database '#{TestData.config.database_name}'. To run them, run:\n\n  RAILS_ENV=test_data bin/rake db:migrate\n\n"
   end
 end
 

data/lib/test_data/save_point.rb

@@ -0,0 +1,34 @@
+module TestData
+  class SavePoint
+    attr_reader :name, :transaction
+
+    def initialize(name)
+      @name = name
+      @transaction = connection.begin_transaction(joinable: false, _lazy: false)
+    end
+
+    def active?
+      !@transaction.state.finalized?
+    end
+
+    def rollback!
+      warn_if_not_rollbackable!
+      while active?
+        connection.rollback_transaction
+      end
+    end
+
+    private
+
+    def connection
+      ActiveRecord::Base.connection
+    end
+
+    def warn_if_not_rollbackable!
+      return if active?
+      TestData.log.warn(
+        "Attempted to roll back transaction save point '#{name}', but its state was #{@transaction.state}"
+      )
+    end
+  end
+end

data/lib/test_data/statistics.rb

@@ -0,0 +1,26 @@
+module TestData
+  def self.statistics
+    @statistics ||= Statistics.new
+  end
+
+  class Statistics
+    attr_reader :load_count, :truncate_count
+
+    def initialize
+      reset
+    end
+
+    def count_load!
+      @load_count += 1
+    end
+
+    def count_truncate!
+      @truncate_count += 1
+    end
+
+    def reset
+      @load_count = 0
+      @truncate_count = 0
+    end
+  end
+end

data/lib/test_data/transactional_data_loader.rb

@@ -1,77 +1,190 @@
-require "fileutils"
-
 module TestData
-  def self.load_data_dump
+  def self.load(transactions: true)
     @transactional_data_loader ||= TransactionalDataLoader.new
-    @transactional_data_loader.load_data_dump
+    @transactional_data_loader.load(transactions: transactions)
   end
 
-  def self.rollback(to: :after_data_load)
-    raise Error.new("rollback called before load_data_dump") unless @transactional_data_loader.present?
-    @transactional_data_loader.rollback(to: to)
+  def self.rollback(save_point_name = :after_data_load)
+    @transactional_data_loader ||= TransactionalDataLoader.new
+    case save_point_name
+    when :before_data_load
+      @transactional_data_loader.rollback_to_before_data_load
+    when :after_data_load
+      @transactional_data_loader.rollback_to_after_data_load
+    when :after_data_truncate
+      @transactional_data_loader.rollback_to_after_data_truncate
+    else
+      raise Error.new("No known save point named '#{save_point_name}'. Valid values are: [:before_data_load, :after_data_load, :after_data_truncate]")
+    end
   end
 
-  class TransactionalDataLoader
-    SavePoint = Struct.new(:name, :transaction, keyword_init: true)
+  def self.truncate(transactions: true)
+    @transactional_data_loader ||= TransactionalDataLoader.new
+    @transactional_data_loader.truncate(transactions: transactions)
+  end
 
+  class TransactionalDataLoader
     def initialize
       @config = TestData.config
+      @statistics = TestData.statistics
       @save_points = []
-      @dump_count = 0
     end
 
-    def load_data_dump
-      create_save_point(:before_data_load) unless save_point?(:before_data_load)
-      unless save_point?(:after_data_load)
-        execute_data_dump
-        @dump_count += 1
+    def load(transactions: true)
+      return execute_data_load unless transactions
+      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:)
-      return unless save_point?(to)
-      rollback_save_point(to)
+    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 truncate(transactions: true)
+      return execute_data_truncate unless transactions
+      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 documents transaction save point ordering")
+        load(transactions: true)
+      end
+
+      execute_data_truncate
+      record_ar_internal_metadata_that_test_data_is_truncated
+      create_save_point(:after_data_truncate)
     end
 
     private
 
-    def execute_data_dump
+    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 execute_data_load
       search_path = execute("show search_path").first["search_path"]
-      execute(File.read(@config.data_dump_full_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(", ")}")
+      end
+      @statistics.count_truncate!
     end
 
-    def save_point?(name)
+    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 save_point_active?(name)
       purge_closed_save_points!
-      @save_points.any? { |sp| sp.name == name }
+      !!@save_points.find { |sp| sp.name == name }&.active?
     end
 
     def create_save_point(name)
-      save_point = SavePoint.new(
-        name: name,
-        transaction: ActiveRecord::Base.connection.begin_transaction(joinable: false, _lazy: false)
-      )
-      @save_points << save_point
+      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)
-      if (save_point = @save_points.find { |sp| sp.name == name }) && save_point.transaction.open?
-        save_point.transaction.rollback
-      end
+      @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.transaction.open?
+        save_point.active?
       }
     end
 
     def execute(sql)
-      ActiveRecord::Base.connection.execute(sql)
+      connection.execute(sql)
+    end
+
+    def connection
+      ActiveRecord::Base.connection
     end
   end
 end

data/lib/test_data/verifies_dumps_are_loadable.rb

@@ -8,22 +8,22 @@ module TestData
     def call(quiet: false)
       schema_dump_looks_good = Pathname.new(@config.schema_dump_full_path).readable?
       if !quiet && !schema_dump_looks_good
-        warn "Warning: Database schema dump '#{@config.schema_dump_path}' not readable"
+        log.warn "Warning: Database schema dump '#{@config.schema_dump_path}' not readable"
       end
 
       data_dump_looks_good = Pathname.new(@config.data_dump_full_path).readable?
       if !quiet && !data_dump_looks_good
-        warn "Warning: Database data dump '#{@config.data_dump_path}' not readable"
+        log.warn "Warning: Database data dump '#{@config.data_dump_path}' not readable"
       end
 
       non_test_data_dump_looks_good = Pathname.new(@config.non_test_data_dump_full_path).readable?
       if !quiet && !non_test_data_dump_looks_good
-        warn "Warning: Database non-test data dump '#{@config.non_test_data_dump_path}' not readable"
+        log.warn "Warning: Database non-test data dump '#{@config.non_test_data_dump_path}' not readable"
       end
 
       database_empty = @detects_database_emptiness.empty?
       unless quiet || database_empty
-        warn "Warning: Database '#{@config.database_name}' is not empty"
+        log.warn "Warning: Database '#{@config.database_name}' is not empty"
       end
 
       [

data/lib/test_data/version.rb

@@ -1,3 +1,3 @@
 module TestData
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/script/reset_example_app

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+
+PS4='[script/test:${LINENO}] $ '
+set -euo pipefail
+set -x
+
+cd example
+
+# Reset database:
+bin/rake db:drop
+dropdb example_test_data 2>/dev/null || true
+
+# Reset files:
+git checkout app/models/boop.rb
+git checkout config/database.yml
+git checkout db/schema.rb
+git clean -xdf .

data/script/test

@@ -1,25 +1,30 @@
 #!/usr/bin/env bash
 
 PS4='[script/test:${LINENO}] $ '
-set -e
+set -euo pipefail
 set -x
 
-# Make sure the main project installs & passes its own rake
+# Install deps and make sure gem passes its own rake
 bundle
 bundle exec rake
-
-# Exercise the example app
 cd example
 bundle
 
 # Avoid test pollution by clearing out any initial state that might be lingering
-rm -rf test/support/test_data
-bin/rake db:reset
+cd ..
+./script/reset_example_app
+
+# Exercise the example app
+cd example
+bin/rake db:setup
 
 # Test basic initial usage
 bin/rake test_data:install
 bin/rake test_data:dump
 bin/rails test test/integration/basic_boops_test.rb
+bundle exec rspec spec/requests/boops_spec.rb
+bin/rails test test/integration/mode_switching_demo_test.rb
+bin/rails test test/integration/better_mode_switching_demo_test.rb
 bin/rails test test/integration/parallel_boops_with_fixtures_test.rb
 bin/rails test test/integration/parallel_boops_without_fixtures_test.rb
 
@@ -38,12 +43,48 @@ RAILS_ENV=test_data bin/rake db:migrate
 bin/rake test_data:dump
 bin/rails test test/integration/migrated_boops_test.rb
 
-# Cleanup
+# Run a test that commits test data thru to the database
+bin/rails test test/integration/transaction_committing_boops_test.rb
+
+# Add a second migration, this time without wiping the test_data db and with a table we want to ignore
+cp ../test/fixtures/20210423114916_add_table_we_want_to_ignore.rb db/migrate
+cp ../test/fixtures/chatty_audit_log.rb app/models
+bin/rake db:migrate
+RAILS_ENV=test_data bin/rake db:migrate
+RAILS_ENV=test_data rails runner "50.times { ChattyAuditLog.create!(message: 'none of this matters') }"
+# Gsub config file and uncomment + add table to excluded table list
+ruby -e '
+  path = "config/initializers/test_data.rb"
+  IO.write(path, File.open(path) { |f|
+    f.read.gsub("# config.dont_dump_these_tables = []", "config.dont_dump_these_tables = [\"chatty_audit_logs\"]")
+  })
+'
+bin/rake test_data:dump
+if grep -q "INSERT INTO public.chatty_audit_logs" "test/support/test_data/data.sql"; then
+  echo "Dump contained excluded table 'chatty_audit_logs'"
+  exit 1
+fi
+bin/rake db:test:prepare
+bin/rails test test/integration/dont_dump_tables_test.rb
+bin/rails test test/integration/load_rollback_truncate_test.rb
 
-# Delete the test_data database
+# Test circular FK constraints
+cp ../test/fixtures/20210423190737_add_foreign_keys.rb db/migrate/
+cp ../test/fixtures/boop_with_other_boops.rb app/models/boop.rb
+RAILS_ENV=test_data bin/rake db:migrate
+bin/rake test_data:dump
+bin/rake db:migrate
+bin/rake db:test:prepare
+bin/rails test test/integration/boops_that_boop_boops_test.rb
+
+# Make sure it loads cleanly again
 bin/rake test_data:drop_database
-# Unset file changes
-git checkout config/database.yml
-git checkout db/schema.rb
-# Delete all untracked files (e.g. dumps, env config)
-git clean -xdf .
+if [ ! bin/rake test_data:load | grep -q "ERROR" ]; then
+  echo "Running test_data:load after adding FK constraints led to errors"
+  exit 1
+fi
+bin/rails test test/integration/boops_that_boop_boops_test.rb
+
+# Cleanup
+cd ..
+./script/reset_example_app