https://github.com/drevops/behat-phpserver
🧪 PHP and API server for Behat tests
https://github.com/drevops/behat-phpserver
api behat behat-context behat-extension php rest test
Last synced: 5 months ago
JSON representation
🧪 PHP and API server for Behat tests
- Host: GitHub
- URL: https://github.com/drevops/behat-phpserver
- Owner: drevops
- License: gpl-3.0
- Created: 2017-01-02T06:51:28.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2025-12-25T02:06:59.000Z (6 months ago)
- Last Synced: 2025-12-30T05:29:55.738Z (6 months ago)
- Topics: api, behat, behat-context, behat-extension, php, rest, test
- Language: PHP
- Homepage:
- Size: 123 KB
- Stars: 3
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
PHP and API server for Behat tests
[](https://github.com/drevops/behat-phpserver/issues)
[](https://github.com/drevops/behat-phpserver/pulls)
[](https://github.com/drevops/behat-phpserver/actions/workflows/test-php.yml)
[](https://codecov.io/gh/drevops/behat-phpserver)
[](https://packagist.org/packages/drevops/behat-phpserver)
## Features
- [`PhpServerContext`](src/DrevOps/BehatPhpServer/ApiServerContext.php) context
to start and stop PHP server:
- Automatically start and stop PHP server for each scenario.
- Serve files from a configurable document root.
- Configurable PHP server protocol, host and port.
- [`ApiServerContext`](src/DrevOps/BehatPhpServer/PhpServerContext.php) context
to serve queued API responses for API mocking:
- A RESTful [API server](apiserver/index.php) used to queue up expected API
responses.
- Step definition to queue up API responses.
- Automatically start and stop PHP server for each scenario.
- Serve files from a configurable document root.
- Configurable PHP server protocol, host and port.
## Installation
composer require --dev drevops/behat-phpserver
## Usage
### `PhpServerContext`
Used to serve assets from a pre-defined document root.
```yaml
default:
suites:
default:
contexts:
- DrevOps\BehatPhpServer\PhpServerContext:
webroot: '%paths.base%/tests/behat/fixtures' # Path to the PHP server document root
protocol: http # PHP server protocol
host: 0.0.0.0 # PHP server host
port: 8888 # PHP server port
debug: false # Enable debug mode for verbose output
```
### `ApiServerContext`
Used to serve a pre-set API responses from a pre-defined document root.
```yaml
default:
suites:
default:
contexts:
- DrevOps\BehatPhpServer\ApiServerContext:
webroot: '%paths.base%/apiserver' # Path to the API server document root
protocol: http # API PHP server protocol
host: 0.0.0.0 # API PHP server host
port: 8889 # API PHP server port
debug: false # API Enable debug mode for verbose output
paths: # Path(s) to fixture files for API responses
- '%paths.base%/tests/behat/fixtures'
- '%paths.base%/tests/behat/fixtures2'
```
API responses can be queued up in the API server server by sending
`PUT` requests to `/admin/responses` as an array of the expected responses
using following JSON format:
```json
[
{
"code": 200,
"reason": "OK",
"headers": {},
"body": ""
},
{
"code": 404,
"reason": "Not found",
"headers": {
},
"body": ""
}
]
```
The `ApiServerContext` provides several step definitions to make it easier to
work with the API server:
```gherkin
# Check if the API server is running.
Given the API server is running
# Queue up a single API response.
Given API will respond with:
"""
{
"code": 200,
"headers": {
"Content-Type": "application/json"
},
"body": {
"Id": "test-id-1",
"Slug": "test-slug-1"
}
}
"""
# Queue up a single API response with minimal configuration.
Given API will respond with:
"""
{
"code": 200
}
"""
# Queue up a single API response with JSON body.
Given API will respond with JSON:
"""
{
"Id": "test-id-1",
"Slug": "test-slug-1"
}
"""
# Queue up a single API response with JSON body and expected code.
Given API will respond with JSON and 201 code:
"""
{
"Id": "test-id-2",
"Slug": "test-slug-2"
}
"""
# Reset the API server by clearing all responses and requests.
Given the API server is reset
# Queue up a file response with automatic content type detection.
Given API will respond with file "test_data.json"
# Queue up a file response with a custom response code.
Given API will respond with file "test_content.xml" and 201 code
# Assert the number of requests received by the API server.
Then the API server should have 3 received requests
# Assert the number of responses queued in the API server.
Then the API server should have 0 queued responses
```
See this [test feature](tests/behat/features/apiserver.feature) for more
examples.
### Using File Responses
The `apiWillRespondWithFile` step definition allows you to respond with the contents of a file
from one of the configured fixture paths. The context will automatically detect the appropriate
content type based on the file extension:
- `.json` → `application/json`
- `.xml` → `application/xml`
- `.html`, `.htm` → `text/html`
- `.txt` → `text/plain`
- All other extensions → `application/octet-stream`
Multiple fixture paths can be configured in the `behat.yml` file. The context will search for the
file in each path in the order specified until it finds a match.
### Resetting the API Server
The `resetApi` step definition allows you to clear all queued responses and request history in the API server.
This is useful for ensuring a clean state between test steps, especially when multiple scenarios
interact with the API server:
```gherkin
# Clear existing state before setting up a new test
Given API server is reset
And API will respond with file "test_data.json"
When I send a GET request to "/"
```
For more information on supported RESTful API endpoints, see
the [API server](apiserver/index.php) implementation.
#### Accessing the API server URL from your contexts
If you need to access the API server URL from your context to update the base
URL of your API client, you can do so by using `beforeScenario` in your
`FeatureContext` class:
```php
getEnvironment();
if (!$environment instanceof InitializedContextEnvironment) {
throw new \Exception('Environment is not initialized');
}
$context = $environment->getContext(PhpServerContext::class);
$this->phpServerUrl = $context->getServerUrl();
$context = $environment->getContext(ApiServerContext::class);
$this->apiServerUrl = $context->getServerUrl();
}
}
```
## Maintenance
### Lint code
```bash
composer lint
composer lint-fix
```
### Run tests
```bash
composer test
composer test-bdd
```
---
_This repository was created using the [Scaffold](https://getscaffold.dev/) project template_