class MediaAccessControlHandlerTest

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

Tests the media access control handler.

@group media

@coversDefaultClass \Drupal\media\MediaAccessControlHandler

Hierarchy

Expanded class hierarchy of MediaAccessControlHandlerTest

File

core/modules/media/tests/src/Kernel/MediaAccessControlHandlerTest.php, line 19

Namespace

Drupal\Tests\media\Kernel
View source 
class MediaAccessControlHandlerTest extends MediaKernelTestBase {
    use UserCreationTrait;
    
    /**
     * Tests the media access control handler.
     *
     * @param string[] $permissions
     *   The permissions that the user should be given.
     * @param array $entity_values
     *   Initial values from which to create the media entity.
     * @param string $operation
     *   The operation, one of 'view', 'update' or 'delete'.
     * @param \Drupal\Core\Access\AccessResultInterface $expected_result
     *   Expected result.
     * @param string[] $expected_cache_contexts
     *   Expected cache contexts.
     * @param string[] $expected_cache_tags
     *   Expected cache tags.
     *
     * @covers ::checkAccess
     * @dataProvider providerAccess
     */
    public function testAccess(array $permissions, array $entity_values, $operation, AccessResultInterface $expected_result, array $expected_cache_contexts, array $expected_cache_tags) {
        // Set a fixed ID so the type specific permissions match.
        $media_type = $this->createMediaType('test', [
            'id' => 'test',
        ]);
        $user = $this->createUser($permissions);
        $entity_values += [
            'status' => FALSE,
            'uid' => $user->id(),
            'bundle' => $media_type->id(),
        ];
        $entity = Media::create($entity_values);
        $entity->save();
        
        /** @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface $access_handler */
        $access_handler = $this->container
            ->get('entity_type.manager')
            ->getAccessControlHandler('media');
        $this->assertAccess($expected_result, $expected_cache_contexts, $expected_cache_tags, $access_handler->access($entity, $operation, $user, TRUE));
    }
    
    /**
     * @param string[] $permissions
     *   User permissions.
     * @param \Drupal\Core\Access\AccessResultInterface $expected_result
     *   Expected result.
     * @param string[] $expected_cache_contexts
     *   Expected cache contexts.
     * @param string[] $expected_cache_tags
     *   Expected cache tags.
     *
     * @covers ::checkCreateAccess
     * @dataProvider providerCreateAccess
     */
    public function testCreateAccess(array $permissions, AccessResultInterface $expected_result, array $expected_cache_contexts, array $expected_cache_tags) {
        $user = $this->createUser($permissions);
        
        /** @var \Drupal\Core\Entity\EntityAccessControlHandlerInterface $access_handler */
        $access_handler = $this->container
            ->get('entity_type.manager')
            ->getAccessControlHandler('media');
        $this->assertAccess($expected_result, $expected_cache_contexts, $expected_cache_tags, $access_handler->createAccess('test', $user, [], TRUE));
    }
    
    /**
     * Asserts an access result.
     *
     * @param \Drupal\Core\Access\AccessResultInterface $expected_access_result
     *   The expected access result.
     * @param string[] $expected_cache_contexts
     *   Expected contexts.
     * @param string[] $expected_cache_tags
     *   Expected cache tags.
     * @param \Drupal\Core\Access\AccessResultInterface $actual
     *   The actual access result.
     *
     * @internal
     */
    protected function assertAccess(AccessResultInterface $expected_access_result, array $expected_cache_contexts, array $expected_cache_tags, AccessResultInterface $actual) : void {
        $this->assertSame($expected_access_result->isAllowed(), $actual->isAllowed());
        $this->assertSame($expected_access_result->isForbidden(), $actual->isForbidden());
        $this->assertSame($expected_access_result->isNeutral(), $actual->isNeutral());
        $actual_cache_contexts = $actual->getCacheContexts();
        sort($expected_cache_contexts);
        sort($actual_cache_contexts);
        $this->assertSame($expected_cache_contexts, $actual_cache_contexts);
        $actual_cache_tags = $actual->getCacheTags();
        sort($expected_cache_tags);
        sort($actual_cache_tags);
        $this->assertSame($expected_cache_tags, $actual_cache_tags);
    }
    
