Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/petrkotek/phpunit-naughtytestdetector
"Naughty test detector" for PHPUnit. Identifies tests, which don't clean after themselves.
https://github.com/petrkotek/phpunit-naughtytestdetector
listener php phpunit testing
Last synced: 2 months ago
JSON representation
"Naughty test detector" for PHPUnit. Identifies tests, which don't clean after themselves.
- Host: GitHub
- URL: https://github.com/petrkotek/phpunit-naughtytestdetector
- Owner: petrkotek
- License: apache-2.0
- Created: 2016-10-13T06:44:13.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-08-22T10:43:31.000Z (over 3 years ago)
- Last Synced: 2024-09-28T03:56:23.506Z (4 months ago)
- Topics: listener, php, phpunit, testing
- Language: PHP
- Homepage:
- Size: 44.9 KB
- Stars: 3
- Watchers: 2
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# phpunit-naughtytestdetector
[](https://travis-ci.org/petrkotek/phpunit-naughtytestdetector)
[](https://coveralls.io/github/petrkotek/phpunit-naughtytestdetector?branch=master)
"Naughty test detector" for PHPUnit. Identifies tests leaving garbage after themselves.
Many of us have been there - your integration test works in isolation, but breaks when running in a sequence of tests.
This can be very difficult to troubleshoot, but luckily `phpunit-naughtytestdetector` is here to help.
## Requirements
- PHPUnit 6.0+
- Supported PHP versions: 7.0 and 7.1
Note: for older PHPUnit or PHP 5.6, use `v0.2.0`.
## Installation
NaughtyTestDetector is installable via [Composer](http://getcomposer.org) and should be added as a `require-dev` dependency:
composer require --dev petrkotek/phpunit-naughtytestdetector
## Usage
#### 1. Enable `NaughtyTestListener` by adding the following to your test suite's `phpunit.xml` file:
```xml
...
MyProject\TestUtils\MyMetricFetcher
hello world
false
true
false
```
#### 2. Implement the `MetricFetcher` interface, e.g.:
```php
namespace MyProject\TestUtils\MyMetricFetcher;
use PetrKotek\NaughtyTestDetector\MetricFetcher;
class MyMetricFetcher implements MetricFetcher
{
private $db;
public function __construct()
{
$this->db = mysqli_connect("127.0.0.1", "my_user", "my_password", "my_db");
}
/**
* @return array
*/
public function fetchMetrics()
{
$result = mysqli_query($this->db, 'SELECT COUNT * FROM my_table');
$row = mysqli_fetch_row($result);
return ['records' => $row[0];
}
}
```
Tip: You can also use built-in metric fetcher, e.g. `PetrKotek\NaughtyTestDetector\MetricFetchers\GlobalsMetricFetcher`.
#### 3. Run your test suite.
E.g. `phpunit --configuration integration.xml`
`NaughtyTestListener` will fetch metrics before & after each TestSuite (aka "test class") and if there is a difference
between before & after, it prints out like message like this:
```
MyProject\Integration\MyNamespace\BadTest is naughty!
- my_table: 0 -> 5 (+5)
```
This means, that before the test, there was `0` records in the `my_table` and after executing all the tests, there were
`5` records.
Note: If you want to temporarily disable Naughty Test Detector, use `DISABLE_NAUGHTY_TEST_DETECTOR` enviromental variable, e.g. `DISABLE_NAUGHTY_TEST_DETECTOR=1 phpunit --configuration integration.xml`.