class CKEditor5AllowedTagsTest

Same name and namespace in other branches

9 core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5AllowedTagsTest
10 core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5AllowedTagsTest

Tests for CKEditor 5.

@group ckeditor5 @internal

Hierarchy

class \Drupal\Tests\BrowserTestBase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait implements \PHPUnit\Framework\TestCase
- class \Drupal\FunctionalJavascriptTests\WebDriverTestBase implements \Drupal\Tests\BrowserTestBase
  - class \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5TestBase implements \Drupal\FunctionalJavascriptTests\WebDriverTestBase
    - class \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5AllowedTagsTest implements \Drupal\Tests\ckeditor5\FunctionalJavascript\CKEditor5TestBase

Expanded class hierarchy of CKEditor5AllowedTagsTest

File

core/modules/ckeditor5/tests/src/FunctionalJavascript/CKEditor5AllowedTagsTest.php, line 20

Namespace

Drupal\Tests\ckeditor5\FunctionalJavascript

View on git.drupalcode.org

View source

class CKEditor5AllowedTagsTest extends CKEditor5TestBase {
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'node',
    'editor_test',
    'ckeditor5',
    'media',
    'media_library',
    'ckeditor5_incompatible_filter_test',
  ];
  
  /**
   * The default CKEditor 5 allowed elements.
   *
   * @var string
   */
  protected $allowedElements = '<br> <p> <h2> <h3> <h4> <h5> <h6> <strong> <em>';
  
  /**
   * The default allowed elements for filter_html's "allowed_html" setting.
   *
   * @var string
   *
   * @see \Drupal\filter\Plugin\Filter\FilterHtml
   */
  protected $defaultElementsWhenUpdatingNotCkeditor5 = "<a href hreflang> <em> <strong> <cite> <blockquote cite> <code> <ul type> <ol start type='1 A I'> <li> <dl> <dt> <dd> <h2 id='jump-*'> <h3 id> <h4 id> <h5 id> <h6 id>";
  
  /**
   * The expected allowed elements after updating to CKEditor 5.
   *
   * @var string
   */
  protected $defaultElementsAfterUpdatingToCkeditor5 = '<br> <p> <h2 id="jump-*"> <h3 id> <h4 id> <h5 id> <h6 id> <cite> <dl> <dt> <dd> <a hreflang href> <blockquote cite> <ul type> <ol type="1 A I" reversed start> <strong> <em> <code> <li>';
  
  /**
   * Test enabling CKEditor 5 in a way that triggers validation.
   */
  public function testEnablingToVersion5Validation() : void {
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    $incompatible_filter_name = 'filters[filter_incompatible][status]';
    $filter_warning = 'CKEditor 5 only works with HTML-based text formats. The "A TYPE_MARKUP_LANGUAGE filter incompatible with CKEditor 5" (filter_incompatible) filter implies this text format is not HTML anymore.';
    $this->createNewTextFormat($page, $assert_session, 'unicorn');
    $page->checkField('filters[filter_html][status]');
    $page->checkField($incompatible_filter_name);
    $page->selectFieldOption('editor[editor]', 'ckeditor5');
    $assert_session->assertExpectedAjaxRequest(2);
    $assert_session->pageTextContains($filter_warning);
    // Disable the incompatible filter.
    $page->uncheckField($incompatible_filter_name);
    // Confirm there are no longer any warnings.
    $assert_session->waitForElementRemoved('css', '[data-drupal-messages] [role="alert"]');
    // Confirm the text format can be saved.
    $this->saveNewTextFormat($page, $assert_session);
  }
  
  /**
   * Tests that when image uploads were enabled, they remain enabled.
   */
  public function testImageUploadsRemainEnabled() : void {
    FilterFormat::create([
      'format' => 'editor_with_image_uploads',
      'name' => 'Text Editor with image uploads enabled',
    ])->save();
    Editor::create([
      'format' => 'editor_with_image_uploads',
      'editor' => 'unicorn',
      'image_upload' => [
        'status' => TRUE,
        'scheme' => 'public',
        'directory' => 'inline-images',
        'max_size' => NULL,
        'max_dimensions' => [
          'width' => NULL,
          'height' => NULL,
        ],
      ],
    ])->save();
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    // Assert that image uploads are enabled initially.
    $this->drupalGet('admin/config/content/formats/manage/editor_with_image_uploads');
    $this->assertTrue($page->hasCheckedField('Enable image uploads'));
    // Switch the text format to CKEditor 5.
    $page->selectFieldOption('editor[editor]', 'ckeditor5');
    $assert_session->assertWaitOnAjaxRequest();
    // Enable the image toolbar item. This does NOT enable image uploads: it
    // triggers the image upload settings form to become visible, to allow the
    // image upload status to be checked.
    $this->triggerKeyUp('.ckeditor5-toolbar-item-drupalInsertImage', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    // Assert that image uploads are still enabled.
    $this->assertTrue($page->hasCheckedField('Enable image uploads'));
  }
  
  /**
   * Confirm that switching to CKEditor 5 from another editor updates tags.
   */
  public function testSwitchToVersion5() : void {
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    $this->createNewTextFormat($page, $assert_session, 'unicorn');
    // Enable the HTML filter.
    $this->assertTrue($page->hasUncheckedField('filters[filter_html][status]'));
    $page->checkField('filters[filter_html][status]');
    // Confirm the allowed HTML tags are the defaults initially.
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $this->defaultElementsWhenUpdatingNotCkeditor5);
    $this->saveNewTextFormat($page, $assert_session);
    $assert_session->pageTextContains('Added text format unicorn');
    // Return to the config form to confirm that switching text editors on
    // existing formats will properly switch allowed tags.
    $this->drupalGet('admin/config/content/formats/manage/unicorn');
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $this->defaultElementsWhenUpdatingNotCkeditor5);
    $page->selectFieldOption('editor[editor]', 'ckeditor5');
    $assert_session->assertWaitOnAjaxRequest();
    $assert_session->pageTextContains('The <br>, <p> tags were added because they are required by CKEditor 5');
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $this->defaultElementsAfterUpdatingToCkeditor5);
    $page->pressButton('Save configuration');
    $assert_session->pageTextContains('The text format unicorn has been updated');
  }
  
  /**
   * Tests that the img tag is added after enabling image uploads.
   */
  public function testImgAddedViaUploadPlugin() : void {
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    $this->createNewTextFormat($page, $assert_session);
    $allowed_html_field = $assert_session->fieldExists('filters[filter_html][settings][allowed_html]');
    $this->assertTrue($allowed_html_field->hasAttribute('readonly'));
    // Allowed tags are currently the default, with no <img>.
    $this->assertEquals($this->allowedElements, $allowed_html_field->getValue());
    // The image upload settings form should not be present.
    $assert_session->elementNotExists('css', '[data-drupal-selector="edit-editor-settings-plugins-ckeditor5-imageupload"]');
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-drupalInsertImage'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-drupalInsertImage', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    // The image upload settings form should now be present.
    $assert_session->elementExists('css', '[data-drupal-selector="edit-editor-settings-plugins-ckeditor5-image"]');
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-active .ckeditor5-toolbar-item-drupalInsertImage'));
    // The image insert plugin is enabled and inserting <img> is allowed.
    $this->assertEquals($this->allowedElements . ' <img src alt height width>', $allowed_html_field->getValue());
    $page->clickLink('Image');
    $assert_session->waitForText('Enable image uploads');
    $this->assertTrue($page->hasUncheckedField('editor[settings][plugins][ckeditor5_image][status]'));
    $page->checkField('editor[settings][plugins][ckeditor5_image][status]');
    $assert_session->assertWaitOnAjaxRequest();
    // Enabling image uploads adds <img> with several attributes to allowed
    // tags.
    $this->assertEquals($this->allowedElements . ' <img src alt height width data-entity-uuid data-entity-type>', $allowed_html_field->getValue());
    // Also enabling the caption filter will add the data-caption attribute to
    // <img>.
    $this->assertTrue($page->hasUncheckedField('filters[filter_caption][status]'));
    $page->checkField('filters[filter_caption][status]');
    $assert_session->assertWaitOnAjaxRequest();
    $this->assertEquals($this->allowedElements . ' <img src alt height width data-entity-uuid data-entity-type data-caption>', $allowed_html_field->getValue());
    // Also enabling the alignment filter will add the data-align attribute to
    // <img>.
    $this->assertTrue($page->hasUncheckedField('filters[filter_align][status]'));
    $page->checkField('filters[filter_align][status]');
    $assert_session->assertWaitOnAjaxRequest();
    $this->assertEquals($this->allowedElements . ' <img src alt height width data-entity-uuid data-entity-type data-caption data-align>', $allowed_html_field->getValue());
    // Disable image upload.
    $page->clickLink('Image');
    $assert_session->waitForText('Enable image uploads');
    $this->assertTrue($page->hasCheckedField('editor[settings][plugins][ckeditor5_image][status]'));
    $page->uncheckField('editor[settings][plugins][ckeditor5_image][status]');
    $assert_session->assertWaitOnAjaxRequest();
    // The image insert is still allowed when image uploads are disabled.
    $this->assertEquals($this->allowedElements . ' <img src alt height width data-caption data-align>', $allowed_html_field->getValue());
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-drupalInsertImage'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-drupalInsertImage', 'ArrowUp');
    $assert_session->assertWaitOnAjaxRequest();
    // Confirm <img> is no longer an allowed tag, once image insert is disabled.
    $this->assertEquals($this->allowedElements, $allowed_html_field->getValue());
  }
  
  /**
   * Test filter_html allowed tags.
   */
  public function testAllowedTags() : void {
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    $this->createNewTextFormat($page, $assert_session);
    // Confirm the "allowed tags" field is  read only, and the value
    // matches the tags required by CKEditor.
    // Allowed HTML field is readonly and its wrapper has a form-disabled class.
    $this->assertNotEmpty($assert_session->waitForElement('css', '.js-form-item-filters-filter-html-settings-allowed-html.form-disabled'));
    $allowed_html_field = $assert_session->fieldExists('filters[filter_html][settings][allowed_html]');
    $this->assertTrue($allowed_html_field->hasAttribute('readonly'));
    $this->assertSame($this->allowedElements, $allowed_html_field->getValue());
    $this->saveNewTextFormat($page, $assert_session);
    $assert_session->pageTextContains('Added text format ckeditor5');
    $assert_session->pageTextContains('Text formats and editors');
    // Confirm the filter config was updated with the correct allowed tags.
    $this->assertSame($this->allowedElements, FilterFormat::load('ckeditor5')->filters('filter_html')
      ->getConfiguration()['settings']['allowed_html']);
    $page->find('css', '[data-drupal-selector="edit-formats-ckeditor5"]')
      ->clickLink('Configure');
    // Add the block quote plugin to the CKEditor 5 toolbar.
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-blockQuote'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-blockQuote', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    $allowed_with_blockquote = $this->allowedElements . ' <blockquote>';
    $assert_session->fieldExists('filters[filter_html][settings][allowed_html]');
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $allowed_with_blockquote);
    $page->pressButton('Save configuration');
    $assert_session->pageTextContains('The text format ckeditor5 has been updated.');
    // Flush caches so the updated config can be checked.
    drupal_flush_all_caches();
    // Confirm that the tags required by the newly-added plugins were correctly
    // saved.
    $this->assertSame($allowed_with_blockquote, FilterFormat::load('ckeditor5')->filters('filter_html')
      ->getConfiguration()['settings']['allowed_html']);
    $page->find('css', '[data-drupal-selector="edit-formats-ckeditor5"]')
      ->clickLink('Configure');
    // And for good measure, confirm the correct tags are in the form field when
    // returning to the form.
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $allowed_with_blockquote);
    // Add the source editing plugin to the CKEditor 5 toolbar.
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-available .ckeditor5-toolbar-item-sourceEditing'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-sourceEditing', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    // Updating Source Editing's editable tags should automatically update
    // filter_html to include those additional tags.
    $assert_session->waitForText('Source editing');
    $page->find('css', '[href^="#edit-editor-settings-plugins-ckeditor5-sourceediting"]')
      ->click();
    $assert_session->waitForText('Manually editable HTML tags');
    $source_edit_tags_field = $assert_session->fieldExists('editor[settings][plugins][ckeditor5_sourceEditing][allowed_tags]');
    $source_edit_tags_field->setValue('<aside>');
    $assert_session->assertWaitOnAjaxRequest();
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', '<br> <p> <h2> <h3> <h4> <h5> <h6> <aside> <strong> <em> <blockquote>');
    $allowed_html_field = $assert_session->fieldExists('filters[filter_html][settings][allowed_html]');
    $this->assertTrue($allowed_html_field->hasAttribute('readonly'));
    // Adding tags to Source Editing's editable tags that are already supported
    // by enabled CKEditor 5 plugins must trigger a validation error, and that
    // error must be associated with the correct form item.
    $source_edit_tags_field->setValue('<aside><strong>');
    $assert_session->waitForText('The following tag(s) are already supported by enabled plugins and should not be added to the Source Editing "Manually editable HTML tags" field: Bold (<strong>)');
    $this->assertTrue($page->find('css', '[href^="#edit-editor-settings-plugins-ckeditor5-sourceediting"]')
      ->getParent()
      ->hasClass('is-selected'));
    $this->assertSame('true', $page->findField('editor[settings][plugins][ckeditor5_sourceEditing][allowed_tags]')
      ->getAttribute('aria-invalid'));
    $this->assertTrue($allowed_html_field->hasAttribute('readonly'));
    // The same validation error appears when saving the form regardless of the
    // immediate AJAX validation error above.
    $page->pressButton('Save configuration');
    $assert_session->pageTextContains('The following tag(s) are already supported by enabled plugins and should not be added to the Source Editing "Manually editable HTML tags" field: Bold (<strong>)');
    $this->assertTrue($page->find('css', '[href^="#edit-editor-settings-plugins-ckeditor5-sourceediting"]')
      ->getParent()
      ->hasClass('is-selected'));
    $this->assertSame('true', $page->findField('editor[settings][plugins][ckeditor5_sourceEditing][allowed_tags]')
      ->getAttribute('aria-invalid'));
    $assert_session->pageTextNotContains('The text format ckeditor5 has been updated');
    // Wait for the "Source editing" vertical tab to appear, remove the already
    // supported tags and re-save. Now the text format should save successfully.
    $assert_session->waitForText('Source editing');
    $page->find('css', '[href^="#edit-editor-settings-plugins-ckeditor5-sourceediting"]')
      ->click();
    $assert_session->pageTextContains('Manually editable HTML tags');
    $source_edit_tags_field = $assert_session->fieldExists('editor[settings][plugins][ckeditor5_sourceEditing][allowed_tags]');
    $source_edit_tags_field->setValue('<aside>');
    $assert_session->assertWaitOnAjaxRequest();
    $page->pressButton('Save configuration');
    $assert_session->pageTextContains('The text format ckeditor5 has been updated');
    $assert_session->pageTextNotContains('The following tag(s) are already supported by enabled plugins and should not be added to the Source Editing "Manually editable HTML tags" field: Bold (<strong>)');
    // Ensure that CKEditor can be initialized with Source Editing.
    // @see https://www.drupal.org/i/3231427
    $this->drupalGet('node/add');
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ck-editor'));
  }
  
  /**
   * Test that <drupal-media> is added to allowed tags when media embed enabled.
   */
  public function testMediaElementAllowedTags() : void {
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    EntityViewMode::create([
      'id' => 'media.view_mode_1',
      'targetEntityType' => 'media',
      'status' => TRUE,
      'enabled' => TRUE,
      'label' => 'View Mode 1',
    ])->save();
    EntityViewMode::create([
      'id' => 'media.view_mode_2',
      'targetEntityType' => 'media',
      'status' => TRUE,
      'enabled' => TRUE,
      'label' => 'View Mode 2',
    ])->save();
    $this->createNewTextFormat($page, $assert_session);
    // Allowed HTML field is readonly and its wrapper has a form-disabled class.
    $this->assertNotEmpty($assert_session->waitForElement('css', '.js-form-item-filters-filter-html-settings-allowed-html.form-disabled'));
    $allowed_html_field = $assert_session->fieldExists('filters[filter_html][settings][allowed_html]');
    $this->assertTrue($allowed_html_field->hasAttribute('readonly'));
    // Allowed tags are currently the default, with no <drupal-media>.
    $this->assertEquals($this->allowedElements, $allowed_html_field->getValue());
    // Enable media embed.
    $this->assertTrue($page->hasUncheckedField('filters[media_embed][status]'));
    $this->assertNull($assert_session->waitForElementVisible('css', '[data-drupal-selector=edit-filters-media-embed-settings]', 0));
    $page->checkField('filters[media_embed][status]');
    $assert_session->assertExpectedAjaxRequest(2);
    $this->assertNotNull($assert_session->waitForElementVisible('css', '[data-drupal-selector=edit-filters-media-embed-settings]', 0));
    $page->clickLink('Embed media');
    $page->checkField('filters[media_embed][settings][allowed_view_modes][view_mode_1]');
    $page->checkField('filters[media_embed][settings][allowed_view_modes][view_mode_2]');
    $allowed_with_media = $this->allowedElements . ' <drupal-media data-entity-type data-entity-uuid alt data-view-mode>';
    $allowed_with_media_without_view_mode = $this->allowedElements . ' <drupal-media data-entity-type data-entity-uuid alt>';
    $page->clickLink('Media');
    $this->assertTrue($page->hasUncheckedField('editor[settings][plugins][media_media][allow_view_mode_override]'));
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $allowed_with_media_without_view_mode);
    $page->checkField('editor[settings][plugins][media_media][allow_view_mode_override]');
    $assert_session->assertExpectedAjaxRequest(3);
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $allowed_with_media);
    $this->saveNewTextFormat($page, $assert_session);
    $assert_session->pageTextContains('Added text format ckeditor5.');
    // Confirm <drupal-media> was added to allowed tags on save, as a result of
    // enabling the media embed filter.
    $this->assertSame($allowed_with_media, FilterFormat::load('ckeditor5')->filters('filter_html')
      ->getConfiguration()['settings']['allowed_html']);
    $page->find('css', '[data-drupal-selector="edit-formats-ckeditor5"]')
      ->clickLink('Configure');
    // Confirm that <drupal-media> is now included in the "Allowed tags" form
    // field.
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $allowed_with_media);
    // Ensure that data-align attribute is added to <drupal-media> when
    // filter_align is enabled.
    $page->checkField('filters[filter_align][status]');
    $assert_session->assertExpectedAjaxRequest(1);
    $this->assertEquals($this->allowedElements . ' <drupal-media data-entity-type data-entity-uuid alt data-view-mode data-align>', $allowed_html_field->getValue());
    // Disable media embed.
    $this->assertTrue($page->hasCheckedField('filters[media_embed][status]'));
    $page->uncheckField('filters[media_embed][status]');
    $assert_session->assertExpectedAjaxRequest(2);
    // Confirm allowed tags no longer has <drupal-media>.
    $this->assertHtmlEsqueFieldValueEquals('filters[filter_html][settings][allowed_html]', $this->allowedElements);
  }
  
  /**
   * Tests full HTML text format.
   */
  public function testFullHtml() : void {
    FilterFormat::create(Yaml::parseFile('core/profiles/standard/config/install/filter.format.full_html.yml'))->save();
    FilterFormat::create(Yaml::parseFile('core/profiles/standard/config/install/filter.format.basic_html.yml'))->save();
    $page = $this->getSession()
      ->getPage();
    $assert_session = $this->assertSession();
    // Add a node with text rendered via the Plain Text format.
    $this->drupalGet('node/add');
    $page->fillField('title[0][value]', 'My test content');
    $page->fillField('body[0][value]', '<foo bar="baz">⬅️✌️➡️</foo><p><a style="color:#ff0000;" foo="bar" hreflang="en" href="https://example.com"><abbr title="National Aeronautics and Space Administration">NASA</abbr> is an acronym.</a></p>');
    $page->pressButton('Save');
    // Configure Full HTML text format to use CKEditor 5.
    $this->drupalGet('admin/config/content/formats/manage/full_html');
    $page->checkField('roles[authenticated]');
    $page->selectFieldOption('editor[editor]', 'ckeditor5');
    $assert_session->assertWaitOnAjaxRequest();
    $page->pressButton('Save configuration');
    $this->assertTrue($assert_session->waitForText('The text format Full HTML has been updated.'));
    // Change the node's text format to Full HTML.
    $this->drupalGet('node/1/edit');
    $filter_tips = $page->find('css', '[data-drupal-format-id="basic_html"]');
    $this->assertTrue($filter_tips->isVisible());
    $page->selectFieldOption('body[0][format]', 'full_html');
    $this->assertNotEmpty($assert_session->waitForText('Change text format?'));
    // Check the visibility of "Filter tips" by clicking the "Cancel" button.
    $page->pressButton('Cancel');
    $this->assertTrue($filter_tips->isVisible());
    $page->selectFieldOption('body[0][format]', 'full_html');
    $this->assertNotEmpty($assert_session->waitForText('Change text format?'));
    $page->pressButton('Continue');
    // Ensure the editor is loaded and ensure that arbitrary markup is retained.
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ck-editor'));
    $page->pressButton('Save');
    // But note that the `style` attribute was stripped by
    // \Drupal\editor\EditorXssFilter\Standard.
    $assert_session->responseContains('<foo bar="baz">⬅️✌️➡️</foo><p><a foo="bar" hreflang="en" href="https://example.com"><abbr title="National Aeronautics and Space Administration">NASA</abbr> is an acronym.</a></p>');
    // Ensure attributes are retained after enabling link plugin.
    $this->drupalGet('admin/config/content/formats/manage/full_html');
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-item-link'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-link', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    $page->pressButton('Save configuration');
    $this->drupalGet('node/1/edit');
    $page->pressButton('Save');
    $assert_session->responseContains('<p><a foo="bar" hreflang="en" href="https://example.com"><abbr title="National Aeronautics and Space Administration">NASA</abbr> is an acronym.</a></p>');
    // Configure Basic HTML text format to use CKE5 and enable the link plugin.
    $this->drupalGet('admin/config/content/formats/manage/basic_html');
    $page->checkField('roles[authenticated]');
    $page->selectFieldOption('editor[editor]', 'ckeditor5');
    $assert_session->assertWaitOnAjaxRequest();
    $this->assertNotEmpty($assert_session->waitForElement('css', '.ckeditor5-toolbar-available .ckeditor5-toolbar-item-underline'));
    $this->triggerKeyUp('.ckeditor5-toolbar-item-underline', 'ArrowDown');
    $assert_session->assertWaitOnAjaxRequest();
    $page->pressButton('Save configuration');
    $this->assertTrue($assert_session->waitForText('The text format Basic HTML has been updated.'));
    // Change the node's text format to Basic HTML.
    $this->drupalGet('node/1/edit');
    $page->selectFieldOption('body[0][format]', 'basic_html');
    $this->assertNotEmpty($assert_session->waitForText('Change text format?'));
    $page->pressButton('Continue');
    $assert_session->assertWaitOnAjaxRequest();
    $page->pressButton('Save');
    // The `style` and foo` attributes should have been removed, as should the
    // `<abbr>` and `<foo>` tags.
    $assert_session->responseContains('<p>⬅️✌️➡️</p><p><a href="https://example.com" hreflang="en">NASA is an acronym.</a></p>');
  }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Member alias	Overriden Title	Overrides
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::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::$mink		protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs		protected	property	Mink default driver params.
BrowserTestBase::$originalShutdownCallbacks		protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$profile		protected	property	The profile to install as a basis for testing.			45
BrowserTestBase::$timeLimit		protected	property	Time limit in seconds for the test.
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::getHttpClient		protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions	Deprecated	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::installDrupal		public	function	Installs Drupal into the test site.			2
BrowserTestBase::registerSessions		protected	function	Registers additional Mink sessions.
BrowserTestBase::setDebugDumpHandler		public static	function	Registers the dumper CLI handler when the DebugDump extension is enabled.
BrowserTestBase::setUpAppRoot		protected	function	Sets up the root application path.
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				1
BrowserTestBase::__sleep		public	function	Prevents serializing any properties.
CKEditor5AllowedTagsTest::$allowedElements		protected	property	The default CKEditor 5 allowed elements.
CKEditor5AllowedTagsTest::$defaultElementsAfterUpdatingToCkeditor5		protected	property	The expected allowed elements after updating to CKEditor 5.
CKEditor5AllowedTagsTest::$defaultElementsWhenUpdatingNotCkeditor5		protected	property	The default allowed elements for filter_html's "allowed_html" setting.
CKEditor5AllowedTagsTest::$modules		protected static	property	Modules to install.		Overrides CKEditor5TestBase::$modules
CKEditor5AllowedTagsTest::testAllowedTags		public	function	Test filter_html allowed tags.
CKEditor5AllowedTagsTest::testEnablingToVersion5Validation		public	function	Test enabling CKEditor 5 in a way that triggers validation.
CKEditor5AllowedTagsTest::testFullHtml		public	function	Tests full HTML text format.
CKEditor5AllowedTagsTest::testImageUploadsRemainEnabled		public	function	Tests that when image uploads were enabled, they remain enabled.
CKEditor5AllowedTagsTest::testImgAddedViaUploadPlugin		public	function	Tests that the img tag is added after enabling image uploads.
CKEditor5AllowedTagsTest::testMediaElementAllowedTags		public	function	Test that <drupal-media> is added to allowed tags when media embed enabled.
CKEditor5AllowedTagsTest::testSwitchToVersion5		public	function	Confirm that switching to CKEditor 5 from another editor updates tags.
CKEditor5TestBase::$defaultTheme		protected	property	The theme to install as the default for testing.		Overrides BrowserTestBase::$defaultTheme	2
CKEditor5TestBase::addNewTextFormat		protected	function	Add and save a new text format using CKEditor 5.
CKEditor5TestBase::assertHtmlEsqueFieldValueEquals		protected	function	Decorates ::fieldValueEquals() to force DrupalCI to provide useful errors.
CKEditor5TestBase::assertNoRealtimeValidationErrors		protected	function	Checks that no real-time validation errors are present.
CKEditor5TestBase::createNewTextFormat		public	function	Create a new text format using CKEditor 5.
CKEditor5TestBase::saveNewTextFormat		public	function	Save the new text format.
CKEditor5TestBase::setUp		protected	function			Overrides BrowserTestBase::setUp	6
CKEditor5TestBase::triggerKeyUp		protected	function	Trigger a keyup event on the selected element.
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::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.			1
FunctionalTestSetupTrait::doInstall		protected	function	Execute the non-interactive installer.			1
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::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.			29
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.			4
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::$useOneTimeLoginLinks		protected	property	Use one-time login links instead of submitting the login form.			3
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		1
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.
WebDriverTestBase::$disableCssAnimations		protected	property	Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors		protected	property	Determines if a test should fail on JavaScript console errors.			2
WebDriverTestBase::$minkDefaultDriverClass		protected	property	Mink class for the default driver to use.		Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition		protected	function	Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession		public	function	Returns WebAssert object.		Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot		protected	function	Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors		protected	function	Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings		protected	function	Gets the current Drupal javascript settings and parses into an array.		Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders		protected	function	Returns headers in HTML output format.		Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs		protected	function	Gets the Mink driver args from an environment variable.		Overrides BrowserTestBase::getMinkDriverArgs	1
WebDriverTestBase::initFrontPage		protected	function	Visits the front page when initializing Mink.		Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink		protected	function	Initializes Mink sessions.		Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty		protected	function	Install modules defined by `static::$modules`.		Overrides FunctionalTestSetupTrait::installModulesFromClassProperty	1
WebDriverTestBase::tearDown		protected	function			Overrides BrowserTestBase::tearDown	1
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.

class CKEditor5AllowedTagsTest

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation

Breadcrumb

class CKEditor5AllowedTagsTest

Hierarchy

File

Namespace

Members

Search drupal 11.x

API Navigation