    /**
     * Data provider for testAccess().
     *
     * @return array
     *   The data sets to test.
     */
    public function providerAccess() {
        $test_data = [];
        // Check published / unpublished media access for a user owning the media
        // item without permissions.
        $test_data['owner, no permissions / published / view'] = [
            [],
            [
                'status' => TRUE,
            ],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, no permissions / published / update'] = [
            [],
            [
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, no permissions / published / delete'] = [
            [],
            [
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, no permissions / unpublished / view'] = [
            [],
            [],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, no permissions / unpublished / update'] = [
            [],
            [],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, no permissions / unpublished / delete'] = [
            [],
            [],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check published / unpublished media access for a user not owning the
        // media item without permissions.
        $test_data['not owner, no permissions / published / view'] = [
            [],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, no permissions / published / update'] = [
            [],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, no permissions / published / delete'] = [
            [],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, no permissions / unpublished / view'] = [
            [],
            [
                'uid' => 0,
            ],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, no permissions / unpublished / update'] = [
            [],
            [
                'uid' => 0,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, no permissions / unpublished / delete'] = [
            [],
            [
                'uid' => 0,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check published / unpublished media access for a user owning the media
        // item with only the 'view media' permission.
        $test_data['owner, can view media / published / view'] = [
            [
                'view media',
            ],
            [
                'status' => TRUE,
            ],
            'view',
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, can view media / published / update'] = [
            [
                'view media',
            ],
            [
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view media / published / delete'] = [
            [
                'view media',
            ],
            [
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view media / unpublished / view'] = [
            [
                'view media',
            ],
            [],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, can view media / unpublished / update'] = [
            [
                'view media',
            ],
            [],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view media / unpublished / delete'] = [
            [
                'view media',
            ],
            [],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check published / unpublished media access for a user not owning the
        // media item with only the 'view media' permission.
        $test_data['not owner, can view media / published / view'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'view',
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, can view media / published / update'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view media / published / delete'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view media / unpublished / view'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
            ],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, can view media / unpublished / update'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view media / unpublished / delete'] = [
            [
                'view media',
            ],
            [
                'uid' => 0,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check published / unpublished media access for a user owning the media
        // item with the 'view media' and 'view own unpublished' permission.
        $test_data['owner, can view own unpublished media / published / view'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'status' => TRUE,
            ],
            'view',
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, can view own unpublished media / published / update'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view own unpublished media / published / delete'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view own unpublished media / unpublished / view'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [],
            'view',
            AccessResult::allowed(),
            [
                'user.permissions',
                'user',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['owner, can view own unpublished media / unpublished / update'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['owner, can view own unpublished media / unpublished / delete'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check published / unpublished media access for a user not owning the
        // media item with the 'view media' and 'view own unpublished' permission.
        $test_data['not owner, can view own unpublished media / published / view'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'view',
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, can view own unpublished media / published / update'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view own unpublished media / published / delete'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
                'status' => TRUE,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view own unpublished media / unpublished / view'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
            ],
            'view',
            AccessResult::neutral(),
            [
                'user.permissions',
                'user',
            ],
            [
                'media:1',
            ],
        ];
        $test_data['not owner, can view own unpublished media / unpublished / update'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
            ],
            'update',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        $test_data['not owner, can view own unpublished media / unpublished / delete'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            [
                'uid' => 0,
            ],
            'delete',
            AccessResult::neutral(),
            [
                'user.permissions',
            ],
            [],
        ];
        return $test_data;
    }
    
    /**
     * Data provider for testCreateAccess().
     *
     * @return array
     *   The data sets to test.
     */
    public function providerCreateAccess() {
        $test_data = [];
        // Check create access for a user without permissions.
        $test_data['user, no permissions / create'] = [
            [],
            AccessResult::neutral()->setReason("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'view media' permission.
        $test_data['user, can view media / create'] = [
            [
                'view media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'view media' and 'view own
        // unpublished media' permission.
        $test_data['user, can view own unpublished media / create'] = [
            [
                'view media',
                'view own unpublished media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'view media', 'view own
        // unpublished media', 'update any media' and 'delete any media' permission.
        $test_data['user, can view own unpublished media and update or delete any media / create'] = [
            [
                'view media',
                'view own unpublished media',
                'update any media',
                'delete any media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'view media', 'view own
        // unpublished media', 'update media' and 'delete media' permission.
        $test_data['user, can view own unpublished media and update or delete own media / create'] = [
            [
                'view media',
                'view own unpublished media',
                'update media',
                'delete media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'view media', 'view own
        // unpublished media', 'update any media', 'delete any media', 'update
        // media' and 'delete media' permission.
        $test_data['user, can view own unpublished media and update or delete all media / create'] = [
            [
                'view media',
                'view own unpublished media',
                'update any media',
                'delete any media',
                'update media',
                'delete media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with all media permissions except 'create
        // media' or 'administer media'.
        $test_data['user, can not create or administer media / create'] = [
            [
                'access media overview',
                'view media',
                'view own unpublished media',
                'update any media',
                'delete any media',
                'update media',
                'delete media',
            ],
            AccessResult::neutral("The following permissions are required: 'administer media' OR 'create media'."),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'create media' permission.
        $test_data['user, can create media / create'] = [
            [
                'create media',
            ],
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [],
        ];
        // Check create access for a user with the 'administer media' permission.
        $test_data['user, can administer media / create'] = [
            [
                'administer media',
            ],
            AccessResult::allowed(),
            [
                'user.permissions',
            ],
            [],
        ];
        return $test_data;
    }
    
    /**
     * Tests MediaAccessControlHandler deprecation.
     *
     * @group legacy
     */
    public function testMediaAccessControlHandlerDeprecation() {
        $this->expectDeprecation('Calling Drupal\\media\\MediaAccessControlHandler::__construct() without the $entity_type_manager argument is deprecated in drupal:9.3.0 and will be required in drupal:10.0.0. See https://www.drupal.org/node/3214171');
        $entity_type = $this->prophesize(EntityTypeInterface::class);
        $entity_type->id()
            ->willReturn('media');
        new MediaAccessControlHandler($entity_type->reveal());
    }

}

Members

Title Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
MediaAccessControlHandlerTest::assertAccess protected function Asserts an access result.
MediaAccessControlHandlerTest::providerAccess public function Data provider for testAccess().
MediaAccessControlHandlerTest::providerCreateAccess public function Data provider for testCreateAccess().
MediaAccessControlHandlerTest::testAccess public function Tests the media access control handler.
MediaAccessControlHandlerTest::testCreateAccess public function @covers ::checkCreateAccess
@dataProvider providerCreateAccess
MediaAccessControlHandlerTest::testMediaAccessControlHandlerDeprecation public function Tests MediaAccessControlHandler deprecation.
MediaKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 4
MediaKernelTestBase::$testConstraintsMediaType protected property The test media type with constraints.
MediaKernelTestBase::$testMediaType protected property The test media type.
MediaKernelTestBase::$user protected property A user.
MediaKernelTestBase::generateMedia protected function Helper to generate a media item.
MediaKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 2
MediaTypeCreationTrait::createMediaType protected function Create a media type for a source plugin.
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.
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.
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.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.