test_data 0.1.0 → 0.3.0

data/example/.gitignore

@@ -18,7 +18,4 @@
 # Ignore master key for decrypting credentials and more.
 /config/master.key
 
-# Ignore files that are intentionally generated / asserted by the tests
-/config/environments/test_data.rb
-/test/support/test_data
-/db/migrate/20210418220133_add_beep_to_boops.rb
+

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    test_data (0.0.2)
+    test_data (0.3.0)
       railties (~> 6.0)
 
 GEM

data/example/config/application.rb

@@ -24,6 +24,9 @@ module Example
     # Initialize configuration defaults for originally generated Rails version.
     config.load_defaults 6.1
 
+    # Uncomment this to switch from schema.rb to structure.sql
+    # config.active_record.schema_format = :sql
+
     # Configuration for the application, engines, and railties goes here.
     #
     # These settings can be overridden in specific environments using the files

data/example/config/credentials.yml.enc

@@ -1,2 +1 @@
-F/lkjSeOZwy+4IAYNV/+5sOwn9XOGjyNNvDkNyrpRG0kqoP8jmI4GE8mb73fdRIVoI9H7zefa3GxQ7R+udxqKWMLwAtSgTt+YGf5Eng0IzRBPp7hY2gIxFO0b84/+eG4Q6rD5xsg0kogzK3Ab4jj7f8Ci8vzFclSwqyUwP6TBCnaZJYsLMcNmF3tKBnWrJNKcQJ6Rj6/J2OH/nNi5x+KbsIgbARCJsZEK8PjD+cx8Qs9Cvk99Pj3VljLmjYA0L3jx1uCKahr0tzkkPkujBCKci05QHF/+vq0fcFduxc5wwlf5qMf7wGayz8i1YONyM9yORMrcnvSz/6AKC25np24+nmvZNsuVqtyoA4LRL+k3RBCMKo867FkwJmmGkhZSAFplFdQ2C0qJ+Gzem6UD6Lr70klDaUq1hITDqIc--nPRVkeqxjYlJDoKQ--Iu4hCDiJSpYuKL56Z/CUjA==
-
+5AstMrUHKXO5ed+i/hI/GnVm5IB525qXJOqPHvqfqhJSxEJSyfwKfQURigix3HsTcOwcPFIU6vPSC20bi5H8CQ7SHnYdHJuGB2T3WC9iiNiSBz49HaZoYX8ucHYoMMBbC+0u/6diYLW8ZTKR2Ab7bn4r1lkGzQjJe5clic5wNto7btjAbStXyAOHZCStXfnOFgQQhVjZno3iS7c279jaVYkYpZ12P5LbMxcJO4ipWfFexCzysIQu/WSPfmNMcvrIPijmPBvkVMJuhhDzd0yk1ysJu8jJMa8FJKx9aVd7Bes/k8Nywd04GDY6eSxyH6gkoG+BeQeqW3ig1XsuOWvx39qE9EQAcsgT13uxGc8M4wBKqIdSoibPl/79kTB843rnGlL8X/pKipJYczYJxazLSojwcQSto1UeIqQFWaDPQhz0--C7YAj7j4YQdWGiMG--JFTyHZbGKXiCdfZoBmF3xw==

data/example/spec/rails_helper.rb

@@ -32,7 +32,7 @@ rescue ActiveRecord::PendingMigrationError => e
 end
 RSpec.configure do |config|
   # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
-  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+  config.fixture_path = "#{::Rails.root}/test/fixtures"
 
   # If you're not using ActiveRecord, or you'd prefer not to run each of your
   # examples within a transaction, remove the following line or assign false

data/example/spec/requests/boops_spec.rb

@@ -2,11 +2,7 @@ require "rails_helper"
 
 RSpec.configure do |config|
   config.before(:each) do
-    TestData.load
-  end
-
-  config.after(:each) do
-    TestData.rollback
+    TestData.uses_test_data
   end
 end
 

data/example/spec/requests/rails_fixtures_override_spec.rb

