class CKEditorPluginManagerTest

Same name in this branch
  1. 9 core/modules/ckeditor/tests/src/Unit/CKEditorPluginManagerTest.php \Drupal\Tests\ckeditor\Unit\CKEditorPluginManagerTest
Same name in other branches
  1. 8.9.x core/modules/ckeditor/tests/src/Unit/CKEditorPluginManagerTest.php \Drupal\Tests\ckeditor\Unit\CKEditorPluginManagerTest
  2. 8.9.x core/modules/ckeditor/tests/src/Kernel/CKEditorPluginManagerTest.php \Drupal\Tests\ckeditor\Kernel\CKEditorPluginManagerTest

Tests different ways of enabling CKEditor plugins.

@group ckeditor @group legacy

Hierarchy

Expanded class hierarchy of CKEditorPluginManagerTest

File

core/modules/ckeditor/tests/src/Kernel/CKEditorPluginManagerTest.php, line 15

Namespace

Drupal\Tests\ckeditor\Kernel
View source
class CKEditorPluginManagerTest extends KernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'system',
        'user',
        'filter',
        'editor',
        'ckeditor',
    ];
    
    /**
     * The manager for "CKEditor plugin" plugins.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $manager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Install the Filter module.
        // Create text format, associate CKEditor.
        $filtered_html_format = FilterFormat::create([
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'weight' => 0,
            'filters' => [],
        ]);
        $filtered_html_format->save();
        $editor = Editor::create([
            'format' => 'filtered_html',
            'editor' => 'ckeditor',
        ]);
        $editor->save();
    }
    
    /**
     * Tests the enabling of plugins.
     */
    public function testEnabledPlugins() {
        $this->manager = $this->container
            ->get('plugin.manager.ckeditor.plugin');
        $editor = Editor::load('filtered_html');
        // Case 1: no CKEditor plugins.
        $definitions = array_keys($this->manager
            ->getDefinitions());
        sort($definitions);
        $this->assertSame([
            'drupalimage',
            'drupalimagecaption',
            'drupallink',
            'internal',
            'language',
            'stylescombo',
        ], $definitions, 'No CKEditor plugins found besides the built-in ones.');
        $enabled_plugins = [
            'drupalimage' => $this->getModulePath('ckeditor') . '/js/plugins/drupalimage/plugin.js',
            'drupallink' => $this->getModulePath('ckeditor') . '/js/plugins/drupallink/plugin.js',
        ];
        $this->assertSame($enabled_plugins, $this->manager
            ->getEnabledPluginFiles($editor), 'Only built-in plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $enabled_plugins, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');
        // Enable the CKEditor Test module, which has the Llama plugin (plus four
        // variations of it, to cover all possible ways a plugin can be enabled) and
        // clear the editor manager's cache so it is picked up.
        $this->enableModules([
            'ckeditor_test',
        ]);
        $this->manager = $this->container
            ->get('plugin.manager.ckeditor.plugin');
        $this->manager
            ->clearCachedDefinitions();
        // Case 2: CKEditor plugins are available.
        $plugin_ids = array_keys($this->manager
            ->getDefinitions());
        sort($plugin_ids);
        $this->assertSame([
            'drupalimage',
            'drupalimagecaption',
            'drupallink',
            'internal',
            'language',
            'llama',
            'llama_button',
            'llama_contextual',
            'llama_contextual_and_button',
            'llama_css',
            'stylescombo',
        ], $plugin_ids, 'Additional CKEditor plugins found.');
        $this->assertSame($enabled_plugins, $this->manager
            ->getEnabledPluginFiles($editor), 'Only the internal plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $enabled_plugins, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'Only the "internal" plugin is enabled.');
        // Case 3: enable each of the newly available plugins, if possible:
        // 1. Llama: cannot be enabled, since it does not implement
        //    CKEditorPluginContextualInterface nor CKEditorPluginButtonsInterface.
        // 2. LlamaContextual: enabled by adding the 'Strike' button, which is
        //    part of another plugin!
        // 3. LlamaButton: automatically enabled by adding its 'Llama' button.
        // 4. LlamaContextualAndButton: enabled by either 2 or 3.
        // 5. LlamaCSS: automatically enabled by add its 'LlamaCSS' button.
        // Below, we will first enable the "Llama" button, which will cause the
        // LlamaButton and LlamaContextualAndButton plugins to be enabled. Then we
        // will remove the "Llama" button and add the "Strike" button, which will
        // cause the LlamaContextual and LlamaContextualAndButton plugins to be
        // enabled. Then we will add the "Strike" button back again, which would
        // cause LlamaButton, LlamaContextual and LlamaContextualAndButton to be
        // enabled. Finally, we will add the "LlamaCSS" button which would cause
        // all four plugins to be enabled.
        $settings = $editor->getSettings();
        $original_toolbar = $settings['toolbar'];
        $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
        $editor->setSettings($settings);
        $editor->save();
        $file = [];
        $file['b'] = $this->getModulePath('ckeditor_test') . '/js/llama_button.js';
        $file['c'] = $this->getModulePath('ckeditor_test') . '/js/llama_contextual.js';
        $file['cb'] = $this->getModulePath('ckeditor_test') . '/js/llama_contextual_and_button.js';
        $file['css'] = $this->getModulePath('ckeditor_test') . '/js/llama_css.js';
        $expected = $enabled_plugins + [
            'llama_button' => $file['b'],
            'llama_contextual_and_button' => $file['cb'],
        ];
        $this->assertSame($expected, $this->manager
            ->getEnabledPluginFiles($editor), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $expected, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
        $settings['toolbar'] = $original_toolbar;
        $settings['toolbar']['rows'][0][0]['items'][] = 'Strike';
        $editor->setSettings($settings);
        $editor->save();
        $expected = $enabled_plugins + [
            'llama_contextual' => $file['c'],
            'llama_contextual_and_button' => $file['cb'],
        ];
        $this->assertSame($expected, $this->manager
            ->getEnabledPluginFiles($editor), 'The  LLamaContextual and LlamaContextualAndButton plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $expected, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'The LlamaContextual and LlamaContextualAndButton plugins are enabled.');
        $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
        $editor->setSettings($settings);
        $editor->save();
        $expected = $enabled_plugins + [
            'llama_button' => $file['b'],
            'llama_contextual' => $file['c'],
            'llama_contextual_and_button' => $file['cb'],
        ];
        $this->assertSame($expected, $this->manager
            ->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $expected, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
        $settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
        $editor->setSettings($settings);
        $editor->save();
        $expected = $enabled_plugins + [
            'llama_button' => $file['b'],
            'llama_contextual' => $file['c'],
            'llama_contextual_and_button' => $file['cb'],
            'llama_css' => $file['css'],
        ];
        $this->assertSame($expected, $this->manager
            ->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual, LlamaContextualAndButton and LlamaCSS plugins are enabled.');
        $this->assertSame([
            'internal' => NULL,
        ] + $expected, $this->manager
            ->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual, LlamaContextualAndButton and LlamaCSS plugins are enabled.');
    }
    
    /**
     * Tests the iframe instance CSS files of plugins.
     */
    public function testCssFiles() {
        $this->manager = $this->container
            ->get('plugin.manager.ckeditor.plugin');
        $editor = Editor::load('filtered_html');
        // Case 1: no CKEditor iframe instance CSS file.
        $this->assertSame([], $this->manager
            ->getCssFiles($editor), 'No iframe instance CSS file found.');
        // Enable the CKEditor Test module, which has the LlamaCss plugin and
        // clear the editor manager's cache so it is picked up.
        $this->enableModules([
            'ckeditor_test',
        ]);
        $this->manager = $this->container
            ->get('plugin.manager.ckeditor.plugin');
        $settings = $editor->getSettings();
        // LlamaCss: automatically enabled by adding its 'LlamaCSS' button.
        $settings['toolbar']['rows'][0][0]['items'][] = 'LlamaCSS';
        $editor->setSettings($settings);
        $editor->save();
        // Case 2: CKEditor iframe instance CSS file.
        $expected = [
            'llama_css' => [
                $this->getModulePath('ckeditor_test') . '/css/llama.css',
            ],
        ];
        $this->assertSame($expected, $this->manager
            ->getCssFiles($editor), 'Iframe instance CSS file found.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
CKEditorPluginManagerTest::$manager protected property The manager for "CKEditor plugin" plugins.
CKEditorPluginManagerTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
CKEditorPluginManagerTest::setUp protected function Overrides KernelTestBase::setUp
CKEditorPluginManagerTest::testCssFiles public function Tests the iframe instance CSS files of plugins.
CKEditorPluginManagerTest::testEnabledPlugins public function Tests the enabling of plugins.
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.