Skip to main content

Unit Test With Drupal 8

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

Popular posts from this blog

How to span column of custom table in Drupal

If you want to span the column of custom drupal table like below image, Follow the below code to make the header of the table , <?php $header = array('S.N','District', array('data' => '<div class ="house">Household </div><br><span>Rural</span> <p>Urban</p>','colspan' => 2), array('data' => '<div class ="house">Members</div> <br><span>Rural</span> <p>Urban</p>','colspan' => 2), 'Duplicate/Failed Registration', array('data' => '<div class ="house">Pending De duplication </div><br><span>Rural</span> <p>Urban</p>','colspan' => 2), 'Non Un-organised Workers', 'SSID Generated', 'No. of Card Personlised', ); $rows[] = arra...

Drupal 8 : Link actions,Link menus,Link Tasks,Routings

Drupal 8 : Link actions,Link menus,Link Tasks,Routings Link actions Local actions have also been moved out of the hook_menu() system in Drupal 8 .Use actions to define local operations such as adding new items to an administrative list (menus, contact categories, etc). Local actions are defined in a YAML format, named after the module they are defined by. Such as menu_ui.links.action.yml for this example from menu_ui module: menu_ui.link_add:   route_name: menu_ui.link_add   title: 'Add link'   appears_on:     - menu_ui.menu_edit Here, menu_ui.link_add: It is the Unique name of the link action Most likely start with module name, route_name : Name of the route it means when click the link it redirect to this route, appears_on :  An array of route names for this action to be display on. Now how to know the Route name of any internal/external admin pages like below, By through the drupal console we achieve it, drupal debug:router...

Cache In Drupal

Drupal 8 core caching modules: The Internal Page Cache module: this caches pages for anonymous users in the database. Pages requested by anonymous users are stored the first time they are requested and then are reused for future visitors. The Internal Dynamic Page Cache module: This is a key feature that Drupal 7 did not have. Unlike the Internal Page module, the Dynamic Page module aims to speed up the site for both anonymous and logged-in users. How Cache Works in Drupal: There are two modules available in the drupal core 1 - Internal page cache: The Internal Page Cache module caches pages for anonymous users in the database. Pages requested by anonymous users are stored the first time they are requested and then are reused. Configuring the internal page cache :   From the performance page we can set the maximum time how long browsers and proxies may cache pages based on the Cache-Control header. 2 - Internal dynamic page cache: Drupal 8 provides the Dynamic Page Cache m...