@@ -0,0 +1,106 @@
+require "rails_helper"
+
+TestData.prevent_rails_fixtures_from_loading_automatically!
+
+module TestDataModes
+  def uses(mode)
+    case mode
+    when :clean_slate
+      before(:each) { TestData.uses_clean_slate }
+    when :test_data
+      before(:each) { TestData.uses_test_data }
+    else
+      raise "Invalid test data mode: #{mode}"
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.extend(TestDataModes)
+end
+
+RSpec.describe "FixtureFreeTestData", type: :request do
+  fixtures :boops
+
+  uses :test_data
+  it "has 15 boops in the test_data" do
+    expect(Boop.count).to eq(15)
+  end
+end
+
+RSpec.describe "Clean Slate" do
+  uses :clean_slate
+
+  it "has no boops" do
+    expect(Boop.count).to eq(0)
+  end
+end
+
+RSpec.describe "FixturesUsingTest", type: :request do
+  fixtures :boops
+
+  before(:each) do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  it "has_fixture_boops" do
+    expect(boops(:boop_1)).to be_persisted
+    expect(Boop.count).to eq(2)
+  end
+
+  it "does_not_get_the_other_fixture_accessor" do
+    expect { method(:pants) }.to raise_error(NameError)
+  end
+
+  it "even_explicitly_loading_test_data_will_truncate_and_then_load_fixtures" do
+    TestData.uses_test_data
+    TestData.uses_rails_fixtures(self)
+
+    expect(Boop.count).to eq(2)
+  end
+
+  it "load_and_rollback_leaves_them_as_is" do
+    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)
+
+    expect(Boop.find(boop.id).created_at.to_date).to eq(a_year_ago)
+
+    # Now after rollback
+    TestData.uses_rails_fixtures(self)
+
+    expect(Boop.find(boop.id).created_at.to_date).to eq(original_created_on)
+  end
+end
+
+RSpec.describe "SomeFixturesAndSomeTestDataInOneClassTest", type: :request do
+  fixtures :all
+
+  it "fixtures_work" do
+    TestData.uses_rails_fixtures(self)
+
+    expect(boops(:boop_1).updated_at.to_date).to eq(Date.civil(2020, 1, 1))
+    expect(pants(:pant_1).brand).to eq("Levi")
+  end
+
+  it "test_that_rewinds_to_test_data" do
+    TestData.uses_test_data
+
+    expect(Boop.count).to eq(15)
+  end
+
+  it "that_rewinds_to_the_very_start" do
+    TestData.uninitialize
+
+    expect(Boop.count).to eq(0)
+  end
+
+  it "fixtures_get_reloaded_because_cache_is_cleared" do
+    TestData.uses_rails_fixtures(self)
+
+    expect(boops(:boop_2).updated_at.to_date).to eq(Date.civil(2019, 1, 1))
+    expect(pants(:pant_2).brand).to eq("Wrangler")
+  end
+end

data/example/test/integration/better_mode_switching_demo_test.rb

@@ -8,19 +8,11 @@ class ActiveSupport::TestCase
       include FactoryBot::Syntax::Methods
 
       setup do
-        TestData.truncate
-      end
-
-      teardown do
-        TestData.rollback(:after_data_truncate)
+        TestData.uses_clean_slate
       end
     when :test_data
       setup do
-        TestData.load
-      end
-
-      teardown do
-        TestData.rollback
+        TestData.uses_test_data
       end
     end
   end

data/example/test/integration/fixture_load_count_test.rb

@@ -0,0 +1,82 @@
+# Regression test to make sure we don't load fixtures too many times
+
+class HookCounter
+  def self.count
+    @call_count || 0
+  end
+
+  def self.count!
+    @call_count ||= 0
+    @call_count += 1
+  end
+end
+at_exit do
+  if TestData.statistics.load_rails_fixtures_count > 2 # could be 1 if :all runs first, 2 if :boops only does
+    raise "Rails fixture load was called #{TestData.statistics.load_rails_fixtures_count} times, shouldn't be more than 2!"
+  end
+  if HookCounter.count > 2
+    raise "Rails fixture load hook was called #{HookCounter.count} times, shouldn't be more than 2!"
+  end
+end
+
+require "test_helper"
+
+TestData.prevent_rails_fixtures_from_loading_automatically!
+
+TestData.config do |config|
+  config.after_rails_fixture_load {
+    HookCounter.count!
+  }
+end
+
+class PartialFixtureTest < ActiveSupport::TestCase
+  fixtures :boops
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_only_boops
+    assert boops(:boop_1)
+    assert_raises(NameError) { method(:pants) }
+  end
+end
+
+class AllFixtureTest < ActiveSupport::TestCase
+  fixtures :all
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_both
+    assert boops(:boop_1)
+    assert pants(:pant_1)
+  end
+end
+
+class AllFixtureTest2 < ActiveSupport::TestCase
+  fixtures :all
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_both
+    assert boops(:boop_1)
+    assert pants(:pant_1)
+  end
+end
+
+class AllFixtureTest3 < ActiveSupport::TestCase
+  fixtures :all
+
+  setup do
+    TestData.uses_rails_fixtures(self)
+  end
+
+  def test_has_both
+    assert boops(:boop_1)
+    assert pants(:pant_1)
+  end
+end

