class EntityReferenceAdminTest

Same name in this branch
  1. 10 core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\Functional\EntityReference\EntityReferenceAdminTest
Same name in other branches
  1. 9 core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\FunctionalJavascript\EntityReference\EntityReferenceAdminTest
  2. 9 core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\Functional\EntityReference\EntityReferenceAdminTest
  3. 8.9.x core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\FunctionalJavascript\EntityReference\EntityReferenceAdminTest
  4. 8.9.x core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\Functional\EntityReference\EntityReferenceAdminTest
  5. 11.x core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\FunctionalJavascript\EntityReference\EntityReferenceAdminTest
  6. 11.x core/modules/field/tests/src/Functional/EntityReference/EntityReferenceAdminTest.php \Drupal\Tests\field\Functional\EntityReference\EntityReferenceAdminTest

Tests for the administrative UI.

@group entity_reference

Hierarchy

Expanded class hierarchy of EntityReferenceAdminTest

File

core/modules/field/tests/src/FunctionalJavascript/EntityReference/EntityReferenceAdminTest.php, line 21

Namespace

Drupal\Tests\field\FunctionalJavascript\EntityReference
View source
class EntityReferenceAdminTest extends WebDriverTestBase {
    use FieldUiTestTrait;
    use FieldUiJSTestTrait;
    
    /**
     * Modules to install.
     *
     * Enable path module to ensure that the selection handler does not fail for
     * entities with a path field.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'field_ui',
        'path',
        'taxonomy',
        'block',
        'views_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The name of the content type created for testing purposes.
     *
     * @var string
     */
    protected $type;
    
