blastcloud/guzzler

Supercharge your app or SDK with a testing library specifically for Guzzle.

2.0.2 2022-01-18 05:32 UTC

This package is auto-updated.

Last update: 2022-07-18 06:41:30 UTC


README

Guzzler-logo.svg

68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f626c617374636c6f75642f67757a7a6c65722f72756e2d74657374733f6c6162656c3d7465737473 68747470733a2f2f706f7365722e707567782e6f72672f626c617374636c6f75642f67757a7a6c65722f762f737461626c65 68747470733a2f2f706f7365722e707567782e6f72672f626c617374636c6f75642f67757a7a6c65722f646f776e6c6f616473 68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f30316336663636656161356462303265353431312f6d61696e7461696e6162696c697479 68747470733a2f2f706f7365722e707567782e6f72672f626c617374636c6f75642f67757a7a6c65722f6c6963656e7365

Full Documentation at guzzler.dev

Supercharge your app or SDK with a testing library specifically for Guzzle. Guzzler covers the process of setting up a mock handler, recording history of requests, and provides several convenience methods for creating expectations and assertions on that history.

Installation

composer require --dev --prefer-dist blastcloud/guzzler

Example Usage

<?php

use BlastCloud\Guzzler\UsesGuzzler;
use GuzzleHttp\Client;

class SomeTest extends TestCase
{
    use UsesGuzzler;

    public $classToTest;

    public function setUp(): void
    {
        parent::setUp();
    
        $client = $this->guzzler->getClient([
            /* Any configs for a client */
            "base_uri" => "https://example.com/api"
        ]);
        
        // You can then inject this client object into your code or IOC container.
        $this->classToTest = new ClassToTest($client);
    }

    public function testSomethingWithExpectations()
    {
        $this->guzzler->expects($this->once())
            ->post("/some-url")
            ->withHeader("X-Authorization", "some-key")
            ->willRespond(new Response(201));
    
        $this->classToTest->someMethod();
    }

    public function testSomethingWithAssertions()
    {
        $this->guzzler->queueResponse(
            new Response(204),
            new \Exception("Some message"),
            // any needed responses to return from the client.
        );
    
        $this->classToTest->someMethod();
        // ... Some other number of calls
    
        $this->guzzler->assertAll(function ($expect) {
            return $expect->withHeader("Authorization", "some-key");
        });
    }
}

Documentation

Full Documentation

License

Guzzler is open-source software licensed under the MIT License.