test_data 0.0.1 → 0.0.2

data/example/test/integration/mode_switching_demo_test.rb

@@ -0,0 +1,48 @@
+require "test_helper"
+
+class ModeSwitchingTestCase < ActiveSupport::TestCase
+  def self.test_data_mode(mode)
+    if mode == :factory_bot
+      require "factory_bot_rails"
+      include FactoryBot::Syntax::Methods
+
+      setup do
+        TestData.rollback(:before_data_load)
+        ActiveRecord::Base.connection.begin_transaction(joinable: false, _lazy: false)
+      end
+
+      teardown do
+        ActiveRecord::Base.connection.rollback_transaction
+      end
+
+    elsif mode == :test_data
+      self.use_transactional_tests = false
+
+      setup do
+        TestData.load
+      end
+
+      teardown do
+        TestData.rollback
+      end
+    end
+  end
+end
+
+class FactoryModeTest < ModeSwitchingTestCase
+  test_data_mode :factory_bot
+
+  def test_boops
+    create(:boop)
+
+    assert_equal 1, Boop.count
+  end
+end
+
+class TestDataModeTest < ModeSwitchingTestCase
+  test_data_mode :test_data
+
+  def test_boops
+    assert_equal 10, Boop.count
+  end
+end

data/example/test/integration/parallel_boops_with_fixtures_test.rb

@@ -1,5 +1,19 @@
 require "test_helper"
 
+class ParallelizedTransactionalFixturefullTestCase < ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+  self.use_transactional_tests = true
+  fixtures :all
+
+  def setup
+    TestData.load
+  end
+
+  def teardown
+    TestData.rollback
+  end
+end
+
 class ParallelBoopsWithFixturesTest < ParallelizedTransactionalFixturefullTestCase
   100.times do |i|
     test "that boops don't change ##{i}" do

data/example/test/integration/parallel_boops_without_fixtures_test.rb

@@ -1,5 +1,18 @@
 require "test_helper"
 
+class ParallelizedNonTransactionalFixturelessTestCase < ActiveSupport::TestCase
+  parallelize(workers: :number_of_processors)
+  self.use_transactional_tests = false
+
+  def setup
+    TestData.load
+  end
+
+  def teardown
+    TestData.rollback
+  end
+end
+
 class ParallelBoopsWithoutFixturesTest < ParallelizedNonTransactionalFixturelessTestCase
   100.times do |i|
     test "that boops don't change ##{i}" do

data/example/test/integration/transaction_committing_boops_test.rb

@@ -0,0 +1,25 @@
+require "test_helper"
+
+class TransactionCommittingTestCase < ActiveSupport::TestCase
+  self.use_transactional_tests = false
+
+  def setup
+    Noncommittal.stop!
+    TestData.load(transactions: false)
+  end
+
+  def teardown
+    Boop.delete_all
+    Noncommittal.start!
+  end
+end
+
+class TransactionCommittingBoopsTest < TransactionCommittingTestCase
+  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,37 +2,14 @@ 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
+    TestData.load
   end
 
   def teardown

data/lib/generators/test_data/database_yaml_generator.rb

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

data/lib/generators/test_data/environment_file_generator.rb

@@ -6,20 +6,6 @@ module TestData
       create_file "config/environments/test_data.rb", <<~RUBY
         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
           config.active_record.dump_schema_after_migration = false
         end

data/lib/generators/test_data/initializer_generator.rb

@@ -0,0 +1,38 @@
+require "rails/generators"
+
+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|
+          # 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.
+          #   ("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 = []
+
+          # Tables whose data should be truncated by TestData.truncate
+          #   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/webpacker_yaml_generator.rb

@@ -7,7 +7,7 @@ module TestData
 
     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"

data/lib/test_data.rb

@@ -3,6 +3,7 @@ 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/database_yaml"
 require_relative "test_data/configurators/webpacker_yaml"
 require_relative "test_data/detects_database_emptiness"
