Symfony HttpClient and sequential requests assertions
Symfony/HttpClient is a powerful component to perform HTTP(s) requests. It already embeds a MockHttpClient and MockResponse to ease testing. When a method performs only one request, it’s very convenient to use, but when the class performs many request and you want to make assertions on the requests it becomes a bit more complex.
Let’s consider a class that performs HTTP requests:
class MyClass
{
public function __construct(
private HttpClientInterface $httpClient,
) {
}
public function sendRequests(): void
{
// In real life, these requests would have been created programmatically.
// Otherwise, it's totally useless to test them!
$this->httpClient->request('GET', 'https://httpbin.org/status/200', ['headers' => ['my-header' => 'foo']]);
$this->httpClient->request('PUT', 'https://httpbin.org/status/201', ['headers' => ['my-header' => 'bar']]);
}
}
Now, we want to test all requests.
If you look at the API you can see you can pass different shapes of data.
Here, we are going to pass a Generator of function. These functions are able to perform assertion on the request. Then they will return a Response.
final class MyClassTest extends TestCase
{
public function test()
{
$httpClient = new MockHttpClient((function (): Generator {
$expectedRequests = [
['GET', 'https://httpbin.org/status/200', 'my-header: foo'],
['PUT', 'https://httpbin.org/status/201', 'my-header: bar'],
];
foreach ($expectedRequests as [$expectedMethod, $expectedUrl, $expectedHeader]) {
yield function (string $method, string $url, array $options) use ($expectedMethod, $expectedUrl, $expectedHeader): ResponseInterface {
$this->assertSame($expectedMethod, $method);
$this->assertSame($expectedUrl, $url);
$this->assertSame($expectedHeader, $options['normalized_headers']['my-header'][0]);
return new MockResponse();
};
}
})());
$myClass = new MyClass($httpClient);
// In real life, you usually pass some parameters to construct all requests.
$myClass->sendRequests();
}
}
The first step is to create a MockHttpClient
. We give it a generator (did you notice the callback is executed right away?).
The generator is responsible for generating a callback that must return a response. One callback per request.
The callback allows us to make some assertion on the method
, the url
, and the options
.
The second and last step is to instantiate MyClass
with the mock HTTP client and execute the method we want to test.
That’s all! ✨
We hope you enjoy this post and see you soon for a new copy/paste snippet!
Commentaires et discussions
Nos formations sur ce sujet
Notre expertise est aussi disponible sous forme de formations professionnelles !

Symfony avancée
Découvrez les fonctionnalités et concepts avancés de Symfony
Ces clients ont profité de notre expertise

Dans le cadre d’une refonte complète de son architecture Web, le journal en ligne Mediapart a sollicité l’expertise de JoliCode afin d’accompagner ses équipes. Mediapart.fr est un des rares journaux 100% en ligne qui n’appartient qu’à ses lecteurs qui amène un fort traffic authentifiés et donc difficilement cachable. Pour effectuer cette migration, …

Afin de poursuivre son déploiement sur le Web, Arte a souhaité être accompagné dans le développement de son API REST “OPA” (API destinée à exposer les programmes et le catalogue vidéo de la chaine). En collaboration avec l’équipe technique Arte, JoliCode a mené un travail spécifique à l’amélioration des performances et de la fiabilité de l’API. Ces…

Dans le cadre d’une refonte complète de son architecture Web, Expertissim a sollicité l’expertise de JoliCode afin de tenir les délais et le niveau de qualité attendus. Le domaine métier d’Expertissim n’est pas trivial : les spécificités du marché de l’art apportent une logique métier bien particulière et un processus complexe. La plateforme propose…