test_data 0.2.0 → 0.2.1

data/example/.gitignore

@@ -18,7 +18,4 @@
 # Ignore master key for decrypting credentials and more.
 /config/master.key
 
-# Ignore files that are intentionally generated / asserted by the tests
-/config/environments/test_data.rb
-/test/support/test_data
-/db/migrate/20210418220133_add_beep_to_boops.rb
+

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    test_data (0.2.0)
+    test_data (0.2.1)
       railties (~> 6.0)
 
 GEM

data/example/config/application.rb

@@ -24,6 +24,9 @@ module Example
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 6.1
 
+    # Uncomment this to switch from schema.rb to structure.sql
+    # config.active_record.schema_format = :sql
+
     # Configuration for the application, engines, and railties goes here.
     #
     # These settings can be overridden in specific environments using the files

data/example/spec/requests/rails_fixtures_override_spec.rb

@@ -2,18 +2,40 @@ require "rails_helper"
 
 TestData.prevent_rails_fixtures_from_loading_automatically!
 
+module TestDataModes
+  def uses(mode)
+    case mode
+    when :clean_slate
+      before(:each) { TestData.uses_clean_slate }
+    when :test_data
+      before(:each) { TestData.uses_test_data }
+    else
+      raise "Invalid test data mode: #{mode}"
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend(TestDataModes)
+end
+
 RSpec.describe "FixtureFreeTestData", type: :request do
   fixtures :boops
 
-  before(:each) do
-    TestData.uses_test_data
-  end
-
+  uses :test_data
   it "has 15 boops in the test_data" do
     expect(Boop.count).to eq(15)
   end
 end
 
+RSpec.describe "Clean Slate" do
+  uses :clean_slate
+
+  it "has no boops" do
+    expect(Boop.count).to eq(0)
+  end
+end
+
 RSpec.describe "FixturesUsingTest", type: :request do
   fixtures :boops
 

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/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,6 +27,15 @@ module TestData
           # Tables whose data should be excluded from SQL dumps (still dumps their schema DDL)
           # config.dont_dump_these_tables = []
 
+          # 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

data/lib/test_data/config.rb

@@ -41,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|
@@ -64,6 +65,33 @@ module TestData
       @non_test_data_tables = []
       @dont_dump_these_tables = []
       @truncate_these_test_data_tables = nil
+      @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

data/lib/test_data/custom_loaders/rails_fixtures.rb

@@ -2,6 +2,7 @@ module TestData
   module CustomLoaders
     class RailsFixtures < AbstractBase
       def initialize
+        @config = TestData.config
         @statistics = TestData.statistics
         @already_loaded_rails_fixtures = {}
       end
@@ -34,6 +35,7 @@ module TestData
         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!
+        @config.after_rails_fixture_load_hook.call
       end
     end
   end

data/lib/test_data/manager.rb

@@ -14,6 +14,7 @@ module TestData
 
       create_save_point(:before_data_load)
       @inserts_test_data.call
+      @config.after_test_data_load_hook.call
       record_ar_internal_metadata_that_test_data_is_loaded
       create_save_point(:after_data_load)
     end
@@ -41,6 +42,7 @@ module TestData
       end
 
       @truncates_test_data.call
+      @config.after_test_data_truncate_hook.call
       record_ar_internal_metadata_that_test_data_is_truncated
       create_save_point(:after_data_truncate)
     end

data/lib/test_data/rake.rb

@@ -52,8 +52,7 @@ task "test_data:initialize" => ["test_data:verify_config", :environment] do
   end
 
   TestData.log.info <<~MSG
-    Your test_data environment and database are ready for use! You can now run
-    your server (or any command) to create some test data like so:
+    Your test_data environment and database are ready for use! You can now run your server (or any command) to create some test data like so:
 
       $ RAILS_ENV=test_data bin/rails server
 
@@ -83,7 +82,7 @@ task "test_data:load" => ["test_data:verify_config", :environment] do
   TestData::LoadsDatabaseDumps.new.call
 
   if ActiveRecord::Base.connection.migration_context.needs_migration?
-    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"
+    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/version.rb

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

data/script/reset_example_app

@@ -12,6 +12,7 @@ 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

@@ -83,18 +83,30 @@ 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/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
-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/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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: test_data
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-07-24 00:00:00.000000000 Z
+date: 2021-07-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/ruby.yml"
 - ".gitignore"
+- ".standard.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -109,6 +110,7 @@ files:
 - 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