Skip to content

Add mock client factory for test purpose. #242

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.

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 6 commits into from
Jan 9, 2018
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
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
40 changes: 40 additions & 0 deletions ClientFactory/MockFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
<?php

namespace Http\HttplugBundle\ClientFactory;

use Http\Mock\Client;

/**
* @author Gary PEGEOT <[email protected]>
*/
class MockFactory implements ClientFactory
{
/**
* @var Client
*/
private $client;

/**
* @param Client $client
*/
public function setClient(Client $client)
{
$this->client = $client;
}

/**
* {@inheritdoc}
*/
public function createClient(array $config = [])
{
if (!class_exists(Client::class)) {
throw new \LogicException('To use the mock adapter you need to install the "php-http/mock-client" package.');
}

if (!$this->client) {
$this->client = new Client();
}

return $this->client;
}
}
14 changes: 14 additions & 0 deletions DependencyInjection/HttplugExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
use Http\Message\Authentication\BasicAuth;
use Http\Message\Authentication\Bearer;
use Http\Message\Authentication\Wsse;
use Http\Mock\Client as MockClient;
use Psr\Http\Message\UriInterface;
use Symfony\Component\Config\FileLocator;
use Symfony\Component\DependencyInjection\ChildDefinition;
Expand Down Expand Up @@ -106,6 +107,19 @@ private function configureClients(ContainerBuilder $container, array $config)
$container->setAlias('httplug.client.default', 'httplug.client.'.$first);
}
}

$mockServiceId = 'httplug.client.mock';

if (!\class_exists(MockClient::class)) {
$container->removeDefinition('httplug.factory.mock');
Copy link
Contributor

Choose a reason for hiding this comment

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

Instead of removing a definition when the class does not exist, could you move the relevant service definition to a dedicated file and load this file if the class is available?

}

if ($container->has('httplug.factory.mock') && !$container->has($mockServiceId)) {
$container->register($mockServiceId, MockClient::class)->setPublic($container->getParameter('kernel.debug'));

$container->findDefinition('httplug.factory.mock')
->addMethodCall('setClient', [new Reference($mockServiceId)]);
}
}

/**
Expand Down
1 change: 1 addition & 0 deletions Resources/config/services.xml
Original file line number Diff line number Diff line change
Expand Up @@ -68,5 +68,6 @@
<service id="httplug.factory.socket" class="Http\HttplugBundle\ClientFactory\SocketFactory" public="false">
<argument type="service" id="httplug.message_factory"/>
</service>
<service id="httplug.factory.mock" class="Http\HttplugBundle\ClientFactory\MockFactory" public="false" />
Copy link
Collaborator

Choose a reason for hiding this comment

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

i think this service should be removed from the container when the mock client is not available. that way, users notice problems at container build time instead of at runtime.

</services>
</container>
33 changes: 33 additions & 0 deletions Tests/Unit/ClientFactory/MockFactoryTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php
/**
* This file is part of the HttplugBundle package.
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/

namespace Http\HttplugBundle\Tests\Unit\ClientFactory;

use Http\HttplugBundle\ClientFactory\MockFactory;
use Http\Mock\Client;
use PHPUnit\Framework\TestCase;

/**
* @author Gary PEGEOT <[email protected]>
*/
class MockFactoryTest extends TestCase
{
public function testCreateClient()
{
$factory = new MockFactory();
$client = $factory->createClient();

$this->assertInstanceOf(Client::class, $client);

$client = new Client();

$factory->setClient($client);

$this->assertEquals($client, $factory->createClient());
}
}
1 change: 1 addition & 0 deletions Tests/Unit/DependencyInjection/HttplugExtensionTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -134,6 +134,7 @@ public function testClientPlugins()
$this->assertContainerBuilderHasService($id);
}
$this->assertContainerBuilderHasServiceDefinitionWithArgument('httplug.client.acme', 1, $pluginReferences);
$this->assertContainerBuilderHasService('httplug.client.mock');
}

/**
Expand Down
3 changes: 3 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,9 @@
"conflict": {
"php-http/guzzle6-adapter": "<1.1"
},
"suggest": {
"php-http/mock-client": "Add this to your require-dev section to mock HTTP responses easily"
},
"autoload": {
"psr-4": {
"Http\\HttplugBundle\\": ""
Expand Down