class NodeAccessLanguageAwareTest

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

Tests node_access and select queries with node_access tag functionality with multiple languages with node_access_test_language which is language-aware.

@group node

Hierarchy

Expanded class hierarchy of NodeAccessLanguageAwareTest

File

core/modules/node/tests/src/Kernel/NodeAccessLanguageAwareTest.php, line 18

Namespace

Drupal\Tests\node\Kernel
View source
class NodeAccessLanguageAwareTest extends NodeAccessTestBase {
    
    /**
     * Enable language and a language-aware node access module.
     *
     * @var array
     */
    public static $modules = [
        'language',
        'node_access_test_language',
    ];
    
    /**
     * A set of nodes to use in testing.
     *
     * @var \Drupal\node\NodeInterface[]
     */
    protected $nodes = [];
    
    /**
     * A user with permission to bypass access content.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * A normal authenticated user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $webUser;
    protected function setUp() {
        parent::setUp();
        // Create the 'private' field, which allows the node to be marked as private
        // (restricted access) in a given translation.
        $field_storage = FieldStorageConfig::create([
            'field_name' => 'field_private',
            'entity_type' => 'node',
            'type' => 'boolean',
            'cardinality' => 1,
        ]);
        $field_storage->save();
        FieldConfig::create([
            'field_storage' => $field_storage,
            'bundle' => 'page',
            'widget' => [
                'type' => 'options_buttons',
            ],
            'settings' => [
                'on_label' => 'Private',
                'off_label' => 'Not private',
            ],
        ])->save();
        // After enabling a node access module, the access table has to be rebuild.
        node_access_rebuild();
        // Create a normal authenticated user.
        $this->webUser = $this->drupalCreateUser([
            'access content',
        ]);
        // Load the user 1 user for later use as an admin user with permission to
        // see everything.
        $this->adminUser = User::load(1);
        // Add Hungarian and Catalan.
        ConfigurableLanguage::createFromLangcode('hu')->save();
        ConfigurableLanguage::createFromLangcode('ca')->save();
        // The node_access_test_language module allows individual translations of a
        // node to be marked private (not viewable by normal users).
        // Create six nodes:
        // 1. Four Hungarian nodes with Catalan translations
        //   - One with neither language marked as private.
        //   - One with only the Hungarian translation private.
        //   - One with only the Catalan translation private.
        //   - One with both the Hungarian and Catalan translations private.
        // 2. Two nodes with no language specified.
        //   - One public.
        //   - One private.
        $this->nodes['both_public'] = $node = $this->drupalCreateNode([
            'body' => [
                [],
            ],
            'langcode' => 'hu',
            'field_private' => [
                [
                    'value' => 0,
                ],
            ],
        ]);
        $translation = $node->addTranslation('ca');
        $translation->title->value = $this->randomString();
        $translation->field_private->value = 0;
        $node->save();
        $this->nodes['ca_private'] = $node = $this->drupalCreateNode([
            'body' => [
                [],
            ],
            'langcode' => 'hu',
            'field_private' => [
                [
                    'value' => 0,
                ],
            ],
        ]);
        $translation = $node->addTranslation('ca');
        $translation->title->value = $this->randomString();
        $translation->field_private->value = 1;
        $node->save();
        $this->nodes['hu_private'] = $node = $this->drupalCreateNode([
            'body' => [
                [],
            ],
            'langcode' => 'hu',
            'field_private' => [
                [
                    'value' => 1,
                ],
            ],
        ]);
        $translation = $node->addTranslation('ca');
        $translation->title->value = $this->randomString();
        $translation->field_private->value = 0;
        $node->save();
        $this->nodes['both_private'] = $node = $this->drupalCreateNode([
            'body' => [
                [],
            ],
            'langcode' => 'hu',
            'field_private' => [
                [
                    'value' => 1,
                ],
            ],
        ]);
        $translation = $node->addTranslation('ca');
        $translation->title->value = $this->randomString();
        $translation->field_private->value = 1;
        $node->save();
        $this->nodes['no_language_public'] = $this->drupalCreateNode([
            'field_private' => [
                [
                    'value' => 0,
                ],
            ],
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
        ]);
        $this->nodes['no_language_private'] = $this->drupalCreateNode([
            'field_private' => [
                [
                    'value' => 1,
                ],
            ],
            'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
        ]);
    }
    
    /**
     * Tests node access and node access queries with multiple node languages.
     */
    public function testNodeAccessLanguageAware() {
        // The node_access_test_language module only grants view access.
        $expected_node_access = [
            'view' => TRUE,
            'update' => FALSE,
            'delete' => FALSE,
        ];
        $expected_node_access_no_access = [
            'view' => FALSE,
            'update' => FALSE,
            'delete' => FALSE,
        ];
        // When both Hungarian and Catalan are marked as public, access to the
        // Hungarian translation should be granted with the default entity object or
        // when the Hungarian translation is specified explicitly.
        $this->assertNodeAccess($expected_node_access, $this->nodes['both_public'], $this->webUser);
        $this->assertNodeAccess($expected_node_access, $this->nodes['both_public']
            ->getTranslation('hu'), $this->webUser);
        // Access to the Catalan translation should also be granted.
        $this->assertNodeAccess($expected_node_access, $this->nodes['both_public']
            ->getTranslation('ca'), $this->webUser);
        // When Hungarian is marked as private, access to the Hungarian translation
        // should be denied with the default entity object or when the Hungarian
        // translation is specified explicitly.
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['hu_private'], $this->webUser);
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['hu_private']
            ->getTranslation('hu'), $this->webUser);
        // Access to the Catalan translation should be granted.
        $this->assertNodeAccess($expected_node_access, $this->nodes['hu_private']
            ->getTranslation('ca'), $this->webUser);
        // When Catalan is marked as private, access to the Hungarian translation
        // should be granted with the default entity object or when the Hungarian
        // translation is specified explicitly.
        $this->assertNodeAccess($expected_node_access, $this->nodes['ca_private'], $this->webUser);
        $this->assertNodeAccess($expected_node_access, $this->nodes['ca_private']
            ->getTranslation('hu'), $this->webUser);
        // Access to the Catalan translation should be granted.
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['ca_private']
            ->getTranslation('ca'), $this->webUser);
        // When both translations are marked as private, access should be denied
        // regardless of the entity object specified.
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['both_private'], $this->webUser);
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['both_private']
            ->getTranslation('hu'), $this->webUser);
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['both_private']
            ->getTranslation('ca'), $this->webUser);
        // When no language is specified for a private node, access to every node
        // translation is denied.
        $this->assertNodeAccess($expected_node_access_no_access, $this->nodes['no_language_private'], $this->webUser);
        // When no language is specified for a public node, access should be
        // granted.
        $this->assertNodeAccess($expected_node_access, $this->nodes['no_language_public'], $this->webUser);
        // Query the node table with the node access tag in several languages.
        $connection = Database::getConnection();
        // Query with no language specified. The fallback (hu) will be used.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->webUser)
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // Three nodes should be returned:
        // - Node with both translations public.
        // - Node with only the Catalan translation marked as private.
        // - No language node marked as public.
        $this->assertCount(3, $nids, 'db_select() returns 3 nodes when no langcode is specified.');
        $this->assertArrayHasKey($this->nodes['both_public']
            ->id(), $nids);
        $this->assertArrayHasKey($this->nodes['ca_private']
            ->id(), $nids);
        $this->assertArrayHasKey($this->nodes['no_language_public']
            ->id(), $nids);
        // Query with Hungarian (hu) specified.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->webUser)
            ->addMetaData('langcode', 'hu')
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // Two nodes should be returned: the node with both translations public, and
        // the node with only the Catalan translation marked as private.
        $this->assertCount(2, $nids, 'Query returns 2 nodes when the hu langcode is specified.');
        $this->assertArrayHasKey($this->nodes['both_public']
            ->id(), $nids);
        $this->assertArrayHasKey($this->nodes['ca_private']
            ->id(), $nids);
        // Query with Catalan (ca) specified.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->webUser)
            ->addMetaData('langcode', 'ca')
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // Two nodes should be returned: the node with both translations public, and
        // the node with only the Hungarian translation marked as private.
        $this->assertCount(2, $nids, 'Query returns 2 nodes when the hu langcode is specified.');
        $this->assertArrayHasKey($this->nodes['both_public']
            ->id(), $nids);
        $this->assertArrayHasKey($this->nodes['hu_private']
            ->id(), $nids);
        // Query with German (de) specified.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->webUser)
            ->addMetaData('langcode', 'de')
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // There are no nodes with German translations, so no results are returned.
        $this->assertTrue(empty($nids), 'Query returns an empty result when the de langcode is specified.');
        // Query the nodes table as admin user (full access) with the node access
        // tag and no specific langcode.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->adminUser)
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // All nodes are returned.
        $this->assertCount(6, $nids, 'Query returns all nodes.');
        // Query the nodes table as admin user (full access) with the node access
        // tag and langcode de.
        $select = $connection->select('node', 'n')
            ->fields('n', [
            'nid',
        ])
            ->addMetaData('account', $this->adminUser)
            ->addMetaData('langcode', 'de')
            ->addTag('node_access');
        $nids = $select->execute()
            ->fetchAllAssoc('nid');
        // Even though there is no German translation, all nodes are returned
        // because node access filtering does not occur when the user is user 1.
        $this->assertCount(6, $nids, 'Query returns all nodes.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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
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
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.
NodeAccessLanguageAwareTest::$adminUser protected property A user with permission to bypass access content.
NodeAccessLanguageAwareTest::$modules public static property Enable language and a language-aware node access module. Overrides NodeAccessTestBase::$modules
NodeAccessLanguageAwareTest::$nodes protected property A set of nodes to use in testing.
NodeAccessLanguageAwareTest::$webUser protected property A normal authenticated user.
NodeAccessLanguageAwareTest::setUp protected function Overrides NodeAccessTestBase::setUp
NodeAccessLanguageAwareTest::testNodeAccessLanguageAware public function Tests node access and node access queries with multiple node languages.
NodeAccessTestBase::$accessHandler protected property Access handler.
NodeAccessTestBase::assertNodeAccess public function Asserts that node access correctly grants or denies access.
NodeAccessTestBase::assertNodeCreateAccess public function Asserts that node create access correctly grants or denies access.
NodeAccessTestBase::nodeAccessAssertMessage public function Constructs an assert message to display which node access was tested.
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
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.

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