Skip to content
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

Include test helpers in ActionDispatch::IntegrationTest #33849

Conversation

ricardotk002
Copy link
Contributor

@ricardotk002 ricardotk002 commented Sep 12, 2018

Summary

Fixes #33838

As @dhh brings up, the point of ActionDispatch::IntegrationTest is to
allow users to test the integration of all the pieces called by a
controller. Asserting about the emails and jobs queued is part of that
task.

In this commit, I use the action_dispatch_integration_test hook to include
the ActionMailer::TestHelper and ActiveJob::TestHelper modules
when the ActionMailer and ActiveJob railties are initialized respectively.

@rails-bot
Copy link

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @georgeclaghorn (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

require "active_job"
require "action_mailer"

include ActiveJob::TestHelper
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This need to be the opposite. It should be the Active Job and Action Mailer railtie that includes those modules in the action_dispatch_integration_test for the case were your app don't use one of those frameworks.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes a lot of sense. I was struggling about loading both libraries in the ActionDispatch railtie. I updated this patch according to your suggestions. Thanks!

As @dhh brings up, the point of `ActionDispatch::IntegrationTest` is to
allow users to test the integration of all the pieces called by a
controller. Asserting about the emails and jobs queued is part of that
task.

This commit includes the `ActionMailer::TestHelper` and
`ActiveJob::TestHelper` modules when the ActionMailer and ActiveJob
railties are initialized respectively.
@ricardotk002 ricardotk002 force-pushed the include-helpers-action-dispatch-integration-test branch from 9039abb to 64a9759 Compare September 12, 2018 22:28
@rafaelfranca rafaelfranca merged commit b79f3cc into rails:master Sep 12, 2018
@dhh
Copy link
Member

dhh commented Sep 12, 2018

❤️

bogdanvlviv added a commit to bogdanvlviv/rails that referenced this pull request Sep 13, 2018
Since these changes related to the public API, I think we should add
changelog entries.

Related to rails#33838, rails#33849
kamipo added a commit that referenced this pull request Sep 13, 2018
claudioclutter added a commit to clutter/mdma that referenced this pull request Jun 6, 2019
In Rails 5.x, having this setting in config/environments/test.rb

```
config.active_job.queue_adapter     = :inline
```

was enough to tell Active Job to **run** the jobs during test.

In Rails 6, the behavior has changed because of
rails/rails#33849
that uses the Test Adapter by default.

Therefore we need to specify *which* tests to run with InlineAdapter.
@ricardotk002 ricardotk002 deleted the include-helpers-action-dispatch-integration-test branch February 8, 2021 03:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants