class NodeQueryAlterTest

Same name in other branches
  1. 9 core/modules/node/tests/src/Functional/NodeQueryAlterTest.php \Drupal\Tests\node\Functional\NodeQueryAlterTest
  2. 8.9.x core/modules/node/tests/src/Functional/NodeQueryAlterTest.php \Drupal\Tests\node\Functional\NodeQueryAlterTest
  3. 11.x core/modules/node/tests/src/Functional/NodeQueryAlterTest.php \Drupal\Tests\node\Functional\NodeQueryAlterTest

Tests that node access queries are properly altered by the node module.

@group node @group #slow

Hierarchy

Expanded class hierarchy of NodeQueryAlterTest

File

core/modules/node/tests/src/Functional/NodeQueryAlterTest.php, line 16

Namespace

Drupal\Tests\node\Functional
View source
class NodeQueryAlterTest extends NodeTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node_access_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * User with permission to view content.
     */
    protected $accessUser;
    
    /**
     * User without permission to view content.
     */
    protected $noAccessUser;
    
    /**
     * User without permission to view content.
     *
     * @var \Drupal\user\Entity\User
     */
    protected User $noAccessUser2;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        node_access_rebuild();
        // Create some content.
        $this->drupalCreateNode();
        $this->drupalCreateNode();
        $this->drupalCreateNode();
        $this->drupalCreateNode();
        // Create user with simple node access permission. The 'node test view'
        // permission is implemented and granted by the node_access_test module.
        $this->accessUser = $this->drupalCreateUser([
            'access content overview',
            'access content',
            'node test view',
        ]);
        $this->noAccessUser = $this->drupalCreateUser([
            'access content overview',
            'access content',
        ]);
        $this->noAccessUser2 = $this->drupalCreateUser([
            'access content overview',
            'access content',
        ]);
    }
    
    /**
     * Tests 'node_access' query alter, for user with access.
     *
     * Verifies that a non-standard table alias can be used, and that a user with
     * node access can view the nodes.
     */
    public function testNodeQueryAlterLowLevelWithAccess() : void {
        // User with access should be able to view 4 nodes.
        try {
            $query = Database::getConnection()->select('node', 'n')
                ->fields('n');
            $query->addTag('node_access');
            $query->addMetaData('op', 'view');
            $query->addMetaData('account', $this->accessUser);
            $result = $query->execute()
                ->fetchAll();
            $this->assertCount(4, $result, 'User with access can see correct nodes');
        } catch (\Exception $e) {
            $this->fail('Altered query is malformed');
        }
    }
    
    /**
     * Tests 'node_access' query alter with revision-enabled nodes.
     */
    public function testNodeQueryAlterWithRevisions() : void {
        // Execute a query that only deals with the 'node_revision' table.
        try {
            $query = \Drupal::entityTypeManager()->getStorage('node')
                ->getQuery();
            $result = $query->accessCheck(TRUE)
                ->allRevisions()
                ->execute();
            $this->assertCount(4, $result, 'User with access can see correct nodes');
        } catch (\Exception $e) {
            $this->fail('Altered query is malformed');
        }
    }
    
    /**
     * Tests 'node_access' query alter, for user without access.
     *
     * Verifies that a non-standard table alias can be used, and that a user
     * without node access cannot view the nodes.
     */
    public function testNodeQueryAlterLowLevelNoAccess() : void {
        // User without access should be able to view 0 nodes.
        try {
            $query = Database::getConnection()->select('node', 'n')
                ->fields('n');
            $query->addTag('node_access');
            $query->addMetaData('op', 'view');
            $query->addMetaData('account', $this->noAccessUser);
            $result = $query->execute()
                ->fetchAll();
            $this->assertCount(0, $result, 'User with no access cannot see nodes');
        } catch (\Exception $e) {
            $this->fail('Altered query is malformed');
        }
    }
    
    /**
     * Tests 'node_access' query alter, for edit access.
     *
     * Verifies that a non-standard table alias can be used, and that a user with
     * view-only node access cannot edit the nodes.
     */
    public function testNodeQueryAlterLowLevelEditAccess() : void {
        // User with view-only access should not be able to edit nodes.
        try {
            $query = Database::getConnection()->select('node', 'n')
                ->fields('n');
            $query->addTag('node_access');
            $query->addMetaData('op', 'update');
            $query->addMetaData('account', $this->accessUser);
            $result = $query->execute()
                ->fetchAll();
            $this->assertCount(0, $result, 'User with view-only access cannot edit nodes');
        } catch (\Exception $e) {
            $this->fail($e->getMessage());
            $this->fail((string) $query);
            $this->fail('Altered query is malformed');
        }
    }
    
    /**
     * Tests 'node_access' query alter override.
     *
     * Verifies that node_access_view_all_nodes() is called from
     * node_query_node_access_alter(). We do this by checking that a user who
     * normally would not have view privileges is able to view the nodes when we
     * add a record to {node_access} paired with a corresponding privilege in
     * hook_node_grants().
     */
    public function testNodeQueryAlterOverride() : void {
        $record = [
            'nid' => 0,
            'gid' => 0,
            'realm' => 'node_access_all',
            'grant_view' => 1,
            'grant_update' => 0,
            'grant_delete' => 0,
        ];
        $connection = Database::getConnection();
        $connection->insert('node_access')
            ->fields($record)
            ->execute();
        // Test that the noAccessUser still doesn't have the 'view'
        // privilege after adding the node_access record.
        drupal_static_reset('node_access_view_all_nodes');
        try {
            $query = $connection->select('node', 'n')
                ->fields('n');
            $query->addTag('node_access');
            $query->addMetaData('op', 'view');
            $query->addMetaData('account', $this->noAccessUser);
            $result = $query->execute()
                ->fetchAll();
            $this->assertCount(0, $result, 'User view privileges are not overridden');
        } catch (\Exception $e) {
            $this->fail('Altered query is malformed');
        }
        // Have node_test_node_grants return a node_access_all privilege,
        // to grant the noAccessUser 'view' access.  To verify that
        // node_access_view_all_nodes is properly checking the specified
        // $account instead of the current user, we will log in as
        // noAccessUser2.
        $this->drupalLogin($this->noAccessUser2);
        \Drupal::state()->set('node_access_test.no_access_uid', $this->noAccessUser
            ->id());
        drupal_static_reset('node_access_view_all_nodes');
        try {
            $query = $connection->select('node', 'n')
                ->fields('n');
            $query->addTag('node_access');
            $query->addMetaData('op', 'view');
            $query->addMetaData('account', $this->noAccessUser);
            $result = $query->execute()
                ->fetchAll();
            $this->assertCount(4, $result, 'User view privileges are overridden');
        } catch (\Exception $e) {
            $this->fail('Altered query is malformed');
        }
        \Drupal::state()->delete('node_access_test.no_access_uid');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
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 SettingsEditor::rewrite().
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. 40
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 test site. 2
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::__get public function
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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
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
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
NodeQueryAlterTest::$accessUser protected property User with permission to view content.
NodeQueryAlterTest::$defaultTheme protected property Overrides BrowserTestBase::$defaultTheme
NodeQueryAlterTest::$modules protected static property Overrides NodeTestBase::$modules
NodeQueryAlterTest::$noAccessUser protected property User without permission to view content.
NodeQueryAlterTest::$noAccessUser2 protected property User without permission to view content.
NodeQueryAlterTest::setUp protected function Overrides NodeTestBase::setUp
NodeQueryAlterTest::testNodeQueryAlterLowLevelEditAccess public function Tests 'node_access' query alter, for edit access.
NodeQueryAlterTest::testNodeQueryAlterLowLevelNoAccess public function Tests 'node_access' query alter, for user without access.
NodeQueryAlterTest::testNodeQueryAlterLowLevelWithAccess public function Tests 'node_access' query alter, for user with access.
NodeQueryAlterTest::testNodeQueryAlterOverride public function Tests 'node_access' query alter override.
NodeQueryAlterTest::testNodeQueryAlterWithRevisions public function Tests 'node_access' query alter with revision-enabled nodes.
NodeTestBase::$accessHandler protected property The node access control handler.
NodeTestBase::assertNodeAccess public function Asserts that node access correctly grants or denies access.
NodeTestBase::assertNodeCreateAccess public function Asserts that node create access correctly grants or denies access.
NodeTestBase::nodeAccessAssertMessage public function Constructs an assert message to display which node access was tested.
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::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
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 Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated 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. 2
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. 4
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 Deprecated public static function Returns the database connection to the site under test.
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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. 3
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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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.