function CKEditorLoadingTest::testLoading

Tests loading of CKEditor CSS, JS and JS settings.

File

core/modules/ckeditor/tests/src/Functional/CKEditorLoadingTest.php, line 94

Class

CKEditorLoadingTest

Tests loading of CKEditor.

Namespace

Code

public function testLoading() {
    // The untrusted user:
    // - has access to 1 text format (plain_text);
    // - doesn't have access to the filtered_html text format, so: no text editor.
    $this->drupalLogin($this->untrustedUser);
    $this->drupalGet('node/add/article');
    [
        $settings,
        $editor_settings_present,
        $editor_js_present,
    ] = $this->getThingsToCheck();
    $this->assertFalse($editor_settings_present, 'No Text Editor module settings.');
    $this->assertFalse($editor_js_present, 'No Text Editor JavaScript.');
    $this->assertSession()
        ->fieldExists('edit-body-0-value');
    $this->assertSession()
        ->elementNotExists('css', 'select.js-filter-list');
    // Verify that a single text format hidden input does not exist on the page.
    $this->assertSession()
        ->elementNotExists('xpath', '//input[@type="hidden" and contains(@class, "editor")]');
    // Verify that CKEditor glue JS is absent.
    $this->assertSession()
        ->responseNotContains($this->getModulePath('ckeditor') . '/js/ckeditor.js');
    // On pages where there would never be a text editor, CKEditor JS is absent.
    $this->drupalGet('user');
    $this->assertSession()
        ->responseNotContains($this->getModulePath('ckeditor') . '/js/ckeditor.js');
    // The normal user:
    // - has access to 2 text formats;
    // - does have access to the filtered_html text format, so: CKEditor.
    $this->drupalLogin($this->normalUser);
    $this->drupalGet('node/add/article');
    [
        $settings,
        $editor_settings_present,
        $editor_js_present,
    ] = $this->getThingsToCheck();
    $ckeditor_plugin = $this->container
        ->get('plugin.manager.editor')
        ->createInstance('ckeditor');
    $editor = Editor::load('filtered_html');
    $expected = [
        'formats' => [
            'filtered_html' => [
                'format' => 'filtered_html',
                'editor' => 'ckeditor',
                'editorSettings' => $ckeditor_plugin->getJSSettings($editor),
                'editorSupportsContentFiltering' => TRUE,
                'isXssSafe' => FALSE,
            ],
        ],
    ];
    $this->assertTrue($editor_settings_present, "Text Editor module's JavaScript settings are on the page.");
    $this->assertEquals($expected, $settings['editor'], "Text Editor module's JavaScript settings on the page are correct.");
    $this->assertTrue($editor_js_present, 'Text Editor JavaScript is present.');
    $this->assertSession()
        ->fieldExists('edit-body-0-value');
    // Verify that a single text format selector exists on the page and has a
    // "data-editor-for" attribute with the correct value.
    $this->assertSession()
        ->elementsCount('css', 'select.js-filter-list', 1);
    $select = $this->assertSession()
        ->elementExists('css', 'select.js-filter-list');
    $this->assertSame('edit-body-0-value', $select->getAttribute('data-editor-for'));
    $this->assertContains('ckeditor/drupal.ckeditor', explode(',', $settings['ajaxPageState']['libraries']), 'CKEditor glue library is present.');
    // Enable the ckeditor_test module, customize configuration. In this case,
    // there is additional CSS and JS to be loaded.
    // NOTE: the tests in CKEditorTest already ensure that changing the
    // configuration also results in modified CKEditor configuration, so we
    // don't test that here.
    \Drupal::service('module_installer')->install([
        'ckeditor_test',
    ]);
    $this->container
        ->get('plugin.manager.ckeditor.plugin')
        ->clearCachedDefinitions();
    $editor_settings = $editor->getSettings();
    $editor_settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
    $editor->setSettings($editor_settings);
    $editor->save();
    $this->drupalGet('node/add/article');
    [
        $settings,
        $editor_settings_present,
        $editor_js_present,
    ] = $this->getThingsToCheck();
    $expected = [
        'formats' => [
            'filtered_html' => [
                'format' => 'filtered_html',
                'editor' => 'ckeditor',
                'editorSettings' => $ckeditor_plugin->getJSSettings($editor),
                'editorSupportsContentFiltering' => TRUE,
                'isXssSafe' => FALSE,
            ],
        ],
    ];
    $this->assertTrue($editor_settings_present, "Text Editor module's JavaScript settings are on the page.");
    $this->assertEquals($expected, $settings['editor'], "Text Editor module's JavaScript settings on the page are correct.");
    $this->assertTrue($editor_js_present, 'Text Editor JavaScript is present.');
    $this->assertContains('ckeditor/drupal.ckeditor', explode(',', $settings['ajaxPageState']['libraries']), 'CKEditor glue library is present.');
    // Assert that CKEditor uses Drupal's cache-busting query string by
    // comparing the setting sent with the page with the current query string.
    $settings = $this->getDrupalSettings();
    $expected = $settings['ckeditor']['timestamp'];
    $this->assertSame($expected, \Drupal::state()->get('system.css_js_query_string'), "CKEditor scripts cache-busting string is correct before flushing all caches.");
    // Flush all caches then make sure that $settings['ckeditor']['timestamp']
    // still matches.
    $this->resetAll();
    $this->assertSame($expected, \Drupal::state()->get('system.css_js_query_string'), "CKEditor scripts cache-busting string is correct after flushing all caches.");
}