Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/persata/symfonyapiextension
Provides functionality for testing Symfony APIs with Behat.
https://github.com/persata/symfonyapiextension
api behat behat-extension symfony
Last synced: about 2 months ago
JSON representation
Provides functionality for testing Symfony APIs with Behat.
- Host: GitHub
- URL: https://github.com/persata/symfonyapiextension
- Owner: Persata
- License: mit
- Created: 2017-09-28T02:45:19.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2019-10-16T09:30:29.000Z (over 5 years ago)
- Last Synced: 2024-11-18T09:54:02.927Z (2 months ago)
- Topics: api, behat, behat-extension, symfony
- Language: PHP
- Size: 37.1 KB
- Stars: 1
- Watchers: 4
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Symfony API Extension [](https://packagist.org/packages/persata/symfony-api-extension) [](https://packagist.org/packages/persata/symfony-api-extension) [](https://travis-ci.org/Persata/SymfonyApiExtension)
Provides functionality for testing Symfony APIs with Behat.
This package offers an `ApiClient` class that can be shared between all relevant contexts that require being able to modify the request or inspect the response.
Requires the FriendsOfBehat [SymfonyExtension](https://github.com/FriendsOfBehat/SymfonyExtension).
## Usage
1. Install via Composer:
```bash
$ composer require persata/symfony-api-extension --dev
```
2. Enable and configure in your Behat configuration:
```yaml
# behat.yml
default:
suites:
default:
contexts:
- Persata\SymfonyApiExtension\Context\ApiContext: ~
extensions:
Persata\SymfonyApiExtension: ~
FriendsOfBehat\SymfonyExtension:
kernel:
bootstrap: vendor/autoload.php
```
## Additional Custom Contexts
This package provides a `ContextInitializer` that will set the shared `ApiClient` on any Behat Contexts that implement the `ApiClientAwareContext`. It is best to extend the `RawApiContext` as this already includes the getter & setter for the `ApiClient` instance.
## ContextServiceExtension Integration
If using the FriendsOfBehat [ContextServiceExtension](https://github.com/FriendsOfBehat/ContextServiceExtension), declare the `ApiContext` service like so:
```yaml
services:
# ...
Persata\SymfonyApiExtension\Context\ApiContext:
tags:
- { name: fob.context_service }
```
If you need additional context services with access to the same shared ApiClient instance, have them extend `RawApiContext` and then declare the service like so:
```yaml
services:
# ...
TheClass\Of\Your\CustomContext:
tags:
- { name: fob.context_service }
```
## FOSRest Form Validation
If you are using the FOSRestBundle within your Symfony application and are making use of the [form response features](https://symfony.com/doc/master/bundles/FOSRestBundle/2-the-view-layer.html#forms-and-views), there is an additional `FOSRestFormValidationContext` class provided for testing for the presence or omission of errors:
```gherkin
Then the JSON response should have the error "This value should not be null." at "user.firstName"
And the JSON response should not have any errors on "user.lastName"
```
## Example Scenario
```gherkin
Scenario: Testing Basic JSON Endpoint
Given the "Authorization" request header is "Bearer MyToken"
When the request is sent using GET to "/example-endpoint"
Then the response status code should be 200
And the response content type should be JSON
And the response content should be valid JSON
And the JSON response should be
"""
{
"hello": "world"
}
"""
And the JSON response should have the structure
"""
[
"hello"
]
"""
```
## Extension Configuration
```yaml
# behat.yml
default:
extensions:
Persata\SymfonyApiExtension:
base_url: 'http://my-api.local' # Base URL used for requests sent to the Symfony kernel. Defaults to null.
files_path: "%paths.base%/src/Behat/Resources/fixtures/" # Base directory of files to be used for upload tests. Defaults to null.
```