Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sanmai/phpunit-legacy-adapter
PHPUnit Legacy Versions Adapter
https://github.com/sanmai/phpunit-legacy-adapter
phpunit phpunit-legacy-adapter
Last synced: 2 months ago
JSON representation
PHPUnit Legacy Versions Adapter
- Host: GitHub
- URL: https://github.com/sanmai/phpunit-legacy-adapter
- Owner: sanmai
- License: apache-2.0
- Created: 2020-08-22T02:23:51.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-05-07T14:00:05.000Z (over 1 year ago)
- Last Synced: 2024-09-20T12:37:55.857Z (3 months ago)
- Topics: phpunit, phpunit-legacy-adapter
- Language: PHP
- Homepage:
- Size: 92.8 KB
- Stars: 3
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
## PHPUnit Legacy Versions Adapter
As you're here, you are probably well aware that PHPUnit 8+ requires [common template methods](https://phpunit.readthedocs.io/en/latest/fixtures.html)
like `setUp()` or `tearDown()` to have a `void` return type declaration, which methods naturally break anything below PHP 7.1.
Although it is not a big deal to automatically update your code to use these return type declaration with help from the likes of [PHP-CS-Fixer](https://github.com/FriendsOfPHP/PHP-CS-Fixer) or [Rector](https://github.com/rectorphp/rector/blob/master/docs/rector_rules_overview.md#phpunit),
it might become a problem if, for whatever unfortunate (but, hopefully, lucrative) reasons, you have to ensure your code is working under PHP 7.0 or PHP 5.6, all the
while wanting using the best world can give you in the more-less recent versions of PHPUnit.
In this case, you'll have two problems. One, newer versions of PHPUnit [do not have old assertions](https://thephp.cc/news/2019/02/help-my-tests-stopped-working), but you can find a way around this, and another,
as mentioned, newer versions of PHPUnit require `void` return type declarations for the convenient template methods, and then you're stuck because
rewriting tests to work without these template methods is a major pain and might be impossible even. And then this small library comes to save your day!
```
composer require --dev sanmai/phpunit-legacy-adapter:"^6.4 || ^8.2.1"
```
### How to use
First, update your tests to extend from `\LegacyPHPUnit\TestCase` instead of `\PHPUnit\Framework\TestCase`:
```diff
- class MyTest extends \PHPUnit\Framework\TestCase
+ class MyTest extends \LegacyPHPUnit\TestCase
```
Then, where you had to use `setUp(): void` template method, use `doSetUp()` method, omitting all any any return types in a fully backward-compatible way.
```diff
- protected function setUp(): void
+ protected function doSetUp()
```
There are similar replacements for most other template method:
```diff
- public static function setUpBeforeClass(): void
+ public static function doSetUpBeforeClass()
```
```diff
- public static function tearDownAfterClass(): void
+ public static function doTearDownAfterClass()
```
```diff
- protected function setUp(): void
+ protected function doSetUp()
```
```diff
- protected function tearDown(): void
+ protected function doTearDown()
```
```diff
- protected function assertPreConditions(): void
+ protected function doAssertPreConditions()
```
```diff
- protected function assertPostConditions(): void
+ protected function doAssertPostConditions()
```
### Reference
| Method | Replacement |
| ----------- | ----------------------------- |
| `setUpBeforeClass(): void` | `doSetUpBeforeClass()` |
| `tearDownAfterClass(): void` | `doTearDownAfterClass()` |
| `setUp(): void` | `doSetUp()` |
| `tearDown(): void` | `doTearDown()` |
| `assertPreConditions(): void` | `doAssertPreConditions()` |
| `assertPostConditions(): void` | `doAssertPostConditions()` |
### Supported versions
- 6.x version branch supports [PHPUnit 4](https://phpunit.de/getting-started/phpunit-4.html), [PHPUnit 5](https://phpunit.de/getting-started/phpunit-5.html), and [PHPUnit 6](https://phpunit.de/getting-started/phpunit-6.html).
- It was tested to work under PHP 5.3 - PHP 7.4.
- 
- 8.x version branch supports [PHPUnit 7](https://phpunit.de/getting-started/phpunit-7.html), [PHPUnit 8](https://phpunit.de/getting-started/phpunit-8.html), and [PHPUnit 9](https://phpunit.de/getting-started/phpunit-9.html).
- It was tested to work under PHP 7.1 - PHP 8.1.
- 
Future versions will likely follow the same pattern.
### What this library does not do
Although this library solves the most annoying part of the problem, there are other parts the library was not designed to cover. For example:
- Some versions of PHPUnit allow `assertContains` to be used with strings, while other do not.
- In some versions one method is called `expectExceptionMessageRegExp`, while in others the same method is called `expectExceptionMessageMatches`.
- And so on and on.
There are polyfills for these changed methods (see below), but it should not be a big deal to write an ad hoc polyfill just for the methods you need. E.g.:
```php
public function __call($method, $args)
{
if ($method === 'assertStringContainsString') {
$this->assertContains(...$args);
}
if ($method === 'assertIsBool') {
$this->assertTrue(\is_bool($args[0]));
}
if ($method === 'expectExceptionMessageRegExp') {
$this->expectExceptionMessageMatches(...$args);
}
throw new \InvalidArgumentException();
}
```
If there are several modular (and not) multi-version polyfills for these, and other methods:
- One of the most used is one that comes with [Symfony's PHPUnit Bridge](https://github.com/symfony/phpunit-bridge). You can [check the source here](https://github.com/symfony/phpunit-bridge/tree/5.x/Legacy). Note that [it does not support inheritance](https://github.com/symfony/symfony/pull/35311) (you'll have to import the trait into every class).
- There's [`yoast/phpunit-polyfills`](https://github.com/Yoast/PHPUnit-Polyfills/).
- There's [`phpunitgoodpractices/polyfill`](https://github.com/PHPUnitGoodPractices/polyfill).