guzzle mock handler Télécharger - guzzle mock handler Téléchargement du code source

Manipulateur de simulation Guzzle

Lors du test d'API tierces, il est souvent difficile de s'en moquer de manière simple et déclarative. Ce paquet vise à simplifier ce processus en fournissant un gestionnaire personnalisé pour guzzle qui a un comportement de type routeur, plutôt que de compter sur les réponses extraites de la pile dans un ordre particulier.

Installation

Vous pouvez installer le package via composer :

composer require tomb1n0/guzzle-mock-handler

Usage

Exemple de base

 use GuzzleHttp  Client ;
use Tomb1n0  GuzzleMockHandler  GuzzleMockHandler ;

// Create a new instance of the mock handler
$ handler = new GuzzleMockHandler ;

// Create a new mock response for '/login', returning ['key' => 'value'] in the body.
// By default responses expect a GET verb, and return a 200 response.
$ loginResponse = ( new GuzzleMockResponse ( ' /login ' ))-> withBody ([
    ' key ' => ' value '
]);

// Tell the handler that we're expecting this response
$ handler -> expect ( $ loginResponse );

// Create a new Guzzle Handlerstack, passing in our custom handler
$ stack = HandlerStack :: create ( $ handler );

// Finally, create the guzzle client, passing our stack in
$ guzzle = new Client ([ ' handler ' => $ stack ]);

$ response = $ guzzle -> get ( ' /login ' );

// A normal guzzle response object
$ response -> getStatusCode (); // == 200
json_decode (( string ) $ response -> getBody ()); // == ['key' => 'value']

Demander une assertion

Parfois, il est utile d'effectuer des assertions sur la requête qui a renvoyé votre réponse. Peut-être avez-vous une classe qui se connecte à une API tierce et vous souhaitez affirmer que le nom d'utilisateur et le mot de passe ont été envoyés correctement.

 $ handler = new GuzzleMockHandler ;
$ loginResponse = ( new GuzzleMockResponse ( ' /login ' ))
    -> withMethod ( ' post ' )
    -> assertRequestJson ([
        ' username ' => ' tomb1n0 ' ,
        ' password ' => ' correct-horse-battery-staple '
    ]);
    // NOTE: If you only care about the username in this case, you can pass in a key as the second parameter to assertRequestJson like so:
    /**
     * ->assertRequestJson('tomb1n0, 'username');
     **/

$ handler -> expect ( $ loginResponse );

$ stack = HandlerStack :: create ( $ handler );
$ guzzle = new Client ([ ' handler ' => $ stack ]);

// Just before the response is actually sent back to guzzle, our handler will assert the request JSON is corect.
$ response = $ guzzle -> post ( ' /login ' , [
    ' json ' => [
        ' username ' => ' tomb1n0 ' ,
        ' password ' => ' correct-horse-battery-staple '
    ]
]);

Remarque : Vous pouvez également effectuer exactement les mêmes assertions en utilisant ->assertRequestHeaders() , cela vous permettra de vous assurer que les requêtes API contiennent un en-tête X-API-KEY ou similaire.

Assertions personnalisées

L'affirmation du corps ou des en-têtes peut ne pas suffire, nous vous permettons donc d'appeler ->withAssertion() , en vous transmettant les objets de requête et de réponse, afin que vous puissiez effectuer vos propres assertions :

 $ handler = new GuzzleMockHandler ;
$ loginResponse = ( new GuzzleMockResponse ( ' /login ' ))
    -> withMethod ( ' post ' )
    // if you want to perform multiple assertions, you can call -> withAssertion multiple times.
    -> withAssertion ( function ( RequestInterface $ request , ResponseInterface $ response ) {
        $ this -> assertEquals ( ' super-secure-key ' , $ request -> getHeader ( ' X-API-KEY ' ));
    });

$ handler -> expect ( $ loginResponse );

$ stack = HandlerStack :: create ( $ handler );
$ guzzle = new Client ([ ' handler ' => $ stack ]);

$ guzzle -> post ( ' /login ' );

Affirmation de l'ordre

Il est parfois utile d'affirmer que les appels d'API ont été effectués dans le bon ordre. Peut-être que vous devez appeler /login avant de récupérer /users par exemple. Ceci est réalisé en donnant un nom à vos réponses, puis en affirmant l'ordre une fois vos appels effectués.

 $ handler = new GuzzleMockHandler ;
$ loginResponse = ( new GuzzleMockResponse ( ' /login ' ))-> withMethod ( ' post ' );
$ usersResponse = new GuzzleMockResponse ( ' /users ' );

$ handler -> expect ( $ loginResponse , ' login-response ' );
$ handler -> expect ( $ usersResponse , ' users-response ' );

$ stack = HandlerStack :: create ( $ handler );
$ guzzle = new Client ([ ' handler ' => $ stack ]);

$ guzzle -> post ( ' /login ' );
$ guzzle -> get ( ' /users ' );

// Performs a assertsEquals behind the scenes, as the handler keeps track of the order calls were made in.
$ handler -> assertCalledOrder ([
    ' login-response ' , ' users-response '
]);

Autoriser uniquement l'appel des réponses une seule fois

Parfois, vous souhaiterez peut-être autoriser l'appel d'un point de terminaison une seule fois dans vos tests - cela peut être réalisé en appelant ->once() sur votre objet de réponse.

 $ handler = new GuzzleMockHandler ;
$ loginResponse = ( new GuzzleMockResponse ( ' /login ' ))
    -> withMethod ( ' post ' )
    -> once ();

$ handler -> expect ( $ loginResponse );

$ stack = HandlerStack :: create ( $ handler );
$ guzzle = new Client ([ ' handler ' => $ stack ]);

$ response = $ guzzle -> post ( ' /login ' ); // successfull

$ response = $ guzzle -> post ( ' /login ' ); // ResponseNotFound exception is thrown, "No response set for post => /login"