Behat HTTP Mock Context

https://github.com/macpaw/behat-http-mock-context
Admin
Behat HTTP Mock Context is a Behat extension that provides tools to mock HTTP client responses for...
Tokens:4,496
Snippets:44
Trust Score:9.8
License:MIT
Update:9 months ago
Show doc for...
Tokens:
Raw
### Install Behat HTTP Mock Context using Composer

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Instructions for installing the Behat HTTP Mock Context bundle using Composer. This command requires Composer to be installed globally.

```bash
composer require --dev macpaw/behat-http-mock-context
```

--------------------------------

### Configure Mock HTTP Client in services_test.yaml

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Example configuration for mocking an HTTP client using `ExtendedMockHttpClient` in `config/services_test.yaml`. This replaces the default client with a mockable version tagged for mocking.

```yaml
    oauth_http_client:
        class: ExtendedMockHttpClient\ExtendedMockHttpClient
        arguments:
            - '%env(OAUTH_URL)%'
        tags: ['mock.http_client']
...

```

--------------------------------

### Use Mock Context Step Definition in Behat

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Example of a Behat step definition using the `MockContext` to define a mock HTTP response. This allows you to specify the status code and response body for a given HTTP client.

```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200 with body:
    """
    {
        "success": true,
        "response": {
            "user_id": 234
        }
    }
    """

```

--------------------------------

### Configure Behat Context for HTTP Mocking

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Configures Behat to include the HttpMockContext for test suites. This example shows basic integration and an example with multiple suites.

```yaml
# behat.yml
default:
    suites:
        default:
            contexts:
                - BehatHttpMockContext\Context\HttpMockContext
                - App\Tests\Behat\FeatureContext

# behat.yml with multiple suites
default:
    suites:
        api:
            paths: ['%paths.base%/features/api']
            contexts:
                - BehatHttpMockContext\Context\HttpMockContext
                - App\Tests\Behat\ApiContext

        integration:
            paths: ['%paths.base%/features/integration']
            contexts:
                - BehatHttpMockContext\Context\HttpMockContext
                - App\Tests\Behat\IntegrationContext

```

--------------------------------

### Enable Behat HTTP Mock Context Bundle in AppKernel

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Code snippet showing how to enable the BehatHttpMockContextBundle in the `app/AppKernel.php` file for testing environments.

```php
<?php
// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = array(
            // ...
            BehatHttpMockContext\BehatHttpMockContextBundle::class => ['test' => true],
        );

        // ...
    }

    // ...
}

```

--------------------------------

### Mocking API HTTP Client for User Profile

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

This snippet illustrates mocking responses from an API HTTP client for fetching user profiles. It simulates a successful retrieval of user data with a 200 status code and specific user details, including roles. Dependencies include the Behat HTTP Mock Context bundle. Inputs are HTTP client name, URL path, status code, and response body. The output is a simulated HTTP response.

```gherkin
Given I mock "api_http_client" HTTP client url "users/234" response status code should be 200 with body:
    """
    {
        "id": 234,
        "username": "john_doe",
        "email": "john@example.com",
        "roles": ["ROLE_USER", "ROLE_ADMIN"]
    }
    """
When I request user profile for user ID "234"
Then the user should have role "ROLE_ADMIN"
```

--------------------------------

### Configure Behat Context in behat.yml

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Configuration snippet for `behat.yml` to include the `MockContext` from the Behat HTTP Mock Context library. This makes the context's step definitions available in your Behat tests.

```yaml
...
  contexts:
    - BehatHttpMockContext\Context\MockContext
...

```

--------------------------------

### Configure Mock Client Collection in services.yaml

Source: https://github.com/macpaw/behat-http-mock-context/blob/develop/README.md

Configuration for `ExtendedMockHttpClientCollection` which aggregates tagged mock HTTP clients. This is essential for the Behat context to manage the mocked clients.

```yaml
    BehatHttpMockContext\Collection\ExtendedMockHttpClientCollection:
        arguments:
            - !tagged_iterator mock.http_client
...

```

--------------------------------

### Mock HTTP Client Next Response (Status Code and Body)

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Configures a mock HTTP response including both a status code and a JSON body for the next client request. This allows for testing more complex scenarios involving data payloads.

```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200 with body:
    """
    {
        "success": true,
        "response": {
            "user_id": 234,
            "username": "john_doe",
            "email": "john@example.com"
        }
    }
    """

// Example with error response
Given I mock "payment_http_client" HTTP client next response status code should be 400 with body:
    """
    {
        "error": "Invalid payment method",
        "code": "PAYMENT_ERROR"
    }
    """
```

--------------------------------

### Mock HTTP Client Next Response with Status Code and Body

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Define a mock response with both status code and response body for the next HTTP client request.

```APIDOC
## Mock HTTP Client Next Response with Status Code and Body

### Description
Define a mock response with both status code and response body for the next HTTP client request.

### Method
Given

### Endpoint
N/A (Gherkin step)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **status_code** (integer) - Required - The HTTP status code for the mock response.
- **body** (string) - Required - The response body in JSON format.

### Request Example
```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200 with body:
    """
    {
        "success": true,
        "response": {
            "user_id": 234,
            "username": "john_doe",
            "email": "john@example.com"
        }
    }
    """
```

### Response
#### Success Response (200)
N/A (This is a Gherkin step, not an API endpoint)

#### Response Example
N/A
```

