Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/alexskrypnyk/testmode
💧 Drupal module used to alter existing site content and other configurations when running tests.
https://github.com/alexskrypnyk/testmode
behat drupal testing
Last synced: about 5 hours ago
JSON representation
💧 Drupal module used to alter existing site content and other configurations when running tests.
- Host: GitHub
- URL: https://github.com/alexskrypnyk/testmode
- Owner: AlexSkrypnyk
- License: gpl-3.0
- Created: 2019-07-12T00:37:59.000Z (over 5 years ago)
- Default Branch: 2.x
- Last Pushed: 2024-11-27T08:40:27.000Z (3 months ago)
- Last Synced: 2025-02-08T00:59:33.143Z (3 days ago)
- Topics: behat, drupal, testing
- Language: PHP
- Homepage: https://www.drupal.org/project/testmode
- Size: 108 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Drupal module to modify existing site content and configurations while running tests.
[](https://github.com/AlexSkrypnyk/testmode/issues)
[](https://github.com/AlexSkrypnyk/testmode/pulls)
[](https://github.com/AlexSkrypnyk/testmode/actions/workflows/test.yml)
---
This is a module to support testing, so it is not expected to be used in production (although, it adheres to Drupal coding standards and has good test coverage).
## Installation
```shell
composer require --dev drupal/testmode
```
## Use case
Running a Behat test on the site with existing content may result in
false-positives because of the live content being mixed with the test content.
Example: list of 3 featured articles. When the test creates 3 articles and makes
them featured, there may be existing featured articles that will confuse tests
resulting in a false-positive failure.
## How it works
1. When writing Behat tests, all test content items (nodes,
terms, users) follow specific pattern. For example, node titles start with
`[TEST] `.
2. A machine name of a view, which needs to be tested, is added to
Testmode configuration form.
3. Behat test tagged with `@testmode` will put
the site in test mode that will filter-out all items in the view that do not
fit the pattern, leaving only content items created by the test.
## Maintenance / Development
Releases in GitHub are automatically pushed to http://drupal.org/project/testmode by CI.
## Issues
https://www.drupal.org/project/issues/testmode
## Local development
Provided that you have PHP installed locally, you can develop an extension using
the provided scripts.
### Build
Run the following commands to start inbuilt PHP
server locally and run the same commands as in CI,
plus installing a site and Testmode automatically.
```shell
./.devtools/assemble.sh
./.devtools/start.sh
./.devtools/provision.sh
```
or `ahoy build` or `make build`.
### Code linting
Run tools individually (or `ahoy lint` to run all tools
if [Ahoy](https://github.com/ahoy-cli/ahoy) is installed or `make lint`) to lint your code
according to
the [Drupal coding standards](https://www.drupal.org/docs/develop/standards).
```
cd build
vendor/bin/phpcs
vendor/bin/phpstan
vendor/bin/rector --clear-cache --dry-run
vendor/bin/phpmd . text phpmd.xml
vendor/bin/twig-cs-fixer
```
- PHPCS config: [`phpcs.xml`](phpcs.xml)
- PHPStan config: [`phpstan.neon`](phpstan.neon)
- PHPMD config: [`phpmd.xml`](phpmd.xml)
- Rector config: [`rector.php`](rector.php)
- Twig CS Fixer config: [`.twig-cs-fixer.php`](.twig-cs-fixer.php)
### Tests
Run tests individually with `cd build && ./vendor/bin/phpunit` (`ahoy test` or `make test`) to run all test for
Testmode.
### Browsing SQLite database
To browse the contents of created SQLite database
(located at `/tmp/site_testmode.sqlite`),
use [DB Browser for SQLite](https://sqlitebrowser.org/).
---
_This repository was created using the [Drupal Extension Scaffold](https://github.com/AlexSkrypnyk/drupal_extension_scaffold) project template_