feat: Improve multipart handling in request builder

Stephan Wentz · pl-github · commit 9b4840630d04 · 2024-10-31T15:29:50.000+01:00
BREAKING CHANGE: Use MockRequestBuilder-&gt;multipart() instead of MockRequestBuilder-&gt;multipartFile()
diff --git a/src/HttpClientMock/MockRequestBuilder.php b/src/HttpClientMock/MockRequestBuilder.php
@@ -62,7 +62,7 @@ final class MockRequestBuilder
 
     private string|null $content = null;
 
-    /** @var mixed[]|null */
+    /** @var array<string, array{filename?: string|null, mimetype?: string|null, content?: string|null}>|null */
     private array|null $multiparts = null;
 
     /** @var callable(MockRequestBuilder $expectation, MockRequestBuilder $realRequest): ?string|null */
@@ -277,27 +277,43 @@ public function hasRequestParams(): bool
         return (bool) preg_match('/[^=]+=[^=]*(&[^=]+=[^=]*)*/', (string) $this->content) && !$this->isJson();
     }
 
-    public function multipartFile(string $name, string|null $filename, string $mimetype, int $size): self
-    {
+    public function multipart(
+        string $name,
+        string|null $mimetype = null,
+        string|null $filename = null,
+        string|null $content = null,
+    ): self {
         $this->multiparts ??= [];
-        $this->multiparts[$name] = [
-            'type' => $filename !== null ? 'file' : 'data',
-            'filename' => $filename,
-            'mimetype' => $mimetype,
-            'size' => $size,
-        ];
+        $this->multiparts[$name] = [];
+
+        if ($mimetype !== null) {
+            $this->multiparts[$name]['mimetype'] = $mimetype;
+        }
+
+        if ($filename !== null) {
+            $this->multiparts[$name]['filename'] = $filename;
+        }
+
+        if ($content !== null) {
+            $this->multiparts[$name]['content'] = $content;
+        }
 
         return $this;
     }
 
-    public function multipartFileFromFile(string $name, File $file): self
+    public function multipartFromFile(string $name, File $file): self
     {
-        $this->multipartFile($name, $file->getBasename(), $file->getMimeType(), $file->getSize());
+        $this->multipart(
+            $name,
+            mimetype: $file->getMimeType(),
+            filename: $file->getBasename(),
+            content: $file->getContent(),
+        );
 
         return $this;
     }
 
-    /** @return mixed[]|null */
+    /** @return array<string, array{filename?: string|null, mimetype?: string|null, content?: string|null}>|null */
     public function getMultiparts(): array|null
     {
         return $this->multiparts;
diff --git a/src/HttpClientMock/MockRequestBuilderFactory.php b/src/HttpClientMock/MockRequestBuilderFactory.php
@@ -18,7 +18,6 @@
 use function Safe\json_decode;
 use function Safe\preg_match;
 use function Safe\rewind;
-use function strlen;
 use function strpos;
 use function urldecode;
 
@@ -113,11 +112,12 @@ private function processBody(
             $mp = new StreamedPart($stream);
             foreach ($mp->getParts() as $part) {
                 assert($part instanceof StreamedPart);
-                $mockRequestBuilder->multipartFile(
+
+                $mockRequestBuilder->multipart(
                     $part->getName(),
-                    $part->getFileName(),
-                    $part->getMimeType(),
-                    strlen($part->getBody()),
+                    mimetype: $part->getMimeType(),
+                    filename: $part->getFileName(),
+                    content: $part->getBody(),
                 );
             }
 
diff --git a/src/HttpClientMock/MockRequestMatcher.php b/src/HttpClientMock/MockRequestMatcher.php
@@ -98,10 +98,10 @@ public function __invoke(MockRequestBuilder $expectation, MockRequestBuilder $re
         }
 
         if ($expectation->getMultiparts() !== null) {
-            if (!($this->compare)($expectation->getMultiparts(), $realRequest->getMultiparts())) {
+            if (!$this->isMultipartMatching($expectation, $realRequest)) {
                 return MockRequestMatch::mismatchingMultiparts(
                     $expectation->getMultiparts(),
-                    $realRequest->getMultiparts(),
+                    $this->reduceMultiparts($expectation, $realRequest),
                 );
             }
         }
@@ -166,6 +166,42 @@ private function isPlainContentMatching(MockRequestBuilder $expectation, MockReq
         return $expectation->getContent() === $realRequest->getContent();
     }
 
+    /** @return array<string, array{mimetype?: string|null, filename?: string|null, content?: string|null}> */
+    private function reduceMultiparts(MockRequestBuilder $expectation, MockRequestBuilder $realRequest): array
+    {
+        $realMultiparts = $realRequest->getMultiparts();
+        $expectationMultiparts = $expectation->getMultiparts();
+
+        $reducedMultiparts = $realMultiparts;
+        foreach ($expectationMultiparts as $key => $data) {
+            if (!($realMultiparts[$key] ?? false)) {
+                continue;
+            }
+
+            $reducedMultiparts[$key] = [];
+            foreach ($data as $name => $value) {
+                $reducedMultiparts[$key][$name] = $value !== null ? $realMultiparts[$key][$name] : null;
+            }
+        }
+
+        return $reducedMultiparts;
+    }
+
+    private function isMultipartMatching(MockRequestBuilder $expectation, MockRequestBuilder $realRequest): bool
+    {
+        if (!$expectation->hasMultiparts() && !$realRequest->hasMultiparts()) {
+            return true;
+        }
+
+        if (!$expectation->hasMultiparts() || !$realRequest->hasMultiparts()) {
+            return false;
+        }
+
+        $realMultiparts = $this->reduceMultiparts($expectation, $realRequest);
+
+        return ($this->compare)($expectation->getMultiparts(), $realMultiparts);
+    }
+
     private function isJsonContentMatching(MockRequestBuilder $expectation, MockRequestBuilder $realRequest): bool
     {
         if (!$expectation->hasContent() || !$expectation->isJson()) {
diff --git a/tests/HttpClientMock/MockRequestBuilderCollectionTest.php b/tests/HttpClientMock/MockRequestBuilderCollectionTest.php
@@ -6,17 +6,18 @@
 
 use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilder;
 use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilderCollection;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestMatch;
+use Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestMatcher;
 use Brainbits\FunctionalTestHelpers\HttpClientMock\MockResponseBuilder;
 use Brainbits\FunctionalTestHelpers\HttpClientMock\SymfonyMockResponseFactory;
+use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\Attributes\DataProvider;
 use PHPUnit\Framework\TestCase;
 
-/**
- * @covers \Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilder
- * @covers \Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestBuilderCollection
- * @covers \Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestMatch
- * @covers \Brainbits\FunctionalTestHelpers\HttpClientMock\MockRequestMatcher
- */
+#[CoversClass(MockRequestBuilder::class)]
+#[CoversClass(MockRequestBuilderCollection::class)]
+#[CoversClass(MockRequestMatch::class)]
+#[CoversClass(MockRequestMatcher::class)]
 final class MockRequestBuilderCollectionTest extends TestCase
 {
     private MockRequestBuilderCollection $collection;
@@ -82,6 +83,12 @@ public function setUp(): void
                 ->uri('/bar')
                 ->content('content')
                 ->willRespond(new MockResponseBuilder()),
+
+            'postBarWithMultipart' => (new MockRequestBuilder())
+                ->method('POST')
+                ->uri('/barx')
+                ->multipart('key', 'application/octet-stream', null, 'content')
+                ->willRespond(new MockResponseBuilder()),
         ];
 
         $this->collection = new MockRequestBuilderCollection(new SymfonyMockResponseFactory());
@@ -135,6 +142,21 @@ public static function requests(): array
                 ['body' => 'content', 'headers' => ['Content-Type: application/x-www-form-urlencoded']],
                 'postBarWithContent',
             ],
+            'postBarWithMultipart' => [
+                'POST',
+                '/barx',
+                [
+                    'body' => <<<'BODY'
+                    --12345
+                    Content-Disposition: form-data; name="key"
+                    
+                    content
+                    --12345--
+                    BODY,
+                    'headers' => ['Content-Type: multipart/form-data; boundary=12345'],
+                ],
+                'postBarWithMultipart',
+            ],
         ];
     }
 }
diff --git a/tests/HttpClientMock/MockRequestBuilderTest.php b/tests/HttpClientMock/MockRequestBuilderTest.php
@@ -12,6 +12,9 @@
 use PHPUnit\Framework\Attributes\CoversClass;
 use PHPUnit\Framework\TestCase;
 use RuntimeException;
+use Symfony\Component\HttpFoundation\File\File;
+
+use function Safe\file_get_contents;
 
 #[CoversClass(MockRequestBuilder::class)]
 final class MockRequestBuilderTest extends TestCase
@@ -288,4 +291,39 @@ public function testWithBasicAuthentication(): void
 
         $this->assertSame('Basic dXNlcm5hbWU6cGFzc3dvcmQ=', $mockRequestBuilder->getHeader('Authorization'));
     }
+
+    public function testWithMultipart(): void
+    {
+        $mockRequestBuilder = new MockRequestBuilder();
+        $mockRequestBuilder->multipart('key', 'mimetype', 'filename', 'content');
+
+        $this->assertTrue($mockRequestBuilder->hasMultiparts());
+        $this->assertSame(
+            [
+                'key' => [
+                    'mimetype' => 'mimetype',
+                    'filename' => 'filename',
+                    'content' => 'content',
+                ],
+            ],
+            $mockRequestBuilder->getMultiparts(),
+        );
+    }
+
+    public function testWithMultipartFromFile(): void
+    {
+        $mockRequestBuilder = new MockRequestBuilder();
+        $mockRequestBuilder->multipartFromFile('key', new File(__DIR__ . '/../files/test.zip'));
+
+        $this->assertSame(
+            [
+                'key' => [
+                    'mimetype' => 'application/zip',
+                    'filename' => 'test.zip',
+                    'content' => file_get_contents(__DIR__ . '/../files/test.zip'),
+                ],
+            ],
+            $mockRequestBuilder->getMultiparts(),
+        );
+    }
 }
diff --git a/tests/HttpClientMock/MockRequestMatcherTest.php b/tests/HttpClientMock/MockRequestMatcherTest.php
