class MediaUiFunctionalTest

Same name in other branches
  1. 8.9.x core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php \Drupal\Tests\media\Functional\MediaUiFunctionalTest
  2. 10 core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php \Drupal\Tests\media\Functional\MediaUiFunctionalTest
  3. 11.x core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php \Drupal\Tests\media\Functional\MediaUiFunctionalTest

Ensures that media UI works correctly.

@group media

Hierarchy

Expanded class hierarchy of MediaUiFunctionalTest

File

core/modules/media/tests/src/Functional/MediaUiFunctionalTest.php, line 16

Namespace

Drupal\Tests\media\Functional
View source
class MediaUiFunctionalTest extends MediaFunctionalTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'block',
        'media_test_source',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalPlaceBlock('local_actions_block');
        $this->drupalPlaceBlock('local_tasks_block');
    }
    
    /**
     * Tests the media actions (add/edit/delete).
     */
    public function testMediaWithOnlyOneMediaType() {
        $session = $this->getSession();
        $page = $session->getPage();
        $assert_session = $this->assertSession();
        $media_type = $this->createMediaType('test', [
            'queue_thumbnail_downloads' => FALSE,
        ]);
        $this->drupalGet('media/add');
        $assert_session->statusCodeEquals(200);
        $assert_session->addressEquals('media/add/' . $media_type->id());
        $assert_session->elementNotExists('css', '#edit-revision');
        // Tests media add form.
        $media_name = $this->randomMachineName();
        $page->fillField('name[0][value]', $media_name);
        $revision_log_message = $this->randomString();
        $page->fillField('revision_log_message[0][value]', $revision_log_message);
        $source_field = $this->randomString();
        $page->fillField('field_media_test[0][value]', $source_field);
        $page->pressButton('Save');
        $media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->execute();
        $media_id = reset($media_id);
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->loadUnchanged($media_id);
        $this->assertSame($media->getRevisionLogMessage(), $revision_log_message);
        $this->assertSame($media->getName(), $media_name);
        // Tests media edit form.
        $media_type->setNewRevision(FALSE);
        $media_type->save();
        $media_name2 = $this->randomMachineName();
        $this->drupalGet('media/' . $media_id . '/edit');
        $assert_session->checkboxNotChecked('edit-revision');
        $media_name = $this->randomMachineName();
        $page->fillField('name[0][value]', $media_name2);
        $page->pressButton('Save');
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->loadUnchanged($media_id);
        $this->assertSame($media->getName(), $media_name2);
        // Change the authored by field to an empty string, which should assign
        // authorship to the anonymous user (uid 0).
        $this->drupalGet('media/' . $media_id . '/edit');
        $edit['uid[0][target_id]'] = '';
        $this->submitForm($edit, 'Save');
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->loadUnchanged($media_id);
        $uid = $media->getOwnerId();
        // Most SQL database drivers stringify fetches but entities are not
        // necessarily stored in a SQL database. At the same time, NULL/FALSE/""
        // won't do.
        $this->assertTrue($uid === 0 || $uid === '0', 'Media authored by anonymous user.');
        // Test that there is no empty vertical tabs element, if the container is
        // empty (see #2750697).
        // Make the "Publisher ID" and "Created" fields hidden.
        $this->drupalGet('/admin/structure/media/manage/' . $media_type->id() . '/form-display');
        $page->selectFieldOption('fields[created][parent]', 'hidden');
        $page->selectFieldOption('fields[uid][parent]', 'hidden');
        $page->pressButton('Save');
        // Assure we are testing with a user without permission to manage revisions.
        $this->drupalLogin($this->nonAdminUser);
        // Check the container is not present.
        $this->drupalGet('media/' . $media_id . '/edit');
        $assert_session->elementNotExists('css', 'input.vertical-tabs__active-tab');
        // Continue testing as admin.
        $this->drupalLogin($this->adminUser);
        // Enable revisions by default.
        $previous_revision_id = $media->getRevisionId();
        $media_type->setNewRevision(TRUE);
        $media_type->save();
        $this->drupalGet('media/' . $media_id . '/edit');
        $assert_session->checkboxChecked('edit-revision');
        $page->fillField('name[0][value]', $media_name);
        $page->fillField('revision_log_message[0][value]', $revision_log_message);
        $page->pressButton('Save');
        $this->drupalGet('media/' . $media_id);
        $assert_session->statusCodeEquals(404);
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->loadUnchanged($media_id);
        $this->assertSame($media->getRevisionLogMessage(), $revision_log_message);
        $this->assertNotEquals($previous_revision_id, $media->getRevisionId());
        // Test the status checkbox.
        $this->drupalGet('media/' . $media_id . '/edit');
        $page->uncheckField('status[value]');
        $page->pressButton('Save');
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->loadUnchanged($media_id);
        $this->assertFalse($media->isPublished());
        // Tests media delete form.
        $this->drupalGet('media/' . $media_id . '/edit');
        $page->clickLink('Delete');
        $assert_session->pageTextContains('This action cannot be undone');
        $page->pressButton('Delete');
        $media_id = \Drupal::entityQuery('media')->accessCheck(FALSE)
            ->execute();
        $this->assertEmpty($media_id);
    }
    
    /**
     * Tests the "media/add" page.
     *
     * Tests if the "media/add" page gives you a selecting option if there are
     * multiple media types available.
     */
    public function testMediaWithMultipleMediaTypes() {
        $assert_session = $this->assertSession();
        // Tests and creates the first media type.
        $first_media_type = $this->createMediaType('test', [
            'description' => $this->randomMachineName(),
        ]);
        // Test and create a second media type.
        $second_media_type = $this->createMediaType('test', [
            'description' => $this->randomMachineName(),
        ]);
        // Test if media/add displays two media type options.
        $this->drupalGet('media/add');
        // Checks for the first media type.
        $assert_session->pageTextContains($first_media_type->label());
        $assert_session->pageTextContains($first_media_type->getDescription());
        // Checks for the second media type.
        $assert_session->pageTextContains($second_media_type->label());
        $assert_session->pageTextContains($second_media_type->getDescription());
    }
    
    /**
     * Tests that media in ER fields use the Rendered Entity formatter by default.
     */
    public function testRenderedEntityReferencedMedia() {
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Page',
        ]);
        $this->drupalGet('/admin/structure/types/manage/page/fields/add-field');
        $page->selectFieldOption('new_storage_type', 'field_ui:entity_reference:media');
        $page->fillField('label', 'Foo field');
        $page->fillField('field_name', 'foo_field');
        $page->pressButton('Save and continue');
        $this->drupalGet('/admin/structure/types/manage/page/display');
        $assert_session->fieldValueEquals('fields[field_foo_field][type]', 'entity_reference_entity_view');
    }
    
    /**
     * Data provider for testMediaReferenceWidget().
     *
     * @return array[]
     *   Test data. See testMediaReferenceWidget() for the child array structure.
     */
    public function providerTestMediaReferenceWidget() {
        return [
            // Single-value fields with a single media type and the default widget:
            // - The user can create and list the media.
'single_value:single_type:create_list' => [
                1,
                [
                    TRUE,
                ],
                TRUE,
            ],
            // - The user can list but not create the media.
'single_value:single_type:list' => [
                1,
                [
                    FALSE,
                ],
                TRUE,
            ],
            // - The user can create but not list the media.
'single_value:single_type:create' => [
                1,
                [
                    TRUE,
                ],
                FALSE,
            ],
            // - The user can neither create nor list the media.
'single_value:single_type' => [
                1,
                [
                    FALSE,
                ],
                FALSE,
            ],
            // Single-value fields with the tags-style widget:
            // - The user can create and list the media.
'single_value:single_type:create_list:tags' => [
                1,
                [
                    TRUE,
                ],
                TRUE,
                'entity_reference_autocomplete_tags',
            ],
            // - The user can list but not create the media.
'single_value:single_type:list:tags' => [
                1,
                [
                    FALSE,
                ],
                TRUE,
                'entity_reference_autocomplete_tags',
            ],
            // - The user can create but not list the media.
'single_value:single_type:create:tags' => [
                1,
                [
                    TRUE,
                ],
                FALSE,
                'entity_reference_autocomplete_tags',
            ],
            // - The user can neither create nor list the media.
'single_value:single_type:tags' => [
                1,
                [
                    FALSE,
                ],
                FALSE,
                'entity_reference_autocomplete_tags',
            ],
            // Single-value fields with two media types:
            // - The user can create both types.
'single_value:two_type:create2_list' => [
                1,
                [
                    TRUE,
                    TRUE,
                ],
                TRUE,
            ],
            // - The user can create only one type.
'single_value:two_type:create1_list' => [
                1,
                [
                    TRUE,
                    FALSE,
                ],
                TRUE,
            ],
            // - The user cannot create either type.
'single_value:two_type:list' => [
                1,
                [
                    FALSE,
                    FALSE,
                ],
                TRUE,
            ],
            // Multiple-value field with a cardinality of 3, with media the user can
            // create and list.
'multi_value:single_type:create_list' => [
                3,
                [
                    TRUE,
                ],
                TRUE,
            ],
            // The same, with the tags field.
'multi-value:single_type:create_list:tags' => [
                3,
                [
                    TRUE,
                ],
                TRUE,
                'entity_reference_autocomplete_tags',
            ],
            // Unlimited value field.
'unlimited_value:single_type:create_list' => [
                FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
                [
                    TRUE,
                ],
                TRUE,
            ],
            // Unlimited value field with the tags widget.
'unlimited_value:single_type:create_list:tags' => [
                FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
                [
                    TRUE,
                ],
                TRUE,
                'entity_reference_autocomplete_tags',
            ],
        ];
    }
    
    /**
     * Tests the default autocomplete widgets for media reference fields.
     *
     * @param int $cardinality
     *   The field cardinality.
     * @param bool[] $media_type_create_access
     *   An array of booleans indicating whether to grant the test user create
     *   access for each media type. A media type is created automatically for
     *   each; for example, an array [TRUE, FALSE] would create two media types,
     *   one that allows the user to create media and a second that does not.
     * @param bool $list_access
     *   Whether to grant the test user access to list media.
     * @param string $widget_id
     *   The widget ID to test.
     *
     * @see media_field_widget_entity_reference_autocomplete_form_alter()
     * @see media_field_widget_multiple_entity_reference_autocomplete_form_alter()
     *
     * @dataProvider providerTestMediaReferenceWidget
     */
    public function testMediaReferenceWidget($cardinality, array $media_type_create_access, $list_access, $widget_id = 'entity_reference_autocomplete') {
        $assert_session = $this->assertSession();
        // Create two content types.
        $non_media_content_type = $this->createContentType();
        $content_type = $this->createContentType();
        // Create some media types.
        $media_types = [];
        $permissions = [];
        $create_media_types = [];
        foreach ($media_type_create_access as $id => $access) {
            if ($access) {
                $create_media_types[] = "media_type_{$id}";
                $permissions[] = "create media_type_{$id} media";
            }
            $this->createMediaType('test', [
                'id' => "media_type_{$id}",
                'label' => "media_type_{$id}",
            ]);
            $media_types["media_type_{$id}"] = "media_type_{$id}";
        }
        // Create a user that can create content of the type, with other
        // permissions as given by the data provider.
        $permissions[] = "create {$content_type->id()} content";
        if ($list_access) {
            $permissions[] = "access media overview";
        }
        $test_user = $this->drupalCreateUser($permissions);
        // Create a non-media entity reference.
        $non_media_storage = FieldStorageConfig::create([
            'field_name' => 'field_not_a_media_field',
            'entity_type' => 'node',
            'type' => 'entity_reference',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
            'settings' => [
                'target_type' => 'node',
            ],
        ]);
        $non_media_storage->save();
        $non_media_field = FieldConfig::create([
            'label' => 'No media here!',
            'field_storage' => $non_media_storage,
            'entity_type' => 'node',
            'bundle' => $non_media_content_type->id(),
            'settings' => [
                'handler' => 'default',
                'handler_settings' => [
                    'target_bundles' => [
                        $non_media_content_type->id() => $non_media_content_type->id(),
                    ],
                ],
            ],
        ]);
        $non_media_field->save();
        \Drupal::entityTypeManager()->getStorage('entity_form_display')
            ->load('node.' . $non_media_content_type->id() . '.default')
            ->setComponent('field_not_a_media_field', [
            'type' => $widget_id,
        ])
            ->save();
        // Create a media field through the user interface to ensure that the
        // help text handling does not break the default value entry on the field
        // settings form.
        // Using submitForm() to avoid dealing with JavaScript on the previous
        // page in the field creation.
        $edit = [
            'new_storage_type' => 'field_ui:entity_reference:media',
            'label' => "Media (cardinality {$cardinality})",
            'field_name' => 'media_reference',
        ];
        $this->drupalGet("admin/structure/types/manage/{$content_type->id()}/fields/add-field");
        $this->submitForm($edit, 'Save and continue');
        $edit = [];
        foreach ($media_types as $type) {
            $edit["settings[handler_settings][target_bundles][{$type}]"] = TRUE;
        }
        $this->drupalGet("admin/structure/types/manage/{$content_type->id()}/fields/node.{$content_type->id()}.field_media_reference");
        $this->submitForm($edit, "Save settings");
        \Drupal::entityTypeManager()->getStorage('entity_form_display')
            ->load('node.' . $content_type->id() . '.default')
            ->setComponent('field_media_reference', [
            'type' => $widget_id,
        ])
            ->save();
        // Some of the expected texts.
        $create_help = 'Create your media on the media add page (opens a new window), then add it by name to the field below.';
        $list_text = 'See the media list (opens a new window) to help locate media.';
        $use_help = 'Type part of the media name.';
        $create_header = "Create new media";
        $use_header = "Use existing media";
        // First check that none of the help texts are on the non-media content.
        $this->drupalGet("/node/add/{$non_media_content_type->id()}");
        $this->assertNoHelpTexts([
            $create_header,
            $create_help,
            $use_header,
            $use_help,
            $list_text,
            'Allowed media types:',
        ]);
        // Now, check that the widget displays the expected help text under the
        // given conditions for the test user.
        $this->drupalLogin($test_user);
        $this->drupalGet("/node/add/{$content_type->id()}");
        // Specific expected help texts for the media field.
        $create_header = "Create new media";
        $use_header = "Use existing media";
        $type_list = 'Allowed media types: ' . implode(", ", array_keys($media_types));
        $fieldset_selector = '#edit-field-media-reference-wrapper fieldset';
        $fieldset = $assert_session->elementExists('css', $fieldset_selector);
        $this->assertSame("Media (cardinality {$cardinality})", $assert_session->elementExists('css', 'legend', $fieldset)
            ->getText());
        // Assert text that should be displayed regardless of other access.
        $this->assertHelpTexts([
            $use_header,
            $use_help,
            $type_list,
        ], $fieldset_selector);
        // The entire section for creating new media should only be displayed if
        // the user can create at least one media of the type.
        if ($create_media_types) {
            if (count($create_media_types) === 1) {
                $url = Url::fromRoute('entity.media.add_form')->setRouteParameter('media_type', $create_media_types[0]);
            }
            else {
                $url = Url::fromRoute('entity.media.add_page');
            }
            $this->assertHelpTexts([
                $create_header,
                $create_help,
            ], $fieldset_selector);
            $this->assertHelpLink($fieldset, 'media add page', [
                'target' => '_blank',
                'href' => $url->toString(),
            ]);
        }
        else {
            $this->assertNoHelpTexts([
                $create_header,
                $create_help,
            ]);
            $this->assertNoHelpLink($fieldset, 'media add page');
        }
        if ($list_access) {
            $this->assertHelpTexts([
                $list_text,
            ], $fieldset_selector);
            $this->assertHelpLink($fieldset, 'media list', [
                'target' => '_blank',
                'href' => Url::fromRoute('entity.media.collection')->toString(),
            ]);
        }
        else {
            $this->assertNoHelpTexts([
                $list_text,
            ]);
            $this->assertNoHelpLink($fieldset, 'media list');
        }
    }
    
    /**
     * Tests the redirect URL after creating a media item.
     */
    public function testMediaCreateRedirect() {
        $session = $this->getSession();
        $page = $session->getPage();
        $assert_session = $this->assertSession();
        $this->createMediaType('test', [
            'queue_thumbnail_downloads' => FALSE,
        ]);
        // Test a redirect to the media canonical URL for a user without the 'access
        // media overview' permission.
        $this->drupalLogin($this->drupalCreateUser([
            'view media',
            'create media',
        ]));
        $this->drupalGet('media/add');
        $page->fillField('name[0][value]', $this->randomMachineName());
        $page->fillField('field_media_test[0][value]', $this->randomString());
        $page->pressButton('Save');
        $media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->execute();
        $media_id = reset($media_id);
        $assert_session->addressEquals("media/{$media_id}/edit");
        // Test a redirect to the media overview for a user with the 'access media
        // overview' permission.
        $this->drupalLogin($this->drupalCreateUser([
            'view media',
            'create media',
            'access media overview',
        ]));
        $this->drupalGet('media/add');
        $page->fillField('name[0][value]', $this->randomMachineName());
        $page->fillField('field_media_test[0][value]', $this->randomString());
        $page->pressButton('Save');
        $assert_session->addressEquals('admin/content/media');
    }
    
    /**
     * Asserts that the given texts are present exactly once.
     *
     * @param string[] $texts
     *   A list of the help texts to check.
     * @param string $selector
     *   (optional) The selector to search.
     *
     * @internal
     */
    public function assertHelpTexts(array $texts, string $selector = '') : void {
        $assert_session = $this->assertSession();
        foreach ($texts as $text) {
            // We only want to escape single quotes, so use str_replace() rather than
            // addslashes().
            $text = str_replace("'", "\\'", $text);
            if ($selector) {
                $assert_session->elementsCount('css', $selector . ":contains('{$text}')", 1);
            }
            else {
                $assert_session->pageTextContains($text);
            }
        }
    }
    
    /**
     * Asserts that none of the given texts are present.
     *
     * @param string[] $texts
     *   A list of the help texts to check.
     *
     * @internal
     */
    public function assertNoHelpTexts(array $texts) : void {
        $assert_session = $this->assertSession();
        foreach ($texts as $text) {
            $assert_session->pageTextNotContains($text);
        }
    }
    
    /**
     * Asserts whether a given link is present.
     *
     * @param \Behat\Mink\Element\NodeElement $element
     *   The element to search.
     * @param string $text
     *   The link text.
     * @param string[] $attributes
     *   An associative array of any expected attributes, keyed by the
     *   attribute name.
     *
     * @internal
     */
    protected function assertHelpLink(NodeElement $element, string $text, array $attributes = []) : void {
        // Find all the links inside the element.
        $link = $element->findLink($text);
        $this->assertNotEmpty($link);
        foreach ($attributes as $attribute => $value) {
            $this->assertSame($link->getAttribute($attribute), $value);
        }
    }
    
    /**
     * Asserts that a given link is not present.
     *
     * @param \Behat\Mink\Element\NodeElement $element
     *   The element to search.
     * @param string $text
     *   The link text.
     *
     * @internal
     */
    protected function assertNoHelpLink(NodeElement $element, string $text) : void {
        $assert_session = $this->assertSession();
        // Assert that the link and its text are not present anywhere on the page.
        $assert_session->elementNotExists('named', [
            'link',
            $text,
        ], $element);
        $assert_session->pageTextNotContains($text);
    }
    
    /**
     * Tests the media collection route.
     */
    public function testMediaCollectionRoute() {
        
        /** @var \Drupal\Core\Entity\EntityStorageInterface $media_storage */
        $media_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('media');
        $this->container
            ->get('module_installer')
            ->uninstall([
            'views',
        ]);
        // Create a media type and media item.
        $media_type = $this->createMediaType('test');
        $media = $media_storage->create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
        ]);
        $media->save();
        $this->drupalGet($media->toUrl('collection'));
        $assert_session = $this->assertSession();
        // Media list table exists.
        $assert_session->elementExists('css', 'th:contains("Media Name")');
        $assert_session->elementExists('css', 'th:contains("Type")');
        $assert_session->elementExists('css', 'th:contains("Operations")');
        // Media item is present.
        $assert_session->elementExists('css', 'td:contains("Unnamed")');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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 drupal_rewrite_settings().
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. 37
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
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::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::__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
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 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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
MediaFunctionalTestTrait::$adminUser protected property An admin test user account.
MediaFunctionalTestTrait::$adminUserPermissions protected static property Permissions for the admin user that will be logged-in for test.
MediaFunctionalTestTrait::$nonAdminUser protected property A non-admin test user account.
MediaFunctionalTestTrait::$storage protected property The storage service.
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
MediaUiFunctionalTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaUiFunctionalTest::$modules protected static property Modules to enable. Overrides MediaFunctionalTestBase::$modules
MediaUiFunctionalTest::assertHelpLink protected function Asserts whether a given link is present.
MediaUiFunctionalTest::assertHelpTexts public function Asserts that the given texts are present exactly once.
MediaUiFunctionalTest::assertNoHelpLink protected function Asserts that a given link is not present.
MediaUiFunctionalTest::assertNoHelpTexts public function Asserts that none of the given texts are present.
MediaUiFunctionalTest::providerTestMediaReferenceWidget public function Data provider for testMediaReferenceWidget().
MediaUiFunctionalTest::setUp protected function Overrides MediaFunctionalTestTrait::setUp
MediaUiFunctionalTest::testMediaCollectionRoute public function Tests the media collection route.
MediaUiFunctionalTest::testMediaCreateRedirect public function Tests the redirect URL after creating a media item.
MediaUiFunctionalTest::testMediaReferenceWidget public function Tests the default autocomplete widgets for media reference fields.
MediaUiFunctionalTest::testMediaWithMultipleMediaTypes public function Tests the "media/add" page.
MediaUiFunctionalTest::testMediaWithOnlyOneMediaType public function Tests the media actions (add/edit/delete).
MediaUiFunctionalTest::testRenderedEntityReferencedMedia public function Tests that media in ER fields use the Rendered Entity formatter by default.
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::$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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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 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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 1
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. 1
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 public static function Returns the database connection to the site running Simpletest.
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::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. 2
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::drupalPostForm Deprecated protected function Executes a form submission.
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.