test_data 0.0.1 → 0.2.1

data/lib/test_data/truncates_test_data.rb

@@ -0,0 +1,31 @@
+module TestData
+  class TruncatesTestData
+    def initialize
+      @config = TestData.config
+      @statistics = TestData.statistics
+    end
+
+    def call
+      connection.disable_referential_integrity do
+        connection.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
+
+    private
+
+    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
+  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.2.1"
 end

data/script/reset_example_app

@@ -0,0 +1,18 @@
+#!/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/application.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
 
@@ -30,6 +35,9 @@ bin/rails test test/integration/updated_boops_test.rb
 
 # Test a migration being added and run and an out-of-date dump being loaded
 cp ../test/fixtures/20210418220133_add_beep_to_boops.rb db/migrate
+cp ../test/fixtures/20210624180810_create_pants.rb db/migrate
+cp ../test/fixtures/pant.rb app/models
+cp ../test/fixtures/pants.yml test/fixtures
 bin/rake db:migrate
 bin/rake db:test:prepare
 bin/rake test_data:drop_database
@@ -38,12 +46,69 @@ 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
 
-# Delete the test_data database
+# 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
+
+# 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
+
+# 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 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 .
+bin/rake test_data:load
+bin/rails test test/integration/boops_that_boop_boops_test.rb
+
+# Test all the after hooks!
+cp ../test/fixtures/20210729130542_add_materialized_meta_boop_view.rb db/migrate/
+cp ../test/fixtures/meta_boop.rb app/models/meta_boop.rb
+# Gsub config file to switch to structure.sql b/c materialized view
+ruby -e '
+  path = "config/application.rb"
+  IO.write(path, File.open(path) { |f|
+    f.read.gsub("# config.active_record.schema_format = :sql", "config.active_record.schema_format = :sql")
+  })
+'
+rm db/schema.rb
+bin/rake db:migrate db:test:prepare
+RAILS_ENV=test_data bin/rake db:migrate
+bin/rake test_data:dump
+bin/rails test test/integration/test_data_hooks_test.rb
+
+# Cleanup
+cd ..
+./script/reset_example_app
+
+echo "You win!"

data/test_data.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_data
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-04-19 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -31,7 +31,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -90,36 +92,66 @@ files:
 - example/public/apple-touch-icon.png
 - example/public/favicon.ico
 - 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
 - example/test/fixtures/boops.yml
 - example/test/integration/basic_boops_test.rb
+- example/test/integration/better_mode_switching_demo_test.rb
+- example/test/integration/boops_that_boop_boops_test.rb
+- example/test/integration/dont_dump_tables_test.rb
+- example/test/integration/load_rollback_truncate_test.rb
 - example/test/integration/migrated_boops_test.rb
+- example/test/integration/mode_switching_demo_test.rb
 - example/test/integration/parallel_boops_with_fixtures_test.rb
 - example/test/integration/parallel_boops_without_fixtures_test.rb
+- example/test/integration/rails_fixtures_double_load_test.rb
+- example/test/integration/rails_fixtures_override_test.rb
+- example/test/integration/test_data_hooks_test.rb
+- example/test/integration/transaction_committing_boops_test.rb
 - example/test/integration/updated_boops_test.rb
 - example/test/test_helper.rb
+- lib/generators/test_data/cable_yaml_generator.rb
 - lib/generators/test_data/database_yaml_generator.rb
 - lib/generators/test_data/environment_file_generator.rb
+- lib/generators/test_data/initializer_generator.rb
+- lib/generators/test_data/secrets_yaml_generator.rb
 - lib/generators/test_data/webpacker_yaml_generator.rb
 - lib/test_data.rb
+- lib/test_data/active_record_ext.rb
 - lib/test_data/active_support_ext.rb
 - lib/test_data/config.rb
 - lib/test_data/configuration_verification.rb
 - lib/test_data/configurators.rb
+- lib/test_data/configurators/cable_yaml.rb
 - lib/test_data/configurators/database_yaml.rb
 - lib/test_data/configurators/environment_file.rb
+- 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/transactional_data_loader.rb
+- lib/test_data/save_point.rb
+- lib/test_data/statistics.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
+- script/reset_example_app
 - script/test
 - test_data.gemspec
 homepage: https://github.com/testdouble/test_data
@@ -127,7 +159,7 @@ licenses: []
 metadata:
   homepage_uri: https://github.com/testdouble/test_data
   source_code_uri: https://github.com/testdouble/test_data
-  changelog_uri: https://github.com/testdouble/test_data/blob/master/CHANGELOG.md
+  changelog_uri: https://github.com/testdouble/test_data/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:

data/lib/test_data/transactional_data_loader.rb

@@ -1,77 +0,0 @@
-require "fileutils"
-
-module TestData
-  def self.load_data_dump
-    @transactional_data_loader ||= TransactionalDataLoader.new
-    @transactional_data_loader.load_data_dump
-  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)
-  end
-
-  class TransactionalDataLoader
-    SavePoint = Struct.new(:name, :transaction, keyword_init: true)
-
-    def initialize
-      @config = TestData.config
-      @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
-        create_save_point(:after_data_load)
-      end
-    end
-
-    def rollback(to:)
-      return unless save_point?(to)
-      rollback_save_point(to)
-    end
-
-    private
-
-    def execute_data_dump
-      search_path = execute("show search_path").first["search_path"]
-      execute(File.read(@config.data_dump_full_path))
-      execute <<~SQL
-        select pg_catalog.set_config('search_path', '#{search_path}', false)
-      SQL
-    end
-
-    def save_point?(name)
-      purge_closed_save_points!
-      @save_points.any? { |sp| sp.name == name }
-    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
-    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
-      purge_closed_save_points!
-    end
-
-    def purge_closed_save_points!
-      @save_points = @save_points.select { |save_point|
-        save_point.transaction.open?
-      }
-    end
-
-    def execute(sql)
-      ActiveRecord::Base.connection.execute(sql)
-    end
-  end
-end