BlockContentCreationTest.php

<?php

namespace Drupal\Tests\block_content\Functional;

use Drupal\Component\Render\FormattableMarkup;
use Drupal\block_content\Entity\BlockContent;
use Drupal\Core\Database\Database;

/**
 * Create a block and test saving it.
 *
 * @group block_content
 */
class BlockContentCreationTest extends BlockContentTestBase {
    
    /**
     * Modules to enable.
     *
     * Enable dummy module that implements hook_block_insert() for exceptions and
     * field_ui to edit display settings.
     *
     * @var array
     */
    public static $modules = [
        'block_content_test',
        'dblog',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'classy';
    
    /**
     * Permissions to grant admin user.
     *
     * @var array
     */
    protected $permissions = [
        'administer blocks',
        'administer block_content display',
    ];
    
    /**
     * Sets the test up.
     */
    protected function setUp() {
        parent::setUp();
        $this->drupalLogin($this->adminUser);
    }
    
    /**
     * Creates a "Basic page" block and verifies its consistency in the database.
     */
    public function testBlockContentCreation() {
        $this->drupalLogin($this->adminUser);
        // Create a block.
        $edit = [];
        $edit['info[0][value]'] = 'Test Block';
        $edit['body[0][value]'] = $this->randomMachineName(16);
        $this->drupalPostForm('block/add/basic', $edit, t('Save'));
        // Check that the Basic block has been created.
        $this->assertRaw(new FormattableMarkup('@block %name has been created.', [
            '@block' => 'basic',
            '%name' => $edit['info[0][value]'],
        ]), 'Basic block created.');
        // Check that the view mode setting is hidden because only one exists.
        $this->assertNoFieldByXPath('//select[@name="settings[view_mode]"]', NULL, 'View mode setting hidden because only one exists');
        // Check that the block exists in the database.
        $blocks = \Drupal::entityTypeManager()->getStorage('block_content')
            ->loadByProperties([
            'info' => $edit['info[0][value]'],
        ]);
        $block = reset($blocks);
        $this->assertNotEmpty($block, 'Custom Block found in database.');
        // Check that attempting to create another block with the same value for
        // 'info' returns an error.
        $this->drupalPostForm('block/add/basic', $edit, t('Save'));
        // Check that the Basic block has been created.
        $this->assertRaw(new FormattableMarkup('A custom block with block description %value already exists.', [
            '%value' => $edit['info[0][value]'],
        ]));
        $this->assertSession()
            ->statusCodeEquals(200);
    }
    
    /**
     * Creates a "Basic page" block with multiple view modes.
     */
    public function testBlockContentCreationMultipleViewModes() {
        // Add a new view mode and verify if it is selected as expected.
        $this->drupalLogin($this->drupalCreateUser([
            'administer display modes',
        ]));
        $this->drupalGet('admin/structure/display-modes/view/add/block_content');
        $edit = [
            'id' => 'test_view_mode',
            'label' => 'Test View Mode',
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertRaw(t('Saved the %label view mode.', [
            '%label' => $edit['label'],
        ]));
        $this->drupalLogin($this->adminUser);
        // Create a block.
        $edit = [];
        $edit['info[0][value]'] = 'Test Block';
        $edit['body[0][value]'] = $this->randomMachineName(16);
        $this->drupalPostForm('block/add/basic', $edit, t('Save'));
        // Check that the Basic block has been created.
        $this->assertRaw(new FormattableMarkup('@block %name has been created.', [
            '@block' => 'basic',
            '%name' => $edit['info[0][value]'],
        ]), 'Basic block created.');
        // Save our block permanently
        $this->drupalPostForm(NULL, [
            'region' => 'content',
        ], t('Save block'));
        // Set test_view_mode as a custom display to be available on the list.
        $this->drupalGet('admin/structure/block/block-content');
        $this->drupalGet('admin/structure/block/block-content/types');
        $this->clickLink(t('Manage display'));
        $this->drupalGet('admin/structure/block/block-content/manage/basic/display');
        $custom_view_mode = [
            'display_modes_custom[test_view_mode]' => 1,
        ];
        $this->drupalPostForm(NULL, $custom_view_mode, t('Save'));
        // Go to the configure page and change the view mode.
        $this->drupalGet('admin/structure/block/manage/testblock');
        // Test the available view mode options.
        $this->assertOption('edit-settings-view-mode', 'default', 'The default view mode is available.');
        $this->assertOption('edit-settings-view-mode', 'test_view_mode', 'The test view mode is available.');
        $view_mode['settings[view_mode]'] = 'test_view_mode';
        $this->drupalPostForm(NULL, $view_mode, t('Save block'));
        // Check that the view mode setting is shown because more than one exists.
        $this->drupalGet('admin/structure/block/manage/testblock');
        $this->assertFieldByXPath('//select[@name="settings[view_mode]"]', NULL, 'View mode setting shown because multiple exist');
        // Change the view mode.
        $view_mode['region'] = 'content';
        $view_mode['settings[view_mode]'] = 'test_view_mode';
        $this->drupalPostForm(NULL, $view_mode, t('Save block'));
        // Go to the configure page and verify the view mode has changed.
        $this->drupalGet('admin/structure/block/manage/testblock');
        $this->assertFieldByXPath('//select[@name="settings[view_mode]"]/option[@selected="selected"]', 'test_view_mode', 'View mode changed to Test View Mode');
        // Check that the block exists in the database.
        $blocks = \Drupal::entityTypeManager()->getStorage('block_content')
            ->loadByProperties([
            'info' => $edit['info[0][value]'],
        ]);
        $block = reset($blocks);
        $this->assertNotEmpty($block, 'Custom Block found in database.');
        // Check that attempting to create another block with the same value for
        // 'info' returns an error.
        $this->drupalPostForm('block/add/basic', $edit, t('Save'));
        // Check that the Basic block has been created.
        $this->assertRaw(new FormattableMarkup('A custom block with block description %value already exists.', [
            '%value' => $edit['info[0][value]'],
        ]));
        $this->assertSession()
            ->statusCodeEquals(200);
    }
    
    /**
     * Create a default custom block.
     *
     * Creates a custom block from defaults and ensures that the 'basic block'
     * type is being used.
     */
    public function testDefaultBlockContentCreation() {
        $edit = [];
        $edit['info[0][value]'] = $this->randomMachineName(8);
        $edit['body[0][value]'] = $this->randomMachineName(16);
        // Don't pass the custom block type in the url so the default is forced.
        $this->drupalPostForm('block/add', $edit, t('Save'));
        // Check that the block has been created and that it is a basic block.
        $this->assertRaw(new FormattableMarkup('@block %name has been created.', [
            '@block' => 'basic',
            '%name' => $edit['info[0][value]'],
        ]), 'Basic block created.');
        // Check that the block exists in the database.
        $blocks = \Drupal::entityTypeManager()->getStorage('block_content')
            ->loadByProperties([
            'info' => $edit['info[0][value]'],
        ]);
        $block = reset($blocks);
        $this->assertNotEmpty($block, 'Default Custom Block found in database.');
    }
    
    /**
     * Verifies that a transaction rolls back the failed creation.
     */
    public function testFailedBlockCreation() {
        // Create a block.
        try {
            $this->createBlockContent('fail_creation');
            $this->fail('Expected exception has not been thrown.');
        } catch (\Exception $e) {
            // Expected exception; just continue testing.
        }
        $connection = Database::getConnection();
        if ($connection->supportsTransactions()) {
            // Check that the block does not exist in the database.
            $id = $connection->select('block_content_field_data', 'b')
                ->fields('b', [
                'id',
            ])
                ->condition('info', 'fail_creation')
                ->execute()
                ->fetchField();
            $this->assertFalse($id, 'Transactions supported, and block not found in database.');
        }
        else {
            // Check that the block exists in the database.
            $id = $connection->select('block_content_field_data', 'b')
                ->fields('b', [
                'id',
            ])
                ->condition('info', 'fail_creation')
                ->execute()
                ->fetchField();
            $this->assertTrue($id, 'Transactions not supported, and block found in database.');
            // Check that the failed rollback was logged.
            $records = $connection->query("SELECT wid FROM {watchdog} WHERE message LIKE 'Explicit rollback failed%'")
                ->fetchAll();
            $this->assertTrue(count($records) > 0, 'Transactions not supported, and rollback error logged to watchdog.');
        }
    }
    
    /**
     * Test deleting a block.
     */
    public function testBlockDelete() {
        // Create a block.
        $edit = [];
        $edit['info[0][value]'] = $this->randomMachineName(8);
        $body = $this->randomMachineName(16);
        $edit['body[0][value]'] = $body;
        $this->drupalPostForm('block/add/basic', $edit, t('Save'));
        // Place the block.
        $instance = [
            'id' => mb_strtolower($edit['info[0][value]']),
            'settings[label]' => $edit['info[0][value]'],
            'region' => 'sidebar_first',
        ];
        $block = BlockContent::load(1);
        $url = 'admin/structure/block/add/block_content:' . $block->uuid() . '/' . $this->config('system.theme')
            ->get('default');
        $this->drupalPostForm($url, $instance, t('Save block'));
        $block = BlockContent::load(1);
        // Test getInstances method.
        $this->assertCount(1, $block->getInstances());
        // Navigate to home page.
        $this->drupalGet('');
        $this->assertText($body);
        // Delete the block.
        $this->drupalGet('block/1/delete');
        $this->assertText(\Drupal::translation()->formatPlural(1, 'This will also remove 1 placed block instance.', 'This will also remove @count placed block instance.'));
        $this->drupalPostForm(NULL, [], 'Delete');
        $this->assertRaw(t('The custom block %name has been deleted.', [
            '%name' => $edit['info[0][value]'],
        ]));
        // Create another block and force the plugin cache to flush.
        $edit2 = [];
        $edit2['info[0][value]'] = $this->randomMachineName(8);
        $body2 = $this->randomMachineName(16);
        $edit2['body[0][value]'] = $body2;
        $this->drupalPostForm('block/add/basic', $edit2, t('Save'));
        $this->assertNoRaw('Error message');
        // Create another block with no instances, and test we don't get a
        // confirmation message about deleting instances.
        $edit3 = [];
        $edit3['info[0][value]'] = $this->randomMachineName(8);
        $body = $this->randomMachineName(16);
        $edit3['body[0][value]'] = $body;
        $this->drupalPostForm('block/add/basic', $edit3, t('Save'));
        // Show the delete confirm form.
        $this->drupalGet('block/3/delete');
        $this->assertNoText('This will also remove');
    }
    
    /**
     * Test that placed content blocks create a dependency in the block placement.
     */
    public function testConfigDependencies() {
        $block = $this->createBlockContent();
        // Place the block.
        $block_placement_id = mb_strtolower($block->label());
        $instance = [
            'id' => $block_placement_id,
            'settings[label]' => $block->label(),
            'region' => 'sidebar_first',
        ];
        $block = BlockContent::load(1);
        $url = 'admin/structure/block/add/block_content:' . $block->uuid() . '/' . $this->config('system.theme')
            ->get('default');
        $this->drupalPostForm($url, $instance, t('Save block'));
        $dependencies = \Drupal::service('config.manager')->findConfigEntityDependentsAsEntities('content', [
            $block->getConfigDependencyName(),
        ]);
        $block_placement = reset($dependencies);
        $this->assertEqual($block_placement_id, $block_placement->id(), "The block placement config entity has a dependency on the block content entity.");
    }

}