test_data 0.0.1 → 0.0.2

data/example/Gemfile

@@ -10,6 +10,9 @@ group :development, :test, :test_data do
   gem "test_data", path: ".."
   gem "standard"
   gem "pry-rails"
+  gem "factory_bot_rails", require: false
+  gem "noncommittal"
+  gem "rspec-rails"
 end
 
 group :test do

data/example/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    test_data (0.0.1)
+    test_data (0.0.2)
       railties (~> 6.0)
 
 GEM
@@ -84,7 +84,13 @@ GEM
     coderay (1.1.3)
     concurrent-ruby (1.1.8)
     crass (1.0.6)
+    diff-lcs (1.4.4)
     erubi (1.10.0)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    factory_bot_rails (6.1.0)
+      factory_bot (~> 6.1.0)
+      railties (>= 5.0.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.10)
@@ -97,11 +103,14 @@ GEM
     marcel (1.0.1)
     method_source (1.0.0)
     mini_mime (1.0.3)
+    mini_portile2 (2.5.0)
     minitest (5.14.4)
     msgpack (1.4.2)
     nio4r (2.5.7)
-    nokogiri (1.11.3-arm64-darwin)
+    nokogiri (1.11.3)
+      mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
+    noncommittal (0.2.0)
     parallel (1.20.1)
     parser (3.0.1.0)
       ast (~> 2.4.1)
