Merge pull request #278 from norkunas/compiler-pass-unit-tests

Add unit tests for compiler passes

Author: norkunas

DependencyInjection/Compiler/AddProvidersPass.php

@@ -22,11 +22,6 @@
  */
 class AddProvidersPass implements CompilerPassInterface
 {
-    /**
-     * @var \Symfony\Component\DependencyInjection\ContainerBuilder
-     */
-    protected $container;
-
     /**
      * Get all providers based on their tag (`bazinga_geocoder.provider`) and
      * register them.

Tests/DependencyInjection/Compiler/AddProvidersPassTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\DependencyInjection\Compiler;
+
+use Bazinga\GeocoderBundle\DependencyInjection\Compiler\AddProvidersPass;
+use Geocoder\Provider\BingMaps\BingMaps;
+use Geocoder\ProviderAggregator;
+use Http\Client\Curl\Client;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+
+class AddProvidersPassTest extends TestCase
+{
+    use SetUpTearDownTrait;
+
+    /**
+     * @var AddProvidersPass
+     */
+    private $compilerPass;
+
+    protected function doSetUp()
+    {
+        $this->compilerPass = new AddProvidersPass();
+    }
+
+    public function testRegistersProviders()
+    {
+        $containerBuilder = new ContainerBuilder();
+        $containerBuilder->setDefinition(ProviderAggregator::class, new Definition(ProviderAggregator::class));
+
+        $bing = $containerBuilder->setDefinition('bing_maps', new Definition(BingMaps::class, [new Client(), 'apikey']));
+        $bing->addTag('bazinga_geocoder.provider');
+
+        $this->compilerPass->process($containerBuilder);
+
+        /** @var ProviderAggregator $providerAggregator */
+        $providerAggregator = $containerBuilder->get(ProviderAggregator::class);
+        $providers = $providerAggregator->getProviders();
+
+        $this->assertArrayHasKey('bing_maps', $providers);
+        $this->assertInstanceOf(BingMaps::class, $providers['bing_maps']);
+    }
+}

Tests/DependencyInjection/Compiler/FactoryValidatorPassTest.php

@@ -0,0 +1,97 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\DependencyInjection\Compiler;
+
+use Bazinga\GeocoderBundle\DependencyInjection\Compiler\FactoryValidatorPass;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
+
+class FactoryValidatorPassTest extends TestCase
+{
+    use SetUpTearDownTrait;
+
+    /**
+     * @var FactoryValidatorPass
+     */
+    private $compilerPass;
+
+    /**
+     * @var string
+     */
+    private $factoryId;
+
+    protected function doSetUp()
+    {
+        $this->compilerPass = new FactoryValidatorPass();
+        $this->factoryId = 'dummy_factory_id';
+        $this->compilerPass::addFactoryServiceId($this->factoryId);
+    }
+
+    protected function doTearDown()
+    {
+        $reflection = new \ReflectionObject($this->compilerPass);
+        $prop = $reflection->getProperty('factoryServiceIds');
+        $prop->setAccessible(true);
+        $prop->setValue([]);
+    }
+
+    public function testProcessThrows()
+    {
+        $this->expectException(ServiceNotFoundException::class);
+        $this->expectExceptionMessage("Factory with ID \"$this->factoryId\" could not be found");
+
+        $container = $this->createMock(ContainerBuilder::class);
+        $container->expects($this->once())
+            ->method('hasAlias')
+            ->with($this->factoryId)
+            ->willReturn(false);
+        $container->expects($this->once())
+            ->method('hasDefinition')
+            ->with($this->factoryId)
+            ->willReturn(false);
+
+        $this->compilerPass->process($container);
+    }
+
+    public function testProcessDoesntThrowIfAliasExists()
+    {
+        $container = $this->createMock(ContainerBuilder::class);
+        $container->expects($this->once())
+            ->method('hasAlias')
+            ->with($this->factoryId)
+            ->willReturn(true);
+        $container->expects($this->never())
+            ->method('hasDefinition')
+            ->with($this->factoryId)
+            ->willReturn(false);
+
+        $this->compilerPass->process($container);
+    }
+
+    public function testProcessDoesntThrowIfDefinitionExists()
+    {
+        $container = $this->createMock(ContainerBuilder::class);
+        $container->expects($this->once())
+            ->method('hasAlias')
+            ->with($this->factoryId)
+            ->willReturn(false);
+        $container->expects($this->once())
+            ->method('hasDefinition')
+            ->with($this->factoryId)
+            ->willReturn(true);
+
+        $this->compilerPass->process($container);
+    }
+}

Tests/DependencyInjection/Compiler/ProfilerPassTest.php

@@ -0,0 +1,53 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the BazingaGeocoderBundle package.
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ *
+ * @license    MIT License
+ */
+
+namespace Bazinga\GeocoderBundle\Tests\DependencyInjection\Compiler;
+
+use Bazinga\GeocoderBundle\DataCollector\GeocoderDataCollector;
+use Bazinga\GeocoderBundle\DependencyInjection\Compiler\ProfilerPass;
+use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\PhpUnit\SetUpTearDownTrait;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Definition;
+use Symfony\Component\DependencyInjection\Reference;
+
+class ProfilerPassTest extends TestCase
+{
+    use SetUpTearDownTrait;
+
+    /**
+     * @var ProfilerPass
+     */
+    private $compilerPass;
+
+    protected function doSetUp()
+    {
+        $this->compilerPass = new ProfilerPass();
+    }
+
+    public function testRegistersProviders()
+    {
+        $geocoderDataCollectorDefinition = new Definition(GeocoderDataCollector::class);
+
+        $containerBuilder = new ContainerBuilder();
+        $containerBuilder->setDefinition(GeocoderDataCollector::class, $geocoderDataCollectorDefinition);
+
+        $bing = $containerBuilder->setDefinition('geocoder_profiling', new Definition(ProfilingPlugin::class, ['provider_id']));
+        $bing->addTag('bazinga_geocoder.profiling_plugin');
+
+        $this->compilerPass->process($containerBuilder);
+
+        $this->assertTrue($geocoderDataCollectorDefinition->hasMethodCall('addInstance'));
+        $this->assertInstanceOf(Reference::class, $geocoderDataCollectorDefinition->getMethodCalls()[0][1][0]);
+    }
+}