test_data 0.0.2 → 0.2.2

data/example/test/integration/transaction_committing_boops_test.rb

@@ -3,18 +3,20 @@ require "test_helper"
 class TransactionCommittingTestCase < ActiveSupport::TestCase
   self.use_transactional_tests = false
 
-  def setup
+  setup do
     Noncommittal.stop!
-    TestData.load(transactions: false)
+    TestData.insert_test_data_dump
   end
 
-  def teardown
+  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

data/example/test/test_helper.rb

@@ -8,11 +8,7 @@ class SerializedNonTransactionalTestCase < ActiveSupport::TestCase
   parallelize(workers: 1)
   self.use_transactional_tests = false
 
-  def setup
-    TestData.load
-  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?
         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,12 +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"
 
         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

@@ -1,4 +1,5 @@
 require "rails/generators"
+require_relative "../../test_data/generator_support"
 
 module TestData
   class InitializerGenerator < Rails::Generators::Base
@@ -7,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)
@@ -23,7 +27,16 @@ module TestData
           # Tables whose data should be excluded from SQL dumps (still dumps their schema DDL)
           # config.dont_dump_these_tables = []
 
-          # Tables whose data should be truncated by TestData.truncate
+          # 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

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,9 +1,9 @@
 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?
@@ -12,12 +12,13 @@ module TestData
         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

data/lib/test_data.rb

@@ -1,25 +1,61 @@
+require_relative "test_data/active_record_ext"
 require_relative "test_data/active_support_ext"
 require_relative "test_data/config"
 require_relative "test_data/configuration_verification"
 require_relative "test_data/configurators"
 require_relative "test_data/configurators/environment_file"
 require_relative "test_data/configurators/initializer"
+require_relative "test_data/configurators/cable_yaml"
 require_relative "test_data/configurators/database_yaml"
+require_relative "test_data/configurators/secrets_yaml"
 require_relative "test_data/configurators/webpacker_yaml"
+require_relative "test_data/custom_loaders/abstract_base"
+require_relative "test_data/custom_loaders/rails_fixtures"
 require_relative "test_data/detects_database_emptiness"
 require_relative "test_data/dumps_database"
 require_relative "test_data/error"
+require_relative "test_data/inserts_test_data"
 require_relative "test_data/installs_configuration"
 require_relative "test_data/loads_database_dumps"
 require_relative "test_data/log"
 require_relative "test_data/railtie"
 require_relative "test_data/save_point"
 require_relative "test_data/statistics"
-require_relative "test_data/transactional_data_loader"
+require_relative "test_data/manager"
+require_relative "test_data/truncates_test_data"
 require_relative "test_data/verifies_configuration"
 require_relative "test_data/verifies_dumps_are_loadable"
 require_relative "test_data/version"
 require_relative "generators/test_data/environment_file_generator"
 require_relative "generators/test_data/initializer_generator"
+require_relative "generators/test_data/cable_yaml_generator"
 require_relative "generators/test_data/database_yaml_generator"
+require_relative "generators/test_data/secrets_yaml_generator"
 require_relative "generators/test_data/webpacker_yaml_generator"
+
+module TestData
+  def self.uninitialize
+    @manager ||= Manager.new
+    @manager.rollback_to_before_data_load
+  end
+
+  def self.uses_test_data
+    @manager ||= Manager.new
+    @manager.load
+  end
+
+  def self.uses_clean_slate
+    @manager ||= Manager.new
+    @manager.truncate
+  end
+
+  def self.uses_rails_fixtures(test_instance)
+    @rails_fixtures_loader ||= CustomLoaders::RailsFixtures.new
+    @manager ||= Manager.new
+    @manager.load_custom_data(@rails_fixtures_loader, test_instance: test_instance)
+  end
+
+  def self.insert_test_data_dump
+    InsertsTestData.new.call
+  end
+end

data/lib/test_data/active_record_ext.rb

@@ -0,0 +1,11 @@
+module TestData
+  def self.prevent_rails_fixtures_from_loading_automatically!
+    ActiveRecord::TestFixtures.define_method(:__test_data_gem_setup_fixtures,
+      ActiveRecord::TestFixtures.instance_method(:setup_fixtures))
+    ActiveRecord::TestFixtures.remove_method(:setup_fixtures)
+    ActiveRecord::TestFixtures.define_method(:setup_fixtures, ->(config = nil) {})
+
+    ActiveRecord::TestFixtures.remove_method(:teardown_fixtures)
+    ActiveRecord::TestFixtures.define_method(:teardown_fixtures, -> {})
+  end
+end

data/lib/test_data/config.rb

@@ -29,7 +29,7 @@ module TestData
     # Tables to exclude from all dumps
     attr_accessor :dont_dump_these_tables
 
