function ContentNegotiationRoutingTest::testContentRouting

Tests the content negotiation aspect of routing.

File

core/tests/Drupal/KernelTests/Core/Routing/ContentNegotiationRoutingTest.php, line 38

Class

ContentNegotiationRoutingTest

Tests content negotiation routing variations.

Namespace

Code

public function testContentRouting() : void {
    // Alias with extension pointing to no extension/constant content-type.
    $this->createPathAlias('/content_negotiation/html', '/alias.html');
    // Alias with extension pointing to dynamic extension/linked content-type.
    $this->createPathAlias('/content_negotiation/html?_format=json', '/alias.json');
    $tests = [
        // ['path', 'accept', 'content-type'],
        // Extension is part of the route path. Constant Content-type.
[
            'content_negotiation/simple.json',
            '',
            'application/json',
        ],
        [
            'content_negotiation/simple.json',
            'application/xml',
            'application/json',
        ],
        [
            'content_negotiation/simple.json',
            'application/json',
            'application/json',
        ],
        // No extension. Constant Content-type.
[
            'content_negotiation/html',
            '',
            'text/html',
        ],
        [
            'content_negotiation/html',
            '*/*',
            'text/html',
        ],
        [
            'content_negotiation/html',
            'application/xml',
            'text/html',
        ],
        [
            'content_negotiation/html',
            'text/xml',
            'text/html',
        ],
        [
            'content_negotiation/html',
            'text/html',
            'text/html',
        ],
        // Dynamic extension. Linked Content-type.
[
            'content_negotiation/html?_format=json',
            '',
            'application/json',
        ],
        [
            'content_negotiation/html?_format=json',
            '*/*',
            'application/json',
        ],
        [
            'content_negotiation/html?_format=json',
            'application/xml',
            'application/json',
        ],
        [
            'content_negotiation/html?_format=json',
            'application/json',
            'application/json',
        ],
        [
            'content_negotiation/html?_format=xml',
            '',
            'application/xml',
        ],
        [
            'content_negotiation/html?_format=xml',
            '*/*',
            'application/xml',
        ],
        [
            'content_negotiation/html?_format=xml',
            'application/json',
            'application/xml',
        ],
        [
            'content_negotiation/html?_format=xml',
            'application/xml',
            'application/xml',
        ],
        // Path with a variable. Variable contains a period.
[
            'content_negotiation/plugin/plugin.id',
            '',
            'text/html',
        ],
        [
            'content_negotiation/plugin/plugin.id',
            '*/*',
            'text/html',
        ],
        [
            'content_negotiation/plugin/plugin.id',
            'text/xml',
            'text/html',
        ],
        [
            'content_negotiation/plugin/plugin.id',
            'text/html',
            'text/html',
        ],
        // Alias with extension pointing to no extension/constant content-type.
[
            'alias.html',
            '',
            'text/html',
        ],
        [
            'alias.html',
            '*/*',
            'text/html',
        ],
        [
            'alias.html',
            'text/xml',
            'text/html',
        ],
        [
            'alias.html',
            'text/html',
            'text/html',
        ],
    ];
    foreach ($tests as $test) {
        $path = $test[0];
        $accept_header = $test[1];
        $content_type = $test[2];
        $message = "Testing path:{$path} Accept:{$accept_header} Content-type:{$content_type}";
        $request = Request::create('/' . $path);
        if ($accept_header) {
            $request->headers
                ->set('Accept', $accept_header);
        }
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request);
        $this->assertEquals(Response::HTTP_OK, $response->getStatusCode(), $message);
        $this->assertStringContainsString($content_type, $response->headers
            ->get('Content-type'), $message);
    }
}