Merge pull request #13 from SymfonyTest/pass

Adding compiler pass support

Author: mwadon

Readme.md

@@ -72,6 +72,29 @@ class BundleInitializationTest extends BaseBundleTestCase
 
 ```
 
+## Private services in Symfony 4
+
+In Symfony 4 services are private by default. This is a good thing, but in order to test them properly we need to make
+them public when we are running the tests. This can easily be done with a compiler pass. 
+
+```php
+class BundleInitializationTest extends BaseBundleTestCase
+{
+    protected function setUp()
+    {
+        parent::setUp();
+        
+        // Make all services public
+        $this->addCompilerPass(new PublicServicePass());
+        
+        // Make services public that have an idea that matches a regex
+        $this->addCompilerPass(new PublicServicePass('|my_bundle.*|'));
+    }
+
+    // ...
+}
+```
+
 ## Configure Travis
 
 You want Travis to run against each currently supported LTS version of Symfony (since there would be only one per major version), plus the current if it's not an LTS too. There is no need for testing against version in between because Symfony follows [Semantic Versioning](http://semver.org/spec/v2.0.0.html). 

src/AppKernel.php

@@ -4,6 +4,7 @@
 
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Kernel;
 use Symfony\Component\Routing\RouteCollectionBuilder;
@@ -33,6 +34,11 @@ class AppKernel extends Kernel
      */
     private $fakedProjectDir;
 
+    /**
+     * @var CompilerPassInterface[]
+     */
+    private $compilerPasses = [];
+
     /**
      * @param string $cachePrefix
      */
@@ -141,4 +147,26 @@ public function loadRoutes(LoaderInterface $loader)
 
         return $routes->build();
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function buildContainer()
+    {
+        $container = parent::buildContainer();
+
+        foreach ($this->compilerPasses as $pass) {
+            $container->addCompilerPass($pass);
+        }
+
+        return $container;
+    }
+
+    /**
+     * @param CompilerPassInterface[] $compilerPasses
+     */
+    public function addCompilerPasses(array $compilerPasses)
+    {
+        $this->compilerPasses = $compilerPasses;
+    }
 }

src/BaseBundleTestCase.php

@@ -3,6 +3,7 @@
 namespace Nyholm\BundleTest;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ResettableContainerInterface;
 use Symfony\Component\HttpKernel\Kernel;
 
@@ -16,6 +17,11 @@ abstract class BaseBundleTestCase extends TestCase
      */
     private $kernel;
 
+    /**
+     * @var CompilerPassInterface[]
+     */
+    private $compilerPasses = [];
+
     /**
      * @return string
      */
@@ -61,6 +67,7 @@ protected function createKernel()
 
         $this->kernel = new $class(uniqid('cache'));
         $this->kernel->addBundle($this->getBundleClass());
+        $this->kernel->addCompilerPasses($this->compilerPasses);
 
         return $this->kernel;
     }
@@ -86,4 +93,12 @@ protected function tearDown()
     {
         $this->ensureKernelShutdown();
     }
+
+    /**
+     * @param CompilerPassInterface $compilerPass
+     */
+    protected function addCompilerPass(CompilerPassInterface $compilerPass)
+    {
+        $this->compilerPasses[] = $compilerPass;
+    }
 }

src/CompilerPass/PublicServicePass.php

@@ -0,0 +1,38 @@
+<?php
+
+namespace Nyholm\BundleTest\CompilerPass;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+
+/**
+ * @author Tobias Nyholm <[email protected]>
+ */
+class PublicServicePass implements CompilerPassInterface
+{
+    /**
+     * A regex to match the services that should be public
+     * @var string
+     */
+    private $regex;
+
+    /**
+     * @param string $regex
+     */
+    public function __construct($regex = '|.*|')
+    {
+        $this->regex = $regex;
+    }
+
+    /**
+     * @param ContainerBuilder $container
+     */
+    public function process(ContainerBuilder $container)
+    {
+        foreach ($container->getDefinitions() as $id => $definition) {
+            if (preg_match($this->regex, $id)) {
+                $definition->setPublic(true);
+            }
+        }
+    }
+}