class BlockContentAccessHandlerTest

Same name in other branches
  1. 9 core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php \Drupal\Tests\block_content\Kernel\BlockContentAccessHandlerTest
  2. 10 core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php \Drupal\Tests\block_content\Kernel\BlockContentAccessHandlerTest
  3. 11.x core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php \Drupal\Tests\block_content\Kernel\BlockContentAccessHandlerTest

Tests the block content entity access handler.

@coversDefaultClass \Drupal\block_content\BlockContentAccessControlHandler

@group block_content

Hierarchy

Expanded class hierarchy of BlockContentAccessHandlerTest

File

core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php, line 21

Namespace

Drupal\Tests\block_content\Kernel
View source
class BlockContentAccessHandlerTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    public static $modules = [
        'block',
        'block_content',
        'system',
        'user',
    ];
    
    /**
     * The BlockContent access controller to test.
     *
     * @var \Drupal\block_content\BlockContentAccessControlHandler
     */
    protected $accessControlHandler;
    
    /**
     * The BlockContent entity used for testing.
     *
     * @var \Drupal\block_content\Entity\BlockContent
     */
    protected $blockEntity;
    
    /**
     * The test role.
     *
     * @var \Drupal\user\RoleInterface
     */
    protected $role;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $this->installSchema('system', [
            'sequences',
        ]);
        $this->installSchema('user', [
            'users_data',
        ]);
        $this->installEntitySchema('user');
        $this->installEntitySchema('block_content');
        // Create a block content type.
        $block_content_type = BlockContentType::create([
            'id' => 'square',
            'label' => 'A square block type',
            'description' => "Provides a block type that is square.",
        ]);
        $block_content_type->save();
        $this->blockEntity = BlockContent::create([
            'info' => 'The Block',
            'type' => 'square',
        ]);
        $this->blockEntity
            ->save();
        // Create user 1 test does not have all permissions.
        User::create([
            'name' => 'admin',
        ])->save();
        $this->role = Role::create([
            'id' => 'roly',
            'label' => 'roly poly',
        ]);
        $this->role
            ->save();
        $this->accessControlHandler = new BlockContentAccessControlHandler(\Drupal::entityTypeManager()->getDefinition('block_content'), \Drupal::service('event_dispatcher'));
    }
    
    /**
     * @covers ::checkAccess
     *
     * @dataProvider providerTestAccess
     */
    public function testAccess($operation, $published, $reusable, $permissions, $parent_access, $expected_access) {
        $published ? $this->blockEntity
            ->setPublished() : $this->blockEntity
            ->setUnpublished();
        $reusable ? $this->blockEntity
            ->setReusable() : $this->blockEntity
            ->setNonReusable();
        $user = User::create([
            'name' => 'Someone',
            'mail' => 'hi@example.com',
        ]);
        if ($permissions) {
            foreach ($permissions as $permission) {
                $this->role
                    ->grantPermission($permission);
            }
            $this->role
                ->save();
        }
        $user->addRole($this->role
            ->id());
        $user->save();
        if ($parent_access) {
            $parent_entity = $this->prophesize(AccessibleInterface::class);
            $expected_parent_result = NULL;
            switch ($parent_access) {
                case 'allowed':
                    $expected_parent_result = AccessResult::allowed();
                    break;
                case 'neutral':
                    $expected_parent_result = AccessResult::neutral();
                    break;
                case 'forbidden':
                    $expected_parent_result = AccessResult::forbidden();
                    break;
            }
            $parent_entity->access($operation, $user, TRUE)
                ->willReturn($expected_parent_result)
                ->shouldBeCalled();
            $this->blockEntity
                ->setAccessDependency($parent_entity->reveal());
        }
        $this->blockEntity
            ->save();
        $result = $this->accessControlHandler
            ->access($this->blockEntity, $operation, $user, TRUE);
        switch ($expected_access) {
            case 'allowed':
                $this->assertTrue($result->isAllowed());
                break;
            case 'forbidden':
                $this->assertTrue($result->isForbidden());
                break;
            case 'neutral':
                $this->assertTrue($result->isNeutral());
                break;
            default:
                $this->fail('Unexpected access type');
        }
    }
    
    /**
     * Dataprovider for testAccess().
     */
    public function providerTestAccess() {
        $cases = [
            'view:published:reusable' => [
                'view',
                TRUE,
                TRUE,
                [],
                NULL,
                'allowed',
            ],
            'view:unpublished:reusable' => [
                'view',
                FALSE,
                TRUE,
                [],
                NULL,
                'neutral',
            ],
            'view:unpublished:reusable:admin' => [
                'view',
                FALSE,
                TRUE,
                [
                    'administer blocks',
                ],
                NULL,
                'allowed',
            ],
            'view:published:reusable:admin' => [
                'view',
                TRUE,
                TRUE,
                [
                    'administer blocks',
                ],
                NULL,
                'allowed',
            ],
            'view:published:non_reusable' => [
                'view',
                TRUE,
                FALSE,
                [],
                NULL,
                'forbidden',
            ],
            'view:published:non_reusable:parent_allowed' => [
                'view',
                TRUE,
                FALSE,
                [],
                'allowed',
                'allowed',
            ],
            'view:published:non_reusable:parent_neutral' => [
                'view',
                TRUE,
                FALSE,
                [],
                'neutral',
                'neutral',
            ],
            'view:published:non_reusable:parent_forbidden' => [
                'view',
                TRUE,
                FALSE,
                [],
                'forbidden',
                'forbidden',
            ],
        ];
        foreach ([
            'update',
            'delete',
        ] as $operation) {
            $cases += [
                $operation . ':published:reusable' => [
                    $operation,
                    TRUE,
                    TRUE,
                    [],
                    NULL,
                    'neutral',
                ],
                $operation . ':unpublished:reusable' => [
                    $operation,
                    FALSE,
                    TRUE,
                    [],
                    NULL,
                    'neutral',
                ],
                $operation . ':unpublished:reusable:admin' => [
                    $operation,
                    FALSE,
                    TRUE,
                    [
                        'administer blocks',
                    ],
                    NULL,
                    'allowed',
                ],
                $operation . ':published:reusable:admin' => [
                    $operation,
                    TRUE,
                    TRUE,
                    [
                        'administer blocks',
                    ],
                    NULL,
                    'allowed',
                ],
                $operation . ':published:non_reusable' => [
                    $operation,
                    TRUE,
                    FALSE,
                    [],
                    NULL,
                    'forbidden',
                ],
                $operation . ':published:non_reusable:parent_allowed' => [
                    $operation,
                    TRUE,
                    FALSE,
                    [],
                    'allowed',
                    'neutral',
                ],
                $operation . ':published:non_reusable:parent_neutral' => [
                    $operation,
                    TRUE,
                    FALSE,
                    [],
                    'neutral',
                    'neutral',
                ],
                $operation . ':published:non_reusable:parent_forbidden' => [
                    $operation,
                    TRUE,
                    FALSE,
                    [],
                    'forbidden',
                    'forbidden',
                ],
            ];
        }
        return $cases;
    }

}

Members

Title Sort descending 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 the raw text IS NOT found escaped on the 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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
BlockContentAccessHandlerTest::$accessControlHandler protected property The BlockContent access controller to test.
BlockContentAccessHandlerTest::$blockEntity protected property The BlockContent entity used for testing.
BlockContentAccessHandlerTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
BlockContentAccessHandlerTest::$role protected property The test role.
BlockContentAccessHandlerTest::providerTestAccess public function Dataprovider for testAccess().
BlockContentAccessHandlerTest::setUp protected function Overrides KernelTestBase::setUp
BlockContentAccessHandlerTest::testAccess public function @covers ::checkAccess
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.
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. 7
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::$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. 6
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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