test_data 0.0.1 → 0.2.1

data/example/test/integration/rails_fixtures_override_test.rb

@@ -0,0 +1,110 @@
+require "test_helper"
+
+TestData.prevent_rails_fixtures_from_loading_automatically!
+
+class FixtureFreeTestData < ActiveSupport::TestCase
+  fixtures :boops # why not
+
+  setup do
+    TestData.uses_test_data
+  end
+
+  def test_has_no_fixture_boops
+    assert_equal 15, Boop.count
+  end
+end
+
+class FixturesUsingTest < ActiveSupport::TestCase
+  fixtures :boops
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_fixture_boops
+    assert boops(:boop_1).persisted?
+    assert_equal 2, Boop.count
+  end
+
+  def test_does_not_get_the_other_fixture_accessor
+    assert_raises(NameError) { method(:pants) }
+  end
+
+  def test_even_explicitly_loading_test_data_will_truncate_and_then_load_fixtures
+    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_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.to_date, a_year_ago
+
+    # Now trigger a rollback to the fixtures point
+    TestData.uses_rails_fixtures(self)
+
+    assert_equal Boop.find(boop.id).created_at.to_date, original_created_on
+  end
+end
+
+class SomeFixturesAndSomeTestDataInOneClassTest < ActiveSupport::TestCase
+  i_suck_and_my_tests_are_order_dependent!
+  fixtures :all
+
+  def test_fixtures_work
+    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
+  end
+
+  def test_that_rewinds_to_test_data
+    TestData.uses_test_data
+
+    assert_equal 15, Boop.count
+  end
+
+  def test_that_rewinds_to_the_very_start
+    TestData.uninitialize
+
+    assert_equal 0, Boop.count
+  end
+
+  def test_fixtures_get_reloaded_because_cache_is_cleared
+    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
+  end
+end
+
+class PantsFixturesTest < ActiveSupport::TestCase
+  fixtures :pants
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_fixture_pants
+    assert_equal 2, Pant.count
+  end
+
+  def test_does_not_get_the_other_fixture_accessor
+    assert_raises(NameError) { method(:boops) }
+  end
+end
+
+class FixtureTestPassingTheWrongThingTest < ActiveSupport::TestCase
+  def test_doing_it_wrong
+    error = assert_raises(TestData::Error) do
+      TestData.uses_rails_fixtures(ActiveRecord::Base)
+    end
+    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

@@ -0,0 +1,27 @@
+require "test_helper"
+
+class TransactionCommittingTestCase < ActiveSupport::TestCase
+  self.use_transactional_tests = false
+
+  setup do
+    Noncommittal.stop!
+    TestData.insert_test_data_dump
+  end
+
+  teardown do
+    Boop.delete_all
+    Noncommittal.start!
+  end
+end
+
+class TransactionCommittingBoopsTest < TransactionCommittingTestCase
+  i_suck_and_my_tests_are_order_dependent!
+
+  def test_finds_the_boops
+    assert_equal 15, Boop.count
+  end
+
+  def test_finds_the_boops_via_another_process
+    assert_equal 15, `RAILS_ENV=test bin/rails runner "puts Boop.count"`.chomp.to_i
+  end
+end

data/example/test/test_helper.rb

@@ -2,40 +2,13 @@ ENV["RAILS_ENV"] ||= "test"
 require_relative "../config/environment"
 require "rails/test_help"
 
+Noncommittal.start!
+
 class SerializedNonTransactionalTestCase < ActiveSupport::TestCase
   parallelize(workers: 1)
   self.use_transactional_tests = false
 
-  def setup
-    TestData.load_data_dump
-  end
-
-  def teardown
-    TestData.rollback
-  end
-end
-
-class ParallelizedTransactionalFixturefullTestCase < ActiveSupport::TestCase
-  parallelize(workers: :number_of_processors)
-  self.use_transactional_tests = true
-  fixtures :all
-
-  def setup
-    TestData.load_data_dump
-  end
-
-  # use_transactional_tests will cause a single rollback on teardown
-end
-
-class ParallelizedNonTransactionalFixturelessTestCase < ActiveSupport::TestCase
-  parallelize(workers: :number_of_processors)
-  self.use_transactional_tests = false
-
-  def setup
-    TestData.load_data_dump
-  end
-
-  def teardown
-    TestData.rollback
+  setup do
+    TestData.uses_test_data
   end
 end

data/lib/generators/test_data/cable_yaml_generator.rb

@@ -0,0 +1,18 @@
+require "rails/generators"
+require_relative "../../test_data/generator_support"
+
+module TestData
+  class CableYamlGenerator < Rails::Generators::Base
+    def call
+      unless Configurators::CableYaml.new.verify.looks_good?
+        inject_into_file "config/cable.yml", before: BEFORE_TEST_STANZA_REGEX do
+          <<~YAML
+
+            test_data:
+              adapter: async
+          YAML
+        end
+      end
+    end
+  end
+end

