ShutdownFunctionsTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\System;

use Drupal\Tests\BrowserTestBase;

/**
 * Functional tests shutdown functions.
 *
 * @group system
 */
class ShutdownFunctionsTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function tearDown() : void {
        // This test intentionally throws an exception in a PHP shutdown function.
        // Prevent it from being interpreted as an actual test failure.
        // Not using File API; a potential error must trigger a PHP warning.
        unlink(\Drupal::root() . '/' . $this->siteDirectory . '/error.log');
        parent::tearDown();
    }
    
    /**
     * Tests shutdown functions.
     */
    public function testShutdownFunctions() : void {
        $arg1 = $this->randomMachineName();
        $arg2 = $this->randomMachineName();
        $this->drupalGet('system-test/shutdown-functions/' . $arg1 . '/' . $arg2);
        // If using PHP-FPM or output buffering, the response will be flushed to
        // the client before shutdown functions have fired.
        // @see \Drupal\system_test\Controller\SystemTestController::shutdownFunctions()
        $response_will_flush = strpos($this->getSession()
            ->getPage()
            ->getContent(), 'The response will flush before shutdown functions are called.');
        if ($response_will_flush) {
            // We need to wait to ensure that the shutdown functions have fired.
            sleep(1);
        }
        $this->assertEquals([
            $arg1,
            $arg2,
        ], \Drupal::state()->get('_system_test_first_shutdown_function'));
        $this->assertEquals([
            $arg1,
            $arg2,
        ], \Drupal::state()->get('_system_test_second_shutdown_function'));
        if (!$response_will_flush) {
            // Make sure exceptions displayed through
            // \Drupal\Core\Utility\Error::renderExceptionSafe() are correctly
            // escaped.
            $this->assertSession()
                ->responseContains('Drupal is &lt;blink&gt;awesome&lt;/blink&gt;.');
        }
    }

}