test_data 0.2.2 → 0.3.2

data/lib/test_data/warns_if_database_is_newer_than_dump.rb

@@ -0,0 +1,32 @@
+module TestData
+  class WarnsIfDatabaseIsNewerThanDump
+    def initialize
+      @config = TestData.config
+      @determines_when_sql_dump_was_made = DeterminesWhenSqlDumpWasMade.new
+      @determines_databases_associated_dump_time = DeterminesDatabasesAssociatedDumpTime.new
+    end
+
+    def call
+      return unless Rails.env.test_data?
+      sql_dumped_at = @determines_when_sql_dump_was_made.call
+      database_dumped_at = @determines_databases_associated_dump_time.call
+
+      if database_dumped_at.present? &&
+          sql_dumped_at.present? &&
+          database_dumped_at > sql_dumped_at
+        TestData.log.warn <<~MSG
+          Your local test_data database '#{@config.database_name}' is associated
+          with a SQL dump that was NEWER than the current dumps located in
+          '#{File.dirname(@config.data_dump_path)}':
+
+            SQL Dump: #{sql_dumped_at.localtime}
+            Database: #{database_dumped_at.localtime}
+
+          If you're not intentionally resetting your local test_data database to an earlier
+          version, you may want to take a closer look before taking any destructive actions.
+
+        MSG
+      end
+    end
+  end
+end

data/lib/test_data/warns_if_dump_is_newer_than_database.rb

@@ -0,0 +1,36 @@
+module TestData
+  class WarnsIfDumpIsNewerThanDatabase
+    def initialize
+      @config = TestData.config
+      @determines_when_sql_dump_was_made = DeterminesWhenSqlDumpWasMade.new
+      @determines_databases_associated_dump_time = DeterminesDatabasesAssociatedDumpTime.new
+    end
+
+    def call
+      return unless Rails.env.test_data?
+      sql_dumped_at = @determines_when_sql_dump_was_made.call
+      database_dumped_at = @determines_databases_associated_dump_time.call
+
+      if sql_dumped_at.present? &&
+          database_dumped_at.present? &&
+          sql_dumped_at > database_dumped_at
+        TestData.log.warn <<~MSG
+          The SQL dumps in '#{File.dirname(@config.data_dump_path)}' were created
+          after your local test_data database '#{@config.database_name}' was last dumped.
+
+            SQL Dump: #{sql_dumped_at.localtime}
+            Database: #{database_dumped_at.localtime}
+
+          To avoid potential data loss, you may want to consider dropping '#{@config.database_name}'
+          and loading the SQL dumps before making changes to the test data in this database
+          or performing another dump.
+
+          To do this, kill any processes with RAILS_ENV=test_data and then run:
+
+            $ bin/rake test_data:reinitialize
+
+        MSG
+      end
+    end
+  end
+end

data/lib/test_data/wrap/webpacker_config.rb

@@ -0,0 +1,42 @@
+module TestData
+  module Wrap
+    class WebpackerConfig
+      def initialize
+        @user_config_path = Pathname.new("#{TestData.config.pwd}/config/webpacker.yml")
+      end
+
+      def relative_user_config_path
+        @user_config_path.relative_path_from(Rails.root)
+      end
+
+      def no_user_config_exists?
+        !@user_config_path.readable?
+      end
+
+      def user_config
+        load_yaml(@user_config_path)
+      end
+
+      def webpacker_gem_spec_loaded?
+        !!Gem.loaded_specs["webpacker"]
+      end
+
+      def builtin_config
+        webpacker_path = Gem.loaded_specs["webpacker"].full_gem_path
+        load_yaml(File.join(webpacker_path, "lib/install/config/webpacker.yml"))
+      end
+
+      def required_entries_missing_from_test_data_config
+        missing_keys = builtin_config["development"].keys - user_config["test_data"].keys
+        builtin_config["development"].slice(*missing_keys).presence
+      end
+
+      private
+
+      def load_yaml(path)
+        YAML.load_file(path)
+      rescue
+      end
+    end
+  end
+end

data/lib/test_data.rb

@@ -11,21 +11,28 @@ 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/wrap/webpacker_config"
 require_relative "test_data/detects_database_emptiness"
+require_relative "test_data/detects_database_existence"
+require_relative "test_data/determines_when_sql_dump_was_made"
+require_relative "test_data/determines_databases_associated_dump_time"
 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/manager"
 require_relative "test_data/railtie"
+require_relative "test_data/records_dump_metadata"
 require_relative "test_data/save_point"
 require_relative "test_data/statistics"
-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 "test_data/warns_if_dump_is_newer_than_database"
+require_relative "test_data/warns_if_database_is_newer_than_dump"
 require_relative "generators/test_data/environment_file_generator"
 require_relative "generators/test_data/initializer_generator"
 require_relative "generators/test_data/cable_yaml_generator"
