Posted 9 months ago. Visible to the public. Repeats.

Pattern: Disabling a certain feature in tests

There is a kind of features in web applications that hinder automated integration tests. Examples include cookie consent banners or form captchas. Clearly, these should be disabled so you do not have to explicitly deal with them in each and every test (like, every test starting with accepting the cookies notice). On the other hand, they must be tested as well.

A good feature disabling solution should therefore meet these requirements:

  • The feature is generally disabled in tests. A test does not need to do anything manually.

  • It is possible to activate the feature manually, so it can be tested specifically.

Suggested solution

Define a constant that is set to true when in test mode:

Copy
class ExampleController < BaseController SKIP_CAPTCHA = Rails.env.test? ...

Next, depend activation of that feature on the value of that constant:

Copy
private def captcha_valid? return true if SKIP_CAPTCHA ...

To manually activate the feature in tests that actually need it, override the constant:

Copy
Given 'bot detection is enabled' do stub_const 'ExampleController::SKIP_CAPTCHA', false end

You may also choose to enable a feature flag using a tag instead:

Copy
Before '@captcha' do stub_const 'ExampleController::SKIP_CAPTCHA', false end
Growing Rails Applications in Practice
Check out our new e-book:
Learn to structure large Ruby on Rails codebases with the tools you already know and love.

Owner of this card:

Avatar
Dominik Schöler
Last edit:
8 months ago
by Besprechungs-PC
About this deck:
We are makandra and do test-driven, agile Ruby on Rails software development.
License for source code
Posted by Dominik Schöler to makandra dev
This website uses short-lived cookies to improve usability.
Accept or learn more