silverstripe-restfulserver/tests/unit/XMLDataFormatterTest.php

<?php

namespace SilverStripe\RestfulServer\Tests;

use SilverStripe\Dev\SapphireTest;
use SilverStripe\RestfulServer\DataFormatter\XMLDataFormatter;
use Exception;
use SilverStripe\Control\Controller;
use SilverStripe\ORM\DataObject;

class XMLDataFormatterTest extends SapphireTest
{
    /**
     * Tests {@link Convert::xml2array()}
     */
    public function testConvertStringToArray()
    {
        $inputXML = <<<XML
<?xml version="1.0"?>
<!DOCTYPE results [
  <!ENTITY long "SOME_SUPER_LONG_STRING">
]>
<results>
    <result>My para</result>
    <result>Ampersand &amp; is retained and not double encoded</result>
</results>
XML
        ;
        $expected = [
            'result' => [
                'My para',
                'Ampersand & is retained and not double encoded'
            ]
        ];
        $formatter = new XMLDataFormatter();
        $actual = $formatter->convertStringToArray($inputXML);
        $this->assertEquals($expected, $actual);
    }

    /**
     * Tests {@link Convert::xml2array()} if an exception the contains a reference to a removed <!ENTITY />
     */
    public function testConvertStringToArrayEntityException()
    {
        $inputXML = <<<XML
        <?xml version="1.0"?>
        <!DOCTYPE results [
            <!ENTITY long "SOME_SUPER_LONG_STRING">
        ]>
        <results>
            <result>Now include &long; lots of times to expand the in-memory size of this XML structure</result>
            <result>&long;&long;&long;</result>
        </results>
        XML;
        $this->expectException(Exception::class);
        $this->expectExceptionMessage('String could not be parsed as XML');
        $formatter = new XMLDataFormatter();
        $formatter->convertStringToArray($inputXML);
    }

    /**
     * Tests {@link Convert::xml2array()} if an exception the contains a reference to a multiple removed <!ENTITY />
     */
    public function testConvertStringToArrayMultipleEntitiesException()
    {
        $inputXML = <<<XML
        <?xml version="1.0"?>
        <!DOCTYPE results [<!ENTITY long "SOME_SUPER_LONG_STRING"><!ENTITY short "SHORT_STRING">]>
        <results>
            <result>Now include &long; and &short; lots of times</result>
            <result>&long;&long;&long;&short;&short;&short;</result>
        </results>
        XML;
        $this->expectException(Exception::class);
        $this->expectExceptionMessage('String could not be parsed as XML');
        $formatter = new XMLDataFormatter();
        $formatter->convertStringToArray($inputXML);
    }

    /**
     * Tests wrapper output of {@link XMLDataFormatter::convertDataObjectWithoutHeader()}
     */
    public function testConvertDataObjectWithoutHeaderClassNameAttribute(): void
    {
        // Create a mock object
        $mock = DataObject::create();
        $mock->ID = 1;

        // Disable trailing slash by default
        Controller::config()->set('add_trailing_slash', false);

        // Create a formatter
        $formatter = new XMLDataFormatter();

        // Test the output
        $expectedClass = 'SilverStripe-ORM-DataObject';
        $expectedHref = sprintf('http://localhost/api/v1/%s/%d.xml', $expectedClass, $mock->ID);
        $expectedOutput = sprintf(
            '<%s href="%s"><ID>%d</ID></%s>',
            $expectedClass,
            $expectedHref,
            $mock->ID,
            $expectedClass
        );

        $actualOutput = $formatter->convertDataObjectWithoutHeader($mock);

        // remove line breaks and compare
        $actualOutput = str_replace(["\n", "\r"], '', $actualOutput);
        $this->assertEquals($expectedOutput, $actualOutput);
    }

    /**
     * Tests wrapper output of {@link XMLDataFormatter::convertDataObjectWithoutHeader()} when
     * used with a forced trailing slash
     */
    public function testConvertDataObjectWithoutHeaderClassNameAttributeWithTrailingSlash(): void
    {
        // Create a mock object
        $mock = DataObject::create();
        $mock->ID = 1;

        // Enable trailing slash by default
        Controller::config()->set('add_trailing_slash', true);

        // Create a formatter
        $formatter = new XMLDataFormatter();

        // Test the output
        $expectedClass = 'SilverStripe-ORM-DataObject';
        $expectedHref = sprintf('http://localhost/api/v1/%s/%d.xml', $expectedClass, $mock->ID);
        $expectedOutput = sprintf(
            '<%s href="%s"><ID>%d</ID></%s>',
            $expectedClass,
            $expectedHref,
            $mock->ID,
            $expectedClass
        );

        $actualOutput = $formatter->convertDataObjectWithoutHeader($mock);

        // remove line breaks and compare
        $actualOutput = str_replace(["\n", "\r"], '', $actualOutput);
        $this->assertEquals($expectedOutput, $actualOutput);
    }
}