@@ -10,11 +11,15 @@ require_relative "test_data/dumps_database"
 require_relative "test_data/error"
 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/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/database_yaml_generator"
 require_relative "generators/test_data/webpacker_yaml_generator"

data/lib/test_data/config.rb

@@ -18,7 +18,28 @@ module TestData
     attr_accessor :non_test_data_dump_path
 
     # Tables to exclude from test data dumps
-    attr_accessor :non_test_data_tables
+    attr_writer :non_test_data_tables
+    def non_test_data_tables
+      (@non_test_data_tables + [
+        ActiveRecord::Base.connection.schema_migration.table_name,
+        ActiveRecord::InternalMetadata.table_name
+      ]).uniq
+    end
+
+    # Tables to exclude from all dumps
+    attr_accessor :dont_dump_these_tables
+
+    # Tables to truncate when TestData.truncate is called
+    attr_accessor :truncate_these_test_data_tables
+
+    # Log level (valid values: [:debug, :info, :warn, :error, :quiet])
+    def log_level
+      TestData.log.level
+    end
+
+    def log_level=(level)
+      TestData.log.level = level
+    end
 
     attr_reader :pwd, :database_yaml_path
 
@@ -38,7 +59,9 @@ module TestData
       @data_dump_path = "test/support/test_data/data.sql"
       @non_test_data_dump_path = "test/support/test_data/non_test_data.sql"
       @database_yaml_path = "config/database.yml"
-      @non_test_data_tables = ["ar_internal_metadata", "schema_migrations"]
+      @non_test_data_tables = []
+      @dont_dump_these_tables = []
+      @truncate_these_test_data_tables = nil
     end
 
     def database_yaml

data/lib/test_data/configurators.rb

@@ -3,6 +3,7 @@ module TestData
     def self.all
       [
         EnvironmentFile,
+        Initializer,
         DatabaseYaml,
         WebpackerYaml
       ].map(&:new)

data/lib/test_data/configurators/initializer.rb

@@ -0,0 +1,25 @@
+module TestData
+  module Configurators
+    class Initializer
+      def initialize
+        @generator = InitializerGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        pathname = Pathname.new("#{@config.pwd}/config/initializers/test_data.rb")
+        if pathname.readable?
+          ConfigurationVerification.new(looks_good?: true)
+        else
+          ConfigurationVerification.new(problems: [
+            "'#{pathname}' is not readable"
+          ])
+        end
+      end
+
+      def configure
+        @generator.call
+      end
+    end
+  end
+end

data/lib/test_data/dumps_database.rb

@@ -1,5 +1,6 @@
 require "pathname"
 require "fileutils"
+require "open3"
 
 module TestData
   class DumpsDatabase
@@ -21,7 +22,7 @@ module TestData
         database_name: @config.database_name,
         relative_path: @config.data_dump_path,
         full_path: @config.data_dump_full_path,
-        flags: @config.non_test_data_tables.map { |t| "-T #{t}" }.join(" ")
+        flags: (@config.non_test_data_tables + @config.dont_dump_these_tables).uniq.map { |t| "-T #{t} -T #{t}_id_seq" }.join(" ")
       )
 
       dump(
@@ -30,7 +31,7 @@ module TestData
         database_name: @config.database_name,
         relative_path: @config.non_test_data_dump_path,
         full_path: @config.non_test_data_dump_full_path,
-        flags: @config.non_test_data_tables.map { |t| "-t #{t}" }.join(" ")
+        flags: (@config.non_test_data_tables - @config.dont_dump_these_tables).uniq.map { |t| "-t #{t}" }.join(" ")
       )
     end
 
@@ -39,11 +40,37 @@ module TestData
     def dump(type:, database_name:, relative_path:, full_path:, name: type, flags: "")
       dump_pathname = Pathname.new(full_path)
       FileUtils.mkdir_p(File.dirname(dump_pathname))