data/example/test/integration/load_rollback_truncate_test.rb

@@ -14,7 +14,6 @@ class LoadRollbackTruncateTest < ActiveSupport::TestCase
   def teardown
     TestData.log.reset
     TestData.statistics.reset
-    TestData.rollback(:before_data_load)
   end
 
   def test_loads_data_then_truncates_then_rolls_back_etc
@@ -22,101 +21,97 @@ class LoadRollbackTruncateTest < ActiveSupport::TestCase
     assert_equal 0, Boop.count
 
     # Now load the dump
-    TestData.load
+    TestData.uses_test_data
     assert_equal 15, Boop.count
     Boop.create!
     assert_equal 16, Boop.count
 
     # Next, truncate the boops
-    TestData.truncate
+    TestData.uses_clean_slate
     assert_equal 0, Boop.count
     Boop.create!
     assert_equal 1, Boop.count
 
     # Now roll back to _just after truncate_
-    TestData.rollback(:after_data_truncate)
+    TestData.uses_clean_slate
     assert_equal 0, Boop.count
     Boop.create!
     assert_equal 1, Boop.count
 
     # Verify default rollback works after truncate
-    TestData.rollback
+    TestData.uses_test_data
     assert_equal 15, Boop.count
 
     # Verify touching non-test-data tables will also be first rollbacked when truncate is called
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
     good = ChattyAuditLog.create!(message: "I do belong here, because now we're at the start, prior to test_data's purview")
-    TestData.load
+    TestData.uses_test_data
     bad = ChattyAuditLog.create!(message: "I won't belong here after truncate because I'm data that the truncate-calling test wouldn't expect")
     assert_equal 2, ChattyAuditLog.count
 
-    TestData.truncate
+    TestData.uses_clean_slate
 
     assert_equal 1, ChattyAuditLog.count
     refute_nil ChattyAuditLog.find_by(id: good.id)
     assert_nil ChattyAuditLog.find_by(id: bad.id)
 
-    # Verify rollbacking to some nonsense savepoint errors out:
-    error = assert_raise(TestData::Error) { TestData.rollback(:before_nonsense) }
-    assert_match "No known save point named 'before_nonsense'", error.message
-
     # Warn but load anyway if rolled back to the start and then truncated
-    TestData.rollback(:before_data_load)
-    TestData.truncate
+    TestData.uninitialize
+    TestData.uses_clean_slate
     assert_equal :debug, @last_log.level
-    assert_match "TestData.truncate was called, but data was not loaded. Loading data", @last_log.message
+    assert_match "TestData.uses_clean_slate was called, but data was not loaded. Loading data", @last_log.message
     assert_equal 0, Boop.count
-    TestData.rollback
+    TestData.uses_test_data
     assert_equal 15, Boop.count
 
     # Chaos: try rolling back outside the gem (one level of extraneous rollback) and verify load recovers
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
     TestData.statistics.reset
     assert_equal 0, TestData.statistics.load_count
-    TestData.load
+    TestData.uses_test_data
     assert_equal 1, TestData.statistics.load_count
-    TestData.load # Smart enough to not load again
+    TestData.uses_test_data # Smart enough to not load again
     assert_equal 1, TestData.statistics.load_count
     ActiveRecord::Base.connection.rollback_transaction # Someone might do this!
-    TestData.load # Still smart enough to not do this
+    TestData.uses_test_data # Still smart enough to not do this
     assert_equal 1, TestData.statistics.load_count
-    TestData.rollback # after load savepoint should have been healed with subsequent load call
+    TestData.uses_test_data # after load savepoint should have been healed with subsequent load call
     assert_equal 15, Boop.count
 
     # Chaos: try rolling back outside the gem (one level of extraneous rollback) and verify truncate recovers
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
     TestData.statistics.reset
     assert_equal 0, TestData.statistics.truncate_count
-    TestData.load
-    TestData.truncate
+    TestData.uses_test_data
+    TestData.uses_clean_slate
     assert_equal 1, TestData.statistics.truncate_count
-    TestData.truncate
+    TestData.uses_clean_slate
     assert_equal 1, TestData.statistics.truncate_count
     ActiveRecord::Base.connection.rollback_transaction # Someone might do this!