    /**
     * Name of a second content type to be used as a target of entity references.
     *
     * @var string
     */
    protected $targetType;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('system_breadcrumb_block');
        // Create a content type, with underscores.
        $type_name = $this->randomMachineName(8) . '_test';
        $type = $this->drupalCreateContentType([
            'name' => $type_name,
            'type' => $type_name,
        ]);
        $this->type = $type->id();
        // Create a second content type, to be a target for entity reference fields.
        $type_name = $this->randomMachineName(8) . '_test';
        $type = $this->drupalCreateContentType([
            'name' => $type_name,
            'type' => $type_name,
        ]);
        $this->targetType = $type->id();
        // Change the title field label.
        $fields = \Drupal::service('entity_field.manager')->getFieldDefinitions('node', $type->id());
        $fields['title']->getConfig($type->id())
            ->setLabel($type->id() . ' title')
            ->save();
        // Add text field to the second content type.
        FieldStorageConfig::create([
            'field_name' => 'field_text',
            'entity_type' => 'node',
            'type' => 'text',
            'entity_types' => [
                'node',
            ],
        ])->save();
        FieldConfig::create([
            'label' => 'Text Field',
            'field_name' => 'field_text',
            'entity_type' => 'node',
            'bundle' => $this->targetType,
            'settings' => [],
            'required' => FALSE,
        ])
            ->save();
        // Create test user.
        $admin_user = $this->drupalCreateUser([
            'access content',
            'administer node fields',
            'administer node display',
            'administer views',
            'create ' . $this->type . ' content',
            'edit own ' . $this->type . ' content',
        ]);
        $this->drupalLogin($admin_user);
    }
    
    /**
     * Tests the Entity Reference Admin UI.
     */
    public function testFieldAdminHandler() : void {
        $bundle_path = 'admin/structure/types/manage/' . $this->type;
        $page = $this->getSession()
            ->getPage();
        
        /** @var \Drupal\FunctionalJavascriptTests\JSWebAssert $assert_session */
        $assert_session = $this->assertSession();
        // First step: 'Add new field' on the 'Manage fields' page.
        $this->drupalGet($bundle_path . '/fields/add-field');
        // Check if the commonly referenced entity types appear in the list.
        $page->find('css', "[name='new_storage_type'][value='reference']")
            ->getParent()
            ->click();
        $page->pressButton('Continue');
        $assert_session->pageTextContains('Choose an option below');
        $this->assertSession()
            ->elementExists('css', "[name='group_field_options_wrapper'][value='field_ui:entity_reference:node']");
        $this->assertSession()
            ->elementExists('css', "[name='group_field_options_wrapper'][value='field_ui:entity_reference:user']");
        $page->pressButton('Back');
        $this->fieldUIAddNewFieldJS(NULL, 'test', 'Test', 'entity_reference', FALSE);
        // Node should be selected by default.
        $this->assertSession()
            ->fieldValueEquals('field_storage[subform][settings][target_type]', 'node');
        // Check that all entity types can be referenced.
        $this->assertFieldSelectOptions('field_storage[subform][settings][target_type]', array_keys(\Drupal::entityTypeManager()->getDefinitions()));
        // The base handler should be selected by default.
        $this->assertSession()
            ->fieldValueEquals('settings[handler]', 'default:node');
        // The base handler settings should be displayed.
        $entity_type_id = 'node';
        // Check that the type label is correctly displayed.
        $assert_session->pageTextContains('Content type');
        // Check that sort options are not yet visible.
        $sort_by = $page->findField('settings[handler_settings][sort][field]');
        $this->assertNotEmpty($sort_by);
        $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden.');
        $bundles = $this->container
            ->get('entity_type.bundle.info')
            ->getBundleInfo($entity_type_id);
        foreach ($bundles as $bundle_name => $bundle_info) {
            $this->assertSession()
                ->fieldExists('settings[handler_settings][target_bundles][' . $bundle_name . ']');
        }
        reset($bundles);
        // Initially, no bundles are selected so no sort options are available.
        $this->assertFieldSelectOptions('settings[handler_settings][sort][field]', [
            '_none',
        ]);
        // Select this bundle so that standard sort options are available.
        $page->findField('settings[handler_settings][target_bundles][' . $this->type . ']')
            ->setValue($this->type);
        $assert_session->assertWaitOnAjaxRequest();
        // Test that a non-translatable base field is a sort option.
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
        // Test that a translatable base field is a sort option.
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
        // Test that a configurable field is a sort option.
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
        // Test that a field not on this bundle is not a sort option.
        $assert_session->optionNotExists('settings[handler_settings][sort][field]', 'field_text.value');
        // Test that the title option appears once, with the default label.
        $title_options = $sort_by->findAll('xpath', 'option[@value="title"]');
        $this->assertEquals(1, count($title_options));
        $this->assertEquals('Title', $title_options[0]->getText());
        // Also select the target bundle so that field_text is also available.
        $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
            ->setValue($this->targetType);
        $assert_session->assertWaitOnAjaxRequest();
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
        // Select only the target bundle. The options should be the same.
        $page->findField('settings[handler_settings][target_bundles][' . $this->type . ']')
            ->uncheck();
        $assert_session->assertWaitOnAjaxRequest();
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'nid');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'title');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'body.value');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
        // Exception: the title option has a different label.
        $title_options = $sort_by->findAll('xpath', 'option[@value="title"]');
        $this->assertEquals(1, count($title_options));
        $this->assertEquals($this->targetType . ' title', $title_options[0]->getText());
        // Test the sort settings.
        // Option 0: no sort.
        $this->assertSession()
            ->fieldValueEquals('settings[handler_settings][sort][field]', '_none');
        $sort_direction = $page->findField('settings[handler_settings][sort][direction]');
        $this->assertFalse($sort_direction->isVisible());
        // Option 1: sort by field.
        $sort_by->setValue('nid');
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertTrue($sort_direction->isVisible());
        $this->assertSession()
            ->fieldValueEquals('settings[handler_settings][sort][direction]', 'ASC');
        // Test that the sort-by options are sorted.
        $labels = array_map(function (NodeElement $element) {
            return $element->getText();
        }, $sort_by->findAll('xpath', 'option'));
        for ($i = count($labels) - 1, $sorted = TRUE; $i > 0; --$i) {
            if ($labels[$i - 1] > $labels[$i]) {
                $sorted = FALSE;
                break;
            }
        }
        $this->assertTrue($sorted, 'The "sort by" options are sorted.');
        // Set back to no sort.
        $sort_by->setValue('_none');
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertFalse($sort_direction->isVisible());
        // Sort by nid, then select no bundles. The sort fields and sort direction
        // should not display.
        $sort_by->setValue('nid');
        $assert_session->assertWaitOnAjaxRequest();
        foreach ($bundles as $bundle_name => $bundle_info) {
            $this->assertSession()
                ->fieldExists('settings[handler_settings][target_bundles][' . $bundle_name . ']');
            $checkbox = $page->findField('settings[handler_settings][target_bundles][' . $bundle_name . ']');
            if ($checkbox->isChecked()) {
                $checkbox->uncheck();
                $assert_session->assertWaitOnAjaxRequest();
            }
        }
        $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden.');
        $this->assertFalse($sort_direction->isVisible());
        // Select a bundle and check the same two fields.
        $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
            ->setValue($this->targetType);
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertTrue($sort_by->isVisible(), 'The "sort by" options are visible.');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'field_text.value');
        // Un-select the bundle and check the same two fields.
        $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
            ->uncheck();
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertFalse($sort_by->isVisible(), 'The "sort by" options are hidden yet again.');
        $this->assertFieldSelectOptions('settings[handler_settings][sort][field]', [
            '_none',
        ]);
        // Third step: confirm.
        $page->findField('settings[handler_settings][target_bundles][' . $this->targetType . ']')
            ->setValue($this->targetType);
        $assert_session->assertWaitOnAjaxRequest();
        $this->submitForm([
            'required' => '1',
        ], 'Save settings');
        // Check that the field appears in the overview form.
        $this->assertSession()
            ->elementTextContains('xpath', '//table[@id="field-overview"]//tr[@id="field-test"]/td[1]', "Test");
        // Check that the field settings form can be submitted again, even when the
        // field is required.
        // The first 'Edit' link is for the Body field.
        $this->clickLink('Edit', 1);
        $this->submitForm([], 'Save settings');
        // Switch the target type to 'taxonomy_term' and check that the settings
        // specific to its selection handler are displayed.
        $field_name = 'node.' . $this->type . '.field_test';
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $page->findField('field_storage[subform][settings][target_type]')
            ->setValue('taxonomy_term');
        $this->assertSession()
            ->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->fieldExists('settings[handler_settings][auto_create]');
        $this->assertSession()
            ->fieldValueEquals('settings[handler]', 'default:taxonomy_term');
        // Switch the target type to 'user' and check that the settings specific to
        // its selection handler are displayed.
        $field_name = 'node.' . $this->type . '.field_test';
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $target_type_input = $assert_session->fieldExists('field_storage[subform][settings][target_type]');
        $target_type_input->setValue('user');
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertSession()
            ->fieldValueEquals('settings[handler_settings][filter][type]', '_none');
        $this->assertSession()
            ->fieldValueEquals('settings[handler_settings][sort][field]', '_none');
        $assert_session->optionNotExists('settings[handler_settings][sort][field]', 'nid');
        $assert_session->optionExists('settings[handler_settings][sort][field]', 'uid');
        // Check that sort direction is visible only when a sort field is selected.
        $sort_direction = $page->findField('settings[handler_settings][sort][direction]');
        $this->assertFalse($sort_direction->isVisible());
        $sort_by->setValue('name');
        $assert_session->assertWaitOnAjaxRequest();
        $this->assertTrue($sort_direction->isVisible());
        // Switch the target type to 'node'.
        $field_name = 'node.' . $this->type . '.field_test';
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $page->findField('field_storage[subform][settings][target_type]')
            ->setValue('node');
        // Try to select the views handler.
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $page->findField('settings[handler]')
            ->setValue('views');
        $views_text = (string) new FormattableMarkup('No eligible views were found. <a href=":create">Create a view</a> with an <em>Entity Reference</em> display, or add such a display to an <a href=":existing">existing view</a>.', [
            ':create' => Url::fromRoute('views_ui.add')->toString(),
            ':existing' => Url::fromRoute('entity.view.collection')->toString(),
        ]);
        $assert_session->waitForElement('xpath', '//a[contains(text(), "Create a view")]');
        $assert_session->responseContains($views_text);
        $this->submitForm([], 'Save settings');
        // If no eligible view is available we should see a message.
        $assert_session->pageTextContains('The views entity selection mode requires a view.');
        // Enable the entity_reference_test module which creates an eligible view.
        $this->container
            ->get('module_installer')
            ->install([
            'entity_reference_test',
        ]);
        $this->resetAll();
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $page->findField('settings[handler]')
            ->setValue('views');
        $assert_session->waitForField('settings[handler_settings][view][view_and_display]')
            ->setValue('test_entity_reference:entity_reference_1');
        $this->submitForm([], 'Save settings');
        $assert_session->pageTextContains('Saved Test configuration.');
        // Switch the target type to 'entity_test'.
        $this->drupalGet($bundle_path . '/fields/' . $field_name);
        $page->findField('field_storage[subform][settings][target_type]')
            ->setValue('entity_test');
        $assert_session->assertWaitOnAjaxRequest();
        $page->findField('settings[handler]')
            ->setValue('views');
        $page->findField('settings[handler_settings][view][view_and_display]')
            ->selectOption('test_entity_reference_entity_test:entity_reference_1');
        $edit = [
            'required' => FALSE,
        ];
        $this->submitForm($edit, 'Save settings');
        $assert_session->pageTextContains('Saved Test configuration.');
    }
    
    /**
     * Checks if a select element contains the specified options.
     *
     * @param string $name
     *   The field name.
     * @param array $expected_options
     *   An array of expected options.
     *
     * @internal
     */
    protected function assertFieldSelectOptions(string $name, array $expected_options) : void {
        $field = $this->assertSession()
            ->selectExists($name);
        $options = $field->findAll('xpath', 'option');
        $optgroups = $field->findAll('xpath', 'optgroup');
        $nested_options = [];
        foreach ($optgroups as $optgroup) {
            $nested_options[] = $optgroup->findAll('xpath', 'option');
        }
        $options = array_merge($options, ...$nested_options);
        array_walk($options, function (NodeElement &$option) {
            $option = $option->getAttribute('value');
        });
        $this->assertEqualsCanonicalizing($expected_options, $options);
    }

}

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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
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.
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
EntityReferenceAdminTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
EntityReferenceAdminTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
EntityReferenceAdminTest::$targetType protected property Name of a second content type to be used as a target of entity references.
EntityReferenceAdminTest::$type protected property The name of the content type created for testing purposes.
EntityReferenceAdminTest::assertFieldSelectOptions protected function Checks if a select element contains the specified options.
EntityReferenceAdminTest::setUp protected function Overrides BrowserTestBase::setUp
EntityReferenceAdminTest::testFieldAdminHandler public function Tests the Entity Reference Admin UI.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FieldUiJSTestTrait::fieldUIAddExistingFieldJS public function Adds an existing field through the Field UI.
FieldUiJSTestTrait::fieldUIAddNewFieldJS public function Creates a new field through the Field UI.
FieldUiJSTestTrait::getFieldFromGroupJS public function Helper function that returns the field card element if it is in a group.
FieldUiTestTrait::assertFieldDoesNotExist protected function Asserts that the field doesn&#039;t exist in the overview form.
FieldUiTestTrait::assertFieldDoesNotExistOnOverview protected function Asserts that the field does not appear on the overview form.
FieldUiTestTrait::assertFieldExistsOnOverview protected function Asserts that the field appears on the overview form.
FieldUiTestTrait::fieldUIAddExistingField public function Adds an existing field through the Field UI.
FieldUiTestTrait::fieldUIAddNewField public function Creates a new field through the Field UI.
FieldUiTestTrait::fieldUIDeleteField public function Deletes a field through the Field UI.
FieldUiTestTrait::getFieldFromGroup public function Helper function that returns the name of the group that a field is in.
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::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
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
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.