test_data 0.0.1

data/lib/test_data/configurators/database_yaml.rb

@@ -0,0 +1,24 @@
+module TestData
+  module Configurators
+    class DatabaseYaml
+      def initialize
+        @generator = DatabaseYamlGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        if @config.database_yaml.key?("test_data")
+          ConfigurationVerification.new(looks_good?: true)
+        else
+          ConfigurationVerification.new(problems: [
+            "'#{@config.database_yaml_path}' 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

@@ -0,0 +1,25 @@
+module TestData
+  module Configurators
+    class EnvironmentFile
+      def initialize
+        @generator = EnvironmentFileGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        pathname = Pathname.new("#{@config.pwd}/config/environments/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/configurators/webpacker_yaml.rb

@@ -0,0 +1,38 @@
+module TestData
+  module Configurators
+    class WebpackerYaml
+      def initialize
+        @generator = WebpackerYamlGenerator.new
+        @config = TestData.config
+      end
+
+      def verify
+        pathname = Pathname.new("#{@config.pwd}/config/webpacker.yml")
+        return ConfigurationVerification.new(looks_good?: true) unless pathname.readable?
+        yaml = load_yaml(pathname)
+        if yaml.nil?
+          ConfigurationVerification.new(problems: [
+            "'#{pathname}' is not valid YAML"
+          ])
+        elsif !yaml.key?("test_data")
+          ConfigurationVerification.new(problems: [
+            "'#{pathname}' does not contain a 'test_data' section"
+          ])
+        else
+          ConfigurationVerification.new(looks_good?: true)
+        end
+      end
+
+      def configure
+        @generator.call
+      end
+
+      private
+
+      def load_yaml(pathname)
+        YAML.load_file(pathname)
+      rescue
+      end
+    end
+  end
+end

data/lib/test_data/detects_database_emptiness.rb

@@ -0,0 +1,17 @@
+module TestData
+  class DetectsDatabaseEmptiness
+    def initialize
+      @config = TestData.config
+    end
+
+    def empty?
+      result = ActiveRecord::Base.connection.execute <<~SQL
+        select not exists (
+          select from information_schema.tables
+          where table_name = 'ar_internal_metadata'
+        ) as empty
+      SQL
+      result.first["empty"]
+    end
+  end
+end

data/lib/test_data/dumps_database.rb

@@ -0,0 +1,49 @@
+require "pathname"
+require "fileutils"
+
+module TestData
+  class DumpsDatabase
+    def initialize
+      @config = TestData.config
+    end
+
+    def call
+      dump(
+        type: :schema,
+        database_name: @config.database_name,
+        relative_path: @config.schema_dump_path,
+        full_path: @config.schema_dump_full_path
+      )
+
+      dump(
+        type: :data,
+        name: "test data",
+        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(" ")
+      )
+
+      dump(
+        type: :data,
+        name: "non-test data",
+        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(" ")
+      )
+    end
+
+    private
+
+    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}'"
+      else
+        raise "Failed while attempting to  dump '#{database_name}' #{name} to '#{relative_path}'"
+      end
+    end
+  end
+end

data/lib/test_data/error.rb

@@ -0,0 +1,4 @@
+module TestData
+  class Error < StandardError
+  end
+end

data/lib/test_data/installs_configuration.rb

@@ -0,0 +1,9 @@
+module TestData
+  class InstallsConfiguration
+    def call
+      Configurators.all.each do |configurator|
+        configurator.configure
+      end
+    end
+  end
+end

data/lib/test_data/loads_database_dumps.rb

@@ -0,0 +1,45 @@
+require "pathname"
+require "fileutils"
+
+module TestData
+  class LoadsDatabaseDumps
+    def initialize
+      @config = TestData.config
+    end
+
+    def call
+      load_dump(
+        name: "schema",
+        database_name: @config.database_name,
+        relative_path: @config.schema_dump_path,
+        full_path: @config.schema_dump_full_path
+      )
+
+      load_dump(
+        name: "test data",
+        database_name: @config.database_name,
+        relative_path: @config.data_dump_path,
+        full_path: @config.data_dump_full_path
+      )
+
+      load_dump(
+        name: "non-test data",
+        database_name: @config.database_name,
+        relative_path: @config.non_test_data_dump_path,
+        full_path: @config.non_test_data_dump_full_path
+      )
+    end
+
+    private
+
+    def load_dump(name:, database_name:, relative_path:, full_path:)
+      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}' "
+      else
+        raise "Failed while attempting to load #{name} from '#{relative_path}' into database '#{database_name}'"
+      end
+    end
+  end
+end

data/lib/test_data/railtie.rb

@@ -0,0 +1,12 @@
+require "rails/railtie"
+require "pathname"
+
+module TestData
+  class Railtie < Rails::Railtie
+    railtie_name :test_data
+
+    rake_tasks do
+      load Pathname.new(__dir__).join("rake.rb")
+    end
+  end
+end

data/lib/test_data/rake.rb

@@ -0,0 +1,104 @@
+def wrong_env?
+  Rails.env != "test_data"
+end
+
+def run_in_test_data_env(task_name)
+  command = "RAILS_ENV=test_data #{Rails.root}/bin/rake #{task_name}"
+  unless system(command)
+    fail "An error ocurred when running: #{command}"
+  end
+end
+
+def create_database_or_else_blow_up_if_its_not_empty!
+  unless TestData::DetectsDatabaseEmptiness.new.empty?
+    raise TestData::Error.new("Database '#{TestData.config.database_name}' already exists and is not empty. To re-initialize it, drop it first (e.g. `rake test_data:drop_database`)")
+  end
+rescue TestData::Error => e
+  raise e
+rescue
+  # Only (anticipated) cause for raise here is DB did not exist
+  Rake::Task["test_data:create_database"].invoke
+end
+
+desc "Verifies test_data environment looks good"
+task "test_data:verify_config" do
+  config = TestData::VerifiesConfiguration.new.call
+  unless config.looks_good?
+    puts "The test_data gem is not configured correctly. Try 'rake test_data:install'?\n"
+    config.problems.each do |problem|
+      puts "  - #{problem}"
+    end
+    fail
+  end
+end
+
+desc "Install default configuration files and snippets"
+task "test_data:configure" do
+  TestData::InstallsConfiguration.new.call
+end
+
+desc "Initialize test_data's interactive database"
+task "test_data:initialize" => ["test_data:verify_config", :environment] do
+  next run_in_test_data_env("test_data:initialize") if wrong_env?
+
+  create_database_or_else_blow_up_if_its_not_empty!
+  if TestData::VerifiesDumpsAreLoadable.new.call(quiet: true)
+    Rake::Task["test_data:load"].invoke
+  else
+    ActiveRecord::Tasks::DatabaseTasks.load_schema_current(ActiveRecord::Base.schema_format, ENV["SCHEMA"], "test_data")
+    ActiveRecord::Tasks::DatabaseTasks.load_seed
+  end
+end
+
+desc "Initialize test_data Rails environment & configure database"
+task "test_data:install" => ["test_data:configure", "test_data:initialize"]
+
+desc "Dumps the interactive test_data database"
+task "test_data:dump" => "test_data:verify_config" do
+  TestData::DumpsDatabase.new.call
+end
+
+desc "Dumps the interactive test_data database"
+task "test_data:load" => ["test_data:verify_config", :environment] do
+  next run_in_test_data_env("test_data:load") if wrong_env?
+
+  create_database_or_else_blow_up_if_its_not_empty!
+
+  unless TestData::VerifiesDumpsAreLoadable.new.call
+    fail "Cannot load schema & data into database '#{TestData.config.database_name}'"
+  end
+
+  TestData::LoadsDatabaseDumps.new.call
+
+  if ActiveRecord::Base.connection.migration_context.needs_migration?
+    warn "Warning: 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
+
+desc "Creates the test_data interactive database"
+task "test_data:create_database" => :environment do
+  if TestData::Configurators::DatabaseYaml.new.verify.looks_good?
+    ActiveRecord::Tasks::DatabaseTasks.create_current("test_data")
+  else
+    warn "Warning: 'test_data' section not defined in config/database.yml - Skipping"
+  end
+end
+
+# Add the test_data env to Rails' default rake db:create task
+Rake::Task["db:create"].enhance do |task|
+  Rake::Task["test_data:create_database"].invoke
+end
+
+desc "Drops the test_data interactive database"
+task "test_data:drop_database" => :environment do
+  if TestData::Configurators::DatabaseYaml.new.verify.looks_good?
+    ActiveRecord::Tasks::DatabaseTasks.drop_current("test_data")
+  else
+    warn "Warning: 'test_data' section not defined in config/database.yml - Skipping"
+  end
+end
+
+# Add the test_data env to Rails' default rake db:create task
+Rake::Task["db:drop"].enhance do |task|
+  Rake::Task["test_data:drop_database"].invoke
+end

data/lib/test_data/transactional_data_loader.rb

@@ -0,0 +1,77 @@
+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

data/lib/test_data/verifies_configuration.rb

@@ -0,0 +1,14 @@
+module TestData
+  class VerifiesConfiguration
+    def call
+      problems = Configurators.all.flat_map { |configurator|
+        configurator.verify.problems
+      }.compact
+
+      ConfigurationVerification.new(
+        looks_good?: problems.none?,
+        problems: problems
+      )
+    end
+  end
+end

data/lib/test_data/verifies_dumps_are_loadable.rb

@@ -0,0 +1,37 @@
+module TestData
+  class VerifiesDumpsAreLoadable
+    def initialize
+      @config = TestData.config
+      @detects_database_emptiness = DetectsDatabaseEmptiness.new
+    end
+
+    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"
+      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"
+      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"
+      end
+
+      database_empty = @detects_database_emptiness.empty?
+      unless quiet || database_empty
+        warn "Warning: Database '#{@config.database_name}' is not empty"
+      end
+
+      [
+        schema_dump_looks_good,
+        data_dump_looks_good,
+        non_test_data_dump_looks_good,
+        database_empty
+      ].all?
+    end
+  end
+end