Feature: Add Rails generator and rake task support for creating data migration test coverage #355
Conversation
…ge on data migrations * New Rake task `rake data:tests:setup` * New Config setting `config.test_support = true/false` (false by default)
| module Helpers | ||
| class InferTestSuiteType | ||
| def call | ||
| if File.exist?(Rails.root.join('spec', 'spec_helper.rb')) |
There was a problem hiding this comment.
We could perform add to the conditionals here for Rails.configuration.generators.options[:rails][:test_framework] == :rspec and Rails.configuration.generators.options[:rails][:test_framework] == :test_unit respectively to look for both installation and configuration.
| module DataMigrate | ||
| module Tasks | ||
| class SetupTests | ||
| INJECTION_MATCHER = Regexp.new(/require_relative ["|']\.\.\/config\/environment["|']/) |
There was a problem hiding this comment.
Had mixed feeling on this. Basically, I want to find a target phrase in either the rails_helper.rb or test_helper.rb. It seemed best to inject the require loop https://github.com/ilyakatz/data-migrate/pull/355/files#diff-ffd91a3de47aa2b12e05f99c726f74f27c7181b3f2f987c24aa9af32f72ea2acR57 after the environment was loaded. Open to other suggestions.
The setup task is also optional. You could just individually require files per data migration test file.
| def test_helper_file_path | ||
| case DataMigrate::Helpers::InferTestSuiteType.new.call | ||
| when :rspec | ||
| Rails.root.join('spec', 'rails_helper.rb') |
There was a problem hiding this comment.
rails_helper.rb contains the injection target BUT DataMigrate::Helpers::InferTestSuiteType checks spec_helper.rb (see: https://github.com/ilyakatz/data-migrate/pull/355/files#diff-e3eb6de888eae80ac87faa33be0419ff8abdc2bd7d14e23c243304834d53604eR5). I'm thinking these maybe should match in their conditional checks. Thoughts?
Why
Implements: #148
I recently needed well-factored test coverage for a complex data migration, so I thought I'd take an attempt at implementing test suite support for both RSpec and Minitest.
What
rake data:tests:setupfor optional help setting up new data migration testsconfig.test_support_enabledwhich conditionally creates associated tests files uponrails g data_migration add_this_to_that. (Default: false)I read the comment here: #162 (comment) regarding using
Rails.configuration.generators.options[:rails]. That returns a very clear:Rails.configuration.generators.options[:rails][:test_framework] #=> :rspec. While testing Minitest and RSpec, I noticed that this comes from having the rspec-rails gem installed. It doesn't necessarily check for valid installation. I attempted a valid installation check by looking for the framework specific filestest/test_helper.rbandspec/rails_helper.rb.Resources
Also, kudos on a great gem! 💎