@@ -37,25 +44,30 @@ module TestData
   def self.uninitialize
     @manager ||= Manager.new
     @manager.rollback_to_before_data_load
+    nil
   end
 
   def self.uses_test_data
     @manager ||= Manager.new
     @manager.load
+    nil
   end
 
   def self.uses_clean_slate
     @manager ||= Manager.new
     @manager.truncate
+    nil
   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)
+    nil
   end
 
   def self.insert_test_data_dump
     InsertsTestData.new.call
+    nil
   end
 end

data/script/test

@@ -28,11 +28,45 @@ bin/rails test test/integration/better_mode_switching_demo_test.rb
 bin/rails test test/integration/parallel_boops_with_fixtures_test.rb
 bin/rails test test/integration/parallel_boops_without_fixtures_test.rb
 
+# Verify the out-of-date database warning system works (step 1)
+mkdir -p tmp/dump-backup-1
+cp test/support/test_data/* tmp/dump-backup-1
+
 # Test using the test_data env to interactively create test data
 RAILS_ENV=test_data rails runner "5.times { Boop.create! }"
 bin/rake test_data:dump
 bin/rails test test/integration/updated_boops_test.rb
 
+# Verify the out-of-date database warning system works (step 2)
+mkdir -p tmp/dump-backup-2
+cp test/support/test_data/* tmp/dump-backup-2
+cp tmp/dump-backup-1/* test/support/test_data
+set +e
+result=`yes "n" | bin/rake test_data:reinitialize 2>&1`
+set -e
+if ! echo "$result" | grep -q "\[test_data:warn\] Your local test_data database 'example_test_data' is associated"; then
+  echo "Expected to be warned that the SQL dump was older than the database, but there was no warning."
+  exit 1
+fi
+TEST_DATA_CONFIRM=true bin/rake test_data:reinitialize
+cp tmp/dump-backup-2/* test/support/test_data
+if ! RAILS_ENV=test_data bin/rails runner "" 2>&1 | grep -q "\[test_data:warn\] The SQL dumps in 'test/support/test_data' were created"; then
+  echo "Expected to be warned that the SQL dump was newer than the database, but there was no warning."
+  exit 1
+fi
+set +e
+result=`yes "n" | bin/rake test_data:reinitialize 2>&1`
+set -e
+if echo "$result" | grep -q "\[test_data:warn\] Your local test_data database 'example_test_data' is associated"; then
+  echo "Expected NOT to be warned that the SQL dump was older than the database, but a warning was printed."
+  exit 1
+fi
+TEST_DATA_CONFIRM=true bin/rake test_data:reinitialize
+if RAILS_ENV=test_data bin/rails runner "" 2>&1 | grep -q "\[test_data:warn\]"; then
+  echo "Expected NOT to be warned that the SQL dump was newer than the database, but a warning was printed."
+  exit 1
+fi
+
 # Test a migration being added and run and an out-of-date dump being loaded
 cp ../test/fixtures/20210418220133_add_beep_to_boops.rb db/migrate
 cp ../test/fixtures/20210624180810_create_pants.rb db/migrate

data/test_data.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "railties", "~> 6.0"
+  spec.add_dependency "railties", ">= 6.0", "< 8.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: test_data
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.2
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-08-03 00:00:00.000000000 Z
+date: 2022-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 description:
 email:
 - searls@gmail.com
@@ -136,6 +142,9 @@ files:
 - lib/test_data/custom_loaders/abstract_base.rb
 - lib/test_data/custom_loaders/rails_fixtures.rb
 - lib/test_data/detects_database_emptiness.rb
+- lib/test_data/detects_database_existence.rb
+- lib/test_data/determines_databases_associated_dump_time.rb
+- lib/test_data/determines_when_sql_dump_was_made.rb
 - lib/test_data/dumps_database.rb
 - lib/test_data/error.rb
 - lib/test_data/generator_support.rb
@@ -146,12 +155,16 @@ files:
 - lib/test_data/manager.rb
 - lib/test_data/railtie.rb
 - lib/test_data/rake.rb
+- lib/test_data/records_dump_metadata.rb
 - lib/test_data/save_point.rb
 - lib/test_data/statistics.rb
 - lib/test_data/truncates_test_data.rb
 - lib/test_data/verifies_configuration.rb
 - lib/test_data/verifies_dumps_are_loadable.rb
 - lib/test_data/version.rb
+- lib/test_data/warns_if_database_is_newer_than_dump.rb
+- lib/test_data/warns_if_dump_is_newer_than_database.rb
+- lib/test_data/wrap/webpacker_config.rb
 - script/reset_example_app
 - script/test
 - test_data.gemspec
@@ -176,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Dumps and Loads data for your Rails app's tests