persata/symfony-api-extension

Provides functionality for testing Symfony APIs with Behat.

Symfony API Extension

Provides functionality for testing Symfony APIs with Behat., _(*1)

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., _(*2)

Requires the FriendsOfBehat SymfonyExtension., _(*3)

Usage

1. Install via Composer:, _(*4)

   $ composer require persata/symfony-api-extension --dev
   

2. Enable and configure in your Behat configuration:, _(*5)

   # 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., _(*6)

ContextServiceExtension Integration

If using the FriendsOfBehat ContextServiceExtension, declare the ApiContext service like so:, _(*7)

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:, _(*8)

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, there is an additional FOSRestFormValidationContext class provided for testing for the presence or omission of errors:, _(*9)

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

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

# 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.