Download guzzle mock handler - download do código-fonte guzzle mock handler

Manipulador simulado Guzzle

Ao testar APIs de terceiros, muitas vezes é um desafio zombar delas de uma forma simples e declarativa. Este pacote tem como objetivo ajudar a tornar esse processo mais simples, fornecendo um manipulador personalizado para guzzle que tem comportamento semelhante ao de um roteador, em vez de depender das respostas sendo retiradas da pilha em qualquer ordem específica.

Instalação

Você pode instalar o pacote via compositor:

composer require tomb1n0/guzzle-mock-handler

Uso

Exemplo 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 declaração

Às vezes é útil realizar afirmações sobre a solicitação que retornou sua resposta. Talvez você tenha uma classe que faz login em uma API de terceiros e deseja garantir que o nome de usuário e a senha foram enviados corretamente.

 $ 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: Você também pode executar exatamente as mesmas asserções usando ->assertRequestHeaders() , isso permitirá garantir que as solicitações de API contenham um cabeçalho X-API-KEY ou similar.

Asserções personalizadas

Afirmar o corpo ou os cabeçalhos pode não ser suficiente, por isso permitimos que você chame ->withAssertion() , passando os objetos de solicitação e resposta, para que você possa executar suas próprias asserções:

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

Afirmando Ordem

Às vezes é útil afirmar que as chamadas de API foram feitas na ordem correta. Talvez você precise ligar para /login antes de buscar /users por exemplo. Isso é conseguido dando um nome às suas respostas e, em seguida, afirmando a ordem após as chamadas terem sido feitas.

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

Permitindo que as respostas sejam chamadas apenas uma vez

Às vezes, você pode querer permitir que um endpoint seja chamado apenas uma vez em seus testes - isso pode ser conseguido chamando ->once() em seu objeto de resposta.

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