data/lib/generators/test_data/database_yaml_generator.rb

@@ -1,15 +1,14 @@
 require "rails/generators"
+require_relative "../../test_data/generator_support"
 
 module TestData
   class DatabaseYamlGenerator < Rails::Generators::Base
-    BEFORE_TEST_DATABASE_STANZA_REGEX = /^$\n(?:^\#.*\n)*^test:/
-
     def call
       if Configurators::DatabaseYaml.new.verify.looks_good?
-        warn "'test_data' section already defined in config/database.yml"
+        TestData.log.info "'test_data' section already defined in config/database.yml"
       else
         app_name = Rails.application.railtie_name.chomp("_application")
-        inject_into_file "config/database.yml", before: BEFORE_TEST_DATABASE_STANZA_REGEX do
+        inject_into_file "config/database.yml", before: BEFORE_TEST_STANZA_REGEX do
           <<~YAML
 
             # Used in conjunction with the test_data gem

data/lib/generators/test_data/environment_file_generator.rb

@@ -1,26 +1,19 @@
 require "rails/generators"
+require_relative "../../test_data/generator_support"
 
 module TestData
   class EnvironmentFileGenerator < Rails::Generators::Base
     def call
       create_file "config/environments/test_data.rb", <<~RUBY
+        # Load the development environment as a starting point
         require_relative "development"
 
-        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"
-
-          # 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 shouldn't be loaded into tests
-          # config.non_test_data_tables = ["ar_internal_metadata", "schema_migrations"]
-        end
-
         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
       RUBY

data/lib/generators/test_data/initializer_generator.rb

@@ -0,0 +1,51 @@
+require "rails/generators"
+require_relative "../../test_data/generator_support"
+
+module TestData
+  class InitializerGenerator < Rails::Generators::Base
+    def call
+      create_file "config/initializers/test_data.rb", <<~RUBY
+        return unless defined?(TestData)
+
+        TestData.config do |config|
+          # Hook run after test data is loaded by `TestData.uses_test_data`,
+          #   but before a savepoint is taken
+          # config.after_test_data_load { }
+
+          # Hook run after test data is truncated by `TestData.uses_clean_slate`,
+          #   but before a savepoint is taken
+          # config.after_test_data_truncate { }
+
+          # 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)
+          # config.non_test_data_tables = []
+
+          # 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
+          # config.truncate_these_test_data_tables = nil
+
+          # Log level (valid values: [:debug, :info, :warn, :error, :quiet])
+          #   Can also be set with env var TEST_DATA_LOG_LEVEL
+          # config.log_level = :info
+        end
+      RUBY
+    end
+  end
+end

data/lib/generators/test_data/secrets_yaml_generator.rb

@@ -0,0 +1,19 @@
+require "rails/generators"
+require_relative "../../test_data/generator_support"
+
+module TestData
+  class SecretsYamlGenerator < Rails::Generators::Base
+    def call
+      unless Configurators::SecretsYaml.new.verify.looks_good?
+        inject_into_file "config/secrets.yml", before: BEFORE_TEST_STANZA_REGEX do
+          <<~YAML
+
+            # Simplify configuration with the test_data environment
+            test_data:
+              secret_key_base: #{SecureRandom.hex(64)}
+          YAML
+        end
+      end
+    end
+  end
+end

data/lib/generators/test_data/webpacker_yaml_generator.rb

@@ -1,23 +1,24 @@
 require "rails/generators"
+require_relative "../../test_data/generator_support"
 
 module TestData
   class WebpackerYamlGenerator < Rails::Generators::Base
     AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX = /^development:/
-    BEFORE_TEST_WEBPACK_STANZA_REGEX = /^$\n(?:^\#.*\n)*^test:/
 
     def call
       if Configurators::WebpackerYaml.new.verify.looks_good?
-        warn "'test_data' section not needed in config/webpacker.yml"
+        TestData.log.debug "'test_data' section not needed in config/webpacker.yml"
       else
         inject_into_file "config/webpacker.yml", after: AFTER_DEVELOPMENT_WEBPACK_STANZA_REGEX do
           " &development"
         end
-        inject_into_file "config/webpacker.yml", before: BEFORE_TEST_WEBPACK_STANZA_REGEX do
+        inject_into_file "config/webpacker.yml", before: BEFORE_TEST_STANZA_REGEX do
           <<~YAML
 
             # Used in conjunction with the test_data gem
             test_data:
               <<: *development
+
           YAML
         end
       end