PageTest.php

<?php

namespace Drupal\Tests\system\Functional\Batch;

use Drupal\Tests\BrowserTestBase;

/**
 * Tests the content of the progress page.
 *
 * @group Batch
 */
class PageTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'batch_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests that the batch API progress page uses the correct theme.
     */
    public function testBatchProgressPageTheme() {
        // Make sure that the page which starts the batch (an administrative page)
        // is using a different theme than would normally be used by the batch API.
        $this->container
            ->get('theme_installer')
            ->install([
            'seven',
            'bartik',
        ]);
        $this->config('system.theme')
            ->set('default', 'bartik')
            ->set('admin', 'seven')
            ->save();
        // Log in as an administrator who can see the administrative theme.
        $admin_user = $this->drupalCreateUser([
            'view the administration theme',
        ]);
        $this->drupalLogin($admin_user);
        // Visit an administrative page that runs a test batch, and check that the
        // theme that was used during batch execution (which the batch callback
        // function saved as a variable) matches the theme used on the
        // administrative page.
        $this->drupalGet('admin/batch-test/test-theme');
        // The stack should contain the name of the theme used on the progress
        // page.
        $this->assertEqual(batch_test_stack(), [
            'seven',
        ], 'A progressive batch correctly uses the theme of the page that started the batch.');
    }
    
    /**
     * Tests that the batch API progress page shows the title correctly.
     */
    public function testBatchProgressPageTitle() {
        // Visit an administrative page that runs a test batch, and check that the
        // title shown during batch execution (which the batch callback function
        // saved as a variable) matches the theme used on the administrative page.
        // Run initial step only first.
        $this->maximumMetaRefreshCount = 0;
        $this->drupalGet('batch-test/test-title');
        $this->assertText('Batch Test', 'The test is in the html output.');
        // Leave the batch process running.
        $this->maximumMetaRefreshCount = NULL;
        $this->drupalGet('batch-test/test-title');
        // The stack should contain the title shown on the progress page.
        $this->assertEqual(batch_test_stack(), [
            'Batch Test',
        ], 'The batch title is shown on the batch page.');
        $this->assertText('Redirection successful.', 'Redirection after batch execution is correct.');
    }
    
    /**
     * Tests that the progress messages are correct.
     */
    public function testBatchProgressMessages() {
        // Go to the initial step only.
        $this->maximumMetaRefreshCount = 0;
        $this->drupalGet('batch-test/test-title');
        $this->assertRaw('<div class="progress__description">Initializing.<br />&nbsp;</div>', 'Initial progress message appears correctly.');
        $this->assertNoRaw('&amp;nbsp;', 'Initial progress message is not double escaped.');
        // Now also go to the next step.
        $this->maximumMetaRefreshCount = 1;
        $this->drupalGet('batch-test/test-title');
        $this->assertRaw('<div class="progress__description">Completed 1 of 1.</div>', 'Progress message for second step appears correctly.');
    }

}