silverstripe-framework/tests/php/Control/HTTPResponseTest.php

<?php

namespace SilverStripe\Control\Tests;

use SilverStripe\Dev\SapphireTest;
use SilverStripe\Control\HTTPResponse;
use SilverStripe\Control\HTTPResponse_Exception;
use PHPUnit\Framework\Attributes\DataProvider;

class HTTPResponseTest extends SapphireTest
{
    public function testStatusDescriptionStripsNewlines()
    {
        $r = new HTTPResponse('my body', 200, "my description \nwith newlines \rand carriage returns");
        $this->assertEquals(
            "my description with newlines and carriage returns",
            $r->getStatusDescription()
        );
    }

    public function testHTTPResponseException()
    {
        $response = new HTTPResponse("Test", 200, 'OK');

        // Confirm that the exception's statusCode and statusDescription take precedence
        $e = new HTTPResponse_Exception($response, 404, 'not even found');
        $this->assertEquals(404, $e->getResponse()->getStatusCode());
        $this->assertEquals('not even found', $e->getResponse()->getStatusDescription());
    }

    public function testExceptionContentPlainByDefault()
    {
        // Confirm that the exception's statusCode and statusDescription take precedence
        $e = new HTTPResponse_Exception("Some content that may be from a hacker", 404, 'not even found');
        $this->assertEquals("text/plain", $e->getResponse()->getHeader("Content-Type"));
    }

    public function testRemoveHeader()
    {
        $response = new HTTPResponse();

        $response->addHeader('X-Animal', 'Monkey');
        $this->assertSame('Monkey', $response->getHeader('X-Animal'));

        $response->removeHeader('X-Animal');
        $this->assertEmpty($response->getHeader('X-Animal'));
    }

    public static function providerSanitiseHeaders()
    {
        return [
            'plain text is retained' => ['some arbitrary value1', 'some arbitrary value1'],
            'special chars are retained' => ['`~!@#$%^&*()_+-=,./<>?;\':"[]{}\\|', '`~!@#$%^&*()_+-=,./<>?;\':"[]{}\\|'],
            'line breaks are removed' => ['no line breaks', "n\ro line \nbreaks\r\n"],
        ];
    }

    #[DataProvider('providerSanitiseHeaders')]
    public function testSanitiseHeaders(string $expected, string $value)
    {
        $response = new HTTPResponse();

        $response->addHeader('X-Sanitised', $value);
        $this->assertSame($expected, $response->getHeader('X-Sanitised'));
    }

    public static function providerTestValidStatusCodes()
    {
        return [
            [200, 'OK'],
            [226, 'IM Used'],
            [426, 'Upgrade Required'],
            [451, 'Unavailable For Legal Reasons'],
        ];
    }

    /**
     * @param int $code
     * @param string $status
     */
    #[DataProvider('providerTestValidStatusCodes')]
    public function testValidStatusCodes($code, $status)
    {
        $response = new HTTPResponse();
        $response->setStatusCode($code);
        $this->assertEquals($status, $response->getStatusDescription());
    }
}