CKEditorIntegrationTest.php in Drupal 9

Namespace

Drupal\Tests\ckeditor\FunctionalJavascript

File

core/modules/ckeditor/tests/src/FunctionalJavascript/CKEditorIntegrationTest.php

<?php

namespace Drupal\Tests\ckeditor\FunctionalJavascript;

use Drupal\Core\Entity\Entity\EntityFormDisplay;
use Drupal\editor\Entity\Editor;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\filter\Entity\FilterFormat;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
use Drupal\node\Entity\NodeType;
use Drupal\Tests\ckeditor\Traits\CKEditorTestTrait;

/**
 * Tests the integration of CKEditor.
 *
 * @group ckeditor
 */
class CKEditorIntegrationTest extends WebDriverTestBase {
  use CKEditorTestTrait;

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * The account.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $account;

  /**
   * The FilterFormat config entity used for testing.
   *
   * @var \Drupal\filter\FilterFormatInterface
   */
  protected $filterFormat;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'ckeditor',
    'filter',
    'ckeditor_test',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Create a text format and associate CKEditor.
    $this->filterFormat = FilterFormat::create([
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
    ]);
    $this->filterFormat
      ->save();
    Editor::create([
      'format' => 'filtered_html',
      'editor' => 'ckeditor',
    ])
      ->save();

    // Create a node type for testing.
    NodeType::create([
      'type' => 'page',
      'name' => 'page',
    ])
      ->save();
    $field_storage = FieldStorageConfig::loadByName('node', 'body');

