class BrowserTestBaseTest

Same name in this branch
  1. 10 core/tests/Drupal/KernelTests/Core/Test/BrowserTestBaseTest.php \Drupal\KernelTests\Core\Test\BrowserTestBaseTest
  2. 10 core/tests/Drupal/Tests/Core/Test/BrowserTestBaseTest.php \Drupal\Tests\Core\Test\BrowserTestBaseTest
Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Test/BrowserTestBaseTest.php \Drupal\KernelTests\Core\Test\BrowserTestBaseTest
  2. 9 core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php \Drupal\FunctionalTests\BrowserTestBaseTest
  3. 9 core/tests/Drupal/Tests/Core/Test/BrowserTestBaseTest.php \Drupal\Tests\Core\Test\BrowserTestBaseTest
  4. 8.9.x core/tests/Drupal/KernelTests/Core/Test/BrowserTestBaseTest.php \Drupal\KernelTests\Core\Test\BrowserTestBaseTest
  5. 8.9.x core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php \Drupal\FunctionalTests\BrowserTestBaseTest
  6. 8.9.x core/tests/Drupal/Tests/Core/Test/BrowserTestBaseTest.php \Drupal\Tests\Core\Test\BrowserTestBaseTest
  7. 11.x core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php \Drupal\FunctionalTests\BrowserTestBaseTest
  8. 11.x core/tests/Drupal/Tests/Core/Test/BrowserTestBaseTest.php \Drupal\Tests\Core\Test\BrowserTestBaseTest

Tests BrowserTestBase functionality.

@group browsertestbase @group #slow

Hierarchy

Expanded class hierarchy of BrowserTestBaseTest

File

core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php, line 27

Namespace

Drupal\FunctionalTests
View source
class BrowserTestBaseTest extends BrowserTestBase {
    use PathAliasTestTrait;
    use CronRunTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'test_page_test',
        'form_test',
        'system_test',
        'node',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests that JavaScript Drupal settings can be read.
     */
    public function testDrupalSettings() : void {
        // Trigger a 403 because those pages have very little else going on.
        $this->drupalGet('admin');
        $this->assertSame([], $this->getDrupalSettings());
        // Now try the same 403 as an authenticated user and verify that Drupal
        // settings do show up.
        $account = $this->drupalCreateUser();
        $this->drupalLogin($account);
        $this->drupalGet('admin');
        $this->assertNotSame([], $this->getDrupalSettings());
    }
    
    /**
     * Tests basic page test.
     */
    public function testGoTo() : void {
        $account = $this->drupalCreateUser();
        $this->drupalLogin($account);
        // Visit a Drupal page that requires login.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Test page contains some text.
        $this->assertSession()
            ->pageTextContains('Test page text.');
        // Check that returned plain text is correct.
        $text = $this->getTextContent();
        $this->assertStringContainsString('Test page text.', $text);
        $this->assertStringNotContainsString('</html>', $text);
        // Ensure Drupal Javascript settings are not part of the page text.
        $this->assertArrayHasKey('currentPathIsAdmin', $this->getDrupalSettings()['path']);
        $this->assertStringNotContainsString('currentPathIsAdmin', $text);
        // Response includes cache tags that we can assert.
        $this->assertSession()
            ->responseHeaderExists('X-Drupal-Cache-Tags');
        $this->assertSession()
            ->responseHeaderEquals('X-Drupal-Cache-Tags', 'http_response rendered');
        // Test that we can read the JS settings.
        $js_settings = $this->getDrupalSettings();
        $this->assertSame('azAZ09();.,\\\\/-_{}', $js_settings['test-setting']);
        // Test drupalGet with a URL object.
        $url = Url::fromRoute('test_page_test.render_title');
        $this->drupalGet($url);
        $this->assertSession()
            ->statusCodeEquals(200);
        // Test page contains some text.
        $this->assertSession()
            ->pageTextContains('Hello Drupal');
        // Test that setting headers with drupalGet() works.
        $this->drupalGet('system-test/header', [], [
            'Test-Header' => 'header value',
        ]);
        $this->assertSession()
            ->responseHeaderExists('Test-Header');
        $this->assertSession()
            ->responseHeaderEquals('Test-Header', 'header value');
        // Ensure that \Drupal\Tests\UiHelperTrait::isTestUsingGuzzleClient() works
        // as expected.
        $this->assertTrue($this->isTestUsingGuzzleClient());
    }
    
