class ContentNegotiationRoutingTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Routing/ContentNegotiationRoutingTest.php \Drupal\KernelTests\Core\Routing\ContentNegotiationRoutingTest
  2. 10 core/tests/Drupal/KernelTests/Core/Routing/ContentNegotiationRoutingTest.php \Drupal\KernelTests\Core\Routing\ContentNegotiationRoutingTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Routing/ContentNegotiationRoutingTest.php \Drupal\KernelTests\Core\Routing\ContentNegotiationRoutingTest

Tests content negotiation routing variations.

@group ContentNegotiation

Hierarchy

Expanded class hierarchy of ContentNegotiationRoutingTest

File

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

Namespace

Drupal\KernelTests\Core\Routing
View source
class ContentNegotiationRoutingTest extends KernelTestBase {
    use PathAliasTestTrait;
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'conneg_test',
        'path_alias',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $this->installEntitySchema('path_alias');
    }
    
    /**
     * {@inheritdoc}
     */
    public function register(ContainerBuilder $container) {
        parent::register($container);
        // \Drupal\KernelTests\KernelTestBase::register() removes the alias path
        // processor.
        if ($container->hasDefinition('path_alias.path_processor')) {
            $definition = $container->getDefinition('path_alias.path_processor');
            $definition->addTag('path_processor_inbound', [
                'priority' => 100,
            ])
                ->addTag('path_processor_outbound', [
                'priority' => 300,
            ]);
        }
    }
    
    /**
     * Tests the content negotiation aspect of routing.
     */
    public function testContentRouting() {
        // Alias with extension pointing to no extension/constant content-type.
        $this->createPathAlias('/conneg/html', '/alias.html');
        // Alias with extension pointing to dynamic extension/linked content-type.
        $this->createPathAlias('/conneg/html?_format=json', '/alias.json');
        $tests = [
            // ['path', 'accept', 'content-type'],
            // Extension is part of the route path. Constant Content-type.
[
                'conneg/simple.json',
                '',
                'application/json',
            ],
            [
                'conneg/simple.json',
                'application/xml',
                'application/json',
            ],
            [
                'conneg/simple.json',
                'application/json',
                'application/json',
            ],
            // No extension. Constant Content-type.
[
                'conneg/html',
                '',
                'text/html',
            ],
            [
                'conneg/html',
                '*/*',
                'text/html',
            ],
            [
                'conneg/html',
                'application/xml',
                'text/html',
            ],
            [
                'conneg/html',
                'text/xml',
                'text/html',
            ],
            [
                'conneg/html',
                'text/html',
                'text/html',
            ],
            // Dynamic extension. Linked Content-type.
[
                'conneg/html?_format=json',
                '',
                'application/json',
            ],
            [
                'conneg/html?_format=json',
                '*/*',
                'application/json',
            ],
            [
                'conneg/html?_format=json',
                'application/xml',
                'application/json',
            ],
            [
                'conneg/html?_format=json',
                'application/json',
                'application/json',
            ],
            [
                'conneg/html?_format=xml',
                '',
                'application/xml',
            ],
            [
                'conneg/html?_format=xml',
                '*/*',
                'application/xml',
            ],
            [
                'conneg/html?_format=xml',
                'application/json',
                'application/xml',
            ],
            [
                'conneg/html?_format=xml',
                'application/xml',
                'application/xml',
            ],
            // Path with a variable. Variable contains a period.
[
                'conneg/plugin/plugin.id',
                '',
                'text/html',
            ],
            [
                'conneg/plugin/plugin.id',
                '*/*',
                'text/html',
            ],
            [
                'conneg/plugin/plugin.id',
                'text/xml',
                'text/html',
            ],
            [
                'conneg/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);
            // Verbose message since simpletest doesn't let us provide a message and
            // see the error.
            $this->assertTrue(TRUE, $message);
            $this->assertEqual($response->getStatusCode(), Response::HTTP_OK);
            $this->assertStringContainsString($content_type, $response->headers
                ->get('Content-type'));
        }
    }
    
    /**
     * Full negotiation by header only.
     */
    public function testFullNegotiation() {
        $this->enableModules([
            'accept_header_routing_test',
        ]);
        \Drupal::service('router.builder')->rebuild();
        $tests = [
            // ['path', 'accept', 'content-type'],
            // 406?
[
                'conneg/negotiate',
                '',
                'text/html',
            ],
            // 406?
[
                'conneg/negotiate',
                '',
                'text/html',
            ],
            // ['conneg/negotiate', '*/*', '??'],
[
                'conneg/negotiate',
                'application/json',
                'application/json',
            ],
            [
                'conneg/negotiate',
                'application/xml',
                'application/xml',
            ],
            [
                'conneg/negotiate',
                'application/json',
                'application/json',
            ],
            [
                'conneg/negotiate',
                'application/xml',
                'application/xml',
            ],
        ];
        foreach ($tests as $test) {
            $path = $test[0];
            $accept_header = $test[1];
            $content_type = $test[2];
            $request = Request::create('/' . $path);
            $request->headers
                ->set('Accept', $accept_header);
            
            /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
            $kernel = \Drupal::getContainer()->get('http_kernel');
            $response = $kernel->handle($request);
            $this->assertEqual($response->getStatusCode(), Response::HTTP_OK, "Testing path:{$path} Accept:{$accept_header} Content-type:{$content_type}");
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail
otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentNegotiationRoutingTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ContentNegotiationRoutingTest::register public function Registers test-specific services. Overrides KernelTestBase::register
ContentNegotiationRoutingTest::setUp protected function Overrides KernelTestBase::setUp
ContentNegotiationRoutingTest::testContentRouting public function Tests the content negotiation aspect of routing.
ContentNegotiationRoutingTest::testFullNegotiation public function Full negotiation by header only.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.