Skip to content

Add "Mock responses in functional tests" part #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jan 9, 2018
Merged

Add "Mock responses in functional tests" part #220

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7a05d83
Add "Mock responses in functional tests" part
GaryPEGEOT Jan 3, 2018
42d0697
Fix missing WS
GaryPEGEOT Jan 3, 2018
8a85c08
Fix missing WS
GaryPEGEOT Jan 3, 2018
d82bec1
Add link to mock-client lib, update wording.
Jan 4, 2018
231a0a5
Add hint about Symfony bundle.
Jan 4, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions integrations/symfony-bundle.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@ services are:
* ``httplug.factory.guzzle6``
* ``httplug.factory.react``
* ``httplug.factory.socket``
* ``httplug.factory.mock`` (Install ``php-http/mock-client``first)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think you need a whitespace before the "first)" bit to make sphinx build this correctly


Plugins
```````
Expand Down Expand Up @@ -342,6 +343,30 @@ The only steps they need is ``require`` one of the adapter implementations in
their projects ``composer.json`` and instantiating the ``HttplugBundle`` in
their kernel.

Mock responses in functional tests
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we use the convention of all caps in titles, this should be "Mock Responses In Functional Tests"

``````````````````````````````````
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you please addd a paragraph here that mentions again that you need the separate mock client library, and cross-link that to the clients/mock-client doc?

To mock responses in your functional tests, proceed as follow:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

s/proceed as follow/use the mock client factory in your test environement configuration/


.. code-block:: yaml

# config_test.yml
httplug:
clients:
my_awesome_client:
factory: 'httplug.factory.mock' # replace factory

And in your tests:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To mock a response in your tests, do:


.. code-block:: php

// SomeWebTestCase.php
$client = static::createClient();
// $client->disableReboot(); You might uncomment this if your client (BrowserKit) make multiple requests as kernel is rebooted on each request.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good idea to mention that!

lets say "If your test has the client (BrowserKit) make multiple requests, you need to disable reboot as the kernel is rebooted on each request." - and i would that put into a comment line above the commented out reboot.


$response = $this->createMock('Psr\Http\Message\ResponseInterface');
$response->method('getBody')->willReturn(/* Psr\Http\Message\Interface instance containing expected response content. */);
$client->getContainer()->get('httplug.client.mock')->addResponse($response);

.. |clearfloat| raw:: html

<div style="clear:left"></div>
Expand Down