-      if system "pg_dump #{database_name} --no-tablespaces --no-owner --inserts --#{type}-only #{flags} -f #{dump_pathname}"
-        puts "Dumped database '#{database_name}' #{name} to '#{relative_path}'"
+      if execute("pg_dump #{database_name} --no-tablespaces --no-owner --inserts --#{type}-only #{flags} -f #{dump_pathname}")
+        prepend_set_replication_role!(full_path) if type == :data
+
+        TestData.log.info "Dumped '#{database_name}' #{name} to '#{relative_path}'"
       else
         raise "Failed while attempting to  dump '#{database_name}' #{name} to '#{relative_path}'"
       end
     end
+
+    def execute(command)
+      TestData.log.debug("Running SQL dump command:\n  #{command}")
+      stdout, stderr, status = Open3.capture3(command)
+      if status == 0
+        TestData.log.debug(stdout)
+        TestData.log.debug(stderr)
+        true
+      else
+        TestData.log.info(stdout)
+        TestData.log.error(stderr)
+        false
+      end
+    end
+
+    def prepend_set_replication_role!(data_dump_path)
+      system <<~COMMAND
+        ed -s #{data_dump_path} <<EOF
+        1 s/^/set session_replication_role = replica;/
+        w
+        EOF
+      COMMAND
+      TestData.log.debug("Prepended replication role instruction to '#{data_dump_path}'")
+    end
   end
 end

data/lib/test_data/loads_database_dumps.rb

@@ -16,17 +16,17 @@ module TestData
       )
 
       load_dump(
-        name: "test data",
+        name: "non-test data",
         database_name: @config.database_name,
-        relative_path: @config.data_dump_path,
-        full_path: @config.data_dump_full_path
+        relative_path: @config.non_test_data_dump_path,
+        full_path: @config.non_test_data_dump_full_path
       )
 
       load_dump(
-        name: "non-test data",
+        name: "test data",
         database_name: @config.database_name,
-        relative_path: @config.non_test_data_dump_path,
-        full_path: @config.non_test_data_dump_full_path
+        relative_path: @config.data_dump_path,
+        full_path: @config.data_dump_full_path
       )
     end
 
@@ -36,7 +36,7 @@ module TestData
       dump_pathname = Pathname.new(full_path)
       FileUtils.mkdir_p(File.dirname(dump_pathname))
       if system "psql -q -d #{database_name} < #{dump_pathname}"
-        puts "Loaded #{name} from '#{relative_path}' into database '#{database_name}' "
+        TestData.log.info "Loaded #{name} from '#{relative_path}' into database '#{database_name}' "
       else
         raise "Failed while attempting to load #{name} from '#{relative_path}' into database '#{database_name}'"
       end

data/lib/test_data/log.rb

@@ -0,0 +1,58 @@
+module TestData
+  def self.log
+    @log ||= Log.new
+  end
+
+  class Log
+    LEVELS = [:debug, :info, :warn, :error, :quiet]
+    DEFAULT_WRITER = ->(message, level) do
+      output = "[test_data: #{level}] #{message}"
+      if [:warn, :error].include?(level)
+        warn output
+      else
+        puts output
+      end
+    end
+
+    attr_reader :level, :writer
+
+    def initialize
+      reset
+    end
+
+    LEVELS[0...4].each do |level|
+      define_method level.to_s do |message|
+        next unless message.strip.present?
+
+        @writer.call(message, level) if enabled?(level)
+      end
+    end
+
+    def reset
+      self.level = ENV["TEST_DATA_LOG_LEVEL"]&.to_sym || :info
+      @writer = DEFAULT_WRITER
+    end
+
+    def level=(level)
+      if LEVELS.include?(level)
+        @level = level
+      else
+        raise Error.new("Not a valid level")
+      end
+    end
+
+    def writer=(writer)
+      if writer.respond_to?(:call)
+        @writer = writer
+      else
+        raise Error.new("Log writer must be callable")
+      end
+    end
+
+    private
+
+    def enabled?(level)
+      LEVELS.index(level) >= LEVELS.index(@level)
+    end
+  end
+end