[FrameworkBundle] Add HttpClientAssertionsTrait which provide shortcuts to assert HTTP calls was triggered

[welcoMattic]

Q	A
Branch?	6.4
Bug fix?	no
New feature?	yes
Deprecations?	no
Tickets
License	MIT
Doc PR	symfony/symfony-docs#18970

This PR brings a new collection (to enhance) of assertions to help users to ensure some HTTP calls has been triggered during a Request processing.

Example

An example is better than thousands words:

HttpClientAssertionsTest.php

public function testHttpClientAssertions()
{
    $client = static::createClient();
    $client->enableProfiler();

    $client->request('GET', '/foo');

    $this->assertHttpClientRequest($client, 'symfony.http_client', 'https://symfony.com/');
    $this->assertHttpClientRequest($client, 'symfony.http_client', 'https://symfony.com/', 'POST', 'foo');
    $this->assertHttpClientRequest($client, 'symfony.http_client', 'https://symfony.com/', 'POST', ['foo' => 'bar']);
    $this->assertHttpClientRequest($client, 'symfony.http_client', 'https://symfony.com/', 'POST', ['foo' => 'bar']);
    $this->assertNotHttpClientRequest($client, 'symfony.http_client', 'https://laravel.com');


    $this->assertHttpClientRequestCount($client, 'symfony.http_client', 5);
}

FooController.php

public function index(HttpClientInterface $symfonyHttpClient)
{
    $symfonyHttpClient->request('GET', '/');
    $symfonyHttpClient->request('POST', '/', ['body' => 'foo']);
    $symfonyHttpClient->request('POST', '/', ['body' => ['foo' => 'bar']]);
    $symfonyHttpClient->request('POST', '/', ['json' => ['foo' => 'bar']]);
    $symfonyHttpClient->request('GET', '/doc/current/index.html');

    return new Response();
}

http_client.yaml

framework:
    http_client:
        scoped_clients:
            symfony.http_client:
                base_uri: 'https://symfony.com'

This is a first try to improve DX in test, to allow users to assert more complex things (here it's HTTP calls, but I think also about adding assertions on logs for example).

Todo

• Write doc

[welcoMattic]

I've update the examples in PR description. Now we allow assertion on a single URL (with method and optional body). I've added the opposition assertion assertHttpClientHasNotBeenCalledForUrl and assertHttpClientCountRequests.

[nicolas-grekas]

Random thoughts:

No need for checking headers using these?
Can't we remove the $client argument somehow? (don't we have it in the context somewhere?)
WHat about defaulting $httpClientId default to http_client?

[welcoMattic]

@nicolas-grekas

Random thoughts:

No need for checking headers using these?

Sure, I can add header checks 👍

Can't we remove the $client argument somehow? (don't we have it in the context somewhere?)

As BrowserKitAssertionTrait::getClient is private, we don't have any other way to get the client here. Should we dig deep to find a way to do?

We have access to this trait through WebTestAssertionsTrait in WebTestCase, so we can call static::getClient()

WHat about defaulting $httpClientId default to http_client?

Nice idea

[weaverryan]

Same thoughts as Nicolas: if we can remove the need for the client arg and service name (when using the default), I think I’ll really dig it!

[welcoMattic]

@weaverryan it's done :) I've removed it https://github.com/symfony/symfony/pull/50662/files#diff-be0ff1fa989a87452ee0ecc8a932f09d50d59d3ecb4c6bce9565202aa254bd37R23.

Through traits we have access to getClient from BrowserKitAssertionsTrait, et tada!

[fabpot]

Thank you @welcoMattic.