    /**
     * Tests drupalGet().
     */
    public function testDrupalGet() : void {
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('test-page');
        $this->drupalGet('/test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('test-page');
        $this->drupalGet('/test-page/');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('/test-page/');
        // Test alias handling.
        $this->createPathAlias('/test-page', '/test-alias');
        $this->rebuildAll();
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('test-alias');
        $this->drupalGet('/test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('test-alias');
        $this->drupalGet('/test-page/');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->addressEquals('/test-page/');
    }
    
    /**
     * Tests basic form functionality.
     */
    public function testForm() : void {
        // Ensure the proper response code for a _form route.
        $this->drupalGet('form-test/object-builder');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Ensure the form and text field exist.
        $this->assertSession()
            ->elementExists('css', 'form#form-test-form-test-object');
        $this->assertSession()
            ->fieldExists('bananas');
        // Check that the hidden field exists and has a specific value.
        $this->assertSession()
            ->hiddenFieldExists('strawberry');
        $this->assertSession()
            ->hiddenFieldExists('red');
        $this->assertSession()
            ->hiddenFieldExists('red-strawberry-hidden-field');
        $this->assertSession()
            ->hiddenFieldValueNotEquals('strawberry', 'brown');
        $this->assertSession()
            ->hiddenFieldValueEquals('strawberry', 'red');
        // Check that a hidden field does not exist.
        $this->assertSession()
            ->hiddenFieldNotExists('bananas');
        $this->assertSession()
            ->hiddenFieldNotExists('pineapple');
        $edit = [
            'bananas' => 'green',
        ];
        $this->submitForm($edit, 'Save', 'form-test-form-test-object');
        $config_factory = $this->container
            ->get('config.factory');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('green', $value);
        // Test submitForm().
        $this->drupalGet('form-test/object-builder');
        // Submit the form using the button label.
        $this->submitForm([
            'bananas' => 'red',
        ], 'Save');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('red', $value);
        $this->submitForm([], 'Save');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('', $value);
        // Submit the form using the button id.
        $this->submitForm([
            'bananas' => 'blue',
        ], 'edit-submit');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('blue', $value);
        // Submit the form using the button name.
        $this->submitForm([
            'bananas' => 'purple',
        ], 'op');
        $value = $config_factory->get('form_test.object')
            ->get('bananas');
        $this->assertSame('purple', $value);
        // Test submitForm() with no-html response.
        $this->drupalGet('form_test/form-state-values-clean');
        $this->submitForm([], 'Submit');
        $values = Json::decode($this->getSession()
            ->getPage()
            ->getContent());
        $this->assertSame(1000, $values['beer']);
        // Test submitForm() with form by HTML id.
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->drupalLogin($this->drupalCreateUser([
            'create page content',
        ]));
        $this->drupalGet('form-test/two-instances-of-same-form');
        $this->getSession()
            ->getPage()
            ->fillField('edit-title-0-value', 'form1');
        $this->getSession()
            ->getPage()
            ->fillField('edit-title-0-value--2', 'form2');
        $this->submitForm([], 'Save', 'node-page-form--2');
        $this->assertSession()
            ->pageTextContains('Page form2 has been created.');
    }
    
    /**
     * Tests clickLink() functionality.
     */
    public function testClickLink() : void {
        $this->drupalGet('test-page');
        $this->clickLink('Visually identical test links');
        $this->assertStringContainsString('user/login', $this->getSession()
            ->getCurrentUrl());
        $this->drupalGet('test-page');
        $this->clickLink('Visually identical test links', 0);
        $this->assertStringContainsString('user/login', $this->getSession()
            ->getCurrentUrl());
        $this->drupalGet('test-page');
        $this->clickLink('Visually identical test links', 1);
        $this->assertStringContainsString('user/register', $this->getSession()
            ->getCurrentUrl());
    }
    public function testError() : void {
        $this->expectException('\\Exception');
        $this->expectExceptionMessage('User notice: foo');
        $this->drupalGet('test-error');
    }
    
    /**
     * Tests legacy field asserts which use xpath directly.
     */
    public function testXpathAsserts() : void {
        $this->drupalGet('test-field-xpath');
        $this->assertSession()
            ->elementTextContains('xpath', '//table/tbody/tr[2]/td[1]', 'one');
        $this->assertSession()
            ->fieldValueEquals('edit-name', 'Test name');
        $this->assertSession()
            ->fieldValueEquals('edit-options', '2');
        $this->assertSession()
            ->elementNotExists('xpath', '//notexisting');
        $this->assertSession()
            ->fieldValueNotEquals('edit-name', 'wrong value');
        // Test that the assertion fails correctly.
        try {
            $this->assertSession()
                ->fieldExists('notexisting');
            $this->fail('The "notexisting" field was found.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        try {
            $this->assertSession()
                ->fieldNotExists('edit-name');
            $this->fail('The "edit-name" field was not found.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
    }
    
    /**
     * Tests field asserts using textfields.
     */
    public function testFieldAssertsForTextfields() : void {
        $this->drupalGet('test-field-xpath');
        // *** 1. fieldNotExists().
        $this->assertSession()
            ->fieldNotExists('invalid_name_and_id');
        // Test that the assertion fails correctly when searching by name.
        try {
            $this->assertSession()
                ->fieldNotExists('name');
            $this->fail('The "name" field was not found based on name.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Test that the assertion fails correctly when searching by id.
        try {
            $this->assertSession()
                ->fieldNotExists('edit-name');
            $this->fail('The "name" field was not found based on id.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // *** 2. fieldExists().
        $this->assertSession()
            ->fieldExists('name');
        $this->assertSession()
            ->fieldExists('edit-name');
        // Test that the assertion fails correctly if the field does not exist.
        try {
            $this->assertSession()
                ->fieldExists('invalid_name_and_id');
            $this->fail('The "invalid_name_and_id" field was found.');
        } catch (ElementNotFoundException $e) {
            // Expected exception; just continue testing.
        }
        // *** 3. assertNoFieldById().
        $this->assertSession()
            ->fieldValueNotEquals('name', 'not the value');
        $this->assertSession()
            ->fieldNotExists('notexisting');
        // Test that the assertion fails correctly if no value is passed in.
        try {
            $this->assertSession()
                ->fieldNotExists('edit-description');
            $this->fail('The "description" field, with no value was not found.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Test that the assertion fails correctly if a NULL value is passed in.
        try {
            $this->assertSession()
                ->fieldNotExists('name', NULL);
            $this->fail('The "name" field was not found.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // *** 4. assertFieldById().
        $this->assertSession()
            ->fieldExists('edit-name');
        $this->assertSession()
            ->fieldValueEquals('edit-name', 'Test name');
        $this->assertSession()
            ->fieldExists('edit-description');
        $this->assertSession()
            ->fieldValueEquals('edit-description', '');
        // Test that the assertion fails correctly if no value is passed in.
        try {
            $this->assertSession()
                ->fieldValueNotEquals('edit-name', '');
        } catch (ExpectationFailedException $e) {
            // Expected exception; just continue testing.
        }
        // Test that the assertion fails correctly if the wrong value is passed in.
        try {
            $this->assertSession()
                ->fieldValueNotEquals('edit-name', 'not the value');
        } catch (ExpectationFailedException $e) {
            // Expected exception; just continue testing.
        }
        // *** 5. fieldValueNotEquals().
        $this->assertSession()
            ->fieldValueNotEquals('name', 'not the value');
        // Test that the assertion fails correctly if given the right value.
        try {
            $this->assertSession()
                ->fieldValueNotEquals('name', 'Test name');
            $this->fail('fieldValueNotEquals failed to throw an exception.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // *** 6. fieldValueEquals().
        $this->assertSession()
            ->fieldValueEquals('name', 'Test name');
        $this->assertSession()
            ->fieldValueEquals('description', '');
        // Test that the assertion fails correctly if given the wrong value.
        try {
            $this->assertSession()
                ->fieldValueEquals('name', 'not the value');
            $this->fail('fieldValueEquals failed to throw an exception.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Test that text areas can contain new lines.
        $this->assertSession()
            ->fieldValueEquals('edit-test-textarea-with-newline', "Test text with\nnewline");
    }
    
    /**
     * Tests legacy field asserts for checkbox field type.
     */
    public function testFieldAssertsForCheckbox() : void {
        $this->drupalGet('test-field-xpath');
        // Part 1 - Test by name.
        // Test that checkboxes are found/not found correctly by name, when using
        // '1' or '' to match their 'checked' state.
        $this->assertSession()
            ->fieldExists('checkbox_enabled');
        $this->assertSession()
            ->fieldExists('checkbox_disabled');
        $this->assertSession()
            ->fieldValueEquals('checkbox_enabled', '1');
        $this->assertSession()
            ->fieldValueEquals('checkbox_disabled', '');
        $this->assertSession()
            ->fieldValueNotEquals('checkbox_enabled', '');
        $this->assertSession()
            ->fieldValueNotEquals('checkbox_disabled', '1');
        // Test that we have legacy support.
        $this->assertSession()
            ->fieldValueEquals('checkbox_enabled', '1');
        $this->assertSession()
            ->fieldValueEquals('checkbox_disabled', '');
        // Test that the assertion fails correctly if given the right value.
        try {
            $this->assertSession()
                ->fieldValueNotEquals('checkbox_enabled', '1');
            $this->fail('fieldValueNotEquals failed to throw an exception.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Part 2 - Test by ID.
        // Test that checkboxes are found/not found correctly by ID, when using
        // '1' or '' to match their 'checked' state.
        $this->assertSession()
            ->fieldValueEquals('edit-checkbox-enabled', '1');
        $this->assertSession()
            ->fieldValueEquals('edit-checkbox-disabled', '');
        $this->assertSession()
            ->fieldValueNotEquals('edit-checkbox-enabled', '');
        $this->assertSession()
            ->fieldValueNotEquals('edit-checkbox-disabled', '1');
        // Test that checkboxes are found by ID, when using NULL to ignore the
        // 'checked' state.
        $this->assertSession()
            ->fieldExists('edit-checkbox-enabled');
        $this->assertSession()
            ->fieldExists('edit-checkbox-disabled');
        // Test that checkboxes are found by ID when passing no second parameter.
        $this->assertSession()
            ->fieldExists('edit-checkbox-enabled');
        $this->assertSession()
            ->fieldExists('edit-checkbox-disabled');
        // Test that we have legacy support.
        $this->assertSession()
            ->fieldValueEquals('edit-checkbox-enabled', '1');
        $this->assertSession()
            ->fieldValueEquals('edit-checkbox-disabled', '');
        // Test that the assertion fails correctly when using NULL to ignore state.
        try {
            $this->assertSession()
                ->fieldNotExists('edit-checkbox-disabled', NULL);
            $this->fail('The "edit-checkbox-disabled" field was not found by ID, using NULL value.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Part 3 - Test the specific 'checked' assertions.
        $this->assertSession()
            ->checkboxChecked('edit-checkbox-enabled');
        $this->assertSession()
            ->checkboxNotChecked('edit-checkbox-disabled');
        // Test that the assertion fails correctly with non-existent field id.
        try {
            $this->assertSession()
                ->checkboxNotChecked('incorrect_checkbox_id');
            $this->fail('The "incorrect_checkbox_id" field was found');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Test that the assertion fails correctly for a checkbox that is checked.
        try {
            $this->assertSession()
                ->checkboxNotChecked('edit-checkbox-enabled');
            $this->fail('The "edit-checkbox-enabled" field was not found in a checked state.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
        // Test that the assertion fails correctly for a checkbox that is not
        // checked.
        try {
            $this->assertSession()
                ->checkboxChecked('edit-checkbox-disabled');
            $this->fail('The "edit-checkbox-disabled" field was found and checked.');
        } catch (ExpectationException $e) {
            // Expected exception; just continue testing.
        }
    }
    
    /**
     * Tests the ::cronRun() method.
     */
    public function testCronRun() : void {
        $last_cron_time = \Drupal::state()->get('system.cron_last');
        $this->cronRun();
        $this->assertSession()
            ->statusCodeEquals(204);
        $next_cron_time = \Drupal::state()->get('system.cron_last');
        $this->assertGreaterThan($last_cron_time, $next_cron_time);
    }
    
    /**
     * Tests the Drupal install done in \Drupal\Tests\BrowserTestBase::setUp().
     */
    public function testInstall() : void {
        $htaccess_filename = $this->tempFilesDirectory . '/.htaccess';
        $this->assertFileExists($htaccess_filename);
        // Ensure the update module is not installed.
        $this->assertFalse(\Drupal::moduleHandler()->moduleExists('update'), 'The Update module is not installed.');
    }
    
    /**
     * Tests the assumption that local time is in 'Australia/Sydney'.
     */
    public function testLocalTimeZone() : void {
        $expected = 'Australia/Sydney';
        // The 'Australia/Sydney' time zone is set in core/tests/bootstrap.php
        $this->assertEquals($expected, date_default_timezone_get());
        // The 'Australia/Sydney' time zone is also set in
        // FunctionalTestSetupTrait::initConfig().
        $config_factory = $this->container
            ->get('config.factory');
        $value = $config_factory->get('system.date')
            ->get('timezone.default');
        $this->assertEquals($expected, $value);
        // Test that users have the correct time zone set.
        $this->assertEquals($expected, $this->rootUser
            ->getTimeZone());
        $admin_user = $this->drupalCreateUser([
            'administer site configuration',
        ]);
        $this->assertEquals($expected, $admin_user->getTimeZone());
    }
    
    /**
     * Tests the ::checkForMetaRefresh() method.
     */
    public function testCheckForMetaRefresh() : void {
        // Disable following redirects in the client.
        $this->getSession()
            ->getDriver()
            ->getClient()
            ->followRedirects(FALSE);
        // Set the maximumMetaRefreshCount to zero to make sure the redirect doesn't
        // happen when doing a drupalGet.
        $this->maximumMetaRefreshCount = 0;
        $this->drupalGet('test-meta-refresh');
        $this->assertNotEmpty($this->cssSelect('meta[http-equiv="refresh"]'));
        // Allow one redirect to happen.
        $this->maximumMetaRefreshCount = 1;
        $this->checkForMetaRefresh();
        // Check that we are now on the test page.
        $this->assertSession()
            ->pageTextContains('Test page text.');
    }
    public function testGetDefaultDriveInstance() : void {
        putenv('MINK_DRIVER_ARGS=' . json_encode([
            NULL,
            [
                'key1' => [
                    'key2' => [
                        'key3' => 3,
                        'key3.1' => 3.1,
                    ],
                ],
            ],
        ]));
        $this->getDefaultDriverInstance();
        $this->assertEquals([
            NULL,
            [
                'key1' => [
                    'key2' => [
                        'key3' => 3,
                        'key3.1' => 3.1,
                    ],
                ],
            ],
        ], $this->minkDefaultDriverArgs);
    }
    
    /**
     * Ensures we can't access modules we shouldn't be able to after install.
     */
    public function testProfileModules() : void {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('The module demo_umami_content does not exist.');
        $this->assertFileExists('core/profiles/demo_umami/modules/demo_umami_content/demo_umami_content.info.yml');
        \Drupal::service('extension.list.module')->getPathname('demo_umami_content');
    }
    
    /**
     * Tests the protections provided by .htkey.
     */
    public function testHtKey() : void {
        // Remove the Simpletest private key file so we can test the protection
        // against requests that forge a valid testing user agent to gain access
        // to the installer.
        // @see drupal_valid_test_ua()
        // Not using File API; a potential error must trigger a PHP warning.
        $install_url = Url::fromUri('base:core/install.php', [
            'external' => TRUE,
            'absolute' => TRUE,
        ])->toString();
        $this->drupalGet($install_url);
        $this->assertSession()
            ->statusCodeEquals(200);
        unlink($this->siteDirectory . '/.htkey');
        $this->drupalGet($install_url);
        $this->assertSession()
            ->statusCodeEquals(403);
    }
    
    /**
     * Tests that a usable session is on the request in test-runner.
     */
    public function testSessionOnRequest() : void {
        
        /** @var \Symfony\Component\HttpFoundation\Session\Session $session */
        $session = $this->container
            ->get('request_stack')
            ->getSession();
        $session->set('some-val', 'do-not-cleanup');
        $this->assertEquals('do-not-cleanup', $session->get('some-val'));
        $session->set('some-other-val', 'do-cleanup');
        $this->assertEquals('do-cleanup', $session->remove('some-other-val'));
    }
    
    /**
     * Tests deprecation of modified request stack lacking a session.
     *
     * @group legacy
     */
    public function testDeprecatedSessionMissing() : void {
        $this->expectDeprecation('Pushing requests without a session onto the request_stack is deprecated in drupal:10.3.0 and an error will be thrown from drupal:11.0.0. See https://www.drupal.org/node/3337193');
        $this->container
            ->get('request_stack')
            ->push(Request::create('/'));
    }
    
    /**
     * Tests that deprecation headers do not get duplicated.
     *
     * @group legacy
     *
     * @see \Drupal\Core\Test\HttpClientMiddleware\TestHttpClientMiddleware::__invoke()
     */
    public function testDeprecationHeaders() : void {
        $this->drupalGet('/test-deprecations');
        $deprecation_messages = [];
        foreach ($this->getSession()
            ->getResponseHeaders() as $name => $values) {
            if (preg_match('/^X-Drupal-Assertion-[0-9]+$/', $name, $matches)) {
                foreach ($values as $value) {
                    $parameters = unserialize(urldecode($value));
                    if (count($parameters) === 3) {
                        if ($parameters[1] === 'User deprecated function') {
                            $deprecation_messages[] = (string) $parameters[0];
                        }
                    }
                }
            }
        }
        $this->assertContains('Test deprecation message', $deprecation_messages);
        $test_deprecation_messages = array_filter($deprecation_messages, function ($message) {
            return $message === 'Test deprecation message';
        });
        $this->assertCount(1, $test_deprecation_messages);
    }
    
    /**
     * Tests the dump() function provided by the var-dumper Symfony component.
     */
    public function testVarDump() : void {
        // Append the stream capturer to the STDERR stream, so that we can test the
        // dump() output and also prevent it from actually outputting in this
        // particular test.
        stream_filter_register("capture", StreamCapturer::class);
        stream_filter_append(STDERR, "capture");
        // Dump some variables to check that dump() in test code produces output
        // on the command line that is running the test.
        $role = Role::load('authenticated');
        dump($role);
        dump($role->id());
        $this->assertStringContainsString('Drupal\\user\\Entity\\Role', StreamCapturer::$cache);
        $this->assertStringContainsString('authenticated', StreamCapturer::$cache);
        // Visit a Drupal page with call to the dump() function to check that dump()
        // in site code produces output in the requested web page's HTML.
        $body = $this->drupalGet('test-page-var-dump');
        $this->assertSession()
            ->statusCodeEquals(200);
        // It is too strict to assert all properties of the Role and it is easy to
        // break if one of these properties gets removed or gets a new default
        // value. It should be sufficient to test just a couple of properties.
        $this->assertStringContainsString('<span class=sf-dump-note>', $body);
        $this->assertStringContainsString('  #<span class=sf-dump-protected title="Protected property">id</span>: "<span class=sf-dump-str title="9 characters">test_role</span>"', $body);
        $this->assertStringContainsString('  #<span class=sf-dump-protected title="Protected property">label</span>: "<span class=sf-dump-str title="9 characters">Test role</span>"', $body);
        $this->assertStringContainsString('  #<span class=sf-dump-protected title="Protected property">permissions</span>: []', $body);
        $this->assertStringContainsString('  #<span class=sf-dump-protected title="Protected property">uuid</span>: "', $body);
        $this->assertStringContainsString('</samp>}', $body);
    }
    
    /**
     * Test if setting an invalid scheme in SIMPLETEST_BASE_URL throws an exception.
     */
    public function testSimpleTestBaseUrlValidation() : void {
        putenv('SIMPLETEST_BASE_URL=mysql://user:pass@localhost/database');
        $this->expectException(\Exception::class);
        $this->expectExceptionMessage('You must provide valid scheme for the SIMPLETEST_BASE_URL environment variable. Valid schema are: http, https.');
        $this->setupBaseUrl();
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 544
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
BrowserTestBaseTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BrowserTestBaseTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
BrowserTestBaseTest::testCheckForMetaRefresh public function Tests the ::checkForMetaRefresh() method.
BrowserTestBaseTest::testClickLink public function Tests clickLink() functionality.
BrowserTestBaseTest::testCronRun public function Tests the ::cronRun() method.
BrowserTestBaseTest::testDeprecatedSessionMissing public function Tests deprecation of modified request stack lacking a session.
BrowserTestBaseTest::testDeprecationHeaders public function Tests that deprecation headers do not get duplicated.
BrowserTestBaseTest::testDrupalGet public function Tests drupalGet().
BrowserTestBaseTest::testDrupalSettings public function Tests that JavaScript Drupal settings can be read.
BrowserTestBaseTest::testError public function
BrowserTestBaseTest::testFieldAssertsForCheckbox public function Tests legacy field asserts for checkbox field type.
BrowserTestBaseTest::testFieldAssertsForTextfields public function Tests field asserts using textfields.
BrowserTestBaseTest::testForm public function Tests basic form functionality.
BrowserTestBaseTest::testGetDefaultDriveInstance public function
BrowserTestBaseTest::testGoTo public function Tests basic page test.
BrowserTestBaseTest::testHtKey public function Tests the protections provided by .htkey.
BrowserTestBaseTest::testInstall public function Tests the Drupal install done in \Drupal\Tests\BrowserTestBase::setUp().
BrowserTestBaseTest::testLocalTimeZone public function Tests the assumption that local time is in &#039;Australia/Sydney&#039;.
BrowserTestBaseTest::testProfileModules public function Ensures we can&#039;t access modules we shouldn&#039;t be able to after install.
BrowserTestBaseTest::testSessionOnRequest public function Tests that a usable session is on the request in test-runner.
BrowserTestBaseTest::testSimpleTestBaseUrlValidation public function Test if setting an invalid scheme in SIMPLETEST_BASE_URL throws an exception.
BrowserTestBaseTest::testVarDump public function Tests the dump() function provided by the var-dumper Symfony component.
BrowserTestBaseTest::testXpathAsserts public function Tests legacy field asserts which use xpath directly.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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 &#039;load by properties&#039; storage call.
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::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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