--------------------------------

### Mock HTTP Client Next Response (Status Code Only)

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Defines a mock HTTP response with a specified status code for the next request made by a named HTTP client. This is useful for simple checks where only the status code matters.

```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200
```

--------------------------------

### Mocking OAuth HTTP Client Responses

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

This snippet demonstrates how to mock HTTP client responses for OAuth authentication scenarios. It allows simulating successful authentication with a 200 status code and a valid access token, or a failed authentication with a 401 status code and an error message. Dependencies include the Behat HTTP Mock Context bundle. Inputs are HTTP client name, desired status code, and response body. Outputs are simulated HTTP responses.

```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200 with body:
    """
    {
        "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9",
        "token_type": "Bearer",
        "expires_in": 3600,
        "user_id": 234
    }
    """
When I send a POST request to "/api/login" with:
    """
    {
        "username": "test@example.com",
        "password": "secure_password"
    }
    """
Then the response status code should be 200
And the response should contain "access_token"

Given I mock "oauth_http_client" HTTP client next response status code should be 401 with body:
    """
    {
        "error": "invalid_credentials",
        "error_description": "The provided credentials are invalid"
    }
    """
When I send a POST request to "/api/login" with:
    """
    {
        "username": "test@example.com",
        "password": "wrong_password"
    }
    """
Then the response status code should be 401
And the response should contain "invalid_credentials"
```

--------------------------------

### Configure HTTP Client Mocks in Symfony Services (Test Env)

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Configures HTTP client services to use mock implementations in the test environment using Symfony's service container. It specifies the use of ExtendedMockHttpClient and applies relevant tags.

```yaml
# config/services.yaml - Production configuration
services:
    oauth_http_client:
        class: Symfony\Contracts\HttpClient\HttpClientInterface
        factory: ['Symfony\Component\HttpClient\HttpClient', createForBaseUri]
        arguments:
            - '%env(OAUTH_URL)%'

    payment_http_client:
        class: Symfony\Contracts\HttpClient\HttpClientInterface
        factory: ['Symfony\Component\HttpClient\HttpClient', createForBaseUri]
        arguments:
            - '%env(PAYMENT_API_URL)%'

# config/services_test.yaml - Test configuration with mocks
services:
    oauth_http_client:
        class: ExtendedMockHttpClient\ExtendedMockHttpClient
        arguments:
            - '%env(OAUTH_URL)%'
        tags: ['mock.http_client']

    payment_http_client:
        class: ExtendedMockHttpClient\ExtendedMockHttpClient
        arguments:
            - '%env(PAYMENT_API_URL)%'
        tags: ['mock.http_client']

    BehatHttpMockContext\Collection\ExtendedHttpMockClientCollection:
        arguments:
            - !tagged_iterator mock.http_client

```

--------------------------------

### Mock HTTP Client Next Response with Status Code

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Define a mock response with a specific HTTP status code for the next request made by a named HTTP client.

```APIDOC
## Mock HTTP Client Next Response with Status Code

### Description
Define a mock response with a specific HTTP status code for the next request made by a named HTTP client.

### Method
Given

### Endpoint
N/A (Gherkin step)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```gherkin
Given I mock "oauth_http_client" HTTP client next response status code should be 200
```

### Response
#### Success Response (200)
N/A (This is a Gherkin step, not an API endpoint)

#### Response Example
N/A
```

--------------------------------

### Register BehatHttpMockContextBundle in Symfony

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Registers the Behat HTTP Mock Context bundle within a Symfony application's configuration file.

```php
<?php
// config/bundles.php
return [
    // ... other bundles
    BehatHttpMockContext\BehatHttpMockContextBundle::class => ['test' => true],
];

```

--------------------------------

### Mock HTTP Client URL-Specific Response

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Sets up a mock HTTP response for a specific URL endpoint, including custom status code and JSON body. This enables precise mocking for individual API routes.

```gherkin
Given I mock "api_http_client" HTTP client url "users/123" response status code should be 200 with body:
    """
    {
        "id": 123,
        "name": "Jane Smith",
        "role": "admin"
    }
    """

// Example with 404 error
Given I mock "api_http_client" HTTP client url "users/999" response status code should be 404 with body:
    """
    {
        "error": "User not found"
    }
    """
```

--------------------------------

### Mock HTTP Client URL-Specific Response

Source: https://context7.com/macpaw/behat-http-mock-context/llms.txt

Define a mock response for a specific URL endpoint with custom status code and body.

```APIDOC
## Mock HTTP Client URL-Specific Response

### Description
Define a mock response for a specific URL endpoint with custom status code and body.

### Method
Given

### Endpoint
N/A (Gherkin step)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
- **client_name** (string) - Required - The name of the HTTP client to mock.
- **url** (string) - Required - The specific URL endpoint to mock.
- **status_code** (integer) - Required - The HTTP status code for the mock response.
- **body** (string) - Required - The response body in JSON format.

### Request Example
```gherkin
Given I mock "api_http_client" HTTP client url "users/123" response status code should be 200 with body:
    """
    {
        "id": 123,
        "name": "Jane Smith",
        "role": "admin"
    }
    """
```

### Response
#### Success Response (200)
N/A (This is a Gherkin step, not an API endpoint)

#### Response Example
N/A
```
Tokens:
Raw