minor #58265 [Webhook] add WebhookController tests (kbond)

kbond · kbond · commit d3d2e4387a0f · 2024-09-14T14:18:07.000-04:00
This PR was merged into the 7.2 branch. Discussion ---------- [Webhook] add `WebhookController` tests | Q | A | ------------- | --- | Branch? | 7.2 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | n/a | License | MIT Just adds tests to WebhookController to prepare for possible changes in #58248. Commits ------- 5bcd490 [Webhook] add WebhookController tests
diff --git a/src/Symfony/Component/Webhook/Tests/Controller/WebhookControllerTest.php b/src/Symfony/Component/Webhook/Tests/Controller/WebhookControllerTest.php
@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Webhook\Tests\Controller;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Messenger\Envelope;
+use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\RemoteEvent\Messenger\ConsumeRemoteEventMessage;
+use Symfony\Component\RemoteEvent\RemoteEvent;
+use Symfony\Component\Webhook\Client\RequestParserInterface;
+use Symfony\Component\Webhook\Controller\WebhookController;
+
+class WebhookControllerTest extends TestCase
+{
+    public function testNoParserAvailable()
+    {
+        $controller = new WebhookController([], $this->createMock(MessageBusInterface::class));
+
+        $response = $controller->handle('foo', new Request());
+
+        $this->assertSame(404, $response->getStatusCode());
+    }
+
+    public function testParserRejectsPayload()
+    {
+        $secret = '1234';
+        $request = new Request();
+        $parser = $this->createMock(RequestParserInterface::class);
+        $parser
+            ->expects($this->once())
+            ->method('parse')
+            ->with($request, $secret)
+            ->willReturn(null);
+        $parser
+            ->expects($this->once())
+            ->method('createRejectedResponse')
+            ->with('Unable to parse the webhook payload.', $request)
+            ->willReturn(new Response('Unable to parse the webhook payload.', 406));
+
+        $controller = new WebhookController(
+            ['foo' => ['parser' => $parser, 'secret' => $secret]],
+            $this->createMock(MessageBusInterface::class)
+        );
+
+        $response = $controller->handle('foo', $request);
+
+        $this->assertSame(406, $response->getStatusCode());
+        $this->assertSame('Unable to parse the webhook payload.', $response->getContent());
+    }
+
+    public function testParserAcceptsPayload()
+    {
+        $secret = '1234';
+        $request = new Request();
+        $event = new RemoteEvent('name', 'id', ['payload']);
+        $parser = $this->createMock(RequestParserInterface::class);
+        $parser
+            ->expects($this->once())
+            ->method('parse')
+            ->with($request, $secret)
+            ->willReturn($event);
+        $parser
+            ->expects($this->once())
+            ->method('createSuccessfulResponse')
+            ->with($request)
+            ->willReturn(new Response('', 202));
+        $bus = new class implements MessageBusInterface {
+            public ?object $message = null;
+
+            public function dispatch(object $message, array $stamps = []): Envelope
+            {
+                return new Envelope($this->message = $message, $stamps);
+            }
+        };
+
+        $controller = new WebhookController(
+            ['foo' => ['parser' => $parser, 'secret' => $secret]],
+            $bus,
+        );
+
+        $response = $controller->handle('foo', $request);
+
+        $this->assertSame(202, $response->getStatusCode());
+        $this->assertSame('', $response->getContent());
+        $this->assertInstanceOf(ConsumeRemoteEventMessage::class, $bus->message);
+        $this->assertSame('foo', $bus->message->getType());
+        $this->assertEquals($event, $bus->message->getEvent());
+    }
+}
