ns3777k/hoverfly

v2.0.0 2023-02-19 16:32 UTC

Requires

• php: >=8.0
• ext-json: *
• guzzlehttp/guzzle: ^7.0
• netresearch/jsonmapper: ^4.1.0

Requires (Dev)

• friendsofphp/php-cs-fixer: ^3.14
• phpunit/phpunit: ^9.5

MIT

• Nikita Safonov

README

PHP Client for hoverfly based on java version.

Why I would use it for?

Consider having a functional test that sends a request to the application. While handling the request application can use multiple external services like forecast, billing or booking system. We don't wanna test external services because they are not stable, require an internet connection, can limit request rate per second and add delay. During the test we just want something to respond to our requests according to the specification, it does not have to be a real service and that's where hoverfly and this client come in.

Installation

$ composer require --dev ns3777k/hoverfly

Example

Your tests have to be configured to use hoverfly proxy server (use HTTP_PROXY) and ignore proxy for itself (use NO_PROXY).

<?php

require_once __DIR__ . '/vendor/autoload.php';

use Hoverfly\Client;
use Hoverfly\Model\Response;

class SomeTest
{
    private $hoverfly;

    public function __construct()
    {
        $this->hoverfly = new Client(['base_uri' => getenv('HOVERFLY_URL')]);
    }

    public function _before()
    {
        $this->hoverfly->deleteJournal();
        $this->hoverfly->deleteSimulation();
    }

    public function testFeature(ApiTester $I)
    {
        $this->hoverfly->simulate(
            $this->hoverfly->buildSimulation()
                ->serviceExact('test.ru')
                ->getExact('/test')
                ->withState('customer', 'individual')
                ->willReturn(
                    Response::json(['test' => true])
                        ->setDelay(3000)
                        ->addTransitionsState('step', 'order')
                        ->addTransitionsState('customer', 'individual')
                        ->addRemovesState('basket')
                )
        );

        $I->sendPOST('/api/v1/faq/9999999/dislike', ['comment' => 'test']);
    }
}