-
-
Notifications
You must be signed in to change notification settings - Fork 1k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Only load example group modules when they're used #2742
base: main
Are you sure you want to change the base?
Changes from all commits
d3e593b
1036b07
800282d
012f864
be1d197
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,6 @@ | ||
# minitest was previously always loaded, and users may have come to depend on it. | ||
require "minitest" | ||
|
||
# rubocop: disable Metrics/ModuleLength | ||
module RSpec | ||
module Rails | ||
|
@@ -45,15 +48,40 @@ class Configuration | |
# | ||
# @api private | ||
def self.add_test_type_configurations(config) | ||
config.include RSpec::Rails::ControllerExampleGroup, type: :controller | ||
config.include RSpec::Rails::HelperExampleGroup, type: :helper | ||
config.include RSpec::Rails::ModelExampleGroup, type: :model | ||
config.include RSpec::Rails::RequestExampleGroup, type: :request | ||
config.include RSpec::Rails::RoutingExampleGroup, type: :routing | ||
config.include RSpec::Rails::ViewExampleGroup, type: :view | ||
config.include RSpec::Rails::FeatureExampleGroup, type: :feature | ||
config.define_derived_metadata(type: :controller) do | ||
config.include RSpec::Rails::ControllerExampleGroup, type: :controller | ||
end | ||
|
||
config.define_derived_metadata(type: :helper) do | ||
config.include RSpec::Rails::HelperExampleGroup, type: :helper | ||
end | ||
|
||
config.define_derived_metadata(type: :model) do | ||
config.include RSpec::Rails::ModelExampleGroup, type: :model | ||
end | ||
|
||
config.define_derived_metadata(type: :request) do | ||
config.include RSpec::Rails::RequestExampleGroup, type: :request | ||
end | ||
|
||
config.define_derived_metadata(type: :routing) do | ||
require "action_controller/test_case" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is necessary because I've fixed that upstream in rails/rails@5307976, but for compatibility with all existing Rails versions we need to keep eager loading |
||
config.include RSpec::Rails::RoutingExampleGroup, type: :routing | ||
end | ||
|
||
config.define_derived_metadata(type: :view) do | ||
config.include RSpec::Rails::ViewExampleGroup, type: :view | ||
end | ||
|
||
config.define_derived_metadata(type: :feature) do | ||
config.include RSpec::Rails::FeatureExampleGroup, type: :feature | ||
end | ||
|
||
config.include RSpec::Rails::Matchers | ||
config.include RSpec::Rails::SystemExampleGroup, type: :system | ||
|
||
config.define_derived_metadata(type: :system) do | ||
config.include RSpec::Rails::SystemExampleGroup, type: :system | ||
end | ||
end | ||
|
||
# @private | ||
|
@@ -192,27 +220,38 @@ def fixture_path=(path) | |
|
||
if defined?(::Rails::Controller::Testing) | ||
[:controller, :view, :request].each do |type| | ||
config.include ::Rails::Controller::Testing::TestProcess, type: type | ||
config.include ::Rails::Controller::Testing::TemplateAssertions, type: type | ||
config.include ::Rails::Controller::Testing::Integration, type: type | ||
config.define_derived_metadata(type: type) do | ||
config.include ::Rails::Controller::Testing::TestProcess, type: type | ||
config.include ::Rails::Controller::Testing::TemplateAssertions, type: type | ||
config.include ::Rails::Controller::Testing::Integration, type: type | ||
end | ||
end | ||
end | ||
|
||
if RSpec::Rails::FeatureCheck.has_action_mailer? | ||
config.include RSpec::Rails::MailerExampleGroup, type: :mailer | ||
config.define_derived_metadata(type: :mailer) do | ||
config.include RSpec::Rails::MailerExampleGroup, type: :mailer | ||
end | ||
|
||
config.after { ActionMailer::Base.deliveries.clear } | ||
end | ||
|
||
if RSpec::Rails::FeatureCheck.has_active_job? | ||
config.include RSpec::Rails::JobExampleGroup, type: :job | ||
config.define_derived_metadata(type: :job) do | ||
config.include RSpec::Rails::JobExampleGroup, type: :job | ||
end | ||
end | ||
|
||
if RSpec::Rails::FeatureCheck.has_action_cable_testing? | ||
config.include RSpec::Rails::ChannelExampleGroup, type: :channel | ||
config.define_derived_metadata(type: :channel) do | ||
config.include RSpec::Rails::ChannelExampleGroup, type: :channel | ||
end | ||
end | ||
|
||
if RSpec::Rails::FeatureCheck.has_action_mailbox? | ||
config.include RSpec::Rails::MailboxExampleGroup, type: :mailbox | ||
config.define_derived_metadata(type: :mailbox) do | ||
config.include RSpec::Rails::MailboxExampleGroup, type: :mailbox | ||
end | ||
end | ||
end | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,3 @@ | ||
require 'rspec/rails/example/rails_example_group' | ||
require 'rspec/rails/example/controller_example_group' | ||
require 'rspec/rails/example/request_example_group' | ||
require 'rspec/rails/example/helper_example_group' | ||
require 'rspec/rails/example/view_example_group' | ||
require 'rspec/rails/example/mailer_example_group' | ||
require 'rspec/rails/example/routing_example_group' | ||
require 'rspec/rails/example/model_example_group' | ||
require 'rspec/rails/example/job_example_group' | ||
require 'rspec/rails/example/feature_example_group' | ||
require 'rspec/rails/example/system_example_group' | ||
require 'rspec/rails/example/channel_example_group' | ||
require 'rspec/rails/example/mailbox_example_group' | ||
RSpec.warn_deprecation <<~WARNING | ||
Requiring rspec/rails/example.rb no longer has any effect, and it will be removed in RSpec Rails 7. | ||
WARNING |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,3 @@ | ||
require 'rspec/rails/view_assigns' | ||
|
||
module RSpec | ||
module Rails | ||
# @api public | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -291,6 +291,7 @@ def in_inferring_type_from_location_environment | |
end | ||
|
||
it "metadata `type: :request` sets up request example groups" do | ||
require "rspec/rails/example/request_example_group" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was going to comment "This could cause order dependent failures, we typically do such requires in a sub process to avoid posioning the env" but its made me think prehaps we should be doing that all over now if we lazy load so that we don't accidentally depend on a module load order that we just happen to have in our specs 😧 |
||
a_rails_app = double("Rails application") | ||
the_rails_module = Module.new { | ||
def self.version; end | ||
|
@@ -328,6 +329,7 @@ def self.application; end | |
end | ||
|
||
it "metadata `type: :feature` sets up feature example groups" do | ||
require "rspec/rails/example/feature_example_group" | ||
a_rails_app = double("Rails application") | ||
the_rails_module = Module.new { | ||
def self.version; end | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I originally wanted to use
when_first_matching_example_defined
here, but that hook doesn't fire until the first call toit
, and some methods from the example group module could be called before then (e.g.render_views
).If this PR is accepted, I propose adding a new
when_first_matching_example_group_defined
hook to rspec-core and using it here instead.