class MediaSourceOEmbedVideoTest

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

Tests the oembed:video media source.

@group media

Hierarchy

Expanded class hierarchy of MediaSourceOEmbedVideoTest

File

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

Namespace

Drupal\Tests\media\FunctionalJavascript
View source
class MediaSourceOEmbedVideoTest extends MediaSourceTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'media_test_oembed',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    use OEmbedTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->lockHttpClientToFixtures();
    }
    
    /**
     * {@inheritdoc}
     */
    protected function initConfig(ContainerInterface $container) {
        parent::initConfig($container);
        // Enable twig debugging to make testing template usage easy.
        $parameters = $container->getParameter('twig.config');
        $parameters['debug'] = TRUE;
        $this->setContainerParameter('twig.config', $parameters);
    }
    
    /**
     * Tests the oembed media source.
     */
    public function testMediaOEmbedVideoSource() {
        $media_type_id = 'test_media_oembed_type';
        $provided_fields = [
            'type',
            'title',
            'default_name',
            'author_name',
            'author_url',
            'provider_name',
            'provider_url',
            'cache_age',
            'thumbnail_uri',
            'thumbnail_width',
            'thumbnail_height',
            'url',
            'width',
            'height',
            'html',
        ];
        $session = $this->getSession();
        $page = $session->getPage();
        $assert_session = $this->assertSession();
        $this->doTestCreateMediaType($media_type_id, 'oembed:video', $provided_fields);
        // Create custom fields for the media type to store metadata attributes.
        $fields = [
            'field_string_width' => 'string',
            'field_string_height' => 'string',
            'field_string_author_name' => 'string',
        ];
        $this->createMediaTypeFields($fields, $media_type_id);
        // Hide the name field widget to test default name generation.
        $this->hideMediaTypeFieldWidget('name', $media_type_id);
        $this->drupalGet("admin/structure/media/manage/{$media_type_id}");
        // Only accept Vimeo videos.
        $page->checkField("source_configuration[providers][Vimeo]");
        $assert_session->selectExists('field_map[width]')
            ->setValue('field_string_width');
        $assert_session->selectExists('field_map[height]')
            ->setValue('field_string_height');
        $assert_session->selectExists('field_map[author_name]')
            ->setValue('field_string_author_name');
        $assert_session->buttonExists('Save')
            ->press();
        // Configure the iframe to be narrower than the actual video, so we can
        // verify that the video scales correctly.
        $display = \Drupal::service('entity_display.repository')->getViewDisplay('media', $media_type_id);
        $this->assertFalse($display->isNew());
        $component = $display->getComponent('field_media_oembed_video');
        $this->assertIsArray($component);
        $component['settings']['max_width'] = 240;
        $display->setComponent('field_media_oembed_video', $component);
        $this->assertSame(SAVED_UPDATED, $display->save());
        $this->hijackProviderEndpoints();
        $video_url = 'https://vimeo.com/7073899';
        ResourceController::setResourceUrl($video_url, $this->getFixturesDirectory() . '/video_vimeo.json');
        // Create a media item.
        $this->drupalGet("media/add/{$media_type_id}");
        $assert_session->fieldExists('Remote video URL')
            ->setValue($video_url);
        $assert_session->buttonExists('Save')
            ->press();
        $assert_session->addressEquals('admin/content/media');
        // Get the media entity view URL from the creation message.
        $this->drupalGet($this->assertLinkToCreatedMedia());
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = Media::load(1);
        // The thumbnail should have been downloaded.
        $thumbnail = $media->getSource()
            ->getMetadata($media, 'thumbnail_uri');
        $this->assertFileExists($thumbnail);
        // Ensure the iframe exists and has the expected CSS class, and that its src
        // attribute contains a coherent URL with the query parameters we expect.
        $iframe = $assert_session->elementExists('css', 'iframe.media-oembed-content');
        $iframe_url = parse_url($iframe->getAttribute('src'));
        $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']);
        // Ensure that the outer iframe's width respects the formatter settings.
        $this->assertSame('240', $iframe->getAttribute('width'));
        // Check the inner iframe to make sure that CSS has been applied to scale it
        // correctly, regardless of whatever its width attribute may be (the fixture
        // hard-codes it to 480).
        $inner_frame = 'frames[0].document.querySelector("iframe")';
        $this->assertSame('480', $session->evaluateScript("{$inner_frame}.getAttribute('width')"));
        $this->assertLessThanOrEqual(240, $session->evaluateScript("{$inner_frame}.clientWidth"));
        // The oEmbed content iFrame should be visible.
        $assert_session->elementExists('css', 'iframe.media-oembed-content');
        // The thumbnail should not be displayed.
        $assert_session->elementNotExists('css', 'img');
        // Load the media and check that all fields are properly populated.
        $media = Media::load(1);
        $this->assertSame('Drupal Rap Video - Schipulcon09', $media->getName());
        $this->assertSame('480', $media->field_string_width->value);
        $this->assertSame('360', $media->field_string_height->value);
        // Try to create a media asset from a disallowed provider.
        $this->drupalGet("media/add/{$media_type_id}");
        $assert_session->fieldExists('Remote video URL')
            ->setValue('http://www.collegehumor.com/video/40003213/grant-and-katie-are-starting-their-own-company');
        $page->pressButton('Save');
        $assert_session->pageTextContains('The CollegeHumor provider is not allowed.');
        // Register a CollegeHumor video as a second oEmbed resource. Note that its
        // thumbnail URL does not have a file extension.
        $media_type = MediaType::load($media_type_id);
        $source_configuration = $media_type->getSource()
            ->getConfiguration();
        $source_configuration['providers'][] = 'CollegeHumor';
        $media_type->getSource()
            ->setConfiguration($source_configuration);
        $media_type->save();
        $video_url = 'http://www.collegehumor.com/video/40003213/let-not-get-a-drink-sometime';
        ResourceController::setResourceUrl($video_url, $this->getFixturesDirectory() . '/video_collegehumor.xml');
        // Create a new media item using a CollegeHumor video.
        $this->drupalGet("media/add/{$media_type_id}");
        $assert_session->fieldExists('Remote video URL')
            ->setValue($video_url);
        $assert_session->buttonExists('Save')
            ->press();
        
        /** @var \Drupal\media\MediaInterface $media */
        $media = Media::load(2);
        $thumbnail = $media->getSource()
            ->getMetadata($media, 'thumbnail_uri');
        $this->assertFileExists($thumbnail);
        // Although the resource's thumbnail URL doesn't have a file extension, we
        // should have deduced the correct one.
        $this->assertStringEndsWith('.png', $thumbnail);
        // Test anonymous access to media via iframe.
        $this->drupalLogout();
        // Without a hash should be denied.
        $no_hash_query = array_diff_key($query, [
            'hash' => '',
        ]);
        $this->drupalGet('media/oembed', [
            'query' => $no_hash_query,
        ]);
        $assert_session->pageTextNotContains('By the power of Grayskull, Vimeo works!');
        $assert_session->pageTextContains('Client error');
        // A correct query should be allowed because the anonymous role has the
        // 'view media' permission.
        $this->drupalGet('media/oembed', [
            'query' => $query,
        ]);
        $assert_session->pageTextContains('By the power of Grayskull, Vimeo works!');
        // Remove the 'view media' permission to test that this restricts access.
        $role = Role::load(AccountInterface::ANONYMOUS_ROLE);
        $role->revokePermission('view media');
        $role->save();
        $this->drupalGet('media/oembed', [
            'query' => $query,
        ]);
        $assert_session->pageTextNotContains('By the power of Grayskull, Vimeo works!');
        $assert_session->pageTextContains('Access denied');
    }
    
    /**
     * Tests that a security warning appears if iFrame domain is not set.
     */
    public function testOEmbedSecurityWarning() {
        $media_type_id = 'test_media_oembed_type';
        $source_id = 'oembed:video';
        $session = $this->getSession();
        $page = $session->getPage();
        $assert_session = $this->assertSession();
        $this->drupalGet('admin/structure/media/add');
        $page->fillField('label', $media_type_id);
        $this->getSession()
            ->wait(5000, "jQuery('.machine-name-value').text() === '{$media_type_id}'");
        // Make sure the source is available.
        $assert_session->fieldExists('Media source');
        $assert_session->optionExists('Media source', $source_id);
        $page->selectFieldOption('Media source', $source_id);
        $result = $assert_session->waitForElementVisible('css', 'fieldset[data-drupal-selector="edit-source-configuration"]');
        $this->assertNotEmpty($result);
        $assert_session->pageTextContains('It is potentially insecure to display oEmbed content in a frame');
        $this->config('media.settings')
            ->set('iframe_domain', 'http://example.com')
            ->save();
        $this->drupalGet('admin/structure/media/add');
        $page->fillField('label', $media_type_id);
        $this->getSession()
            ->wait(5000, "jQuery('.machine-name-value').text() === '{$media_type_id}'");
        // Make sure the source is available.
        $assert_session->fieldExists('Media source');
        $assert_session->optionExists('Media source', $source_id);
        $page->selectFieldOption('Media source', $source_id);
        $result = $assert_session->waitForElementVisible('css', 'fieldset[data-drupal-selector="edit-source-configuration"]');
        $this->assertNotEmpty($result);
        $assert_session->pageTextNotContains('It is potentially insecure to display oEmbed content in a frame');
    }

}

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::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 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::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::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.
MediaSourceOEmbedVideoTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaSourceOEmbedVideoTest::$modules protected static property Modules to enable. Overrides MediaJavascriptTestBase::$modules
MediaSourceOEmbedVideoTest::initConfig protected function Initialize various configurations post-installation. Overrides FunctionalTestSetupTrait::initConfig
MediaSourceOEmbedVideoTest::setUp protected function Overrides MediaSourceTestBase::setUp
MediaSourceOEmbedVideoTest::testMediaOEmbedVideoSource public function Tests the oembed media source.
MediaSourceOEmbedVideoTest::testOEmbedSecurityWarning public function Tests that a security warning appears if iFrame domain is not set.
MediaSourceTestBase::createMediaTypeField protected function Creates storage and field instance, attached to a given media type.
MediaSourceTestBase::createMediaTypeFields protected function Create a set of fields in a media type.
MediaSourceTestBase::doTestCreateMediaType public function Tests generic media type creation.
MediaSourceTestBase::hideMediaTypeFieldWidget protected function Hides a widget in the default form display config.
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.