Tests for the 'CKEditor' text editor plugin.
Expanded class hierarchy of CKEditorTest
class CKEditorTest extends DrupalUnitTestBase {
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array(
'system',
'editor',
'ckeditor',
);
/**
* An instance of the "CKEditor" text editor plugin.
*
* @var \Drupal\ckeditor\Plugin\Editor\CKEditor;
*/
protected $ckeditor;
public static function getInfo() {
return array(
'name' => 'CKEditor text editor plugin',
'description' => 'Tests all aspects of the CKEditor text editor plugin.',
'group' => 'CKEditor',
);
}
function setUp() {
parent::setUp();
// Install the Filter module.
$this
->installSchema('system', 'url_alias');
$this
->enableModules(array(
'user',
'filter',
));
// Create text format, associate CKEditor.
$filtered_html_format = entity_create('filter_format', array(
'format' => 'filtered_html',
'name' => 'Filtered HTML',
'weight' => 0,
'filters' => array(
'filter_html' => array(
'status' => 1,
),
),
));
$filtered_html_format
->save();
$editor = entity_create('editor', array(
'format' => 'filtered_html',
'editor' => 'ckeditor',
));
$editor
->save();
// Create "CKEditor" text editor plugin instance.
$manager = $this->container
->get('plugin.manager.editor');
$this->ckeditor = $manager
->createInstance('ckeditor');
}
/**
* Tests CKEditor::getJSSettings().
*/
function testGetJSSettings() {
$editor = entity_load('editor', 'filtered_html');
// Default toolbar.
$expected_config = $this
->getDefaultInternalConfig() + array(
'toolbar' => $this
->getDefaultToolbarConfig(),
'contentsCss' => $this
->getDefaultContentsCssConfig(),
'extraPlugins' => '',
'language' => 'en',
'stylesSet' => FALSE,
'drupalExternalPlugins' => array(),
);
$this
->assertIdentical($expected_config, $this->ckeditor
->getJSSettings($editor), 'Generated JS settings are correct for default configuration.');
// Customize the configuration: add button, have two contextually enabled
// buttons, and configure a CKEditor plugin setting.
$this
->enableModules(array(
'ckeditor_test',
));
drupal_container()
->get('plugin.manager.ckeditor.plugin')
->clearCachedDefinitions();
$editor->settings['toolbar']['buttons'][0][] = 'Strike';
$editor->settings['toolbar']['buttons'][1][] = 'Format';
$editor->settings['plugins']['internal']['link_shortcut'] = 'CTRL+K';
$editor
->save();
$expected_config['toolbar'][count($expected_config['toolbar']) - 2]['items'][] = 'Strike';
$expected_config['toolbar'][]['items'][] = 'Format';
$expected_config['toolbar'][] = '/';
$expected_config['format_tags'] = 'p;h4;h5;h6';
$expected_config['extraPlugins'] = 'llama_contextual,llama_contextual_and_button';
$expected_config['drupalExternalPlugins']['llama_contextual'] = file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual.js');
$expected_config['drupalExternalPlugins']['llama_contextual_and_button'] = file_create_url('core/modules/ckeditor/tests/modules/js/llama_contextual_and_button.js');
$expected_config['contentsCss'][] = file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css');
$expected_config['keystrokes'] = array(
array(
1114187,
'link',
),
array(
1114188,
NULL,
),
);
$this
->assertEqual($expected_config, $this->ckeditor
->getJSSettings($editor), 'Generated JS settings are correct for customized configuration.');
// Change the allowed HTML tags; the "format_tags" setting for CKEditor
// should automatically be updated as well.
$format = entity_load('filter_format', 'filtered_html');
$format
->filters('filter_html')->settings['allowed_html'] .= '<pre> <h3>';
$format
->save();
$expected_config['format_tags'] = 'p;h3;h4;h5;h6;pre';
$this
->assertEqual($expected_config, $this->ckeditor
->getJSSettings($editor), 'Generated JS settings are correct for customized configuration.');
}
/**
* Tests CKEditor::buildToolbarJSSetting().
*/
function testBuildToolbarJSSetting() {
$editor = entity_load('editor', 'filtered_html');
// Default toolbar.
$expected = $this
->getDefaultToolbarConfig();
$this
->assertIdentical($expected, $this->ckeditor
->buildToolbarJSSetting($editor), '"toolbar" configuration part of JS settings built correctly for default toolbar.');
// Customize the configuration.
$editor->settings['toolbar']['buttons'][0][] = 'Strike';
$editor
->save();
$expected[count($expected) - 2]['items'][] = 'Strike';
$this
->assertIdentical($expected, $this->ckeditor
->buildToolbarJSSetting($editor), '"toolbar" configuration part of JS settings built correctly for customized toolbar.');
// Enable the editor_test module, customize further.
$this
->enableModules(array(
'ckeditor_test',
));
drupal_container()
->get('plugin.manager.ckeditor.plugin')
->clearCachedDefinitions();
$editor->settings['toolbar']['buttons'][0][] = 'Llama';
$editor
->save();
$expected[count($expected) - 2]['items'][] = 'Llama';
$this
->assertIdentical($expected, $this->ckeditor
->buildToolbarJSSetting($editor), '"toolbar" configuration part of JS settings built correctly for customized toolbar with contrib module-provided CKEditor plugin.');
}
/**
* Tests CKEditor::buildContentsCssJSSetting().
*/
function testBuildContentsCssJSSetting() {
$editor = entity_load('editor', 'filtered_html');
// Default toolbar.
$expected = $this
->getDefaultContentsCssConfig();
$this
->assertIdentical($expected, $this->ckeditor
->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly for default toolbar.');
// Enable the editor_test module, which implements hook_ckeditor_css_alter().
$this
->enableModules(array(
'ckeditor_test',
));
$expected[] = file_create_url('core/modules/ckeditor/tests/modules/ckeditor_test.css');
$this
->assertIdentical($expected, $this->ckeditor
->buildContentsCssJSSetting($editor), '"contentsCss" configuration part of JS settings built correctly while a hook_ckeditor_css_alter() implementation exists.');
// @todo test coverage for _ckeditor_theme_css(), by including a custom theme in this test with a "ckeditor_stylesheets" entry in its .info file.
}
/**
* Tests Internal::getConfig().
*/
function testInternalGetConfig() {
$editor = entity_load('editor', 'filtered_html');
$manager = drupal_container()
->get('plugin.manager.ckeditor.plugin');
$internal_plugin = $manager
->createInstance('internal');
// Default toolbar.
$expected = $this
->getDefaultInternalConfig();
$this
->assertIdentical($expected, $internal_plugin
->getConfig($editor), '"Internal" plugin configuration built correctly for default toolbar.');
// Format dropdown/button enabled: new setting should be present.
$editor->settings['toolbar']['buttons'][0][] = 'Format';
$expected['format_tags'] = 'p;h4;h5;h6';
$this
->assertIdentical($expected, $internal_plugin
->getConfig($editor), '"Internal" plugin configuration built correctly for customized toolbar.');
}
/**
* Tests StylesCombo::getConfig().
*/
function testStylesComboGetConfig() {
$editor = entity_load('editor', 'filtered_html');
$manager = drupal_container()
->get('plugin.manager.ckeditor.plugin');
$stylescombo_plugin = $manager
->createInstance('stylescombo');
// Styles dropdown/button enabled: new setting should be present.
$editor->settings['toolbar']['buttons'][0][] = 'Styles';
$editor->settings['plugins']['stylescombo']['styles'] = '';
$editor
->save();
$expected['stylesSet'] = array();
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Configure the optional "styles" setting in odd ways that shouldn't affect
// the end result.
$editor->settings['plugins']['stylescombo']['styles'] = " \n";
$editor
->save();
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor));
$editor->settings['plugins']['stylescombo']['styles'] = "\r\n \n \r \n ";
$editor
->save();
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Now configure it properly, the end result should change.
$editor->settings['plugins']['stylescombo']['styles'] = "h1.title|Title\np.mAgical.Callout|Callout";
$editor
->save();
$expected['stylesSet'] = array(
array(
'name' => 'Title',
'element' => 'h1',
'attributes' => array(
'class' => 'title',
),
),
array(
'name' => 'Callout',
'element' => 'p',
'attributes' => array(
'class' => 'mAgical Callout',
),
),
);
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Same configuration, but now interspersed with nonsense. Should yield the
// same result.
$editor->settings['plugins']['stylescombo']['styles'] = " h1 .title | Title \r \n\r \np.mAgical .Callout|Callout\r";
$editor
->save();
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
// Invalid syntax should cause stylesSet to be set to FALSE.
$editor->settings['plugins']['stylescombo']['styles'] = "h1|Title";
$editor
->save();
$expected['stylesSet'] = FALSE;
$this
->assertIdentical($expected, $stylescombo_plugin
->getConfig($editor), '"StylesCombo" plugin configuration built correctly for customized toolbar.');
}
protected function getDefaultInternalConfig() {
return array(
'customConfig' => '',
'pasteFromWordPromptCleanup' => TRUE,
'removeDialogTabs' => 'image:Link;image:advanced;link:advanced',
'resize_dir' => 'vertical',
'keystrokes' => array(
array(
0x110000 + 75,
'link',
),
array(
0x110000 + 76,
NULL,
),
),
);
}
protected function getDefaultToolbarConfig() {
return array(
0 => array(
'items' => array(
'Bold',
'Italic',
),
),
1 => array(
'items' => array(
'Link',
'Unlink',
),
),
2 => array(
'items' => array(
'BulletedList',
'NumberedList',
),
),
3 => array(
'items' => array(
'Blockquote',
'Image',
),
),
4 => array(
'items' => array(
'Source',
),
),
5 => '/',
);
}
protected function getDefaultContentsCssConfig() {
return array(
file_create_url('core/modules/ckeditor/css/ckeditor-iframe.css'),
);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CKEditorTest:: |
protected | property | An instance of the "CKEditor" text editor plugin. | |
CKEditorTest:: |
public static | property |
Modules to enable. Overrides DrupalUnitTestBase:: |
|
CKEditorTest:: |
protected | function | ||
CKEditorTest:: |
protected | function | ||
CKEditorTest:: |
protected | function | ||
CKEditorTest:: |
public static | function | ||
CKEditorTest:: |
function |
Sets up Drupal unit test environment. Overrides DrupalUnitTestBase:: |
||
CKEditorTest:: |
function | Tests CKEditor::buildContentsCssJSSetting(). | ||
CKEditorTest:: |
function | Tests CKEditor::buildToolbarJSSetting(). | ||
CKEditorTest:: |
function | Tests CKEditor::getJSSettings(). | ||
CKEditorTest:: |
function | Tests Internal::getConfig(). | ||
CKEditorTest:: |
function | Tests StylesCombo::getConfig(). | ||
DrupalUnitTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
private | property | ||
DrupalUnitTestBase:: |
public | function | Sets up the base service container for this test. | 1 |
DrupalUnitTestBase:: |
protected | function | Disables modules for this test. | |
DrupalUnitTestBase:: |
protected | function | Enables modules for this test. | |
DrupalUnitTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
DrupalUnitTestBase:: |
protected | function | Installs a specific table from a module schema definition. | |
DrupalUnitTestBase:: |
protected | function |
Deletes created files, database tables, and reverts all environment changes. Overrides TestBase:: |
2 |
DrupalUnitTestBase:: |
function |
Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase:: |
||
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The config importer that can used in a test. | 1 |
TestBase:: |
protected | property | The dependency injection container used in the test. | 1 |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | Flag to indicate whether the test has been set up. | |
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | ||
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Check to see if a value is false (an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false (not an empty string, 0, NULL, or FALSE). | |
TestBase:: |
protected | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 4 |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 1 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 1 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
protected | function | Create and set new configuration directories. | 1 |
TestBase:: |
protected | function | Generates a database prefix for running tests. | |
TestBase:: |
protected | function | Prepares the current environment for running the test. | |
TestBase:: |
public static | function | Generates a random string containing letters and numbers. | |
TestBase:: |
public static | function | Generates a random PHP object. | |
TestBase:: |
public static | function | Generates a random string of ASCII characters of codes 32 to 126. | |
TestBase:: |
protected | function | Rebuild drupal_container(). | 1 |
TestBase:: |
public | function | Run all tests in this class. | |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Logs verbose message in a text file. | |
UnitTestBase:: |
protected | property |