Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xepozz/internal-mocker
A tool for mocking internal php functions and classes
https://github.com/xepozz/internal-mocker
codeception mock php phpunit testing
Last synced: 4 days ago
JSON representation
A tool for mocking internal php functions and classes
- Host: GitHub
- URL: https://github.com/xepozz/internal-mocker
- Owner: xepozz
- Created: 2022-04-15T05:01:54.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T08:04:20.000Z (9 months ago)
- Last Synced: 2024-11-14T21:42:24.029Z (6 days ago)
- Topics: codeception, mock, php, phpunit, testing
- Language: PHP
- Homepage:
- Size: 135 KB
- Stars: 30
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Introduction
The package helps mock internal php functions as simple as possible. Use this package when you need mock such
functions as: `time()`, `str_contains()`, `rand`, etc.
[](https://packagist.org/packages/xepozz/internal-mocker)
[](https://packagist.org/packages/xepozz/internal-mocker)
[](https://github.com/xepozz/internal-mocker/actions)
# Table of contents
- [Installation](#installation)
- [Usage](#usage)
- [Register a PHPUnit Extension](#register-a-phpunit-extension)
- [PHPUnit 9](#phpunit-9)
- [PHPUnit 10 and higher](#phpunit-10-and-higher)
- [Register mocks](#register-mocks)
- [Runtime mocks](#runtime-mocks)
- [Pre-defined mock](#pre-defined-mock)
- [Mix of two previous ways](#mix-of-two-previous-ways)
- [State](#state)
- [Tracking calls](#tracking-calls)
- [Global namespaced functions](#global-namespaced-functions)
- [Internal functions](#internal-functions)
- [Internal function implementation](#internal-function-implementation)
- [Restrictions](#restrictions)
- [Data Providers](#data-providers)
## Installation
```bash
composer require xepozz/internal-mocker --dev
```
## Usage
The main idea is pretty simple: register a Listener for PHPUnit and call the Mocker extension first.
### Register a PHPUnit Extension
#### PHPUnit 9
1. Create new file `tests/MockerExtension.php`
2. Paste the following code into the created file:
```php
load($mocks);
MockerState::saveState();
}
public function executeBeforeTest(string $test): void
{
MockerState::resetState();
}
}
```
3. Register the hook as extension in `phpunit.xml.dist`
```xml
```
#### PHPUnit 10 and higher
1. Create new file `tests/MockerExtension.php`
2. Paste the following code into the created file:
```php
registerSubscribers(
new class () implements StartedSubscriber {
public function notify(Started $event): void
{
MockerExtension::load();
}
},
new class implements PreparationStartedSubscriber {
public function notify(PreparationStarted $event): void
{
MockerState::resetState();
}
},
);
}
public static function load(): void
{
$mocks = [];
$mocker = new Mocker();
$mocker->load($mocks);
MockerState::saveState();
}
}
```
3. Register the hook as extension in `phpunit.xml.dist`
```xml
```
Here you have registered extension that will be called every time when you run `./vendor/bin/phpunit`.
By default, all functions will be generated and saved into `/vendor/bin/xepozz/internal-mocker/data/mocks.php` file.
Override the first argument of the `Mocker` constructor to change the path:
```php
$mocker = new Mocker('/path/to/your/mocks.php');
```
### Register mocks
The package supports a few ways to mock functions:
1. Runtime mocks
2. Pre-defined mocks
3. Mix of two previous ways
#### Runtime mocks
If you want to make your test case to be used with mocked function you should register it before.
Back to the created `MockerExtension::executeBeforeFirstTest` and edit the `$mocks` variable.
```php
$mocks = [
[
'namespace' => 'App\Service',
'name' => 'time',
],
];
```
This mock will proxy every call of `time()` under the namespace `App\Service` through a generated wrapper.
When you want to mock result in tests you should write the following code into needed test case:
```php
MockerState::addCondition(
'App\Service', // namespace
'time', // function name
[], // arguments
100 // result
);
```
You may also use a callback to set the result of the function:
```php
MockerState::addCondition(
'', // namespace
'headers_sent', // function name
[null, null], // both arguments are references and they are not initialized yet on the function call
fn (&$file, &$line) => $file = $line = 123, // callback result
);
```
So your test case will look like the following:
```php
assertEquals(100, $service->doSomething());
}
}
```
See full example
in [`\Xepozz\InternalMocker\Tests\Integration\DateTimeTest::testRun2`](tests/Integration/DateTimeTest.php)
#### Pre-defined mock
Pre-defined mocks allow you to mock behaviour globally.
It means that you don't need to write `MockerState::addCondition(...)` into each test case if you want to mock it for
whole project.
> Keep in mind that the same functions from different namespaces are not the same for `Mocker`.
So back to the created `MockerExtension::executeBeforeFirstTest` and edit the `$mocks` variable.
```php
$mocks = [
[
'namespace' => 'App\Service',
'name' => 'time',
'result' => 150,
'arguments' => [],
],
];
```
After this variant each `App\Service\time()` will return `150`.
You can add a lot of mocks. `Mocker` compares the `arguments` values with arguments of calling function and returns
needed result.
#### Mix of two previous ways
Mix means that you can use **_Pre-defined mock_** at first and **_Runtime mock_** after.
### State
If you use `Runtime mock` you may face the problem that after mocking function you still have it mocked in another test
cases.
`MockerState::saveState()` and `MockerState::resetState()` solves this problem.
These methods save "current" state and unload each `Runtime mock` mock that was applied.
Using `MockerState::saveState()` after `Mocker->load($mocks)` saves only **_Pre-defined_** mocks.
### Tracking calls
You may track calls of mocked functions by using `MockerState::getTraces()` method.
```php
$traces = MockerState::getTraces('App\Service', 'time');
```
`$traces` will contain an array of arrays with the following structure:
```php
[
[
'arguments' => [], // arguments of the function
'trace' => [], // the result of debug_backtrace function
'result' => 1708764835, // result of the function
],
// ...
]
```
### Function signature stubs
All internal functions are stubbed to be compatible with the original ones.
It makes the functions use referenced arguments (`&$file`) as the originals do.
They are located in the [`src/stubs.php`](src/stubs.php) file.
If you need to add a new function signature, override the second argument of the `Mocker` constructor:
```php
$mocker = new Mocker(stubPath: '/path/to/your/stubs.php');
```
## Global namespaced functions
### Internal functions
The way you can mock global functions is to disable them
in `php.ini`: https://www.php.net/manual/en/ini.core.php#ini.disable-functions
The best way is to disable them only for tests by running a command with the additional flags:
```bash
php -ddisable_functions=${functions} ./vendor/bin/phpunit
```
> If you are using PHPStorm you may set the command in the `Run/Debug Configurations` section.
> Add the flag `-ddisable_functions=${functions}` to the `Interpreter options` field.
> You may keep the command in the `composer.json` file under the `scripts` section.
```json
{
"scripts": {
"test": "php -ddisable_functions=time,serialize,header,date ./vendor/bin/phpunit"
}
}
```
> Replace `${functions}` with the list of functions that you want to mock, separated by commas, e.g.: `time,rand`.
So now you can mock global functions as well.
#### Internal function implementation
When you disable a function in `php.ini` you cannot call it anymore. That means you must implement it by yourself.
Obviously, almost all functions are implemented in PHP looks the same as the Bash ones.
The shortest way to implement a function is to use ``` `bash command` ``` syntax:
```php
$mocks[] = [
'namespace' => '',
'name' => 'time',
'function' => fn () => `date +%s`,
];
```
> Keep in mind that leaving a global function without implementation will cause a recourse call of the function,
> that will lead to a fatal error.
## Restrictions
### Data Providers
Sometimes you may face unpleasant situation when mocked function is not mocking without forced using `namespace`
+ `function`.
It may mean that you are trying make PHP interpreter file in `@dataProvider`.
Be careful of it and as a workaround I may suggest you to call the mocker in test's constructor.
So first move all code from your extension method `executeBeforeFirstTest` to new static method
and call it in both `executeBeforeFirstTest` and `__construct` methods.
```php
final class MyTest extends \PHPUnit\Framework\TestCase
{
public function __construct(?string $name = null, array $data = [], $dataName = '')
{
\App\Tests\MockerExtension::load();
parent::__construct($name, $data, $dataName);
}
/// ...
}
```
```php
final class MockerExtension implements BeforeTestHook, BeforeFirstTestHook
{
public function executeBeforeFirstTest(): void
{
self::load();
}
public static function load(): void
{
$mocks = [];
$mocker = new Mocker();
$mocker->load($mocks);
MockerState::saveState();
}
public function executeBeforeTest(string $test): void
{
MockerState::resetState();
}
}
```
That all because of PHPUnit 9.5 and lower event management system.
Data Provider functionality starts to work before any events, so it's impossible to mock the function at the beginning
of
the runtime.