Skip to content
Snippets Groups Projects
README.md 1.48 KiB
Newer Older
Alexey Korepov's avatar
Alexey Korepov committed
# Test Helpers

Alexey Korepov's avatar
Alexey Korepov committed
The module provides the API to simplify writing Drupal Unit tests. Using the
API can significantly reduce the amount of code in your Unit Tests to cover all
the logic of testing functions, using provided stubs of Drupal services.
Alexey Korepov's avatar
Alexey Korepov committed

Basically, the module provides stubs for the most popular Drupal services like
Entity Storage, Entity Query, Database Query, Configuration Factory, and many
others. The stubs can emulate the behavior of the services in Unit Tests without
requiring an initiated Drupal Kernel and database.
Additionally, it provides some utility functions to get private properties and
methods from classes, Plugin Definitions from a YAML file, and many more.

See `\Drupal\test_helpers\UnitTestHelpers` for the main API functions.
See usage examples in the submodule `test_helpers_example`.

For a full description of the module, visit the
[project page](https://www.drupal.org/project/test_helpers).

Submit bug reports and feature suggestions, or track changes in the
[issue queue](https://www.drupal.org/project/issues/test_helpers).


## Requirements

This module does not have any dependency on any other module.


## Installation

Install as you would normally install a contributed Drupal module. For further
information, see
[Installing Drupal Modules](https://www.drupal.org/docs/extending-drupal/installing-drupal-modules).


## Configuration

The module currently provides no configuration options.


## Maintainers

- Alexey Korepov - [Murz](https://www.drupal.org/u/murz)