class MediaAccessTest

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

Basic access tests for Media.

@group media

Hierarchy

Expanded class hierarchy of MediaAccessTest

File

core/modules/media/tests/src/Functional/MediaAccessTest.php, line 17

Namespace

Drupal\Tests\media\Functional
View source
class MediaAccessTest extends MediaFunctionalTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'media_test_source',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // This is needed to provide the user cache context for a below assertion.
        $this->drupalPlaceBlock('local_tasks_block');
    }
    
    /**
     * Tests some access control functionality.
     */
    public function testMediaAccess() {
        $assert_session = $this->assertSession();
        $media_type = $this->createMediaType('test');
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
        // Create media.
        $media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
        ]);
        $media->save();
        $user_media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
            'uid' => $this->nonAdminUser
                ->id(),
        ]);
        $user_media->save();
        // We are logged in as admin, so test 'administer media' permission.
        $this->drupalGet('media/add/' . $media_type->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('media/' . $user_media->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('media/' . $user_media->id() . '/edit');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('media/' . $user_media->id() . '/delete');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $this->drupalLogin($this->nonAdminUser);
        
        /** @var \Drupal\user\RoleInterface $role */
        $role = Role::load(RoleInterface::AUTHENTICATED_ID);
        user_role_revoke_permissions($role->id(), [
            'view media',
        ]);
        // Test 'create BUNDLE media' permission.
        $this->drupalGet('media/add/' . $media_type->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $permissions = [
            'create ' . $media_type->id() . ' media',
        ];
        $this->grantPermissions($role, $permissions);
        $this->drupalGet('media/add/' . $media_type->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        user_role_revoke_permissions($role->id(), $permissions);
        $role = Role::load(RoleInterface::AUTHENTICATED_ID);
        // Verify the author can not view the unpublished media item without
        // 'view own unpublished media' permission.
        $this->grantPermissions($role, [
            'view media',
        ]);
        $this->drupalGet('media/' . $user_media->id());
        $this->assertNoCacheContext('user');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $user_media->setUnpublished()
            ->save();
        $this->drupalGet('media/' . $user_media->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $access_result = $user_media->access('view', NULL, TRUE);
        $this->assertSame("The user must be the owner and the 'view own unpublished media' permission is required when the media item is unpublished.", $access_result->getReason());
        $this->grantPermissions($role, [
            'view own unpublished media',
        ]);
        $this->drupalGet('media/' . $user_media->id());
        $this->assertCacheContext('user');
        $assert_session->statusCodeEquals(200);
        // Test 'create media' permission.
        $this->drupalGet('media/add/' . $media_type->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $permissions = [
            'create media',
        ];
        $this->grantPermissions($role, $permissions);
        $this->drupalGet('media/add/' . $media_type->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        user_role_revoke_permissions($role->id(), $permissions);
        $role = Role::load(RoleInterface::AUTHENTICATED_ID);
        // Test 'edit own BUNDLE media' and 'delete own BUNDLE media' permissions.
        $this->drupalGet('media/' . $user_media->id() . '/edit');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $this->drupalGet('media/' . $user_media->id() . '/delete');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $permissions = [
            'edit own ' . $user_media->bundle() . ' media',
            'delete own ' . $user_media->bundle() . ' media',
        ];
        $this->grantPermissions($role, $permissions);
        $this->drupalGet('media/' . $user_media->id() . '/edit');
        $this->assertCacheContext('user');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('media/' . $user_media->id() . '/delete');
        $this->assertCacheContext('user');
        $assert_session->statusCodeEquals(200);
        user_role_revoke_permissions($role->id(), $permissions);
        $role = Role::load(RoleInterface::AUTHENTICATED_ID);
        // Test 'edit any BUNDLE media' and 'delete any BUNDLE media' permissions.
        $this->drupalGet('media/' . $media->id() . '/edit');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $this->drupalGet('media/' . $media->id() . '/delete');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $permissions = [
            'edit any ' . $media->bundle() . ' media',
            'delete any ' . $media->bundle() . ' media',
        ];
        $this->grantPermissions($role, $permissions);
        $this->drupalGet('media/' . $media->id() . '/edit');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        $this->drupalGet('media/' . $media->id() . '/delete');
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
        // Test the 'access media overview' permission.
        $this->grantPermissions($role, [
            'access content overview',
        ]);
        $this->drupalGet('admin/content');
        $assert_session->linkByHrefNotExists('/admin/content/media');
        $this->assertCacheContext('user');
        // Create a new role, which implicitly checks if the permission exists.
        $mediaOverviewRole = $this->createRole([
            'access content overview',
            'access media overview',
        ]);
        $this->nonAdminUser
            ->addRole($mediaOverviewRole);
        $this->nonAdminUser
            ->save();
        $this->drupalGet('admin/content');
        $assert_session->linkByHrefExists('/admin/content/media');
        $this->clickLink('Media');
        $this->assertCacheContext('user');
        $assert_session->statusCodeEquals(200);
        $assert_session->elementExists('css', '.views-element-container');
        // First row of the View contains media created by admin user.
        $assert_session->elementTextEquals('xpath', '//div[@class="views-element-container"]//tbody/tr[1]/td[contains(@class, "views-field-uid")]/a', $this->adminUser
            ->getDisplayName());
        $assert_session->elementTextEquals('xpath', "//div[@class='views-element-container']//tbody/tr[1]/td[contains(@class, 'views-field-name')]/a[contains(@href, '/media/{$media->id()}')]", 'Unnamed');
        // Second row of the View contains media created by non-admin user.
        $assert_session->elementTextEquals('xpath', '//div[@class="views-element-container"]//tbody/tr[2]/td[contains(@class, "views-field-uid")]/a', $this->nonAdminUser
            ->getDisplayName());
        $assert_session->elementTextEquals('xpath', "//div[@class='views-element-container']//tbody/tr[2]/td[contains(@class, 'views-field-name')]/a[contains(@href, '/media/{$user_media->id()}')]", 'Unnamed');
    }
    
    /**
     * Tests view access control on the canonical page.
     */
    public function testCanonicalMediaAccess() {
        $media_type = $this->createMediaType('test');
        $assert_session = $this->assertSession();
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
        // Create media.
        $media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
        ]);
        $media->save();
        $user_media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
            'uid' => $this->nonAdminUser
                ->id(),
        ]);
        $user_media->save();
        $this->drupalLogin($this->nonAdminUser);
        
        /** @var \Drupal\user\RoleInterface $role */
        $role = Role::load(RoleInterface::AUTHENTICATED_ID);
        user_role_revoke_permissions($role->id(), [
            'view media',
        ]);
        $this->drupalGet('media/' . $media->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(403);
        $access_result = $media->access('view', NULL, TRUE);
        $this->assertSame("The 'view media' permission is required when the media item is published.", $access_result->getReason());
        $this->grantPermissions($role, [
            'view media',
        ]);
        $this->drupalGet('media/' . $media->id());
        $this->assertCacheContext('user.permissions');
        $assert_session->statusCodeEquals(200);
    }
    
    /**
     * Tests unpublished media access.
     */
    public function testUnpublishedMediaUserAccess() {
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
        $assert_session = $this->assertSession();
        $media_type = $this->createMediaType('test');
        $permissions = [
            'view media',
            'view own unpublished media',
        ];
        $user_one = $this->drupalCreateUser($permissions);
        $user_two = $this->drupalCreateUser($permissions);
        // Create media as user one.
        $user_media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
            'uid' => $user_one->id(),
        ]);
        $user_media->setUnpublished()
            ->save();
        // Make sure user two can't access unpublished media.
        $this->drupalLogin($user_two);
        $this->drupalGet('media/' . $user_media->id());
        $assert_session->statusCodeEquals(403);
        $this->assertCacheContext('user');
        $this->drupalLogout();
        // Make sure user one can access own unpublished media.
        $this->drupalLogin($user_one);
        $this->drupalGet('media/' . $user_media->id());
        $assert_session->statusCodeEquals(200);
        $this->assertCacheContext('user');
    }
    
    /**
     * Tests media access of anonymous user.
     */
    public function testMediaAnonymousUserAccess() {
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
        $assert_session = $this->assertSession();
        $media_type = $this->createMediaType('test');
        // Create media as anonymous user.
        $user_media = Media::create([
            'bundle' => $media_type->id(),
            'name' => 'Unnamed',
            'uid' => 0,
        ]);
        $user_media->save();
        $role = Role::load(RoleInterface::ANONYMOUS_ID);
        $this->grantPermissions($role, [
            'view media',
            'view own unpublished media',
        ]);
        $this->drupalLogout();
        // Make sure anonymous users can access published media.
        $user_media->setPublished()
            ->save();
        $this->drupalGet('media/' . $user_media->id());
        $assert_session->statusCodeEquals(200);
        // Make sure anonymous users can not access unpublished media
        // even though role has 'view own unpublished media' permission.
        $user_media->setUnpublished()
            ->save();
        $this->drupalGet('media/' . $user_media->id());
        $assert_session->statusCodeEquals(403);
        $this->assertCacheContext('user');
    }
    
    /**
     * Tests access for embedded medias.
     */
    public function testReferencedRendering() {
        \Drupal::configFactory()->getEditable('media.settings')
            ->set('standalone_url', TRUE)
            ->save(TRUE);
        $this->container
            ->get('router.builder')
            ->rebuild();
        // Create a media type and an entity reference to itself.
        $media_type = $this->createMediaType('test');
        FieldStorageConfig::create([
            'field_name' => 'field_reference',
            'entity_type' => 'media',
            'type' => 'entity_reference',
            'settings' => [
                'target_type' => 'media',
            ],
        ])->save();
        FieldConfig::create([
            'field_name' => 'field_reference',
            'entity_type' => 'media',
            'bundle' => $media_type->id(),
        ])
            ->save();
        $author = $this->drupalCreateUser([
            'view media',
            'view own unpublished media',
        ]);
        $other_user = $this->drupalCreateUser([
            'view media',
            'view own unpublished media',
        ]);
        $view_user = $this->drupalCreateUser([
            'view media',
        ]);
        $child_title = 'Child media';
        $media_child = Media::create([
            'name' => $child_title,
            'bundle' => $media_type->id(),
            'uid' => $author->id(),
        ]);
        $media_child->setUnpublished()
            ->save();
        $media_parent = Media::create([
            'name' => 'Parent media',
            'bundle' => $media_type->id(),
            'field_reference' => $media_child->id(),
        ]);
        $media_parent->save();
        \Drupal::service('entity_display.repository')->getViewDisplay('media', $media_type->id(), 'full')
            ->set('content', [])
            ->setComponent('title', [
            'type' => 'string',
        ])
            ->setComponent('field_reference', [
            'type' => 'entity_reference_label',
        ])
            ->save();
        $assert_session = $this->assertSession();
        // The author of the child media items should have access to both the parent
        // and child.
        $this->drupalLogin($author);
        $this->drupalGet($media_parent->toUrl());
        $this->assertCacheContext('user');
        $assert_session->pageTextContains($child_title);
        // Other users with the 'view own unpublished media' permission should not
        // be able to see the unpublished child media item. The 'user' cache context
        // should be added in this case.
        $this->drupalLogin($other_user);
        $this->drupalGet($media_parent->toUrl());
        $this->assertCacheContext('user');
        $assert_session->pageTextNotContains($child_title);
        // User with just the 'view media' permission should not be able to see the
        // child media item. The 'user' cache context should not be added in this
        // case.
        $this->drupalLogin($view_user);
        $this->drupalGet($media_parent->toUrl());
        $this->assertNoCacheContext('user');
        $assert_session->pageTextNotContains($child_title);
    }

}

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
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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
MediaAccessTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
MediaAccessTest::$modules protected static property Modules to enable. Overrides MediaFunctionalTestBase::$modules
MediaAccessTest::setUp protected function Overrides MediaFunctionalTestTrait::setUp
MediaAccessTest::testCanonicalMediaAccess public function Tests view access control on the canonical page.
MediaAccessTest::testMediaAccess public function Tests some access control functionality.
MediaAccessTest::testMediaAnonymousUserAccess public function Tests media access of anonymous user.
MediaAccessTest::testReferencedRendering public function Tests access for embedded medias.
MediaAccessTest::testUnpublishedMediaUserAccess public function Tests unpublished media access.
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.
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.