https://github.com/atoum/deprecated-extension
atoum extension to avoid failures on deprecated errors
https://github.com/atoum/deprecated-extension
Last synced: 19 days ago
JSON representation
atoum extension to avoid failures on deprecated errors
- Host: GitHub
- URL: https://github.com/atoum/deprecated-extension
- Owner: atoum
- License: mit
- Created: 2015-12-22T13:18:06.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-12-10T13:17:55.000Z (over 6 years ago)
- Last Synced: 2025-03-24T16:46:03.643Z (about 1 month ago)
- Language: PHP
- Size: 173 KB
- Stars: 1
- Watchers: 6
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# atoum/deprecated-extension [](https://travis-ci.org/atoum/deprecated-extension)
This extension allows you to avoid having `E_USER_DEPRECATED` errors treated errors, and display the list of deprecated calls at the end of the tests.
When your library uses the `trigger_error` function to indicate that the method is deprecated, or when you use a class that does that in your test, you may not want to see your tests fail. This extension will allow to have your atoum's test pass event if you have deprecated calls, so will be able to migrate the deprecated calls at your own pace.
## Example
Let's take this example :
```php
bar instead', E_USER_DEPRECATED);
return "foo";
}
}
}
namespace fooNs\tests\units
{
use mageekguy\atoum;
class foo extends atoum\test
{
public function testFoo()
{
$this
->if($testedClass = new \fooNs\foo)
->then
->string($testedClass->foo())
->isEqualTo('foo')
;
}
}
}
```
Without the extension the test fails, and we get an output like this :
With the extention the test pass, and the deprecated call is displayed at the end of the test.
## Install it
Install extension using [composer](https://getcomposer.org):
```
composer require --dev atoum/deprecated-extension
```
The extension will be automatically loaded. If you ever want to unload it, you can add this to your configuration file:
```php
removeExtension(deprecated\extension::class);
```
## Other examples
### Tests on the error
You can still use the atoum's error asserter. But beware, the tested error will not be displayed in the report at the end of the output. For example :
```php
public function testError()
{
$this
->if($testedClass = new \fooNs\foo)
->then
->string($testedClass->foo())
->error("Deprecated since 2.0. use ->bar instead", E_USER_DEPRECATED)->exists()
;
}
```
## Links
* [atoum](http://atoum.org)
* [atoum's documentation](http://docs.atoum.org)
## License
deprecated-extension is released under the MIT License. See the bundled LICENSE file for details.