    // Create a body field instance for the 'page' node type.
    FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
      'label' => 'Body',
      'settings' => [
        'display_summary' => TRUE,
      ],
      'required' => TRUE,
    ])
      ->save();

    // Assign widget settings for the 'default' form mode.
    EntityFormDisplay::create([
      'targetEntityType' => 'node',
      'bundle' => 'page',
      'mode' => 'default',
      'status' => TRUE,
    ])
      ->setComponent('body', [
      'type' => 'text_textarea_with_summary',
    ])
      ->save();
    $this->account = $this
      ->drupalCreateUser([
      'administer nodes',
      'create page content',
      'use text format filtered_html',
    ]);
    $this
      ->drupalLogin($this->account);
  }

  /**
   * Tests if the fragment link to a textarea works with CKEditor enabled.
   */
  public function testFragmentLink() {
    $session = $this
      ->getSession();
    $web_assert = $this
      ->assertSession();
    $ckeditor_id = '#cke_edit-body-0-value';
    $this
      ->drupalGet('node/add/page');
    $session
      ->getPage();

    // Add a bottom margin to the title field to be sure the body field is not
    // visible.
    $session
      ->executeScript("document.getElementById('edit-title-0-value').style.marginBottom = window.innerHeight*2 +'px';");
    $this
      ->assertSession()
      ->waitForElementVisible('css', $ckeditor_id);

    // Check that the CKEditor-enabled body field is currently not visible in
    // the viewport.
    $web_assert
      ->assertNotVisibleInViewport('css', $ckeditor_id, 'topLeft', 'CKEditor-enabled body field is visible.');
    $before_url = $session
      ->getCurrentUrl();

    // Trigger a hash change with as target the hidden textarea.
    $session
      ->executeScript("location.hash = '#edit-body-0-value';");

    // Check that the CKEditor-enabled body field is visible in the viewport.
    $web_assert
      ->assertVisibleInViewport('css', $ckeditor_id, 'topLeft', 'CKEditor-enabled body field is not visible.');

    // Use JavaScript to go back in the history instead of
    // \Behat\Mink\Session::back() because that function doesn't work after a
    // hash change.
    $session
      ->executeScript("history.back();");
    $after_url = $session
      ->getCurrentUrl();

    // Check that going back in the history worked.
    self::assertEquals($before_url, $after_url, 'History back works.');
  }

  /**
   * Tests if the Image button appears and works as expected.
   */
  public function testDrupalImageDialog() {
    $session = $this
      ->getSession();
    $web_assert = $this
      ->assertSession();
    $this
      ->drupalGet('node/add/page');
    $session
      ->getPage();

    // Asserts the Image button is present in the toolbar.
    $web_assert
      ->elementExists('css', '#cke_edit-body-0-value .cke_button__drupalimage');

    // Asserts the image dialog opens when clicking the Image button.
    $this
      ->click('.cke_button__drupalimage');
    $this
      ->assertNotEmpty($web_assert
      ->waitForElement('css', '.ui-dialog'));
    $web_assert
      ->elementContains('css', '.ui-dialog .ui-dialog-titlebar', 'Insert Image');
  }

  /**
   * Tests if the Drupal Image Caption plugin appears and works as expected.
   */
  public function testDrupalImageCaptionDialog() {
    $web_assert = $this
      ->assertSession();

    // Disable the caption filter.
    $this->filterFormat
      ->setFilterConfig('filter_caption', [
      'status' => FALSE,
    ]);
    $this->filterFormat
      ->save();

    // If the caption filter is disabled, its checkbox should be absent.
    $this
      ->drupalGet('node/add/page');
    $this
      ->waitForEditor();
    $this
      ->pressEditorButton('drupalimage');
    $this
      ->assertNotEmpty($web_assert
      ->waitForElement('css', '.ui-dialog'));
    $web_assert
      ->elementNotExists('css', '.ui-dialog input[name="attributes[hasCaption]"]');

    // Enable the caption filter again.
    $this->filterFormat
      ->setFilterConfig('filter_caption', [
      'status' => TRUE,
    ]);
    $this->filterFormat
      ->save();

    // If the caption filter is enabled, its checkbox should be present.
    $this
      ->drupalGet('node/add/page');
    $this
      ->waitForEditor();
    $this
      ->pressEditorButton('drupalimage');
    $this
      ->assertNotEmpty($web_assert
      ->waitForElement('css', '.ui-dialog'));
    $web_assert
      ->elementExists('css', '.ui-dialog input[name="attributes[hasCaption]"]');
  }

  /**
   * Tests if CKEditor is properly styled inside an off-canvas dialog.
   */
  public function testOffCanvasStyles() {
    $assert_session = $this
      ->assertSession();
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->drupalGet('/ckeditor_test/off_canvas');

    // The "Add Node" link triggers an off-canvas dialog with an add node form
    // that includes CKEditor.
    $page
      ->clickLink('Add Node');
    $assert_session
      ->waitForElementVisible('css', '#drupal-off-canvas');
    $assert_session
      ->assertWaitOnAjaxRequest();

    // Check the background color of two CKEditor elements to confirm they are
    // not overridden by the off-canvas css reset.
    $assert_session
      ->elementExists('css', '.cke_top');
    $ckeditor_top_bg_color = $this
      ->getSession()
      ->evaluateScript('window.getComputedStyle(document.getElementsByClassName(\'cke_top\')[0]).backgroundColor');
    $this
      ->assertEquals('rgb(248, 248, 248)', $ckeditor_top_bg_color);
    $assert_session
      ->elementExists('css', '.cke_button__source');
    $ckeditor_source_button_bg_color = $this
      ->getSession()
      ->evaluateScript('window.getComputedStyle(document.getElementsByClassName(\'cke_button__source\')[0]).backgroundColor');
    $this
      ->assertEquals('rgba(0, 0, 0, 0)', $ckeditor_source_button_bg_color);

    // Check that only one off-canvas style is cached in local storage and that
    // it gets updated with the cache-busting query string.
    $get_cache_keys = 'Object.keys(window.localStorage).filter(function (i) {return i.indexOf(\'Drupal.off-canvas.css.\') === 0})';
    $old_keys = $this
      ->getSession()
      ->evaluateScript($get_cache_keys);

    // Flush the caches to ensure the new timestamp is altered into the
    // drupal.ckeditor library's javascript settings.
    $this
      ->resetAll();

    // Normally flushing caches regenerates the cache busting query string, but
    // as it's based on the request time, it won't change within this test so
    // explicitly set it.
    \Drupal::state()
      ->set('system.css_js_query_string', '0');
    $this
      ->drupalGet('/ckeditor_test/off_canvas');
    $page
      ->clickLink('Add Node');
    $assert_session
      ->waitForElementVisible('css', '#drupal-off-canvas');
    $assert_session
      ->assertWaitOnAjaxRequest();
    $new_keys = $this
      ->getSession()
      ->evaluateScript($get_cache_keys);
    $this
      ->assertCount(1, $old_keys, 'Only one off-canvas style was cached before clearing caches.');
    $this
      ->assertCount(1, $new_keys, 'Only one off-canvas style was cached after clearing caches.');
    $this
      ->assertNotEquals($old_keys, $new_keys, 'Clearing caches changed the off-canvas style cache key.');
  }

}

Classes

Name	Description
CKEditorIntegrationTest	Tests the integration of CKEditor.