class NodeRequirementsStatusFilterWarningTest

Tests redundant status filter warnings raised by node_requirements().

@group node

Hierarchy

Expanded class hierarchy of NodeRequirementsStatusFilterWarningTest

File

core/modules/node/tests/src/Kernel/NodeRequirementsStatusFilterWarningTest.php, line 16

Namespace

Drupal\Tests\node\Kernel
View source
class NodeRequirementsStatusFilterWarningTest extends KernelTestBase {
    use UserCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'user',
        'node',
        'text',
        'field',
        'views',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        $this->installEntitySchema('view');
        $this->installConfig([
            'field',
            'node',
            'views',
        ]);
        $this->installSchema('node', [
            'node_access',
        ]);
        // Remove default views to avoid interference.
        View::load('content')->delete();
        View::load('content_recent')->delete();
    }
    
    /**
     * Tests node_requirements() with no node grants implementations.
     */
    public function testNoNodeGrantsImplementations() : void {
        $requirements = $this->getRequirements();
        $this->assertArrayNotHasKey('node_status_filter', $requirements);
    }
    
    /**
     * Tests node_requirements() with node grants but no problematic views.
     */
    public function testNodeGrantsNoProblematicViews() : void {
        $this->enableNodeAccessTestModule();
        $requirements = $this->getRequirements();
        $this->assertArrayNotHasKey('node_status_filter', $requirements);
    }
    
    /**
     * Tests node_requirements() with node grants and one problematic view.
     */
    public function testNodeGrantsWithProblematicView() : void {
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view', 'Test View', TRUE, [
            $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        $this->assertArrayHasKey('node_status_filter', $requirements);
        $this->assertEquals(REQUIREMENT_WARNING, $requirements['node_status_filter']['severity']);
    }
    
    /**
     * Tests node_requirements() with multiple problematic views.
     */
    public function testMultipleProblematicViews() : void {
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view_1', 'Test View 1', TRUE, [
            $this->getStatusFilterConfig(),
        ]);
        $this->createTestView('test_view_2', 'Test View 2', TRUE, [
            $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        $this->assertArrayHasKey('node_status_filter', $requirements);
        $this->assertEquals(REQUIREMENT_WARNING, $requirements['node_status_filter']['severity']);
    }
    
    /**
     * Tests node_requirements() ignores disabled views.
     */
    public function testDisabledViewsNotChecked() : void {
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_disabled_view', 'Disabled Test View', FALSE, [
            $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        $this->assertArrayNotHasKey('node_status_filter', $requirements);
    }
    
    /**
     * Tests description with one view and one access module.
     */
    public function testDescriptionWithSingleViewAndSingleModule() : void {
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view', 'Test View', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        $this->assertEquals('The <em class="placeholder">Test View (Default)</em> view uses the <em class="placeholder">Published status or admin user</em> filter but it has no effect because the following module(s) control access: <em class="placeholder">Node module access tests</em>. Review and consider removing the filter.', $this->renderStatusFilterDescription($requirements));
    }
    
    /**
     * Tests description with multiple views and one access module.
     */
    public function testDescriptionWithMultipleViewsAndSingleModule() : void {
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view_1', 'Test View 1', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $this->createTestView('test_view_2', 'Test View 2', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        self::assertEquals('The following views use the <em class="placeholder">Published status or admin user</em> filter but it has no effect because the following module(s) control access: <em class="placeholder">Node module access tests</em>. Review and consider removing the filter from these views: <ul><li>Test View 1 (Default)</li><li>Test View 2 (Default)</li></ul>', $this->renderStatusFilterDescription($requirements));
    }
    
    /**
     * Tests description formatting with Views UI disabled.
     */
    public function testDescriptionWithViewsUiDisabled() : void {
        self::assertFalse($this->container
            ->get('module_handler')
            ->moduleExists('views_ui'));
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view', 'Test View', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        $description = $this->renderStatusFilterDescription($requirements);
        $this->assertStringContainsString('Test View (Default)', $description);
        $this->assertStringNotContainsString('href=', $description);
    }
    
    /**
     * Tests description when Views UI is enabled but user cannot edit views.
     */
    public function testDescriptionWithViewsUiEnabledWithoutUserHavingEditViewDisplayAccess() : void {
        $this->enableModules([
            'views_ui',
        ]);
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view', 'Test View', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        self::assertEquals('The <em class="placeholder">Test View (Default)</em> view uses the <em class="placeholder">Published status or admin user</em> filter but it has no effect because the following module(s) control access: <em class="placeholder">Node module access tests</em>. Review and consider removing the filter.', $this->renderStatusFilterDescription($requirements));
    }
    
    /**
     * Tests description when Views UI is enabled but user can edit views.
     */
    public function testDescriptionWithViewsUiEnabledWithUserHavingEditViewDisplayAccess() : void {
        $this->enableModules([
            'views_ui',
        ]);
        $this->setCurrentUser($this->createUser([
            'administer views',
        ]));
        $this->enableNodeAccessTestModule();
        $this->createTestView('test_view', 'Test View', TRUE, [
            'status' => $this->getStatusFilterConfig(),
        ]);
        $requirements = $this->getRequirements();
        self::assertEquals('The <em class="placeholder"><a href="/admin/structure/views/view/test_view/edit/default">Test View (Default)</a></em> view uses the <em class="placeholder">Published status or admin user</em> filter but it has no effect because the following module(s) control access: <em class="placeholder">Node module access tests</em>. Review and consider removing the filter.', $this->renderStatusFilterDescription($requirements));
    }
    
    /**
     * Get requirements by the Node module.
     *
     * @return array
     *   The requirements raised by the Node module.
     */
    private function getRequirements() : array {
        return $this->container
            ->get('module_handler')
            ->invoke('node', 'runtime_requirements');
    }
    
    /**
     * Renders the description of the node_status_filter requirement.
     */
    private function renderStatusFilterDescription(array $requirements) : string {
        return (string) $requirements['node_status_filter']['description']->render();
    }
    
    /**
     * Helper method to create a test view.
     *
     * @param string $id
     *   The view ID.
     * @param string $label
     *   The view label.
     * @param bool $status
     *   Whether the view is enabled.
     * @param array $filters
     *   Filters to apply to the view.
     *
     * @return \Drupal\views\Entity\View
     *   The created view entity.
     */
    private function createTestView(string $id, string $label, bool $status, array $filters) : View {
        $view = View::create([
            'id' => $id,
            'label' => $label,
            'status' => $status,
            'base_table' => 'node_field_data',
            'display' => [
                'default' => [
                    'display_title' => 'Default',
                    'display_plugin' => 'default',
                    'id' => 'default',
                    'display_options' => [
                        'filters' => $filters,
                    ],
                ],
            ],
        ]);
        $view->save();
        return $view;
    }
    
    /**
     * Helper to get status filter configuration.
     */
    private function getStatusFilterConfig() : array {
        return [
            'id' => 'status',
            'table' => 'node_field_data',
            'field' => 'status',
            'plugin_id' => 'node_status',
        ];
    }
    
    /**
     * Enables Node Access Test module.
     */
    private function enableNodeAccessTestModule() : void {
        $this->enableModules([
            'node_access_test',
        ]);
        self::assertTrue($this->container
            ->get('module_handler')
            ->hasImplementations('node_grants'));
    }

}

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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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::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.
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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 10
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 2
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 protected function Bootstraps a kernel for a test. 1
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. 2
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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 33
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
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::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 10
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
NodeRequirementsStatusFilterWarningTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
NodeRequirementsStatusFilterWarningTest::createTestView private function Helper method to create a test view.
NodeRequirementsStatusFilterWarningTest::enableNodeAccessTestModule private function Enables Node Access Test module.
NodeRequirementsStatusFilterWarningTest::getRequirements private function Get requirements by the Node module.
NodeRequirementsStatusFilterWarningTest::getStatusFilterConfig private function Helper to get status filter configuration.
NodeRequirementsStatusFilterWarningTest::renderStatusFilterDescription private function Renders the description of the node_status_filter requirement.
NodeRequirementsStatusFilterWarningTest::setUp protected function Overrides KernelTestBase::setUp
NodeRequirementsStatusFilterWarningTest::testDescriptionWithMultipleViewsAndSingleModule public function Tests description with multiple views and one access module.
NodeRequirementsStatusFilterWarningTest::testDescriptionWithSingleViewAndSingleModule public function Tests description with one view and one access module.
NodeRequirementsStatusFilterWarningTest::testDescriptionWithViewsUiDisabled public function Tests description formatting with Views UI disabled.
NodeRequirementsStatusFilterWarningTest::testDescriptionWithViewsUiEnabledWithoutUserHavingEditViewDisplayAccess public function Tests description when Views UI is enabled but user cannot edit views.
NodeRequirementsStatusFilterWarningTest::testDescriptionWithViewsUiEnabledWithUserHavingEditViewDisplayAccess public function Tests description when Views UI is enabled but user can edit views.
NodeRequirementsStatusFilterWarningTest::testDisabledViewsNotChecked public function Tests node_requirements() ignores disabled views.
NodeRequirementsStatusFilterWarningTest::testMultipleProblematicViews public function Tests node_requirements() with multiple problematic views.
NodeRequirementsStatusFilterWarningTest::testNodeGrantsNoProblematicViews public function Tests node_requirements() with node grants but no problematic views.
NodeRequirementsStatusFilterWarningTest::testNodeGrantsWithProblematicView public function Tests node_requirements() with node grants and one problematic view.
NodeRequirementsStatusFilterWarningTest::testNoNodeGrantsImplementations public function Tests node_requirements() with no node grants implementations.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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. 1
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.