feat(mock-request): Support xml content

Author: Phillip Look

src/HttpClientMock/MockRequestBuilder.php

@@ -7,6 +7,8 @@
 use Brainbits\FunctionalTestHelpers\HttpClientMock\Exception\NoUriConfigured;
 use Brainbits\FunctionalTestHelpers\HttpClientMock\Exception\ResponseAlreadyConfigured;
 use Safe\Exceptions\JsonException;
+use Safe\Exceptions\SimplexmlException;
+use SimpleXMLElement;
 use Symfony\Component\HttpFoundation\File\File;
 use Throwable;
 
@@ -18,6 +20,7 @@
 use function Safe\json_decode;
 use function Safe\json_encode;
 use function Safe\preg_match;
+use function Safe\simplexml_load_string;
 use function Safe\sprintf;
 use function Safe\substr;
 use function str_repeat;
@@ -153,6 +156,21 @@ public function isJson(): bool
         return true;
     }
 
+    public function isXml(): bool
+    {
+        if (!$this->hasContent()) {
+            return false;
+        }
+
+        try {
+            simplexml_load_string($this->content);
+        } catch (SimplexmlException $e) {
+            return false;
+        }
+
+        return true;
+    }
+
     /**
      * @return mixed[]
      */
@@ -165,6 +183,24 @@ public function getJson(): ?array
         return json_decode($this->content, true);
     }
 
+    /**
+     * @param array<string, string> $namespaces
+     */
+    public function getXml(array $namespaces = []): ?SimpleXMLElement
+    {
+        if (!$this->isXml()) {
+            return null;
+        }
+
+        $xml = simplexml_load_string($this->content);
+
+        foreach ($namespaces as $prefix => $namespace) {
+            $xml->registerXPathNamespace($prefix, $namespace);
+        }
+
+        return $xml;
+    }
+
     public function queryParam(string $key, string $value, string ...$placeholders): self
     {
         $this->queryParams ??= [];

tests/HttpClientMock/MockRequestBuilderTest.php

@@ -135,4 +135,32 @@ public function testResponseBuilderIsResettable(): void
 
         self::assertFalse($mockRequestBuilder->hasResponseBuilder());
     }
+
+    public function testXmlStringsAreDetectedAsXml(): void
+    {
+        $mockRequestBuilder = new MockRequestBuilder();
+        $mockRequestBuilder->content('<root><first>abc</first></root>');
+
+        self::assertTrue($mockRequestBuilder->isXml());
+        self::assertFalse($mockRequestBuilder->isEmpty());
+        self::assertFalse($mockRequestBuilder->isJson());
+    }
+
+    public function testXmlStringsAreAccessibleAsSimpleXmlObjects(): void
+    {
+        $mockRequestBuilder = new MockRequestBuilder();
+        $mockRequestBuilder->content('<root><first>abc</first></root>');
+
+        self::assertSame('abc', (string) $mockRequestBuilder->getXml()->first);
+    }
+
+    public function testXmlStringsWithNamespacesAreAccessibleAsSimpleXmlObjects(): void
+    {
+        $mockRequestBuilder = new MockRequestBuilder();
+        $mockRequestBuilder->content('<root xmlns="http://example.org/xml"><first>abc</first></root>');
+
+        $xml = $mockRequestBuilder->getXml(['x' => 'http://example.org/xml']);
+
+        self::assertSame('abc', (string) $xml->xpath('//x:first')[0]);
+    }
 }