class ExceptionHandlingTest

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

Tests the exception handling for various cases.

@group Routing

Hierarchy

Expanded class hierarchy of ExceptionHandlingTest

File

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

Namespace

Drupal\KernelTests\Core\Routing
View source
class ExceptionHandlingTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'router_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('date_format');
    }
    
    /**
     * Tests on a route with a non-supported HTTP method.
     */
    public function test405() {
        $request = Request::create('/router_test/test15', 'PATCH');
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request);
        $this->assertEquals(Response::HTTP_METHOD_NOT_ALLOWED, $response->getStatusCode());
    }
    
    /**
     * Tests the exception handling for json and 403 status code.
     */
    public function testJson403() {
        $request = Request::create('/router_test/test15');
        $request->query
            ->set('_format', 'json');
        $request->setRequestFormat('json');
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request);
        $this->assertEquals(Response::HTTP_FORBIDDEN, $response->getStatusCode());
        $this->assertEquals('application/json', $response->headers
            ->get('Content-type'));
        $this->assertEquals('{"message":""}', $response->getContent());
        $this->assertInstanceOf(CacheableJsonResponse::class, $response);
    }
    
    /**
     * Tests the exception handling for json and 404 status code.
     */
    public function testJson404() {
        $request = Request::create('/not-found');
        $request->query
            ->set('_format', 'json');
        $request->setRequestFormat('json');
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request);
        $this->assertEquals(Response::HTTP_NOT_FOUND, $response->getStatusCode());
        $this->assertEquals('application/json', $response->headers
            ->get('Content-type'));
        $this->assertEquals('{"message":"No route found for \\u0022GET \\/not-found\\u0022"}', $response->getContent());
    }
    
    /**
     * Tests the exception handling for HTML and 403 status code.
     */
    public function testHtml403() {
        $request = Request::create('/router_test/test15');
        $request->setFormat('html', [
            'text/html',
        ]);
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request)
            ->prepare($request);
        $this->assertEquals(Response::HTTP_FORBIDDEN, $response->getStatusCode());
        $this->assertEquals('text/html; charset=UTF-8', $response->headers
            ->get('Content-type'));
    }
    
    /**
     * Tests the exception handling for HTML and 404 status code.
     */
    public function testHtml404() {
        $request = Request::create('/not-found');
        $request->setFormat('html', [
            'text/html',
        ]);
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request)
            ->prepare($request);
        $this->assertEquals(Response::HTTP_NOT_FOUND, $response->getStatusCode());
        $this->assertEquals('text/html; charset=UTF-8', $response->headers
            ->get('Content-type'));
    }
    
    /**
     * Tests that the exception response is executed in the original context.
     */
    public function testExceptionResponseGeneratedForOriginalRequest() {
        // Test with 404 path pointing to a route that uses '_controller'.
        $response = $this->doTest404Route('/router_test/test25');
        $this->assertStringContainsString('/not-found', $response->getContent());
        // Test with 404 path pointing to a route that uses '_form'.
        $response = $this->doTest404Route('/router_test/test26');
        $this->assertStringContainsString('<form class="system-logging-settings"', $response->getContent());
        // Test with 404 path pointing to a route that uses '_entity_form'.
        $response = $this->doTest404Route('/router_test/test27');
        $this->assertStringContainsString('<form class="date-format-add-form date-format-form"', $response->getContent());
    }
    
    /**
     * Sets the given path to use as the 404 page and triggers a 404.
     *
     * @param string $path
     *   The path to test.
     *
     * @return \Drupal\Core\Render\HtmlResponse
     *
     * @see \Drupal\system\Tests\Routing\ExceptionHandlingTest::testExceptionResponseGeneratedForOriginalRequest()
     */
    protected function doTest404Route($path) {
        $this->config('system.site')
            ->set('page.404', $path)
            ->save();
        $request = Request::create('/not-found');
        $request->setFormat('html', [
            'text/html',
        ]);
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        return $kernel->handle($request)
            ->prepare($request);
    }
    
    /**
     * Tests if exception backtraces are properly escaped when output to HTML.
     */
    public function testBacktraceEscaping() {
        // Enable verbose error logging.
        $this->config('system.logging')
            ->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
            ->save();
        $request = Request::create('/router_test/test17');
        $request->setFormat('html', [
            'text/html',
        ]);
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request)
            ->prepare($request);
        $this->assertEquals(Response::HTTP_INTERNAL_SERVER_ERROR, $response->getStatusCode());
        $this->assertEquals('text/html; charset=UTF-8', $response->headers
            ->get('Content-type'));
        // Test both that the backtrace is properly escaped, and that the unescaped
        // string is not output at all.
        $this->assertStringContainsString(Html::escape('<script>alert(\'xss\')</script>'), $response->getContent());
        $this->assertStringNotContainsString('<script>alert(\'xss\')</script>', $response->getContent());
    }
    
    /**
     * Tests exception message escaping.
     */
    public function testExceptionEscaping() {
        // Enable verbose error logging.
        $this->config('system.logging')
            ->set('error_level', ERROR_REPORTING_DISPLAY_VERBOSE)
            ->save();
        // Using \Drupal\Component\Render\FormattableMarkup.
        $request = Request::create('/router_test/test24');
        $request->setFormat('html', [
            'text/html',
        ]);
        
        /** @var \Symfony\Component\HttpKernel\HttpKernelInterface $kernel */
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request)
            ->prepare($request);
        $this->assertEquals(Response::HTTP_INTERNAL_SERVER_ERROR, $response->getStatusCode());
        $this->assertEquals('text/html; charset=UTF-8', $response->headers
            ->get('Content-type'));
        // Test message is properly escaped, and that the unescaped string is not
        // output at all.
        $this->setRawContent($response->getContent());
        $this->assertRaw(Html::escape('Escaped content: <p> <br> <h3>'));
        $this->assertNoRaw('<p> <br> <h3>');
        $string = '<script>alert(123);</script>';
        $request = Request::create('/router_test/test2?_format=json' . urlencode($string), 'GET');
        $kernel = \Drupal::getContainer()->get('http_kernel');
        $response = $kernel->handle($request)
            ->prepare($request);
        // As the Content-type is text/plain the fact that the raw string is
        // contained in the output would not matter, but because it is output by the
        // final exception subscriber, it is printed as partial HTML, and hence
        // escaped.
        $this->assertEquals('text/plain; charset=UTF-8', $response->headers
            ->get('Content-type'));
        $this->assertStringStartsWith('The website encountered an unexpected error. Please try again later.<br><br><em class="placeholder">Symfony\\Component\\HttpKernel\\Exception\\NotAcceptableHttpException</em>: Not acceptable format: json&lt;script&gt;alert(123);&lt;/script&gt; in <em class="placeholder">', $response->getContent());
    }

}

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 raw text IS NOT found escaped on 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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated 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.
ExceptionHandlingTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
ExceptionHandlingTest::doTest404Route protected function Sets the given path to use as the 404 page and triggers a 404.
ExceptionHandlingTest::setUp protected function Overrides KernelTestBase::setUp
ExceptionHandlingTest::test405 public function Tests on a route with a non-supported HTTP method.
ExceptionHandlingTest::testBacktraceEscaping public function Tests if exception backtraces are properly escaped when output to HTML.
ExceptionHandlingTest::testExceptionEscaping public function Tests exception message escaping.
ExceptionHandlingTest::testExceptionResponseGeneratedForOriginalRequest public function Tests that the exception response is executed in the original context.
ExceptionHandlingTest::testHtml403 public function Tests the exception handling for HTML and 403 status code.
ExceptionHandlingTest::testHtml404 public function Tests the exception handling for HTML and 404 status code.
ExceptionHandlingTest::testJson403 public function Tests the exception handling for json and 403 status code.
ExceptionHandlingTest::testJson404 public function Tests the exception handling for json and 404 status code.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
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::$keyValue protected property The key_value service that must persist between container rebuilds.
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. 7
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. 3
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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
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. 3
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::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.
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.