https://github.com/shockedplot7560/pmmpunit
Integration testing framework for PocketMine-MP
https://github.com/shockedplot7560/pmmpunit
developer-tools development integration-testing pocketmine
Last synced: 3 months ago
JSON representation
Integration testing framework for PocketMine-MP
- Host: GitHub
- URL: https://github.com/shockedplot7560/pmmpunit
- Owner: ShockedPlot7560
- Created: 2023-09-21T19:12:01.000Z (over 1 year ago)
- Default Branch: stable
- Last Pushed: 2024-08-06T08:26:47.000Z (9 months ago)
- Last Synced: 2024-10-29T22:08:16.034Z (6 months ago)
- Topics: developer-tools, development, integration-testing, pocketmine
- Language: PHP
- Homepage:
- Size: 343 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## PmIntegration - Integration Testing Framework for PocketMine
**Run only on Unix (Linux, Mac)**
This plugin has been created with the sole aim of making integration and functional tests possible during the pocketmine runtime.
It can be used to correctly test the expected result of a command executed by a fake player, interaction with events and multi-threading support.
Tests are run asynchronously using promises to enable support with different systems in place. The libraries used for the promises are : [ReactPHP/promise](https://github.com/reactphp/promise)
> [!WARNING]
> This plugin should not be used in production, as it will shutdown the server as soon as testing is complete.
## Installation
Using of official docker image is strongly recommended.
Mount your tests in `/data/plugin_data/PmmpUnit/tests/` and copy your plugin in `/plugins/`.
Exemple:
```bash
docker run -it --rm \
-v /tests/pmmpunit/suitetest/normal/tests:/data/plugin_data/PmmpUnit/tests/ \
# -v /path/to/plugin:/plugins/ \
--name pmunit-test \
ghcr.io/shockedplot7560/pmmpunit/tests-runner:latest
```
> [!NOTE]
> An action to simplify the execution of integration tests in a github workflow should be available soon.
## Utilisation
Tests are retrieved from the folder: `plugin_data/PmmpUnit/tests/` and are executed when the server start.
All test classes must inherit from `ShockedPlot7560\PmmpUnit\framework\TestCase`.
All test methods must be prefixed with `test` and must not have any parameters, it must return a `PromiseInterface`.
If the code is executed synchronously and does not have to wait for a result, use `resolve(null)`.
Use `Deferred` instead for asynchronous code and `$deferred->resolve(null)` to resolve the promise.
Each test class can execute code when the server is `onLoad`, `onEnable` or `onDisable`. Simply use the corresponding classes.
`setUp` and `tearDown` are called when each class test is run, respectively before and after the test, whatever the result.
> For exemple tests, look at `tests/pmmpunit/suitetest/*/tests`
### TestPlayer utilisation
To retrieve one player during a test, call ``getPlayer()``.
To test player commands or behavior, create your promise/listener before executing the action. Return the promise in the test method.