class CKEditorPluginManagerTest in Zircon Profile 8

Tests different ways of enabling CKEditor plugins.

@group ckeditor

Hierarchy

• class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
  • class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
    • class \Drupal\ckeditor\Tests\CKEditorPluginManagerTest

File

core/modules/ckeditor/src/Tests/CKEditorPluginManagerTest.php, line 17

Contains \Drupal\ckeditor\Tests\CKEditorPluginManagerTest.

Namespace

Drupal\ckeditor\Tests

class CKEditorPluginManagerTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'system',
    'user',
    'filter',
    'editor',
    'ckeditor',
  );

  /**
   * The manager for "CKEditor plugin" plugins.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $manager;
  protected function setUp() {
    parent::setUp();

    // Install the Filter module.
    $this
      ->installSchema('system', 'url_alias');

    // Create text format, associate CKEditor.
    $filtered_html_format = entity_create('filter_format', array(
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => array(),
    ));
    $filtered_html_format
      ->save();
    $editor = entity_create('editor', array(
      'format' => 'filtered_html',
      'editor' => 'ckeditor',
    ));
    $editor
      ->save();
  }

  /**
   * Tests the enabling of plugins.
   */
  function testEnabledPlugins() {
    $this->manager = $this->container
      ->get('plugin.manager.ckeditor.plugin');
    $editor = entity_load('editor', 'filtered_html');

    // Case 1: no CKEditor plugins.
    $definitions = array_keys($this->manager
      ->getDefinitions());
    sort($definitions);
    $this
      ->assertIdentical(array(
      'drupalimage',
      'drupalimagecaption',
      'drupallink',
      'internal',
      'stylescombo',
    ), $definitions, 'No CKEditor plugins found besides the built-in ones.');
    $enabled_plugins = array(
      'drupalimage' => 'core/modules/ckeditor/js/plugins/drupalimage/plugin.js',
      'drupallink' => 'core/modules/ckeditor/js/plugins/drupallink/plugin.js',
    );
    $this
      ->assertIdentical($enabled_plugins, $this->manager
      ->getEnabledPluginFiles($editor), 'Only built-in plugins are enabled.');
    $this
      ->assertIdentical(array(
      '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 three
    // 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(array(
      '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
      ->assertIdentical(array(
      'drupalimage',
      'drupalimagecaption',
      'drupallink',
      'internal',
      'llama',
      'llama_button',
      'llama_contextual',
      'llama_contextual_and_button',
      'stylescombo',
    ), $plugin_ids, 'Additional CKEditor plugins found.');
    $this
      ->assertIdentical($enabled_plugins, $this->manager
      ->getEnabledPluginFiles($editor), 'Only the internal plugins are enabled.');
    $this
      ->assertIdentical(array(
      '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:
    // a. Llama: cannot be enabled, since it does not implement
    //    CKEditorPluginContextualInterface nor CKEditorPluginButtonsInterface.
    // b. LlamaContextual: enabled by adding the 'Strike' button, which is
    //    part of another plugin!
    // c. LlamaButton: automatically enabled by adding its 'Llama' button.
    // d. LlamaContextualAndButton: enabled by either b or c.
    // 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. Finally, we will add the "Strike" button back again, which would
    // cause all three plugins to be enabled.
    $settings = $editor
      ->getSettings();
    $original_toolbar = $settings['toolbar'];
    $settings['toolbar']['rows'][0][0]['items'][] = 'Llama';
    $editor
      ->setSettings($settings);
    $editor
      ->save();
    $file = array();
    $file['b'] = 'core/modules/ckeditor/tests/modules/js/llama_button.js';
    $file['c'] = 'core/modules/ckeditor/tests/modules/js/llama_contextual.js';
    $file['cb'] = 'core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js';
    $expected = $enabled_plugins + array(
      'llama_button' => $file['b'],
      'llama_contextual_and_button' => $file['cb'],
    );
    $this
      ->assertIdentical($expected, $this->manager
      ->getEnabledPluginFiles($editor), 'The LlamaButton and LlamaContextualAndButton plugins are enabled.');
    $this
      ->assertIdentical(array(
      '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 + array(
      'llama_contextual' => $file['c'],
      'llama_contextual_and_button' => $file['cb'],
    );
    $this
      ->assertIdentical($expected, $this->manager
      ->getEnabledPluginFiles($editor), 'The  LLamaContextual and LlamaContextualAndButton plugins are enabled.');
    $this
      ->assertIdentical(array(
      '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 + array(
      'llama_button' => $file['b'],
      'llama_contextual' => $file['c'],
      'llama_contextual_and_button' => $file['cb'],
    );
    $this
      ->assertIdentical($expected, $this->manager
      ->getEnabledPluginFiles($editor), 'The LlamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
    $this
      ->assertIdentical(array(
      'internal' => NULL,
    ) + $expected, $this->manager
      ->getEnabledPluginFiles($editor, TRUE), 'The LLamaButton, LlamaContextual and LlamaContextualAndButton plugins are enabled.');
  }

}

Members

Name	Modifiers	Type	Description	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.	2
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 the raw text IS NOT found escaped on the 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::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.
AssertHelperTrait::castSafeStrings	protected	function	Casts MarkupInterface objects into strings.
CKEditorPluginManagerTest::$manager	protected	property	The manager for "CKEditor plugin" plugins.
CKEditorPluginManagerTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
CKEditorPluginManagerTest::setUp	protected	function	Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
CKEditorPluginManagerTest::testEnabledPlugins		function	Tests the enabling of plugins.
KernelTestBase::$configDirectories	protected	property	The configuration directories for this test run.
KernelTestBase::$keyValueFactory	protected	property	A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles	private	property
KernelTestBase::$streamWrappers	protected	property	Array of registered stream wrappers.
KernelTestBase::$themeFiles	private	property
KernelTestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild	public	function	Sets up the base service container for this test.	12
KernelTestBase::defaultLanguageData	protected	function	Provides the data for setting the default language on the container.	1
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories	protected	function	Create and set new configuration directories.	1
KernelTestBase::registerStreamWrapper	protected	function	Registers a stream wrapper for this test.
KernelTestBase::render	protected	function	Renders a render array.
KernelTestBase::tearDown	protected	function	Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct		function	Constructor for Test. Overrides TestBase::__construct
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.
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.
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.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.	5
TestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestBase::$container	protected	property	The dependency injection container used in the test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel	protected	property	The DrupalKernel instance used in the test.	1
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalProfile	protected	property	The original installation profile.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.	1
TestBase::$originalSite	protected	property	The site directory of the original parent site.
TestBase::$originalUser	protected	property	The original user, before testing began.	1
TestBase::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestBase::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestBase::$results	public	property	Current results of this test case.
TestBase::$siteDirectory	protected	property	The site directory of this test run.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	4
TestBase::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestBase::$testId	protected	property	The test run ID.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::changeDatabasePrefix	private	function	Changes the database connection to the prefixed one.
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	2
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter	public	function	Returns a ConfigImporter object to import test importing of configuration.	5
TestBase::copyConfig	public	function	Copies configuration objects from source storage to target storage.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	3
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert	public static	function	Store an assertion from outside the testing context.
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests.
TestBase::prepareEnvironment	private	function	Prepares the current environment for running the test.
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	1
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.
TestBase::verbose	protected	function	Logs a verbose message in a text file.