previousnext/drupal-test-utils

Utility traits for Drupal testing.

0.0.4 2024-05-21 00:22 UTC

Requires

• php: ^8

GPL-2.0+

• Adam Bramley

README

Utilities for testing Drupal!

ConfigTrait

A trait to facilitate overriding config for the duration of a test.

Usage

Add the trait to your base class and override the tearDown method.

use PNX\DrupalTestUtils\Traits\ConfigTrait;
use weitzman\DrupalTestTraits\ExistingSiteBase;

abstract class MyBaseClass extends ExistingSiteBase {

  /**
   * {@inheritdoc}
   */
  protected function tearDown(): void {
    $this->setConfigValues($this->originalConfiguration, FALSE);
    parent::tearDown();
  }

}

In a test case, call $this->setConfigValues:

$this->setConfigValues([
  'system.logging' => [
    'error_level' => \ERROR_REPORTING_DISPLAY_VERBOSE,
  ],
]);

EntityLoadTrait

A trait to assist with loading entities in tests.

Usage

Load one node with the title "Hello, World":

$node = $this->loadEntityByProperty('node', ['title' => 'Hello, World']);

Load all article nodes:

$nodes = $this->loadEntityByProperty('node', ['type' => 'article'], FALSE);

Get the last created node. Useful for asserting on entities created via the UI:

$node = $this->getLastCreatedEntity('node');

ExpectsCacheableResponseTrait

A trait to add Dynamic Page Cache cacheability testing to every request in your Functional tests.

Usage

Once your trait is added to your test base class, you can check cachability by overriding the drupalGet function.

/**
 * {@inheritdoc}
 */
protected function drupalGet($path, array $options = [], array $headers = []): string {
  $response = parent::drupalGet($path, $options, $headers);
  $this->detectUncacheableResponse($path, $options);
  return $response;
}

Marking paths as uncacheable

There are some paths that are always uncacheable (i.e pages with forms like node/add). These paths can marked as uncacheable by adding the $uncacheableDynamicPagePatterns property to your tests. You can add a common set of these to your test base and add more specific paths in indivdual tests as these patterns will be gathered up the class hierarchy at run time.

Patterns are regular expressions matched with preg_match

E.g

 protected static array $uncacheableDynamicPagePatterns = [
   '/user/login',
   '/big_pipe/no-js',
   '/batch',
   '/node/add/.*',
 ];