Skip to content

PHPUnit

This job runs the phpunit tests defined by your module, including Functional, FunctionalJavascript, Kernel and Unit tests. You have a choice of two ways that the tests can be executed:

  • Using the phpunit binary directly and running the tests in sequential mode. This is the default, but you can specify it using:
variables:
  _PHPUNIT_CONCURRENT: 0
  • Using the Drupal core script run-tests.sh to execute the tests in parallel mode:
variables:
  _PHPUNIT_CONCURRENT: 1

Using phpunit binary directly (non-concurrent mode)

This is the default option. The tests will be run calling the vendor/bin/phpunit binary directly and in a sequential order. As there is no concurrency, the tests are likely to take longer to run.

You can use the _PHPUNIT_EXTRA variable to add extra options to the phpunit binary. For example:

variables:
  _PHPUNIT_EXTRA: "--debug"

TestDox

An example of one of the phpunit-only options is TestDox. If you want nicer CI terminal output you can set or add the option --testdox to the variable _PHPUNIT_EXTRA. The output will change from the typical

.............. (14/14)

to a more detailed output showing each test name and class, for example:

Admin Pages (Drupal\Tests\api\Functional\AdminPages)
 ✔ Admin pages
Api Access (Drupal\Tests\api\Functional\ApiAccess)
 ✔ Access
 ✔ Branch objects
 ...

Note that this option conflicts with the Drupal HtmlOutputPrinter printer and, if used, no .html artifacts will be generated after the run.

Running a subset of the tests

There may be times when you temporarily only need to run one or two tests, instead of the whole test suite. This can be achieved using:

variables:
  _PHPUNIT_EXTRA: "--filter='/thisTest|thatTest/' "

The --filter parameter is only valid when running the phpunit binary directly.

Using run-tests.sh core script (concurrent mode)

This script is included in Drupal core and leverages concurrency and also runs the tests in the same way that Drupal core tests are run. As there is concurrency, the job should run quicker than with the sequential option.

To enable concurrent mode set the variable _PHPUNIT_CONCURRENT to 1. You can set the _CONCURRENCY_THREADS variable as well to tweak the concurrency level used by run-tests.sh. The default value is set to 32.

In this case, the _PHPUNIT_EXTRA variable will contain options compatible with the run-test.sh script. You can also add parallel or parallel:matrix options to the job definition, to split out the tests into multiple jobs running in parallel.

If you want to split evenly the tests that are run in each parallel job, you can do it like this:

variables:
  _PHPUNIT_EXTRA: "--ci-parallel-node-index $CI_NODE_INDEX --ci-parallel-node-total $CI_NODE_TOTAL"

phpunit:
  parallel: 3

Variants

The phpunit job has multiple variants to check previous, current and future versions of Drupal. See the OPT_IN variables for more details.

If you want to tweak the value of the options per variant, you can do something like this:

variables:
  _PHPUNIT_EXTRA: "value for all variants unless overriden..."

phpunit (next major):
  variables:
    _PHPUNIT_EXTRA: "value for next major variant only"

PHPUnit versions

Drupal 10 uses PHPUnit 9, whereas Drupal 11 uses PHPUnit 10. Because of this, not all phpunit options are valid in both versions. If you use _PHPUNIT_CONCURRENT: 1, then run-tests.sh takes care of these cases for you. However, if you use _PHPUNIT_CONCURRENT: 0, you might need to adapt the options per variant as shown in the previous section.

If you do not provide a PHPUnit configuration file in your module, you can opt for using Drupal core's PHPUnit configuration file by setting _PHPUNIT_EXTRA: '-c $CI_PROJECT_DIR/$_WEB_ROOT/core' in your variables section.

If you do provide a PHPUnit configuration file in your module, you might need to provide a different one depending on the PHPUnit version. You can achieve it like this (where phpunit9.xml and phpunit10.xml are files in the root of your repository):

variables:
  _PHPUNIT_EXTRA: '-c $CI_PROJECT_DIR/phpunit9.xml'

phpunit (next major):
  variables:
    _PHPUNIT_EXTRA: '-c $CI_PROJECT_DIR/phpunit10.xml'

Deprecations

By default, we are setting SYMFONY_DEPRECATIONS_HELPER to disabled. This will not report warnings or deprecations by default.

If you want to mirror what core does, you can do it like this:

phpunit:
  variables:
    SYMFONY_DEPRECATIONS_HELPER: "ignoreFile=$CI_PROJECT_DIR/$_WEB_ROOT/core/.deprecation-ignore.txt"

If you are testing with Drupal 10 (which uses PHPUnit 9), your project needs to have a PHPUnit configuration file to be able to get deprecation warnings. The most minimal required configuration is shown below. This file will need to load the DrupalListener class, as shown below. This is not needed for Drupal 11 (which uses PHPUnit 10):

 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <listeners>
     <listener class="\Drupal\Tests\Listeners\DrupalListener">
     </listener>
   </listeners>
 </phpunit>

If you want to have your own file to include other deprecations, like third party ones, you can create your own file and call it like this:

phpunit:
  variables:
    SYMFONY_DEPRECATIONS_HELPER: "ignoreFile=./.local-deprecation-ignore.txt"

Finally, and if you are using a Drupal core version that comes with PHPUnit 10 or above (this would be Drupal 11 or above), you can also set the flag --fail-on-deprecation in the _PHPUNIT_EXTRA variable. This is only needed if you are running the tests in non-concurrent mode (see above). The code would look like this:

variables:
  _PHPUNIT_EXTRA: '--fail-on-deprecation'