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 2 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
36 changes: 36 additions & 0 deletions ClientFactory/MockFactory.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
<?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('Http\Mock\Client')) {
Copy link
Collaborator

Choose a reason for hiding this comment

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

please use the ::class pseudoconstant. we are on php 5.5 or newer.

throw new \LogicException('To use the mock adapter you need to install the "php-http/mock-client" package.');
}

return $this->client ?: new Client();
Copy link
Collaborator

Choose a reason for hiding this comment

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

this will create a new client on each call, if none has been registered. should we instead register the newly created client if none was set?

}
}
10 changes: 10 additions & 0 deletions DependencyInjection/HttplugExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,16 @@ private function configureClients(ContainerBuilder $container, array $config)
$container->setAlias('httplug.client.default', 'httplug.client.'.$first);
}
}

$mockClass = 'Http\Mock\Client';
Copy link
Collaborator

Choose a reason for hiding this comment

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

lets use the ::class pseudoconstant here. and make the use statement say use Http\Mock\Client as MockClient; to make things more readable.

$mockServiceId = 'httplug.client.mock';

if (\class_exists($mockClass) && !$container->has($mockServiceId)) {
$container->register($mockServiceId, $mockClass)->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