Download the PHP package eboreum/phpunit-with-consecutive-alternative without Composer
On this page you can find all versions of the php package eboreum/phpunit-with-consecutive-alternative. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download eboreum/phpunit-with-consecutive-alternative
More information about eboreum/phpunit-with-consecutive-alternative
Files in eboreum/phpunit-with-consecutive-alternative
Package phpunit-with-consecutive-alternative
Short Description Do you miss the old "withConsecutive" method in PHPUnit? This library fixes that problem for you.
License MIT
Informations about the package phpunit-with-consecutive-alternative
A sensible alternative to PHPUnit's now removed "withConsecutive" method
Do you miss the old "withConsecutive" method in PHPUnit? This library solves that problem for you.
Installation
Via Composer (https://packagist.org/packages/eboreum/phpunit-with-consecutive-alternative):
composer install eboreum/phpunit-with-consecutive-alternative
Via GitHub:
git clone [email protected]:eboreum/phpunit-with-consecutive-alternative.git
Using this library
Within a test method — i.e. a method inside a child of \PHPUnit\Framework\TestCase
— simply do the following:
Make it easy for yourself
Make your own (abstract) test case class and simply add a proxy method doing the above.
Example:
⚠️ Notice: We do not hook into \PHPUnit\Framework\MockObject\Builder\InvocationMocker
and so — contrary to the original withConsecutive
— we place the above method on \PHPUnit\Framework\TestCase
instead.
- In simpler terms: You call a method on
\PHPUnit\Framework\TestCase
, with the mock as an argument, rather than calling a method on the mock itself. - This change is largely because PHPUnit utilizes the "final" keyword a lot on classes and does not support decorators, making extending (an instance of) InvocationMocker nigh-impossible (unless we do evil class-override things).
Why was "withConsecutive" removed?
You can see some of the reasoning and discussion about it here: https://github.com/sebastianbergmann/phpunit/issues/4026
The main reason @sebastianbergmann decided to remove withConsecutive
(and at
, by the way) was with the argument: Don't mock what you don't own. Sadly, the resource he links to in https://github.com/sebastianbergmann/phpunit/issues/4026 — being https://thephp.cc/news/2021/04/do-not-mock-what-you-do-not-own — is now a 404 page. Sebastian is a fantastic person and I and many others greatly appreciate his work over the years. Truly! However, I for one disagree with the "Don't mock what you don't own" sentiment. If something is part of the public API — third-part or not — one should be able to and allowed to mock it. Period.
No convenient alternative has been provided in PHPUnit itself.
A core problem — fixed
A core problem was the disjointed connection between arguments and their corresponding return values, as they would be provided in separate methods, i.e.:
withConsecutive
willReturnOnConsecutiveCalls
orwillReturn
In order to make this connection abundantly clear, the value-object class \Eboreum\PhpunitWithConsecutiveAlternative\MethodCallExpectation
has been implemented. Within it is stored a return value (required) and 0 or more arguments.
Notice: You may indeed use callbacks (i.e. \PHPUnit\Framework\TestCase->callback(...)
) for the arguments instead of the actual values.
License & Disclaimer
See LICENSE
file. Basically: Use this library at your own risk.
Contributing
We prefer that you create a ticket and or a pull request at https://github.com/eboreum/phpunit-with-consecutive-alternative, and have a discussion about a feature or bug here.
Credits
Authors
- Kasper Søfren (kafoso)
E-mail: https://github.com/kafoso