Descarga guzzle mock handler - Descarga del código fuente guzzle mock handler

Manejador simulado de Guzzle

Cuando se prueban API de terceros, a menudo resulta complicado burlarse de ellas de una forma sencilla y declarativa. Este paquete tiene como objetivo ayudar a simplificar este proceso al proporcionar un controlador personalizado para guzzle que tiene un comportamiento similar al de un enrutador, en lugar de depender de que las respuestas se extraigan de la pila en un orden particular.

Instalación

Puede instalar el paquete a través del compositor:

composer require tomb1n0/guzzle-mock-handler

Uso

Ejemplo básico

 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']

Solicitar afirmación

A veces es útil realizar afirmaciones sobre la solicitud que devolvió su respuesta. Tal vez tenga una clase que inicie sesión en una API de terceros y desee afirmar que el nombre de usuario y la contraseña se enviaron correctamente.

 $ 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 '
    ]
]);

Nota: También puede realizar exactamente las mismas afirmaciones usando ->assertRequestHeaders() , esto le permitirá asegurarse de que las solicitudes de API contengan un encabezado X-API-KEY o similar.

Afirmaciones personalizadas

Es posible que afirmar el cuerpo o los encabezados no sea suficiente, por lo que le permitimos llamar a ->withAssertion() y pasarle los objetos de solicitud y respuesta, para que pueda realizar sus propias afirmaciones:

 $ 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 ' );

Afirmar orden

A veces resulta útil afirmar que las llamadas a la API se realizaron en el orden correcto. Tal vez tengas que llamar /login antes de buscar /users por ejemplo. Esto se logra dando un nombre a sus respuestas y luego afirmando el orden después de realizar sus llamadas.

 $ 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 '
]);

Solo permitir que las respuestas se llamen una vez

A veces es posible que desee permitir que solo se llame a un punto final una vez en sus pruebas; esto se puede lograr llamando ->once() en su objeto de respuesta.

 $ 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"