class BlockContentListViewsTest

Same name and namespace in other branches
  1. 9 core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php \Drupal\Tests\block_content\Functional\BlockContentListViewsTest
  2. 8.9.x core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php \Drupal\Tests\block_content\Functional\BlockContentListViewsTest
  3. 10 core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php \Drupal\Tests\block_content\Functional\BlockContentListViewsTest

Tests the Views-powered listing of content blocks.

@group block_content

Hierarchy

Expanded class hierarchy of BlockContentListViewsTest

See also

\Drupal\block\BlockContentListBuilder

\Drupal\block_content\Tests\BlockContentListTest

File

core/modules/block_content/tests/src/Functional/BlockContentListViewsTest.php, line 16

Namespace

Drupal\Tests\block_content\Functional
View source
class BlockContentListViewsTest extends BlockContentTestBase {
    
    /**
     * A user with 'access block library' permission.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $baseUser1;
    
    /**
     * A user with access to create and edit custom basic blocks.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $baseUser2;
    
    /**
     * Permissions to grant admin user.
     *
     * @var array
     */
    protected $permissions = [
        'administer blocks',
        'access block library',
        'create basic block content',
        'edit any basic block content',
        'delete any basic block content',
        'translate configuration',
    ];
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'block',
        'block_content',
        'config_translation',
        'views',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->baseUser1 = $this->drupalCreateUser([
            'access block library',
        ]);
        $this->baseUser2 = $this->drupalCreateUser([
            'access block library',
            'create basic block content',
            'edit any basic block content',
            'delete any basic block content',
        ]);
    }
    
    /**
     * Tests the content block listing page.
     */
    public function testListing() : void {
        // Test with an admin user.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('admin/content/block');
        // Test for the page title.
        $this->assertSession()
            ->titleEquals('Content blocks | Drupal');
        // Test for the exposed filters.
        $this->assertSession()
            ->fieldExists('info');
        $this->assertSession()
            ->fieldExists('type');
        // Test for the table.
        $this->assertSession()
            ->elementExists('xpath', '//div[@class="layout-content"]//table');
        // Test the table header, four cells should be present.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@class="layout-content"]//table/thead/tr/th', 4);
        // Test the contents of each th cell.
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[1]', 'Block description');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[2]', 'Block type');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[3]', 'Updated Sort ascending');
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/thead/tr/th[4]', 'Operations');
        $label = 'Antelope';
        $new_label = 'Albatross';
        // Add a new entity using the operations link.
        $this->clickLink('Add content block');
        $this->assertSession()
            ->statusCodeEquals(200);
        $edit = [];
        $edit['info[0][value]'] = $label;
        $edit['body[0][value]'] = $this->randomMachineName(16);
        $this->submitForm($edit, 'Save');
        // Confirm that once the user returns to the listing, the text of the label
        // (versus elsewhere on the page).
        $this->assertSession()
            ->elementTextContains('xpath', '//td/a', $label);
        // Check the number of table row cells.
        $this->assertSession()
            ->elementsCount('xpath', '//div[@class="layout-content"]//table/tbody/tr/td', 4);
        // Check the contents of each row cell. The first cell contains the label,
        // the second contains the machine name, and the third contains the
        // operations list.
        $this->assertSession()
            ->elementTextEquals('xpath', '//div[@class="layout-content"]//table/tbody/tr/td/a', $label);
        // Edit the entity using the operations link.
        $blocks = $this->container
            ->get('entity_type.manager')
            ->getStorage('block_content')
            ->loadByProperties([
            'info' => $label,
        ]);
        $block = reset($blocks);
        if (!empty($block)) {
            $this->assertSession()
                ->linkByHrefExists('admin/content/block/' . $block->id());
            $this->clickLink('Edit');
            $this->assertSession()
                ->statusCodeEquals(200);
            $this->assertSession()
                ->titleEquals("Edit content block {$label} | Drupal");
            $edit = [
                'info[0][value]' => $new_label,
            ];
            $this->submitForm($edit, 'Save');
        }
        else {
            $this->fail('Did not find Albatross block in the database.');
        }
        // Confirm that once the user returns to the listing, the text of the label
        // (versus elsewhere on the page).
        $this->assertSession()
            ->elementTextContains('xpath', '//td/a', $new_label);
        // Delete the added entity using the operations link.
        $this->assertSession()
            ->linkByHrefExists('admin/content/block/' . $block->id() . '/delete');
        $this->clickLink('Delete');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->titleEquals("Are you sure you want to delete the content block {$new_label}? | Drupal");
        $this->submitForm([], 'Delete');
        // Verify that the text of the label and machine name does not appear in
        // the list (though it may appear elsewhere on the page).
        $this->assertSession()
            ->elementTextNotContains('xpath', '//td', $new_label);
        // Confirm that the empty text is displayed.
        $this->assertSession()
            ->pageTextContains('There are no content blocks available.');
        $this->assertSession()
            ->linkExists('content block');
        $block_content = BlockContent::create([
            'info' => 'Non-reusable block',
            'type' => 'basic',
            'reusable' => FALSE,
        ]);
        $block_content->save();
        $this->drupalGet('admin/content/block');
        // Confirm that the empty text is displayed.
        $this->assertSession()
            ->pageTextContains('There are no content blocks available.');
        // Confirm the non-reusable block is not on the page.
        $this->assertSession()
            ->pageTextNotContains('Non-reusable block');
        $this->drupalLogout();
        // Create test block for other user tests.
        $test_block = $this->createBlockContent($label);
        $link_text = t('Add content block');
        // Test as a user with view only permissions.
        $this->drupalLogin($this->baseUser1);
        $this->drupalGet('admin/content/block');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->linkNotExists($link_text);
        $matches = $this->xpath('//td/a');
        $actual = $matches[0]->getText();
        $this->assertEquals($label, $actual, 'Label found for test block.');
        $this->assertSession()
            ->linkNotExists('Edit');
        $this->assertSession()
            ->linkNotExists('Delete');
        $this->assertSession()
            ->linkByHrefNotExists('admin/content/block/' . $test_block->id() . '/delete');
        $this->drupalLogout();
        // Test as a user with permission to create/edit/delete basic blocks.
        $this->drupalLogin($this->baseUser2);
        $this->drupalGet('admin/content/block');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->linkExists($link_text);
        $matches = $this->xpath('//td/a');
        $actual = $matches[0]->getText();
        $this->assertEquals($label, $actual, 'Label found for test block.');
        $this->assertSession()
            ->linkByHrefExists('admin/content/block/' . $test_block->id());
        $this->assertSession()
            ->linkByHrefExists('admin/content/block/' . $test_block->id() . '/delete');
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockContentListViewsTest::$baseUser1 protected property A user with 'access block library' permission.
BlockContentListViewsTest::$baseUser2 protected property A user with access to create and edit custom basic blocks.
BlockContentListViewsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
BlockContentListViewsTest::$modules protected static property Modules to enable. Overrides BlockContentTestBase::$modules
BlockContentListViewsTest::$permissions protected property Permissions to grant admin user. Overrides BlockContentTestBase::$permissions
BlockContentListViewsTest::setUp protected function Sets the test up. Overrides BlockContentTestBase::setUp
BlockContentListViewsTest::testListing public function Tests the content block listing page.
BlockContentTestBase::$adminUser protected property Admin user.
BlockContentTestBase::$autoCreateBasicBlockType protected property Whether or not to auto-create the basic block type during setup. 1
BlockContentTestBase::$profile protected property Profile to use. Overrides BrowserTestBase::$profile
BlockContentTestBase::createBlockContent protected function Creates a content block.
BlockContentTestBase::createBlockContentType protected function Creates a block type (bundle).
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::$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::$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::__construct 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
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
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.
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. 19
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
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
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.
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::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::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::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.