Types of tests:
Writing tests
All PHP-based tests for Drupal core are written using the industry-standard PHPUnit framework, with Drupal extensions. There are several categories of tests; each has its own purpose, base class, namespace, and directory:
- Unit tests:
- Purpose: Test functionality of a class if the Drupal environment (database, settings, etc.) and web browser are not needed for the test, or if the Drupal environment can be replaced by a "mock" object.
- Base class: \Drupal\Tests\UnitTestCase
- Namespace: \Drupal\Tests\yourmodule\Unit (or a subdirectory)
- Directory location: yourmodule/tests/src/Unit (or a subdirectory)
- Kernel tests:
- Purpose: Test functionality of a class if the full Drupal environment and web browser are not needed for the test, but the functionality has significant Drupal dependencies that cannot easily be mocked. Kernel tests can access services, the database, and a minimal mocked file system, and they use an in-memory pseudo-installation. However, modules are only installed to the point of having services and hooks, unless you install them explicitly.
- Base class: \Drupal\KernelTests\KernelTestBase
- Namespace: \Drupal\Tests\yourmodule\Kernel (or a subdirectory)
- Directory location: yourmodule/tests/src/Kernel (or a subdirectory)
- Browser tests:
- Purpose: Test functionality with the full Drupal environment and an internal simulated web browser, if JavaScript is not needed.
- Base class: \Drupal\Tests\BrowserTestBase
- Namespace: \Drupal\Tests\yourmodule\Functional (or a subdirectory)
- Directory location: yourmodule/tests/src/Functional (or a subdirectory)
- Browser tests with JavaScript:
- Purpose: Test functionality with the full Drupal environment and an internal web browser that includes JavaScript execution.
- Base class: \Drupal\FunctionalJavascriptTests\WebDriverTestBase
- Namespace: \Drupal\Tests\yourmodule\FunctionalJavascript (or a subdirectory)
- Directory location: yourmodule/tests/src/FunctionalJavascript (or a subdirectory)
- Build tests:
- Purpose: Test building processes and their outcomes, such as whether a live update process actually works, or whether a Composer project template actually builds a working site. Provides a temporary build workspace and a PHP-native HTTP server to send requests to the site you've built.
- Base class: \Drupal\BuildTests\Framework\BuildTestBase
- Namespace: \Drupal\Tests\yourmodule\Build (or a subdirectory)
- Directory location: yourmodule/tests/src/Build (or a subdirectory)
Some notes about writing PHP test classes:
- The class needs a phpDoc comment block with a description and @group annotation, which gives information about the test.
- For unit tests, this comment block should also have @coversDefaultClass annotation.
- When writing tests, put the test code into public methods, each covering a logical subset of the functionality that is being tested.
- The test methods must have names starting with 'test'. For unit tests, the test methods need to have a phpDoc block with @covers annotation telling which class method they are testing.
- In some cases, you may need to write a test module to support your test; put such modules under the yourmodule/tests/modules directory.
Ref : https://api.drupal.org/api/drupal/core%21core.api.php/group/testing
Comments
Post a Comment