Rename and refactor test to focus on unstacking the clone of TraceableStack independently

krciga22 · krciga22 · commit 7ae895f1ac35 · 2023-09-17T04:33:09.000Z
Notes:
- This test manually unstacks TraceableStack and it's clone instead of using a MessageBus, which is what StackMiddlewareTest::testClone() uses. I did this because MessageBus always dispatches with a new StackMiddleware(). I thought about using a custom MessageBus mock, however, I'm not sure if it's needed to test unstacking.
- Removed stopwatch expects() as the stopwatch is not currently under test
diff --git a/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php b/src/Symfony/Component/Messenger/Tests/Middleware/TraceableMiddlewareTest.php
@@ -142,38 +142,36 @@ public function handle(Envelope $envelope, StackInterface $stack): Envelope
         $this->assertSame(1, $middleware->calls);
     }
 
-    public function testCloneTraceableStack(): void
+    public function testClonedTraceableStackUnstacksIndependently(): void
     {
         // import TraceableStack
         class_exists(TraceableMiddleware::class);
 
         $stackMiddleware = new StackMiddleware([
+            null,
             $this->createMock(MiddlewareInterface::class),
             $this->createMock(MiddlewareInterface::class),
         ]);
 
         $stopwatch = $this->createMock(Stopwatch::class);
 
-        $series = [
-            [$this->matches('"%sMiddlewareInterface%s" on "command_bus"'), 'messenger.middleware'],
-            [$this->matches('"%sMiddlewareInterface%s" on "command_bus"'), 'messenger.middleware'],
-        ];
-        $stopwatch->expects($this->exactly(2))
-            ->method('start')
-            ->willReturnCallback(function (string $name, string $category = null) use (&$series) {
-                [$constraint, $expectedCategory] = array_shift($series);
+        $traceableStack = new TraceableStack($stackMiddleware, $stopwatch, 'command_bus', 'messenger.middleware');
+        $clonedStack = clone $traceableStack;
 
-                $constraint->evaluate($name);
-                $this->assertSame($expectedCategory, $category);
+        $traceableStackMiddleware1 = $traceableStack->next();
+        $traceableStackMiddleware2 = $traceableStack->next();
+        $traceableStackTail = $traceableStack->next();
+        self::assertSame($stackMiddleware, $traceableStackTail);
 
-                return $this->createMock(StopwatchEvent::class);
-            })
-        ;
-        $stopwatch->expects($this->never())->method('stop');
+        // unstack clonedStack independently
+        $clonedStackMiddleware1 = $clonedStack->next();
+        self::assertSame($traceableStackMiddleware1, $clonedStackMiddleware1);
+        self::assertNotSame($traceableStackMiddleware2, $clonedStackMiddleware1);
 
-        $traceableStack = new TraceableStack($stackMiddleware, $stopwatch, 'command_bus', 'messenger.middleware');
-        $clonedStack = clone $traceableStack;
+        $clonedStackMiddleware2 = $clonedStack->next();
+        self::assertSame($traceableStackMiddleware2, $clonedStackMiddleware2);
 
-        self::assertSame($traceableStack->next(), $clonedStack->next());
+        $clonedStackTail = $clonedStack->next();
+        self::assertNotSame($stackMiddleware, $clonedStackTail, 'stackMiddleware was also cloned');
     }
 }