@@ -148,6 +157,23 @@ GEM
     rake (13.0.3)
     regexp_parser (2.1.1)
     rexml (3.2.5)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
     rubocop (1.12.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -193,15 +219,18 @@ GEM
     zeitwerk (2.4.2)
 
 PLATFORMS
-  arm64-darwin-20
+  ruby
 
 DEPENDENCIES
   bootsnap
   capybara (>= 3.26)
+  factory_bot_rails
+  noncommittal
   pg
   pry-rails
   puma
   rails
+  rspec-rails
   selenium-webdriver
   standard
   test_data!

data/example/README.md

@@ -1,24 +1,4 @@
 # README
 
-This README would normally document whatever steps are necessary to get the
-application up and running.
-
-Things you may want to cover:
-
-* Ruby version
-
-* System dependencies
-
-* Configuration
-
-* Database creation
-
-* Database initialization
-
-* How to run the test suite
-
-* Services (job queues, cache servers, search engines, etc.)
-
-* Deployment instructions
-
-* ...
+This is an example app used by [script/test](/script/test) to exercise the
+`test_data` gem

data/example/config/credentials.yml.enc

@@ -1 +1,2 @@
-F/lkjSeOZwy+4IAYNV/+5sOwn9XOGjyNNvDkNyrpRG0kqoP8jmI4GE8mb73fdRIVoI9H7zefa3GxQ7R+udxqKWMLwAtSgTt+YGf5Eng0IzRBPp7hY2gIxFO0b84/+eG4Q6rD5xsg0kogzK3Ab4jj7f8Ci8vzFclSwqyUwP6TBCnaZJYsLMcNmF3tKBnWrJNKcQJ6Rj6/J2OH/nNi5x+KbsIgbARCJsZEK8PjD+cx8Qs9Cvk99Pj3VljLmjYA0L3jx1uCKahr0tzkkPkujBCKci05QHF/+vq0fcFduxc5wwlf5qMf7wGayz8i1YONyM9yORMrcnvSz/6AKC25np24+nmvZNsuVqtyoA4LRL+k3RBCMKo867FkwJmmGkhZSAFplFdQ2C0qJ+Gzem6UD6Lr70klDaUq1hITDqIc--nPRVkeqxjYlJDoKQ--Iu4hCDiJSpYuKL56Z/CUjA==
+F/lkjSeOZwy+4IAYNV/+5sOwn9XOGjyNNvDkNyrpRG0kqoP8jmI4GE8mb73fdRIVoI9H7zefa3GxQ7R+udxqKWMLwAtSgTt+YGf5Eng0IzRBPp7hY2gIxFO0b84/+eG4Q6rD5xsg0kogzK3Ab4jj7f8Ci8vzFclSwqyUwP6TBCnaZJYsLMcNmF3tKBnWrJNKcQJ6Rj6/J2OH/nNi5x+KbsIgbARCJsZEK8PjD+cx8Qs9Cvk99Pj3VljLmjYA0L3jx1uCKahr0tzkkPkujBCKci05QHF/+vq0fcFduxc5wwlf5qMf7wGayz8i1YONyM9yORMrcnvSz/6AKC25np24+nmvZNsuVqtyoA4LRL+k3RBCMKo867FkwJmmGkhZSAFplFdQ2C0qJ+Gzem6UD6Lr70klDaUq1hITDqIc--nPRVkeqxjYlJDoKQ--Iu4hCDiJSpYuKL56Z/CUjA==
+

data/example/config/database.yml

@@ -20,6 +20,8 @@ default: &default
   # For details on connection pooling, see Rails configuration guide
   # https://guides.rubyonrails.org/configuring.html#database-pooling
   pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
+  host: <%= ENV.fetch("PGHOST") { "localhost" } %>
+  port: <%= ENV.fetch("PGPORT") { "5432" } %>
 
 development:
   <<: *default

data/example/spec/rails_helper.rb

@@ -0,0 +1,64 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+require "spec_helper"
+ENV["RAILS_ENV"] ||= "test"
+require File.expand_path("../config/environment", __dir__)
+# Prevent database truncation if the environment is production
+abort("The Rails environment is running in production mode!") if Rails.env.production?
+require "rspec/rails"
+# Add additional requires below this line. Rails is not loaded until this point!
+
+# Requires supporting ruby files with custom matchers and macros, etc, in
+# spec/support/ and its subdirectories. Files matching `spec/**/*_spec.rb` are
+# run as spec files by default. This means that files in spec/support that end
+# in _spec.rb will both be required and run as specs, causing the specs to be
+# run twice. It is recommended that you do not name files matching this glob to
+# end with _spec.rb. You can configure this pattern with the --pattern
+# option on the command line or in ~/.rspec, .rspec or `.rspec-local`.
+#
+# The following line is provided for convenience purposes. It has the downside
+# of increasing the boot-up time by auto-requiring all files in the support
+# directory. Alternatively, in the individual `*_spec.rb` files, manually
+# require only the support files necessary.
+#
+# Dir[Rails.root.join('spec', 'support', '**', '*.rb')].sort.each { |f| require f }
+
+# Checks for pending migrations and applies them before tests are run.
+# If you are not using ActiveRecord, you can remove these lines.
+begin
+  ActiveRecord::Migration.maintain_test_schema!
+rescue ActiveRecord::PendingMigrationError => e
+  puts e.to_s.strip
+  exit 1
+end
+RSpec.configure do |config|
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/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
+  # instead of true.
+  config.use_transactional_fixtures = true
+
+  # You can uncomment this line to turn off ActiveRecord support entirely.
+  # config.use_active_record = false
+
+  # RSpec Rails can automatically mix in different behaviours to your tests
+  # based on their file location, for example enabling you to call `get` and
+  # `post` in specs under `spec/controllers`.
+  #
+  # You can disable this behaviour by removing the line below, and instead
+  # explicitly tag your specs with their type, e.g.:
+  #
+  #     RSpec.describe UsersController, type: :controller do
+  #       # ...
+  #     end
+  #
+  # The different available types are documented in the features, such as in
+  # https://relishapp.com/rspec/rspec-rails/docs
+  config.infer_spec_type_from_file_location!
+
+  # Filter lines from Rails gems in backtraces.
+  config.filter_rails_from_backtrace!
+  # arbitrary gems may also be filtered via:
+  # config.filter_gems_from_backtrace("gem name")
+end

data/example/spec/requests/boops_spec.rb

@@ -0,0 +1,21 @@
+require "rails_helper"
+
+RSpec.configure do |config|
+  config.before(:each) do
+    TestData.load
+  end
+
+  config.after(:each) do
+    TestData.rollback
+  end
+end
+
+RSpec.describe "Boops", type: :request do
+  30.times do |i|
+    it "counts the boops ##{i}" do
+      expect(Boop.count).to eq(10)
+      Boop.create!
+      expect(Boop.count).to eq(11)
+    end
+  end
+end

data/example/spec/spec_helper.rb

@@ -0,0 +1,94 @@
+# This file was generated by the `rails generate rspec:install` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+  # This option will default to `:apply_to_host_groups` in RSpec 4 (and will
+  # have no way to turn it off -- the option exists only for backwards
+  # compatibility in RSpec 3). It causes shared context metadata to be
+  # inherited by the metadata hash of host groups and examples, rather than
+  # triggering implicit auto-inclusion in groups with matching metadata.
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+  #   # This allows you to limit a spec run to individual examples or groups
+  #   # you care about by tagging them with `:focus` metadata. When nothing
+  #   # is tagged with `:focus`, all examples get run. RSpec also provides
+  #   # aliases for `it`, `describe`, and `context` that include `:focus`
+  #   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
+  #   config.filter_run_when_matching :focus
+  #
+  #   # Allows RSpec to persist some state between runs in order to support
+  #   # the `--only-failures` and `--next-failure` CLI options. We recommend
+  #   # you configure your source control system to ignore this file.
+  #   config.example_status_persistence_file_path = "spec/examples.txt"
+  #
+  #   # Limits the available syntax to the non-monkey patched syntax that is
+  #   # recommended. For more details, see:
+  #   #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  #   config.disable_monkey_patching!
+  #
+  #   # Many RSpec users commonly either run the entire suite or an individual
+  #   # file, and it's useful to allow more verbose output when running an
+  #   # individual spec file.
+  #   if config.files_to_run.one?
+  #     # Use the documentation formatter for detailed output,
+  #     # unless a formatter has already been configured
+  #     # (e.g. via a command-line flag).
+  #     config.default_formatter = "doc"
+  #   end
+  #
+  #   # Print the 10 slowest examples and example groups at the
+  #   # end of the spec run, to help surface which specs are running
+  #   # particularly slow.
+  #   config.profile_examples = 10
+  #
+  #   # Run specs in random order to surface order dependencies. If you find an
+  #   # order dependency and want to debug it, you can fix the order by providing
+  #   # the seed, which is printed after each run.
+  #   #     --seed 1234
+  #   config.order = :random
+  #
+  #   # Seed global randomization in this process using the `--seed` CLI option.
+  #   # Setting this allows you to use `--seed` to deterministically reproduce
+  #   # test failures related to randomization by passing the same `--seed` value
+  #   # as the one that triggered the failure.
+  #   Kernel.srand config.seed
+end

data/example/test/factories.rb

@@ -0,0 +1,4 @@
+FactoryBot.define do
+  factory :boop do
+  end
+end

data/example/test/integration/better_mode_switching_demo_test.rb

@@ -0,0 +1,45 @@
+require "test_helper"
+
+class ActiveSupport::TestCase
+  def self.test_data_mode(mode)
+    case mode
+    when :factory_bot
+      require "factory_bot_rails"
+      include FactoryBot::Syntax::Methods
+
+      setup do
+        TestData.truncate
+      end
+
+      teardown do
+        TestData.rollback(:after_data_truncate)
+      end
+    when :test_data
+      setup do
+        TestData.load
+      end
+
+      teardown do
+        TestData.rollback
+      end
+    end
+  end
+end
+
+class SomeFactoryUsingTest < ActiveSupport::TestCase
+  test_data_mode :factory_bot
+
+  def test_boops
+    create(:boop)
+
+    assert_equal 1, Boop.count
+  end
+end
+
+class SomeTestDataUsingTest < ActionDispatch::IntegrationTest
+  test_data_mode :test_data
+
+  def test_boops
+    assert_equal 10, Boop.count
+  end
+end

data/example/test/integration/boops_that_boop_boops_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+
+class BoopsThatBoopBoopsTest < SerializedNonTransactionalTestCase
+  def test_each_of_the_boops_has_a_boop
+    assert_equal 15, Boop.count
+
+    Boop.find_each do |boop|
+      assert_kind_of Boop, boop.other_boop
+    end
+  end
+
+  def test_it_wont_let_you_assign_a_nonsensical_boop
+    assert_raise {
+      Boop.last.update!(other_boop_id: 2138012)
+    }
+  end
+end

data/example/test/integration/dont_dump_tables_test.rb

@@ -0,0 +1,7 @@
+require "test_helper"
+
+class DontDumpTablesTest < SerializedNonTransactionalTestCase
+  def test_dump_includes_zero_chatty_audit_logs
+    assert_equal 0, ChattyAuditLog.count
+  end
+end

data/example/test/integration/load_rollback_truncate_test.rb

@@ -0,0 +1,195 @@
+require "test_helper"
+
+class LoadRollbackTruncateTest < ActiveSupport::TestCase
+  LogMessage = Struct.new(:message, :level, keyword_init: true)
+
+  def setup
+    @last_log = nil
+    TestData.log.level = :debug
+    TestData.log.writer = ->(message, level) {
+      @last_log = LogMessage.new(message: message, level: level)
+    }
+  end
+
+  def teardown
+    TestData.log.reset
+    TestData.statistics.reset
+    TestData.rollback(:before_data_load)
+  end
+
+  def test_loads_data_then_truncates_then_rolls_back_etc
+    # Check default state
+    assert_equal 0, Boop.count
+
+    # Now load the dump
+    TestData.load
+    assert_equal 15, Boop.count
+    Boop.create!
+    assert_equal 16, Boop.count
+
+    # Next, truncate the boops
+    TestData.truncate
+    assert_equal 0, Boop.count
+    Boop.create!
+    assert_equal 1, Boop.count
+
+    # Now roll back to _just after truncate_
+    TestData.rollback(:after_data_truncate)
+    assert_equal 0, Boop.count
+    Boop.create!
+    assert_equal 1, Boop.count
+
+    # Verify default rollback works after truncate
+    TestData.rollback
+    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)
+    good = ChattyAuditLog.create!(message: "I do belong here, because now we're at the start, prior to test_data's purview")
+    TestData.load
+    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
+
+    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
+    assert_equal :debug, @last_log.level
+    assert_match "TestData.truncate was called, but data was not loaded. Loading data", @last_log.message
+    assert_equal 0, Boop.count
+    TestData.rollback
+    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.statistics.reset
+    assert_equal 0, TestData.statistics.load_count
+    TestData.load
+    assert_equal 1, TestData.statistics.load_count
+    TestData.load # 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
+    assert_equal 1, TestData.statistics.load_count
+    TestData.rollback # 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.statistics.reset
+    assert_equal 0, TestData.statistics.truncate_count
+    TestData.load
+    TestData.truncate
+    assert_equal 1, TestData.statistics.truncate_count
+    TestData.truncate
+    assert_equal 1, TestData.statistics.truncate_count
+    ActiveRecord::Base.connection.rollback_transaction # Someone might do this!
+    TestData.truncate # 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
+    assert_equal 0, Boop.count
+    TestData.rollback
+    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.statistics.reset
+    TestData.load
+    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
+    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.statistics.reset
+    TestData.truncate # 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
+    end
+    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
+    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
+    assert_equal 15, Boop.count
+    TestData.truncate
+    assert_equal 0, Boop.count
+    assert_equal 3, TestData.statistics.truncate_count
+    assert_equal 2, TestData.statistics.load_count
+  end
+
+  def test_suite_runs_different_tests_in_whatever_order
+    # Imagine a test-datay test runs
+    test_data_using_test = -> do
+      TestData.load # before each
+      Boop.create!
+      assert_equal 16, Boop.count
+      TestData.rollback # after each
+    end
+
+    test_data_avoiding_test = -> do
+      TestData.truncate # before each
+      Boop.create!
+      assert_equal 1, Boop.count
+      TestData.rollback(:after_data_truncate) # after each
+    end
+
+    # Run the tests separately:
+    3.times { test_data_using_test.call }
+    3.times { test_data_avoiding_test.call }
+
+    # Mix and match the tests:
+    test_data_using_test.call
+    test_data_avoiding_test.call
+    test_data_using_test.call
+    test_data_avoiding_test.call
+    test_data_using_test.call
+    test_data_avoiding_test.call
+  end
+
+  def test_calling_truncate_multiple_times_will_return_you_to_truncated_state
+    # 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
+      Boop.create!
+      assert_equal 1, Boop.count
+    end
+  end
+
+  def test_other_rollbacks_mess_with_transaction_state_will_debug_you
+    TestData.load
+    ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_load save point destroyed
+    TestData.load
+    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
+    ActiveRecord::Base.connection.rollback_transaction # data loaded, after_data_truncate save point destroyed
+    TestData.truncate
+    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
+    assert_equal 1, TestData.statistics.truncate_count
+  end
+end