Problem/Motivation

Not being able to install test modules even from Drush regularly throws off even avid core contributors.

Proposed resolution

Add documentation on how to allow installing test modules to example.settings.local.php so that when copying the file to settings.local.php (which is best practice for development anyway) this works right out of the box.

Remaining tasks

User interface changes

API changes

CommentFileSizeAuthor
#1 extension-discovery-settings-local.patch680 byteststoeckler
#1 modules-with-testing.png179.33 KBtstoeckler

Comments

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new modules-with-testing.png179.33 KB
new extension-discovery-settings-local.patch680 bytes

Here's a patch. Note that due to the amount of test modules we have this slightly clutters the Modules page. The attached screenshot is a demonstration of that: It shows the Modules page in a super zoomed-out and compacted way and shows the Testing group in comparison with the Core group.

Notes:

  • It would be very easy to collapse the Testing group by default. This could be done as part of this issue or separately.
  • One can collapse the Testing group with a single click to get it out of the way, just like any other group.
dawehner’s picture

dawehner
Primary language German
commented
Status: Needs review » Reviewed & tested by the community
Issue tags: +DX (Developer Experience), +Quickfix

This is soooo damn useful!!

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Title: Document how to allow enabling test modules in example.settings.local.php » Document how to allow test module and theme installation in example.settings.local.php
Status: Reviewed & tested by the community » Fixed

Committed 29c4def and pushed to 8.0.x. Thanks!

 $settings['cache']['bins']['render'] = 'cache.backend.null';

 /**
- * Allow discovering test extensions.
+ * Allow test modules and themes to be installed.
  *
  * Drupal ignores test modules and themes by default for performance reasons.
- * During development it can be useful, however, to enable test extensions for
- * debugging purposes.
+ * During development it can be useful to install test extensions for debugging
+ * purposes.
  */

Simplified the English and concepts a bit.

  • alexpott committed 29c4def on 8.0.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...
tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented

Awesome, thanks!

wim leers’s picture

wim leers
Location Ghent 🇧🇪🇪🇺
commented

Thank you so much for this wonderful addition to example.settings.local.php! :)

(I've also been bitten by this, and was unable to figure it out.)

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Related issues: +#2342435: Don't show 80 bazillion test modules on the modules page when in development mode, +#2342439: Some test modules/themes missing "Testing" package assignment in their info files.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.

xjm’s picture

xjm
she/her
Primary language English
commented
Status: Closed (fixed) » Active
Issue tags: +Needs change record updates

The CR for the original change also needs an update to explain that it made testing modules unable to be enabled (heh) by default and that this is the way to do that now:
https://www.drupal.org/node/2198695

yesct’s picture

yesct commented
Issue tags: +rc eligible

  • alexpott committed 29c4def on 8.1.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

  • alexpott committed 29c4def on 8.3.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...

  • alexpott committed 29c4def on 8.3.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

  • alexpott committed 29c4def on 8.4.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...

  • alexpott committed 29c4def on 8.4.x 
    Issue #2327095 by tstoeckler: Document how to allow test module and...

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.3.x-dev » 8.4.x-dev

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

Bug reports should be targeted against the 8.9.x-dev branch from now on, and new development or disruptive changes should be targeted against the 9.1.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

oknate’s picture

oknate
Location Greater New York City Area
commented
Version: 8.9.x-dev » 9.3.x-dev
Status: Active » Needs review
Issue tags: -Needs change record updates

I have updated the change record to add:

The file example.settings.local.php has been updated to explain how adding $settings['extension_discovery_scan_tests'] = TRUE; to the settings array will allow the discovery of test modules. Note: without this setting, test modules are no longer discoverable by default.

vijaycs85’s picture

vijaycs85
Location London, UK
commented

.

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.0-rc1 was released on November 26, 2021, which means new developments and disruptive changes should now be targeted for the 9.4.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

quietone commented
Status: Needs review » Fixed

This was committed to 8.0.x and marked fixed, but re-opened to update the change record. That was done by oknate and I have read the changes and they look fine.

Since this is a straightforward update to the CR, I am going to got ahead and restore the fixed status.

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.