mroca/request-log-bundle

An HTTP requests mock generator symfony bundle.

MrocaRequestLogBundle

An HTTP requests mock generator symfony bundle., _(*1)

, _(*2)

Description

This bundle allows to log HTTP requests and associated responses as json files. This generated json files can be used as API mock in order to test a front app without running the api., _(*3)

How it works ?

After each request (Kernel::TERMINATE event) containing the x-generate-response-mock header, a json file is created containing the request and the response., _(*4)

Examples :, _(*5)

GET /categories, _(*6)

app/log/mocks/categories/GET__.json, _(*7)

{
    "request": {
        "uri": "/categories",
        "method": "GET",
        "parameters": [],
        "content": ""
    },
    "response": {
        "statusCode": 200,
        "contentType": "application/json",
        "content": {
            "@context": "/contexts/Category",
            "@id": "/categories",
            "hydra:member": [
                {"name": "foo"},
                {"name": "bar"}
            ]
        }
    }
}

PUT /categories/1 {"foo": "bar"}, _(*8)

app/log/mocks/categories/PUT__1-a5e74.json, _(*9)

{
    "request": {
        "uri": "/categories/1",
        "method": "PUT",
        "parameters": [],
        "content": {
            "foo": "bar"
        }
    },
    "response": {
        "statusCode": 204,
        "contentType": "application/json",
        "content": ""
    }
}

File naming strategy, _(*10)

All files are created with the following convention :, _(*11)

uri/METHOD__segments{--sorted-query=string&others}{__<sha1_substr5(sortedJsonContent)>}{__<sha1_substr5(sortedPostParameters)>}.json, _(*12)

Examples :, _(*13)

The filenames query strings can be hashed by setting the `hash_query_params` option to `true`.
For example, `categories/GET__--order[bar]=desc&order[foo]=asc.json` will be `categories/GET__--b0324.json`

The filenames query strings with non-asssocitive arrays are not indexed by default : `?foo[]=bar`.
You can use the indexed format by setting the `use_indexed_associative_array` option to `true` : `?foo[0]=bar`.

See the ResponseLoggerTest file for more examples., _(*14)

Installation

You can use Composer to install the bundle to your project as a dev dependency :, _(*15)

composer require --dev mroca/request-log-bundle

Then, enable the bundle by updating your app/config/AppKernel.php file to enable the bundle:, _(*16)

<?php
// app/config/AppKernel.php

public function registerBundles()
{
    //...
    if (in_array($this->getEnvironment(), ['dev', 'test'])) {
        //...
        $bundles[] = new Mroca\RequestLogBundle\RequestLogBundle();
    }

    return $bundles;
}

If necessary, configure the bundle to your needs (example with default values):, _(*17)

# app/config/config_dev.yml

mroca_request_log:
    mocks_dir: %kernel.logs_dir%/mocks/
    hash_query_params: false
    use_indexed_associative_array: false

If your are using the NelmioCorsBundle or another CORS protection, you must add the header in the allowed ones :, _(*18)

nelmio_cors:
    defaults:
        allow_headers: ['x-generate-response-mock']

Usage

The request & response logger is not always activated. To log a request, add the x-generate-response-mock header into your request :, _(*19)

GET /categories HTTP/1.1
Host: api.my.domain
x-generate-response-mock: true

Commands

Some useful commands are available to manager your mocks :, _(*20)

Clear all mocks

app/console mroca:request-log:clear 

Save mocks in a target directory

app/console mroca:request-log:dump /tmp/mocksdirtarget

Dev

composer install

Php-cs-fixer, _(*21)

vendor/bin/php-cs-fixer fix

Testing, _(*22)

vendor/bin/phpunit

TODO

• A Guzzle client using this files for functionnals tests
• A Protractor client using this files for AngularJS e2e tests