-    TestData.truncate # Will recover, not take the bait
+    TestData.uses_clean_slate # Will recover, not take the bait
     assert_equal 1, TestData.statistics.truncate_count
-    TestData.rollback(:after_data_truncate) # after truncate savepoint should have been healed with subsequent truncate call
+    TestData.uses_clean_slate # after truncate savepoint should have been healed with subsequent truncate call
     assert_equal 0, Boop.count
-    TestData.rollback
+    TestData.uses_test_data
     assert_equal 15, Boop.count
 
     # Chaos: load data then call rollback two times and ensure we're still in a good spot
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
     TestData.statistics.reset
-    TestData.load
+    TestData.uses_test_data
     assert_equal 15, Boop.count
     2.times do # Two rollbacks means we're back at before_data_load
       ActiveRecord::Base.connection.rollback_transaction
     end
     assert_equal 0, Boop.count
-    TestData.load # It should successfully load again a second time
+    TestData.uses_test_data # It should successfully load again a second time
     assert_equal 15, Boop.count
     assert_equal 2, TestData.statistics.load_count
 
     # Chaos: truncate data then call rollback two times and ensure we're still in a good spot
-    TestData.rollback(:before_data_load)
+    TestData.uninitialize
     TestData.statistics.reset
-    TestData.truncate # will warn-and-load and then truncate
+    TestData.uses_clean_slate # will warn-and-load and then truncate
     assert_equal 0, Boop.count
     2.times do # Two rollbacks means data is loaded but after_data_load savepoint has been lost
       ActiveRecord::Base.connection.rollback_transaction
@@ -124,14 +119,14 @@ class LoadRollbackTruncateTest < ActiveSupport::TestCase
     assert_equal 15, Boop.count
     assert_equal 1, TestData.statistics.load_count
     assert_equal 1, TestData.statistics.truncate_count
-    TestData.truncate # should restore the lost after_data_load savepoint and re-truncate
+    TestData.uses_clean_slate # should restore the lost after_data_load savepoint and re-truncate
     3.times do # Three rollbacks means we are at before_data_load again
       ActiveRecord::Base.connection.rollback_transaction
     end
     assert_equal 0, Boop.count
-    TestData.load
+    TestData.uses_test_data
     assert_equal 15, Boop.count
-    TestData.truncate
+    TestData.uses_clean_slate
     assert_equal 0, Boop.count
     assert_equal 3, TestData.statistics.truncate_count
     assert_equal 2, TestData.statistics.load_count
@@ -140,17 +135,15 @@ class LoadRollbackTruncateTest < ActiveSupport::TestCase
   def test_suite_runs_different_tests_in_whatever_order
     # Imagine a test-datay test runs
     test_data_using_test = -> do
-      TestData.load # before each
+      TestData.uses_test_data # before each
       Boop.create!
       assert_equal 16, Boop.count
-      TestData.rollback # after each
     end
 
     test_data_avoiding_test = -> do
-      TestData.truncate # before each
+      TestData.uses_clean_slate # before each
       Boop.create!
       assert_equal 1, Boop.count
-      TestData.rollback(:after_data_truncate) # after each
     end
 
     # Run the tests separately:
@@ -170,23 +163,25 @@ class LoadRollbackTruncateTest < ActiveSupport::TestCase
     # In the interest of behaving similarly to .load, rollback in case the
     # previous test doesn't have an after_each as you might hope/expect
     3.times do
-      TestData.truncate
+      TestData.uses_clean_slate
       Boop.create!
       assert_equal 1, Boop.count
     end
   end
 
   def test_other_rollbacks_mess_with_transaction_state_will_debug_you
-    TestData.load
+    TestData.uninitialize
+    TestData.statistics.reset
+    TestData.uses_test_data
     ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_load save point destroyed
-    TestData.load
+    TestData.uses_test_data
     assert_equal :debug, @last_log.level # debug only b/c rails fixtures will do this on every after_each if enabled
     assert_match "Recreating the :after_data_load save point", @last_log.message
     assert_equal 1, TestData.statistics.load_count
 
-    TestData.truncate
+    TestData.uses_clean_slate
     ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_truncate save point destroyed
-    TestData.truncate
+    TestData.uses_clean_slate
     assert_equal :debug, @last_log.level # debug only b/c rails fixtures will do this on every after_each if enabled
     assert_match "Recreating the :after_data_truncate save point", @last_log.message
     assert_equal 1, TestData.statistics.load_count