[Messenger] Move MiddlewareTestCase in Test ns

Author: ogizanagi

Tests/Middleware/MiddlewareTestCase.php renamed to Test/Middleware/MiddlewareTestCase.php

@@ -9,12 +9,16 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Messenger\Tests\Middleware;
+namespace Symfony\Component\Messenger\Test\Middleware;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Messenger\Middleware\StackInterface;
 
+/**
+ * @author Nicolas Grekas <p@tchwork.com>
+ */
 abstract class MiddlewareTestCase extends TestCase
 {
     protected function getStackMock(bool $nextIsCalled = true)
@@ -23,9 +27,9 @@ protected function getStackMock(bool $nextIsCalled = true)
         $nextMiddleware
             ->expects($nextIsCalled ? $this->once() : $this->never())
             ->method('handle')
-            ->will($this->returnCallback(function ($envelope, StackInterface $stack) {
+            ->willReturnCallback(function (Envelope $envelope, StackInterface $stack): Envelope {
                 return $envelope;
-            }))
+            })
         ;
 
         $stack = $this->createMock(StackInterface::class);
@@ -37,4 +41,23 @@ protected function getStackMock(bool $nextIsCalled = true)
 
         return $stack;
     }
+
+    protected function getThrowingStackMock(\Throwable $throwable = null)
+    {
+        $nextMiddleware = $this->getMockBuilder(MiddlewareInterface::class)->getMock();
+        $nextMiddleware
+            ->expects($this->once())
+            ->method('handle')
+            ->willThrowException($throwable ?? new \RuntimeException('Thrown from next middleware.'))
+        ;
+
+        $stack = $this->createMock(StackInterface::class);
+        $stack
+            ->expects($this->once())
+            ->method('next')
+            ->willReturn($nextMiddleware)
+        ;
+
+        return $stack;
+    }
 }

Tests/Middleware/ActivationMiddlewareTest.php

@@ -14,7 +14,7 @@
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Middleware\ActivationMiddleware;
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
-use Symfony\Component\Messenger\Middleware\StackInterface;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 
 /**
@@ -27,8 +27,7 @@ public function testExecuteMiddlewareOnActivated()
         $message = new DummyMessage('Hello');
         $envelope = new Envelope($message);
 
-        $stack = $this->createMock(StackInterface::class);
-        $stack->expects($this->never())->method('next');
+        $stack = $this->getStackMock(false);
 
         $middleware = $this->createMock(MiddlewareInterface::class);
         $middleware->expects($this->once())->method('handle')->with($envelope, $stack)->willReturn($envelope);
@@ -46,8 +45,7 @@ public function testExecuteMiddlewareOnActivatedWithCallable()
         $activated = $this->createPartialMock(\stdClass::class, array('__invoke'));
         $activated->expects($this->once())->method('__invoke')->with($envelope)->willReturn(true);
 
-        $stack = $this->createMock(StackInterface::class);
-        $stack->expects($this->never())->method('next');
+        $stack = $this->getStackMock(false);
 
         $middleware = $this->createMock(MiddlewareInterface::class);
         $middleware->expects($this->once())->method('handle')->with($envelope, $stack)->willReturn($envelope);

Tests/Middleware/HandleMessageMiddlewareTest.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Handler\Locator\HandlerLocator;
 use Symfony\Component\Messenger\Middleware\HandleMessageMiddleware;
 use Symfony\Component\Messenger\Middleware\StackMiddleware;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 
 class HandleMessageMiddlewareTest extends MiddlewareTestCase

Tests/Middleware/LoggingMiddlewareTest.php

@@ -14,7 +14,7 @@
 use Psr\Log\LoggerInterface;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Middleware\LoggingMiddleware;
-use Symfony\Component\Messenger\Middleware\StackInterface;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 
 class LoggingMiddlewareTest extends MiddlewareTestCase
@@ -34,7 +34,8 @@ public function testDebugLogAndNextMiddleware()
     }
 
     /**
-     * @expectedException \Exception
+     * @expectedException \RuntimeException
+     * @expectedExceptionMessage Thrown from next middleware.
      */
     public function testWarningLogOnException()
     {
@@ -50,12 +51,7 @@ public function testWarningLogOnException()
             ->expects($this->once())
             ->method('warning')
         ;
-        $stack = $this->createMock(StackInterface::class);
-        $stack
-            ->expects($this->once())
-            ->method('next')
-            ->willThrowException(new \Exception())
-        ;
+        $stack = $this->getThrowingStackMock();
 
         (new LoggingMiddleware($logger))->handle($envelope, $stack);
     }

Tests/Middleware/SendMessageMiddlewareTest.php

@@ -12,9 +12,9 @@
 namespace Symfony\Component\Messenger\Tests\Middleware;
 
 use Symfony\Component\Messenger\Envelope;
-use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Messenger\Middleware\SendMessageMiddleware;
 use Symfony\Component\Messenger\Stamp\ReceivedStamp;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\ChildDummyMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessageInterface;
@@ -114,7 +114,6 @@ public function testItCallsTheNextMiddlewareWhenNoSenderForThisMessage()
         $envelope = new Envelope($message);
 
         $middleware = new SendMessageMiddleware(new InMemorySenderLocator(null));
-        $handler = $this->getMockBuilder(MiddlewareInterface::class)->getMock();
 
         $middleware->handle($envelope, $this->getStackMock());
     }

Tests/Middleware/TraceableMiddlewareTest.php

@@ -15,6 +15,7 @@
 use Symfony\Component\Messenger\Middleware\MiddlewareInterface;
 use Symfony\Component\Messenger\Middleware\StackInterface;
 use Symfony\Component\Messenger\Middleware\TraceableMiddleware;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Stopwatch\Stopwatch;
 
@@ -55,7 +56,7 @@ public function testHandle()
 
     /**
      * @expectedException \RuntimeException
-     * @expectedExceptionMessage Foo exception from next callable
+     * @expectedExceptionMessage Thrown from next middleware.
      */
     public function testHandleWithException()
     {
@@ -71,12 +72,7 @@ public function testHandleWithException()
             }))
         ;
 
-        $stack = $this->createMock(StackInterface::class);
-        $stack
-            ->expects($this->once())
-            ->method('next')
-            ->willThrowException(new \RuntimeException('Foo exception from next callable'))
-        ;
+        $stack = $this->getThrowingStackMock();
 
         $stopwatch = $this->createMock(Stopwatch::class);
         $stopwatch->expects($this->once())->method('isStarted')->willReturn(true);

Tests/Middleware/ValidationMiddlewareTest.php

@@ -14,6 +14,7 @@
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Middleware\ValidationMiddleware;
 use Symfony\Component\Messenger\Stamp\ValidationStamp;
+use Symfony\Component\Messenger\Test\Middleware\MiddlewareTestCase;
 use Symfony\Component\Messenger\Tests\Fixtures\DummyMessage;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
 use Symfony\Component\Validator\Validator\ValidatorInterface;