do not mock the ContainerInterface

symfony · xabbuh · Jan 17, 2024 · Jan 9, 2024 · Jan 17, 2024 · 016e6d1c58175a331c923f7e2203d85e99b6ef0e
commit 016e6d1c58175a331c923f7e2203d85e99b6ef0e
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/RouterCacheWarmerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/CacheWarmer/RouterCacheWarmerTest.php
@@ -12,20 +12,20 @@
 namespace Symfony\Bundle\FrameworkBundle\Tests\CacheWarmer;
 
 use PHPUnit\Framework\TestCase;
-use Psr\Container\ContainerInterface;
 use Symfony\Bundle\FrameworkBundle\CacheWarmer\RouterCacheWarmer;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
 use Symfony\Component\Routing\RouterInterface;
 
 class RouterCacheWarmerTest extends TestCase
 {
     public function testWarmUpWithWarmableInterfaceWithBuildDir()
     {
-        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+        $container = new Container();
 
         $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection', 'warmUp'])->getMock();
-        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
-        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+        $container->set('router', $routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($container);
 
         $routerCacheWarmer->warmUp('/tmp/cache', '/tmp/build');
         $routerMock->expects($this->any())->method('warmUp')->with('/tmp/cache', '/tmp/build')->willReturn([]);
@@ -34,23 +34,23 @@ public function testWarmUpWithWarmableInterfaceWithBuildDir()
 
     public function testWarmUpWithoutWarmableInterfaceWithBuildDir()
     {
-        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+        $container = new Container();
 
         $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection'])->getMock();
-        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
-        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+        $container->set('router', $routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($container);
         $this->expectException(\LogicException::class);
         $this->expectExceptionMessage('cannot be warmed up because it does not implement "Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface"');
         $routerCacheWarmer->warmUp('/tmp/cache', '/tmp/build');
     }
 
     public function testWarmUpWithWarmableInterfaceWithoutBuildDir()
     {
-        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+        $container = new Container();
 
         $routerMock = $this->getMockBuilder(testRouterInterfaceWithWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection', 'warmUp'])->getMock();
-        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
-        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+        $container->set('router', $routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($container);
 
         $preload = $routerCacheWarmer->warmUp('/tmp');
         $routerMock->expects($this->never())->method('warmUp');
@@ -60,11 +60,11 @@ public function testWarmUpWithWarmableInterfaceWithoutBuildDir()
 
     public function testWarmUpWithoutWarmableInterfaceWithoutBuildDir()
     {
-        $containerMock = $this->getMockBuilder(ContainerInterface::class)->onlyMethods(['get', 'has'])->getMock();
+        $container = new Container();
 
         $routerMock = $this->getMockBuilder(testRouterInterfaceWithoutWarmableInterface::class)->onlyMethods(['match', 'generate', 'getContext', 'setContext', 'getRouteCollection'])->getMock();
-        $containerMock->expects($this->any())->method('get')->with('router')->willReturn($routerMock);
-        $routerCacheWarmer = new RouterCacheWarmer($containerMock);
+        $container->set('router', $routerMock);
+        $routerCacheWarmer = new RouterCacheWarmer($container);
         $preload = $routerCacheWarmer->warmUp('/tmp');
         self::assertSame([], $preload);
     }

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolClearCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolClearCommandTest.php
@@ -17,7 +17,7 @@
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Component\Console\Tester\CommandCompletionTester;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
 use Symfony\Component\HttpKernel\KernelInterface;
 
@@ -54,13 +54,11 @@ public static function provideCompletionSuggestions(): iterable
 
     private function getKernel(): MockObject&KernelInterface
     {
-        $container = $this->createMock(ContainerInterface::class);
-
         $kernel = $this->createMock(KernelInterface::class);
         $kernel
             ->expects($this->any())
             ->method('getContainer')
-            ->willReturn($container);
+            ->willReturn(new Container());
 
         $kernel
             ->expects($this->once())

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolDeleteCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePoolDeleteCommandTest.php
@@ -18,7 +18,7 @@
 use Symfony\Bundle\FrameworkBundle\Tests\TestCase;
 use Symfony\Component\Console\Tester\CommandCompletionTester;
 use Symfony\Component\Console\Tester\CommandTester;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\HttpKernel\CacheClearer\Psr6CacheClearer;
 use Symfony\Component\HttpKernel\KernelInterface;
 
@@ -108,13 +108,11 @@ public static function provideCompletionSuggestions(): iterable
 
     private function getKernel(): MockObject&KernelInterface
     {
-        $container = $this->createMock(ContainerInterface::class);
-
         $kernel = $this->createMock(KernelInterface::class);
         $kernel
             ->expects($this->any())
             ->method('getContainer')
-            ->willReturn($container);
+            ->willReturn(new Container());
 
         $kernel
             ->expects($this->once())

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePruneCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/CachePruneCommandTest.php
@@ -18,7 +18,7 @@
 use Symfony\Component\Cache\PruneableInterface;
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\DependencyInjection\Argument\RewindableGenerator;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\HttpKernel\KernelInterface;
 
 class CachePruneCommandTest extends TestCase
@@ -50,13 +50,11 @@ private function getEmptyRewindableGenerator(): RewindableGenerator
 
     private function getKernel(): MockObject&KernelInterface
     {
-        $container = $this->createMock(ContainerInterface::class);
-
         $kernel = $this->createMock(KernelInterface::class);
         $kernel
             ->expects($this->any())
             ->method('getContainer')
-            ->willReturn($container);
+            ->willReturn(new Container());
 
         $kernel
             ->expects($this->once())

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Command/RouterMatchCommandTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Command/RouterMatchCommandTest.php
@@ -16,7 +16,7 @@
 use Symfony\Bundle\FrameworkBundle\Command\RouterMatchCommand;
 use Symfony\Bundle\FrameworkBundle\Console\Application;
 use Symfony\Component\Console\Tester\CommandTester;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Routing\RequestContext;
 use Symfony\Component\Routing\Route;
@@ -72,24 +72,11 @@ private function getRouter()
 
     private function getKernel()
     {
-        $container = $this->createMock(ContainerInterface::class);
-        $container
-            ->expects($this->atLeastOnce())
-            ->method('has')
-            ->willReturnCallback(fn ($id) => 'console.command_loader' !== $id)
-        ;
-        $container
-            ->expects($this->any())
-            ->method('get')
-            ->with('router')
-            ->willReturn($this->getRouter())
-        ;
-
         $kernel = $this->createMock(KernelInterface::class);
         $kernel
             ->expects($this->any())
             ->method('getContainer')
-            ->willReturn($container)
+            ->willReturn(new Container())
         ;
         $kernel
             ->expects($this->once())

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Console/ApplicationTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Console/ApplicationTest.php
@@ -22,11 +22,11 @@
 use Symfony\Component\Console\Output\NullOutput;
 use Symfony\Component\Console\Output\OutputInterface;
 use Symfony\Component\Console\Tester\ApplicationTester;
+use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Symfony\Component\HttpFoundation\RequestStack;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
@@ -241,7 +241,10 @@ private function createEventForSuggestingPackages(string $command, array $altern
 
     private function getKernel(array $bundles, $useDispatcher = false)
     {
-        $container = $this->createMock(ContainerInterface::class);
+        $container = new Container(new ParameterBag([
+            'console.command.ids' => [],
+            'console.lazy_command.ids' => [],
+        ]));
 
         if ($useDispatcher) {
             $dispatcher = $this->createMock(EventDispatcherInterface::class);
@@ -250,45 +253,9 @@ private function getKernel(array $bundles, $useDispatcher = false)
                 ->method('dispatch')
             ;
 
-            $container->expects($this->atLeastOnce())
-                ->method('get')
-                ->willReturnMap([
-                    ['.virtual_request_stack', 2, new RequestStack()],
-                    ['event_dispatcher', 1, $dispatcher],
-                ])
-            ;
+            $container->set('event_dispatcher', $dispatcher);
         }
 
-        $container
-            ->expects($this->exactly(2))
-            ->method('hasParameter')
-            ->willReturnCallback(function (...$args) {
-                static $series = [
-                    ['console.command.ids'],
-                    ['console.lazy_command.ids'],
-                ];
-
-                $this->assertSame(array_shift($series), $args);
-
-                return true;
-            })
-        ;
-
-        $container
-            ->expects($this->exactly(2))
-            ->method('getParameter')
-            ->willReturnCallback(function (...$args) {
-                static $series = [
-                    ['console.lazy_command.ids'],
-                    ['console.command.ids'],
-                ];
-
-                $this->assertSame(array_shift($series), $args);
-
-                return [];
-            })
-        ;
-
         $kernel = $this->createMock(KernelInterface::class);
         $kernel->expects($this->once())->method('boot');
         $kernel

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Controller/ControllerResolverTest.php
@@ -16,7 +16,6 @@
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver;
 use Symfony\Component\DependencyInjection\Container;
-use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Tests\Controller\ContainerControllerResolverTest;
 
@@ -107,7 +106,7 @@ class_exists(AbstractControllerTest::class);
     protected function createControllerResolver(LoggerInterface $logger = null, Psr11ContainerInterface $container = null)
     {
         if (!$container) {
-            $container = $this->createMockContainer();
+            $container = new Container();
         }
 
         return new ControllerResolver($container, $logger);
@@ -117,11 +116,6 @@ protected function createMockParser()
     {
         return $this->createMock(ControllerNameParser::class);
     }
-
-    protected function createMockContainer()
-    {
-        return $this->createMock(ContainerInterface::class);
-    }
 }
 
 class DummyController extends AbstractController

diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/RouterTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Routing/RouterTest.php
@@ -23,6 +23,8 @@
 use Symfony\Component\DependencyInjection\Container;
 use Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
+use Symfony\Component\DependencyInjection\ParameterBag\ContainerBag;
+use Symfony\Component\DependencyInjection\ParameterBag\ParameterBag;
 use Symfony\Component\Routing\Loader\YamlFileLoader;
 use Symfony\Component\Routing\Route;
 use Symfony\Component\Routing\RouteCollection;
@@ -406,7 +408,8 @@ public function testExceptionOnNonStringParameter()
         $routes->add('foo', new Route('/%object%'));
 
         $sc = $this->getPsr11ServiceContainer($routes);
-        $parameters = $this->getParameterBag(['object' => new \stdClass()]);
+        $parameters = new Container();
+        $parameters->set('object', new \stdClass());
 
         $router = new Router($sc, 'foo', [], null, $parameters);
 
@@ -424,19 +427,15 @@ public function testExceptionOnNonStringParameterWithSfContainer()
 
         $sc = $this->getServiceContainer($routes);
 
-        $pc = $this->createMock(ContainerInterface::class);
-        $pc
-            ->expects($this->once())
-            ->method('get')
-            ->willReturn(new \stdClass())
-        ;
+        $pc = new Container();
+        $pc->set('object', new \stdClass());
 
         $router = new Router($sc, 'foo', [], null, $pc);
 
         $this->expectException(RuntimeException::class);
         $this->expectExceptionMessage('The container parameter "object", used in the route configuration value "/%object%", must be a string or numeric, but it is of type "stdClass".');
 
-        $router->getRouteCollection()->get('foo');
+        $router->getRouteCollection();
     }
 
     /**
@@ -483,7 +482,9 @@ public function testGetRouteCollectionAddsContainerParametersResource()
 
         $router = new Router($sc, 'foo', [], null, $parameters);
 
-        $router->getRouteCollection();
+        $routeCollection = $router->getRouteCollection();
+
+        $this->assertEquals([new ContainerParametersResource(['locale' => 'en'])], $routeCollection->getResources());
     }
 
     public function testGetRouteCollectionAddsContainerParametersResourceWithSfContainer()
@@ -617,13 +618,8 @@ private function getServiceContainer(RouteCollection $routes): Container
             ->willReturn($routes)
         ;
 
-        $sc = $this->getMockBuilder(Container::class)->onlyMethods(['get'])->getMock();
-
-        $sc
-            ->expects($this->once())
-            ->method('get')
-            ->willReturn($loader)
-        ;
+        $sc = new Container();
+        $sc->set('routing.loader', $loader);
 
         return $sc;
     }
@@ -638,26 +634,14 @@ private function getPsr11ServiceContainer(RouteCollection $routes): ContainerInt
             ->willReturn($routes)
         ;
 
-        $sc = $this->createMock(ContainerInterface::class);
-
-        $sc
-            ->expects($this->once())
-            ->method('get')
-            ->willReturn($loader)
-        ;
+        $container = new Container();
+        $container->set('routing.loader', $loader);
 
-        return $sc;
+        return $container;
     }
 
     private function getParameterBag(array $params = []): ContainerInterface
     {
-        $bag = $this->createMock(ContainerInterface::class);
-        $bag
-            ->expects($this->any())
-            ->method('get')
-            ->willReturnCallback(fn ($key) => $params[$key] ?? null)
-        ;
-
-        return $bag;
+        return new ContainerBag(new Container(new ParameterBag($params)));
     }
 }