[Tests] Replace setMethods() by onlyMethods() and addMethods()

Author: alexandre-daubois

Tests/DataCollector/LoggerDataCollectorTest.php

@@ -26,7 +26,7 @@ public function testCollectWithUnexpectedFormat()
     {
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
         $logger->expects($this->once())->method('countErrors')->willReturn(123);
         $logger->expects($this->exactly(2))->method('getLogs')->willReturn([]);
@@ -66,7 +66,7 @@ public function testCollectFromDeprecationsLog()
 
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
 
         $logger->expects($this->once())->method('countErrors')->willReturn(0);
@@ -100,7 +100,7 @@ public function testWithMainRequest()
 
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
         $logger->expects($this->once())->method('countErrors')->with(null);
         $logger->expects($this->exactly(2))->method('getLogs')->with(null)->willReturn([]);
@@ -121,7 +121,7 @@ public function testWithSubRequest()
 
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
         $logger->expects($this->once())->method('countErrors')->with($subRequest);
         $logger->expects($this->exactly(2))->method('getLogs')->with($subRequest)->willReturn([]);
@@ -139,7 +139,7 @@ public function testCollect($nb, $logs, $expectedLogs, $expectedDeprecationCount
     {
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
         $logger->expects($this->once())->method('countErrors')->willReturn($nb);
         $logger->expects($this->exactly(2))->method('getLogs')->willReturn($logs);
@@ -171,7 +171,7 @@ public function testReset()
     {
         $logger = $this
             ->getMockBuilder(DebugLoggerInterface::class)
-            ->setMethods(['countErrors', 'getLogs', 'clear'])
+            ->onlyMethods(['countErrors', 'getLogs', 'clear'])
             ->getMock();
         $logger->expects($this->once())->method('clear');
 

Tests/Debug/TraceableEventDispatcherTest.php

@@ -48,7 +48,7 @@ public function testStopwatchSections()
     public function testStopwatchCheckControllerOnRequestEvent()
     {
         $stopwatch = $this->getMockBuilder(Stopwatch::class)
-            ->setMethods(['isStarted'])
+            ->onlyMethods(['isStarted'])
             ->getMock();
         $stopwatch->expects($this->once())
             ->method('isStarted')
@@ -64,7 +64,7 @@ public function testStopwatchCheckControllerOnRequestEvent()
     public function testStopwatchStopControllerOnRequestEvent()
     {
         $stopwatch = $this->getMockBuilder(Stopwatch::class)
-            ->setMethods(['isStarted', 'stop'])
+            ->onlyMethods(['isStarted', 'stop'])
             ->getMock();
         $stopwatch->expects($this->once())
             ->method('isStarted')

Tests/EventListener/LocaleListenerTest.php

@@ -76,7 +76,7 @@ public function testLocaleSetForRoutingContext()
         $context = $this->createMock(RequestContext::class);
         $context->expects($this->once())->method('setParameter')->with('_locale', 'es');
 
-        $router = $this->getMockBuilder(Router::class)->setMethods(['getContext'])->disableOriginalConstructor()->getMock();
+        $router = $this->getMockBuilder(Router::class)->onlyMethods(['getContext'])->disableOriginalConstructor()->getMock();
         $router->expects($this->once())->method('getContext')->willReturn($context);
 
         $request = Request::create('/');
@@ -92,7 +92,7 @@ public function testRouterResetWithParentRequestOnKernelFinishRequest()
         $context = $this->createMock(RequestContext::class);
         $context->expects($this->once())->method('setParameter')->with('_locale', 'es');
 
-        $router = $this->getMockBuilder(Router::class)->setMethods(['getContext'])->disableOriginalConstructor()->getMock();
+        $router = $this->getMockBuilder(Router::class)->onlyMethods(['getContext'])->disableOriginalConstructor()->getMock();
         $router->expects($this->once())->method('getContext')->willReturn($context);
 
         $parentRequest = Request::create('/');

Tests/HttpCache/EsiTest.php

@@ -232,7 +232,7 @@ public function testHandleWhenResponseIsNotModified()
 
     protected function getCache($request, $response)
     {
-        $cache = $this->getMockBuilder(HttpCache::class)->setMethods(['getRequest', 'handle'])->disableOriginalConstructor()->getMock();
+        $cache = $this->getMockBuilder(HttpCache::class)->onlyMethods(['getRequest', 'handle'])->disableOriginalConstructor()->getMock();
         $cache->expects($this->any())
               ->method('getRequest')
               ->willReturn($request)

Tests/HttpCache/HttpCacheTest.php

@@ -41,7 +41,7 @@ public function testTerminateDelegatesTerminationOnlyForTerminableInterface()
         // implements TerminableInterface
         $kernelMock = $this->getMockBuilder(Kernel::class)
             ->disableOriginalConstructor()
-            ->setMethods(['terminate', 'registerBundles', 'registerContainerConfiguration'])
+            ->onlyMethods(['terminate', 'registerBundles', 'registerContainerConfiguration'])
             ->getMock();
 
         $kernelMock->expects($this->once())

Tests/HttpCache/SsiTest.php

@@ -190,7 +190,7 @@ public function testHandleWhenResponseIsNot200AndAltIsPresent()
 
     protected function getCache($request, $response)
     {
-        $cache = $this->getMockBuilder(HttpCache::class)->setMethods(['getRequest', 'handle'])->disableOriginalConstructor()->getMock();
+        $cache = $this->getMockBuilder(HttpCache::class)->onlyMethods(['getRequest', 'handle'])->disableOriginalConstructor()->getMock();
         $cache->expects($this->any())
               ->method('getRequest')
               ->willReturn($request)

Tests/HttpKernelBrowserTest.php

@@ -155,7 +155,8 @@ public function testUploadedFileWhenSizeExceedsUploadMaxFileSize()
         $file = $this
             ->getMockBuilder(UploadedFile::class)
             ->setConstructorArgs([$source, 'original', 'mime/original', \UPLOAD_ERR_OK, true])
-            ->setMethods(['getSize', 'getClientSize'])
+            ->onlyMethods(['getSize'])
+            ->addMethods(['getClientSize'])
             ->getMock()
         ;
         /* should be modified when the getClientSize will be removed */

Tests/HttpKernelTest.php

@@ -361,7 +361,7 @@ public function testVerifyRequestStackPushPopDuringHandle()
     {
         $request = new Request();
 
-        $stack = $this->getMockBuilder(RequestStack::class)->setMethods(['push', 'pop'])->getMock();
+        $stack = $this->getMockBuilder(RequestStack::class)->onlyMethods(['push', 'pop'])->getMock();
         $stack->expects($this->once())->method('push')->with($this->equalTo($request));
         $stack->expects($this->once())->method('pop');
 

Tests/KernelTest.php

@@ -148,7 +148,7 @@ public function testBootSetsTheBootedFlagToTrue()
 
     public function testClassCacheIsNotLoadedByDefault()
     {
-        $kernel = $this->getKernel(['initializeBundles', 'doLoadClassCache']);
+        $kernel = $this->getKernel(['initializeBundles'], [], false, ['doLoadClassCache']);
         $kernel->expects($this->never())
             ->method('doLoadClassCache');
 
@@ -449,7 +449,7 @@ public function testTerminateDelegatesTerminationOnlyForTerminableInterface()
         // implements TerminableInterface
         $httpKernelMock = $this->getMockBuilder(HttpKernel::class)
             ->disableOriginalConstructor()
-            ->setMethods(['terminate'])
+            ->onlyMethods(['terminate'])
             ->getMock();
 
         $httpKernelMock
@@ -630,7 +630,7 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu
     {
         $bundle = $this
             ->getMockBuilder(BundleInterface::class)
-            ->setMethods(['getPath', 'getName'])
+            ->onlyMethods(['getPath', 'getName'])
             ->disableOriginalConstructor()
         ;
 
@@ -661,16 +661,21 @@ protected function getBundle($dir = null, $parent = null, $className = null, $bu
      * @param array $methods Additional methods to mock (besides the abstract ones)
      * @param array $bundles Bundles to register
      */
-    protected function getKernel(array $methods = [], array $bundles = [], bool $debug = false): Kernel
+    protected function getKernel(array $methods = [], array $bundles = [], bool $debug = false, array $methodsToAdd = []): Kernel
     {
         $methods[] = 'registerBundles';
 
-        $kernel = $this
+        $kernelMockBuilder = $this
             ->getMockBuilder(KernelForTest::class)
-            ->setMethods($methods)
+            ->onlyMethods($methods)
             ->setConstructorArgs(['test', $debug])
-            ->getMock()
         ;
+
+        if (0 !== \count($methodsToAdd)) {
+            $kernelMockBuilder->addMethods($methodsToAdd);
+        }
+
+        $kernel = $kernelMockBuilder->getMock();
         $kernel->expects($this->any())
             ->method('registerBundles')
             ->willReturn($bundles)

Tests/Profiler/ProfilerTest.php

@@ -45,7 +45,7 @@ public function testCollect()
     public function testReset()
     {
         $collector = $this->getMockBuilder(DataCollectorInterface::class)
-            ->setMethods(['collect', 'getName', 'reset'])
+            ->onlyMethods(['collect', 'getName', 'reset'])
             ->getMock();
         $collector->expects($this->any())->method('getName')->willReturn('mock');
         $collector->expects($this->once())->method('reset');