Document how to use mock with httplug-bundle

[soullivaneuh]

Q	A
Bug?	no
New Feature?	no
Version	N/A

Httplug has a mock client for testing: http://docs.php-http.org/en/latest/clients/mock-client.html

This is great, but it would be better to be able to replace the current client service by mocks on test environment.

I suppose it's possible, but we don't have any "official" way described on the doc.

It would be a great addition IMHO.

[soullivaneuh]

A quick working implement:

# config_test.yml

services:
  httplug.client.mock:
    class: Http\Mock\Client
  httplug.client.default: '@httplug.client.mock'

And then, the services using the default client is using the mock.

Plus, I can access the mock client to check the requests. Example on a WebTestCase:

$client->getContainer()->get('httplug.client.mock')->getRequests()

This might be documented, or event better, we might propose a configuration option to replace some or all the clients by mocks.

WDYT?

[soullivaneuh]

Well, my first weird issue is here. With this test:

public function testSettingsBadAccessToken(): void
{
    /** @var Repository $repository */
    $repository = $this->getReference('repository_github_enabled');
    $client = $this->makeClient(true);
    $crawler = $client->request('GET', $this->getUrl('app_repository_show', [
        'id' => $repository->getId(),
    ]));
    $form = $crawler->selectButton('repository_settings[submit]')->form([
        'repository_settings[accessToken]' => 'not-valid-token',
    ]);
    $httplugMockClient = $client->getContainer()->get('httplug.client.mock');
    // The token will be tested for admin rights. We should return a 404 error here.
    $httplugMockClient->addResponse(new JsonResponse([
        'message' => 'Not Found',
    ], 404));
    dump($httplugMockClient);
    $client->submit($form);
    $this->assertStatusCode(200, $client);
    $this->assertValidationErrors([
        'data.accessToken',
    ], $client->getContainer());
}

And this dump on the concerned controller:

public function showAction(Repository $repository, Request $request): Response
{
    dump(
        $this->get('httplug.client.mock'),
        $this->get('httplug.client.default')
    );
    // stuff...

I can see the mock service is not the same:

RepositoryController.php on line 116:
Http\Mock\Client {#6599
  -responseFactory: Http\Message\MessageFactory\GuzzleMessageFactory {#356}
  -requests: []
  -responses: []
  -exceptions: []
}
RepositoryController.php on line 116:
Http\Mock\Client {#6599
  -responseFactory: Http\Message\MessageFactory\GuzzleMessageFactory {#356}
  -requests: []
  -responses: []
  -exceptions: []
}
Github.php on line 54:
Http\Mock\Client {#6599
  -responseFactory: Http\Message\MessageFactory\GuzzleMessageFactory {#356}
  -requests: []
  -responses: []
  -exceptions: []
}
RepositoryControllerTest.php on line 203:
Http\Mock\Client {#6530
  -responseFactory: Http\Message\MessageFactory\GuzzleMessageFactory {#381}
  -requests: []
  -responses: array:1 [
    0 => Zend\Diactoros\Response\JsonResponse {#4561
      -payload: array:1 [
        "message" => "Not Found"
      ]

So I guess it's because the container is not the same on a request, but this looks to happen only on a form submit. The mock client is the same and works perfectly on a simpler test like this:

public function testSync(): void
{
    $client = $this->makeClient(true);
    $httplugMockClient = $client->getContainer()->get('httplug.client.mock');

    /** @var Repository $existingGithubRepository */
    $existingGithubRepository = $this->getReference('repository_github_disabled');
    // Simulate GitHub API response
    $httplugMockClient->addResponse(new JsonResponse([
        ['id' => $existingGithubRepository->getPlatformId(), 'full_name' => $existingGithubRepository->getName()],
        ['id' => 654654, 'full_name' => 'github/bar'],
        ['id' => 879654, 'full_name' => 'github/superman'],
    ]));
    // Simulate GitLab API response
    $httplugMockClient->addResponse(new JsonResponse([
        ['id' => 9884654, 'path_with_namespace' => 'gitlab/bar'],
    ]));

    $client->request('GET', $this->getUrl('app_repository_sync'));
    $this->assertStatusCode(302, $client);
    $crawler = $client->followRedirect();
    $this->assertContains(
        'github/bar',
        $crawler->filter('h2:contains("Available")')->nextAll()->text()
    );
    $this->assertContains(
        'github/superman',
        $crawler->filter('h2:contains("Available")')->nextAll()->text()
    );
    $this->assertContains(
        'gitlab/bar',
        $crawler->filter('h2:contains("Available")')->nextAll()->text()
    );
}

Any idea?

[soullivaneuh]

I found a workaround: calling $client = $this->makeClient(true); again just before using the mock client.

It works, but does not look very clean.

public function testSettingsBadAccessToken(): void
{
    /** @var Repository $repository */
    $repository = $this->getReference('repository_github_enabled');
    $client = $this->makeClient(true);
    $crawler = $client->request('GET', $this->getUrl('app_repository_show', [
        'id' => $repository->getId(),
    ]));
    $form = $crawler->selectButton('repository_settings[submit]')->form([
        'repository_settings[accessToken]' => 'not-valid-token',
    ]);
    $client = $this->makeClient(true);
    $httplugMockClient = $client->getContainer()->get('httplug.client.mock');
    // The token will be tested for admin rights. We should return a 404 error here.
    $httplugMockClient->addResponse(new JsonResponse([
        'message' => 'Not Found',
    ], 404));
    dump($httplugMockClient);
    $client->submit($form);
    $this->assertStatusCode(200, $client);
    $this->assertValidationErrors([
        'data.accessToken',
    ], $client->getContainer());
}

[soullivaneuh]

Well, the previous workaround gave me another issue:

The CSRF token is invalid. Please try to resubmit the form.

So I'm quite stuff. I may disable CSRF protection on test env but it's quite dirty and not ISO from the dev/prod env.

[fbourigault]

I'm quite lost will all those tries :/ Can you sum-up what's working and what's not?

[soullivaneuh]

@fbourigault sure:

The fake response adding:

• Works on single request web test cases
• Does not works when you fetch the form with a GET request and then submit it (the http-mock service is changed)
• "Works" if you re-instantiate a client and manipulate the fresh new http-mock service before submitting the form, but cause other side effect like CSRF protection because the kernel is not the same.

Do you need any other information?

[GaryPEGEOT]

It seems that you make several requests with the same instance of BrowserKit client ($client in your code), and Symfony Kernel is rebooted on each request, so you reponse bag in httplug.client.mock is empty. You should try with :

$client = $this->makeClient(true); // Or static::createClient();
$client->disableReboot(); // Will prevent reboot

[dbu]

i think gary is spot on. he just added some convenience for using the mock client, and improved the doc so it also mentions the disableReboot thing.

[soullivaneuh]

Thanks a lot @GaryPEGEOT! This is exactly what I want!

BTW, I don't see why the client should be always rebooted. This should be disable as default.

Closing the issue as it's not concerning httplug anymore.

Thanks again!