Unit Tests

Unit tests do not have access to the Drupal bootstrap; these are very fast. You should try to write unit tests whenever possible. Only move to Kernel tests if unit tests are not appropriate.

Quick Start

• Test classes should use namespace \Drupal\Test\{module name}\
• Test classnames should follow: *UnitTest
• Test classes should extend PHPUnit\Framework\TestCase.
• Modules must impelement autoload-dev.
• Module composer.json must be added to drupal_test_config.yml under merge_composer.json:

Setup Autoloading

• Refer to autoloading setup to allow your module to be tested.

A Note About Test Suite Order in XML

You will probably not need to modify phpunit.xml. But if you do...

Be very careful when modifying phpunit.xml, that you do not list even a single kernel test before any unit tests. When any kernel test is run, Drupal will be bootstrapped which "pollutes" the global namespace with stuff that could bleed into your unit tests, giving them out-of-scope and misleading functions, classes, constants, etc. In effect they could be acting like kernel tests, if you're not careful.

Notice how the unit tests come before the kernel tests in the code below; client tests must also precede the Kernel tests.

<testsuites>
    <testsuite name="Client">
        <directory>../../web/sites/all/modules/custom/*/tests/src/Client</directory>
    </testsuite>
    <testsuite name="EndToEnd">
        <directory>../web/sites/all/modules/custom/*/tests/src/EndToEnd</directory>
        <directory>../web/sites/all/modules/custom/*/tests/src/EndToEnd/**</directory>
        <directory>../web/sites/all/themes/*/tests/src/EndToEnd</directory>
        <directory>../web/sites/all/themes/*/tests/src/EndToEnd/**</directory>
    </testsuite>
    <testsuite name="Unit">
        <directory>../../web/sites/all/modules/custom/*/tests/src/Unit</directory>
    </testsuite>
    <testsuite name="Kernel">
        <directory>../../web/sites/all/modules/custom/*/tests/src/Kernel</directory>
    </testsuite>
</testsuites>

To be sure, run the entire unit test suite standalone on occassion, e.g.,

phpunit . --testsuite Unit

Troubleshooting

Fatal error: Class ... not found ...

• Try running composer update --lock from tests (the test runner directory).