class MediaStandardProfileTest

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

Basic tests for Media configuration in the standard profile.

@group media

Hierarchy

Expanded class hierarchy of MediaStandardProfileTest

File

core/modules/media/tests/src/FunctionalJavascript/MediaStandardProfileTest.php, line 18

Namespace

Drupal\Tests\media\FunctionalJavascript
View source
class MediaStandardProfileTest extends MediaJavascriptTestBase {
    use OEmbedTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected $profile = 'standard';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'media_test_oembed',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->lockHttpClientToFixtures();
        $this->hijackProviderEndpoints();
    }
    
    /**
     * Tests all media sources in one method.
     *
     * This prevents installing the standard profile for every test case and
     * increases the performance of this test.
     */
    public function testMediaSources() {
        // This test currently frequently causes the SQLite database to lock, so
        // skip the test on SQLite until the issue can be resolved.
        // @todo https://www.drupal.org/project/drupal/issues/3273626
        if (Database::getConnection()->driver() === 'sqlite') {
            $this->markTestSkipped('Test frequently causes a locked database on SQLite');
        }
        $storage = FieldStorageConfig::create([
            'entity_type' => 'node',
            'field_name' => 'field_related_media',
            'type' => 'entity_reference',
            'settings' => [
                'target_type' => 'media',
            ],
        ]);
        $storage->save();
        FieldConfig::create([
            'field_storage' => $storage,
            'entity_type' => 'node',
            'bundle' => 'article',
            'label' => 'Related media',
            'settings' => [
                'handler_settings' => [
                    'target_bundles' => [
                        'audio' => 'audio',
                        'document' => 'document',
                        'image' => 'image',
                        'remote_video' => 'remote_video',
                        'video' => 'video',
                    ],
                ],
            ],
        ])->save();
        $display = EntityViewDisplay::load('node.article.default');
        $display->setComponent('field_related_media', [
            'type' => 'entity_reference_entity_view',
            'settings' => [
                'view_mode' => 'full',
            ],
        ])
            ->save();
        $this->audioTest();
        $this->documentTest();
        $this->imageTest();
        $this->remoteVideoTest();
        $this->videoTest();
    }
    
    /**
     * Tests the standard profile configuration for media type 'audio'.
     */
    protected function audioTest() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $source_field_id = 'field_media_audio_file';
        // Create 2 test files.
        $test_filename = $this->randomMachineName() . '.mp3';
        $test_filepath = 'public://' . $test_filename;
        $test_filename_updated = $this->randomMachineName() . '.mp3';
        $test_filepath_updated = 'public://' . $test_filename_updated;
        file_put_contents($test_filepath, str_repeat('t', 10));
        file_put_contents($test_filepath_updated, str_repeat('u', 10));
        // Check if the name field is properly hidden on the media form.
        $this->drupalGet('media/add/audio');
        $assert_session->fieldNotExists('name');
        // Check if the source field is available.
        $assert_session->fieldExists("files[{$source_field_id}_0]");
        // Create a media item.
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $audio_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $audio_media_id = reset($audio_media_id);
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $node = Node::create([
            'title' => 'Host node',
            'type' => 'article',
            'field_related_media' => [
                'target_id' => $audio_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is generated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($audio_media_id);
        $this->assertSame($test_filename, $media->label());
        // Here we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-audio > *', 1);
        // Assert the audio file is present inside the media element and that its
        // src attribute matches the audio file.
        $audio_element = $assert_session->elementExists('css', 'div.media--type-audio .field--name-field-media-audio-file audio > source');
        
        /** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
        $file_url_generator = \Drupal::service('file_url_generator');
        $expected_audio_src = $file_url_generator->generateString(\Drupal::token()->replace('public://[date:custom:Y]-[date:custom:m]/' . $test_filename));
        $this->assertSame($expected_audio_src, $audio_element->getAttribute('src'));
        // Assert the media name is updated through the field mapping when changing
        // the source field.
        $this->drupalGet('media/' . $audio_media_id . '/edit');
        $page->pressButton('Remove');
        $result = $assert_session->waitForField("files[{$source_field_id}_0]");
        $this->assertNotEmpty($result);
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath_updated));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is updated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($audio_media_id);
        $this->assertSame($test_filename_updated, $media->label());
        // Again we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-audio > *', 1);
        // Assert the audio file is present inside the media element and that its
        // src attribute matches the updated audio file.
        $audio_element = $assert_session->elementExists('css', 'div.media--type-audio .field--name-field-media-audio-file audio > source');
        $expected_audio_src = $file_url_generator->generateString(\Drupal::token()->replace('public://[date:custom:Y]-[date:custom:m]/' . $test_filename_updated));
        $this->assertSame($expected_audio_src, $audio_element->getAttribute('src'));
    }
    
    /**
     * Tests the standard profile configuration for media type 'image'.
     */
    protected function imageTest() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $source_field_id = 'field_media_image';
        // Check if the name field is properly hidden on the media form.
        $this->drupalGet('media/add/image');
        $assert_session->fieldNotExists('name');
        // Check if the source field is available.
        $assert_session->fieldExists("files[{$source_field_id}_0]");
        // Create a media item.
        $image_media_name = 'example_1.jpeg';
        $page->attachFileToField("files[{$source_field_id}_0]", $this->root . '/core/modules/media/tests/fixtures/' . $image_media_name);
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->fillField("{$source_field_id}[0][alt]", 'Image Alt Text 1');
        $page->pressButton('Save');
        $image_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $image_media_id = reset($image_media_id);
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $node = Node::create([
            'title' => 'Host node',
            'type' => 'article',
            'field_related_media' => [
                'target_id' => $image_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is generated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($image_media_id);
        $this->assertSame($image_media_name, $media->label());
        // Here we expect to see only the image, nothing else. Assert only one
        // element in the content region.
        $assert_session->elementsCount('css', 'div.media--type-image > *', 1);
        // Assert the image element is present inside the media element and that its
        // src attribute uses the large image style, the label is visually hidden,
        // and there is no link to the image file.
        $image_element = $assert_session->elementExists('css', 'div.media--type-image img');
        
        /** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
        $file_url_generator = \Drupal::service('file_url_generator');
        $expected_image_src = $file_url_generator->generateString(\Drupal::token()->replace('public://styles/large/public/[date:custom:Y]-[date:custom:m]/' . $image_media_name));
        $this->assertStringContainsString($expected_image_src, $image_element->getAttribute('src'));
        $assert_session->elementExists('css', '.field--name-field-media-image .field__label.visually-hidden');
        $assert_session->elementNotExists('css', '.field--name-field-media-image a');
        // Assert the media name is updated through the field mapping when changing
        // the source field.
        $this->drupalGet('media/' . $image_media_id . '/edit');
        $page->pressButton('Remove');
        $result = $assert_session->waitForField("files[{$source_field_id}_0]");
        $this->assertNotEmpty($result);
        $image_media_name_updated = 'example_2.jpeg';
        $page->attachFileToField("files[{$source_field_id}_0]", $this->root . '/core/modules/media/tests/fixtures/' . $image_media_name_updated);
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->fillField("{$source_field_id}[0][alt]", 'Image Alt Text 2');
        $page->pressButton('Save');
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is updated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($image_media_id);
        $this->assertSame($image_media_name_updated, $media->label());
        // Again we expect to see only the image, nothing else. Assert only one
        // element in the content region.
        $assert_session->elementsCount('css', 'div.media--type-image > *', 1);
        // Assert the image element is present inside the media element and that its
        // src attribute uses the large image style, the label is visually hidden,
        // and there is no link to the image file.
        $image_element = $assert_session->elementExists('css', 'div.media--type-image img');
        $expected_image_src = $file_url_generator->generateString(\Drupal::token()->replace('public://styles/large/public/[date:custom:Y]-[date:custom:m]/' . $image_media_name_updated));
        $this->assertStringContainsString($expected_image_src, $image_element->getAttribute('src'));
        $assert_session->elementExists('css', '.field--name-field-media-image .field__label.visually-hidden');
        $assert_session->elementNotExists('css', '.field--name-field-media-image a');
    }
    
    /**
     * Tests the standard profile configuration for media type 'document'.
     */
    protected function documentTest() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $source_field_id = 'field_media_document';
        // Create 2 test files.
        $test_filename = $this->randomMachineName() . '.txt';
        $test_filepath = 'public://' . $test_filename;
        $test_filename_updated = $this->randomMachineName() . '.txt';
        $test_filepath_updated = 'public://' . $test_filename_updated;
        file_put_contents($test_filepath, $this->randomMachineName());
        file_put_contents($test_filepath_updated, $this->randomMachineName());
        // Check if the name field is properly hidden on the media form.
        $this->drupalGet('media/add/document');
        $assert_session->fieldNotExists('name');
        // Check if the source field is available.
        $assert_session->fieldExists("files[{$source_field_id}_0]");
        // Create a media item.
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $file_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $file_media_id = reset($file_media_id);
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $node = Node::create([
            'title' => 'Host node',
            'type' => 'article',
            'field_related_media' => [
                'target_id' => $file_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is generated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($file_media_id);
        $this->assertSame($test_filename, $media->label());
        // Here we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-document > *', 1);
        // Assert the file link is present in the media element and its text matches
        // the filename.
        $link_element = $assert_session->elementExists('css', 'div.media--type-document .field--name-field-media-document a');
        $this->assertSame($test_filename, $link_element->getText());
        // Assert the media name is updated through the field mapping when changing
        // the source field.
        $this->drupalGet('media/' . $file_media_id . '/edit');
        $page->pressButton('Remove');
        $result = $assert_session->waitForField("files[{$source_field_id}_0]");
        $this->assertNotEmpty($result);
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath_updated));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is updated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($file_media_id);
        $this->assertSame($test_filename_updated, $media->label());
        // Again we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-document > *', 1);
        // Assert the file link is present in the media element and its text matches
        // the updated filename.
        $link_element = $assert_session->elementExists('css', 'div.media--type-document .field--name-field-media-document a');
        $this->assertSame($test_filename_updated, $link_element->getText());
    }
    
    /**
     * Tests the standard profile configuration for media type 'remote_video'.
     */
    protected function remoteVideoTest() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $source_field_id = 'field_media_oembed_video';
        // Set video fixtures.
        $video_title = 'Drupal Rap Video - Schipulcon09';
        $video_url = 'https://vimeo.com/7073899';
        ResourceController::setResourceUrl($video_url, $this->getFixturesDirectory() . '/video_vimeo.json');
        $video_title_updated = "Everyday I'm Drupalin' Drupal Rap (Rick Ross - Hustlin)";
        $video_url_updated = 'https://www.youtube.com/watch?v=PWjcqE3QKBg';
        ResourceController::setResourceUrl($video_url_updated, $this->getFixturesDirectory() . '/video_youtube.json');
        // Check if the name field is properly hidden on the media form.
        $this->drupalGet('media/add/remote_video');
        $assert_session->fieldNotExists('name');
        // Check if the source field is available.
        $assert_session->fieldExists("{$source_field_id}[0][value]");
        // Create a media item.
        $page->fillField("{$source_field_id}[0][value]", $video_url);
        $page->pressButton('Save');
        $remote_video_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $remote_video_media_id = reset($remote_video_media_id);
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $node = Node::create([
            'title' => 'Host node',
            'type' => 'article',
            'field_related_media' => [
                'target_id' => $remote_video_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is generated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($remote_video_media_id);
        $this->assertSame($video_title, $media->label());
        // Here we expect to see only the video iframe. Assert only one element in
        // the content region.
        $assert_session->elementsCount('css', 'div.media--type-remote-video > *', 1);
        // Assert the iframe is present in the media element and its src attribute
        // matches the URL and query parameters.
        $iframe_url = $assert_session->elementExists('css', 'div.media--type-remote-video .field--name-field-media-oembed-video iframe')
            ->getAttribute('src');
        $iframe_url = parse_url($iframe_url);
        $this->assertStringEndsWith('/media/oembed', $iframe_url['path']);
        $this->assertNotEmpty($iframe_url['query']);
        $query = [];
        parse_str($iframe_url['query'], $query);
        $this->assertSame($video_url, $query['url']);
        $this->assertNotEmpty($query['hash']);
        // Assert the media name is updated through the field mapping when changing
        // the source field.
        $this->drupalGet('media/' . $remote_video_media_id . '/edit');
        $page->fillField("{$source_field_id}[0][value]", $video_url_updated);
        $page->pressButton('Save');
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is updated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($remote_video_media_id);
        $this->assertSame($video_title_updated, $media->label());
        // Again we expect to see only the video iframe. Assert only one element in
        // the content region.
        $assert_session->elementsCount('css', 'div.media--type-remote-video > *', 1);
        // Assert the iframe is present in the media element and its src attribute
        // matches the updated URL and query parameters.
        $iframe_url = $assert_session->elementExists('css', 'div.media--type-remote-video .field--name-field-media-oembed-video iframe')
            ->getAttribute('src');
        $iframe_url = parse_url($iframe_url);
        $this->assertStringEndsWith('/media/oembed', $iframe_url['path']);
        $this->assertNotEmpty($iframe_url['query']);
        $query = [];
        parse_str($iframe_url['query'], $query);
        $this->assertSame($video_url_updated, $query['url']);
        $this->assertNotEmpty($query['hash']);
    }
    
    /**
     * Tests the standard profile configuration for media type 'video'.
     */
    protected function videoTest() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $source_field_id = 'field_media_video_file';
        // Create 2 test files.
        $test_filename = $this->randomMachineName() . '.mp4';
        $test_filepath = 'public://' . $test_filename;
        $test_filename_updated = $this->randomMachineName() . '.mp4';
        $test_filepath_updated = 'public://' . $test_filename_updated;
        file_put_contents($test_filepath, str_repeat('t', 10));
        file_put_contents($test_filepath_updated, str_repeat('u', 10));
        // Check if the name field is properly hidden on the media form.
        $this->drupalGet('media/add/video');
        $assert_session->fieldNotExists('name');
        // Check if the source field is available.
        $assert_session->fieldExists("files[{$source_field_id}_0]");
        // Create a media item.
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $video_media_id = $this->container
            ->get('entity_type.manager')
            ->getStorage('media')
            ->getQuery()
            ->accessCheck(FALSE)
            ->sort('mid', 'DESC')
            ->execute();
        $video_media_id = reset($video_media_id);
        // Reference the created media using an entity_reference field and make sure
        // the output is what we expect.
        $node = Node::create([
            'title' => 'Host node',
            'type' => 'article',
            'field_related_media' => [
                'target_id' => $video_media_id,
            ],
        ]);
        $node->save();
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is generated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($video_media_id);
        $this->assertSame($test_filename, $media->label());
        // Here we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-video > *', 1);
        // Assert the video element is present inside the media element and that its
        // src attribute matches the video file.
        $video_element = $assert_session->elementExists('css', 'div.media--type-video .field--name-field-media-video-file video > source');
        
        /** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
        $file_url_generator = \Drupal::service('file_url_generator');
        $expected_video_src = $file_url_generator->generateString(\Drupal::token()->replace('public://[date:custom:Y]-[date:custom:m]/' . $test_filename));
        $this->assertSame($expected_video_src, $video_element->getAttribute('src'));
        // Assert the media name is updated through the field mapping when changing
        // the source field.
        $this->drupalGet('media/' . $video_media_id . '/edit');
        $page->pressButton('Remove');
        $result = $assert_session->waitForField("files[{$source_field_id}_0]");
        $this->assertNotEmpty($result);
        $page->attachFileToField("files[{$source_field_id}_0]", \Drupal::service('file_system')->realpath($test_filepath_updated));
        $result = $assert_session->waitForButton('Remove');
        $this->assertNotEmpty($result);
        $page->pressButton('Save');
        $this->drupalGet('/node/' . $node->id());
        // Check if the default media name is updated as expected.
        $media = \Drupal::entityTypeManager()->getStorage('media')
            ->loadUnchanged($video_media_id);
        $this->assertSame($test_filename_updated, $media->label());
        // Again we expect to see only the linked filename. Assert only one element
        // in the content region.
        $assert_session->elementsCount('css', 'div.media--type-video > *', 1);
        // Assert the video element is present inside the media element and that its
        // src attribute matches the updated video file.
        $video_element = $assert_session->elementExists('css', 'div.media--type-video .field--name-field-media-video-file video > source');
        $expected_video_src = $file_url_generator->generateString(\Drupal::token()->replace('public://[date:custom:Y]-[date:custom:m]/' . $test_filename_updated));
        $this->assertSame($expected_video_src, $video_element->getAttribute('src'));
    }

}

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::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::$defaultTheme protected property The theme to install as the default for testing. 1659
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::$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::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 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::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::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.
MediaJavascriptTestBase::assertLinkToCreatedMedia protected function Asserts that a link to a new media item is displayed in the messages area.
MediaJavascriptTestBase::waitUntilVisible protected function Waits and asserts that a given element is visible.
MediaStandardProfileTest::$modules protected static property Modules to enable. Overrides MediaJavascriptTestBase::$modules
MediaStandardProfileTest::$profile protected property The profile to install as a basis for testing. Overrides BrowserTestBase::$profile
MediaStandardProfileTest::audioTest protected function Tests the standard profile configuration for media type 'audio'.
MediaStandardProfileTest::documentTest protected function Tests the standard profile configuration for media type 'document'.
MediaStandardProfileTest::imageTest protected function Tests the standard profile configuration for media type 'image'.
MediaStandardProfileTest::remoteVideoTest protected function Tests the standard profile configuration for media type 'remote_video'.
MediaStandardProfileTest::setUp protected function Overrides MediaFunctionalTestTrait::setUp
MediaStandardProfileTest::testMediaSources public function Tests all media sources in one method.
MediaStandardProfileTest::videoTest protected function Tests the standard profile configuration for media type 'video'.
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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
OEmbedTestTrait::getFixturesDirectory protected function Returns the relative path to the oEmbed fixtures directory.
OEmbedTestTrait::getFixturesUrl protected function Returns the absolute URL of the oEmbed fixtures directory.
OEmbedTestTrait::hijackProviderEndpoints protected function Ensures that oEmbed provider endpoints use the test resource route.
OEmbedTestTrait::lockHttpClientToFixtures protected function Configures the HTTP client to always use the fixtures directory.
OEmbedTestTrait::useFixtureProviders protected function Forces Media to use the provider database in the fixtures directory.
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::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.
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. 3
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::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
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
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.