-    # Tables to truncate when TestData.truncate is called
+    # Tables to truncate when TestData.uses_clean_slate is called
     attr_accessor :truncate_these_test_data_tables
 
     # Log level (valid values: [:debug, :info, :warn, :error, :quiet])
@@ -41,7 +41,8 @@ module TestData
       TestData.log.level = level
     end
 
-    attr_reader :pwd, :database_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|
@@ -51,17 +52,46 @@ module TestData
       end
     end
 
-    full_path_reader :schema_dump_path, :data_dump_path, :non_test_data_dump_path, :database_yaml_path
+    full_path_reader :schema_dump_path, :data_dump_path, :non_test_data_dump_path, :cable_yaml_path, :database_yaml_path, :secrets_yaml_path
 
     def initialize(pwd:)
       @pwd = pwd
       @schema_dump_path = "test/support/test_data/schema.sql"
       @data_dump_path = "test/support/test_data/data.sql"
       @non_test_data_dump_path = "test/support/test_data/non_test_data.sql"
+      @cable_yaml_path = "config/cable.yml"
       @database_yaml_path = "config/database.yml"
+      @secrets_yaml_path = "config/secrets.yml"
       @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/configurators.rb

@@ -4,7 +4,9 @@ module TestData
       [
         EnvironmentFile,
         Initializer,
+        CableYaml,
         DatabaseYaml,
+        SecretsYaml,
         WebpackerYaml
       ].map(&:new)
     end

data/lib/test_data/configurators/cable_yaml.rb

@@ -0,0 +1,25 @@
+module TestData
+  module Configurators
+    class CableYaml
+      def initialize
+        @generator = CableYamlGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        if !File.exist?(@config.cable_yaml_full_path) ||
+            YAML.load_file(@config.cable_yaml_full_path).key?("test_data")
+          ConfigurationVerification.new(looks_good?: true)
+        else
+          ConfigurationVerification.new(problems: [
+            "'#{@config.cable_yaml_path}' exists but does not contain a 'test_data' section"
+          ])
+        end
+      end
+
+      def configure
+        @generator.call
+      end
+    end
+  end
+end

data/lib/test_data/configurators/environment_file.rb

@@ -7,12 +7,13 @@ module TestData
       end
 
       def verify
-        pathname = Pathname.new("#{@config.pwd}/config/environments/test_data.rb")
+        path = "config/environments/test_data.rb"
+        pathname = Pathname.new("#{@config.pwd}/#{path}")
         if pathname.readable?
           ConfigurationVerification.new(looks_good?: true)
         else
           ConfigurationVerification.new(problems: [
-            "'#{pathname}' is not readable"
+            "'#{path}' is not readable"
           ])
         end
       end

data/lib/test_data/configurators/initializer.rb

@@ -7,12 +7,13 @@ module TestData
       end
 
       def verify
-        pathname = Pathname.new("#{@config.pwd}/config/initializers/test_data.rb")
+        path = "config/initializers/test_data.rb"
+        pathname = Pathname.new("#{@config.pwd}/#{path}")
         if pathname.readable?
           ConfigurationVerification.new(looks_good?: true)
         else
           ConfigurationVerification.new(problems: [
-            "'#{pathname}' is not readable"
+            "'#{path}' is not readable"
           ])
         end
       end

data/lib/test_data/configurators/secrets_yaml.rb

@@ -0,0 +1,25 @@
+module TestData
+  module Configurators
+    class SecretsYaml
+      def initialize
+        @generator = SecretsYamlGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        if !File.exist?(@config.secrets_yaml_full_path) ||
+            YAML.load_file(@config.secrets_yaml_full_path).key?("test_data")
+          ConfigurationVerification.new(looks_good?: true)
+        else
+          ConfigurationVerification.new(problems: [
+            "'#{@config.secrets_yaml_path}' exists but does not contain a 'test_data' section"
+          ])
+        end
+      end
+
+      def configure
+        @generator.call
+      end
+    end
+  end
+end

data/lib/test_data/configurators/webpacker_yaml.rb

@@ -7,16 +7,17 @@ module TestData
       end
 
       def verify
-        pathname = Pathname.new("#{@config.pwd}/config/webpacker.yml")
+        path = "config/webpacker.yml"
+        pathname = Pathname.new("#{@config.pwd}/#{path}")
         return ConfigurationVerification.new(looks_good?: true) unless pathname.readable?
         yaml = load_yaml(pathname)
         if yaml.nil?
           ConfigurationVerification.new(problems: [
-            "'#{pathname}' is not valid YAML"
+            "'#{path}' is not valid YAML"
           ])
         elsif !yaml.key?("test_data")
           ConfigurationVerification.new(problems: [
-            "'#{pathname}' does not contain a 'test_data' section"
+            "'#{path}' does not contain a 'test_data' section"
           ])
         else
           ConfigurationVerification.new(looks_good?: true)