class CKEditor5UpdateImageToolbarItemTest
Same name in other branches
- 10 core/modules/ckeditor5/tests/src/Functional/Update/CKEditor5UpdateImageToolbarItemTest.php \Drupal\Tests\ckeditor5\Functional\Update\CKEditor5UpdateImageToolbarItemTest
- 11.x core/modules/ckeditor5/tests/src/Functional/Update/CKEditor5UpdateImageToolbarItemTest.php \Drupal\Tests\ckeditor5\Functional\Update\CKEditor5UpdateImageToolbarItemTest
Tests the update path for the CKEditor 5 image toolbar item.
@group Update
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\FunctionalTests\AssertLegacyTrait, \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\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\FunctionalTests\Update\UpdatePathTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\UpdatePathTestTrait
- class \Drupal\Tests\ckeditor5\Functional\Update\CKEditor5UpdateImageToolbarItemTest extends \Drupal\FunctionalTests\Update\UpdatePathTestBase uses \Drupal\Tests\ckeditor5\Traits\CKEditor5TestTrait
- class \Drupal\FunctionalTests\Update\UpdatePathTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\UpdatePathTestTrait
Expanded class hierarchy of CKEditor5UpdateImageToolbarItemTest
File
-
core/
modules/ ckeditor5/ tests/ src/ Functional/ Update/ CKEditor5UpdateImageToolbarItemTest.php, line 20
Namespace
Drupal\Tests\ckeditor5\Functional\UpdateView source
class CKEditor5UpdateImageToolbarItemTest extends UpdatePathTestBase {
use CKEditor5TestTrait;
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* {@inheritdoc}
*/
protected function setDatabaseDumpFiles() {
$this->databaseDumpFiles = [
__DIR__ . '/../../../../../system/tests/fixtures/update/drupal-9.3.0.bare.standard.php.gz',
__DIR__ . '/../../../fixtures/update/ckeditor5-3222756.php',
];
}
/**
* Tests that `uploadImage` toolbar item is updated to `drupalInsertImage`.
*
* @dataProvider provider
*/
public function test(bool $filter_html_is_enabled, bool $image_uploads_are_enabled, bool $source_editing_is_already_enabled, array $expected_source_editing_additions) : void {
// Apply tweaks for the currently provided test case.
$format = FilterFormat::load('test_format_image');
if (!$filter_html_is_enabled) {
$format->setFilterConfig('filter_html', [
'status' => FALSE,
]);
}
$editor = Editor::load('test_format_image');
if (!$image_uploads_are_enabled) {
$editor->setImageUploadSettings([
'status' => FALSE,
]);
}
if (!$source_editing_is_already_enabled) {
$settings = $editor->getSettings();
// Remove the `sourceEditing` toolbar item.
unset($settings['toolbar']['items'][3]);
// Remove the corresponding plugin settings (allowing `<img data-foo>`).
unset($settings['plugins']['ckeditor5_sourceEditing']);
$editor->setSettings($settings);
if ($filter_html_is_enabled) {
// Stop allowing `<img data-foo>`.
$filter_html_config = $format->filters('filter_html')
->getConfiguration();
$filter_html_config['settings']['allowed_html'] = str_replace('data-foo', '', $filter_html_config['settings']['allowed_html']);
$format->setFilterConfig('filter_html', $filter_html_config);
}
}
$format->trustData()
->save();
$editor->trustData()
->save();
// Run update path; snapshot the Text Format and Editor before and after.
$editor_before = Editor::load('test_format_image');
$filter_format_before = $editor->getFilterFormat();
$this->runUpdates();
$editor_after = Editor::load('test_format_image');
$filter_format_after = $editor->getFilterFormat();
// 1. Toolbar item: `uploadImage` -> `drupalInsertImage`, position must be
// unchanged.
$this->assertContains('uploadImage', $editor_before->getSettings()['toolbar']['items']);
$this->assertNotContains('drupalInsertImage', $editor_before->getSettings()['toolbar']['items']);
$this->assertNotContains('uploadImage', $editor_after->getSettings()['toolbar']['items']);
$this->assertContains('drupalInsertImage', $editor_after->getSettings()['toolbar']['items']);
$this->assertSame(array_search('uploadImage', $editor_before->getSettings()['toolbar']['items']), array_search('drupalInsertImage', $editor_after->getSettings()['toolbar']['items']));
// 2. Even though `sourceEditing` may not be enabled before this update, it
// must be after, at least if image uploads are disabled: extra mark-up will
// be added to its configuration to avoid breaking backwards compatibility.
if (!$image_uploads_are_enabled) {
if (!$source_editing_is_already_enabled) {
$this->assertNotContains('sourceEditing', $editor_before->getSettings()['toolbar']['items']);
}
$this->assertContains('sourceEditing', $editor_after->getSettings()['toolbar']['items']);
$source_editing_before = $source_editing_is_already_enabled ? static::getSourceEditingRestrictions($editor_before) : HTMLRestrictions::emptySet();
$source_editing_after = static::getSourceEditingRestrictions($editor_after);
if ($source_editing_is_already_enabled) {
// Nothing has been removed from the allowed source editing tags.
$this->assertFalse($source_editing_before->allowsNothing());
$this->assertTrue($source_editing_before->diff($source_editing_after)
->allowsNothing());
}
$this->assertSame($expected_source_editing_additions, $source_editing_after->diff($source_editing_before)
->toCKEditor5ElementsArray());
}
else {
if (!$source_editing_is_already_enabled) {
$this->assertNotContains('sourceEditing', $editor_before->getSettings()['toolbar']['items']);
}
else {
$this->assertContains('sourceEditing', $editor_before->getSettings()['toolbar']['items']);
$this->assertSame(static::getSourceEditingRestrictions($editor_before)->toCKEditor5ElementsArray(), static::getSourceEditingRestrictions($editor_after)->toCKEditor5ElementsArray());
}
}
// 3. `filter_html` restrictions MUST remain unchanged.
if ($filter_html_is_enabled) {
$filter_html_before = static::getFilterHtmlRestrictions($filter_format_before);
$filter_html_after = static::getFilterHtmlRestrictions($filter_format_after);
$this->assertTrue($filter_html_before->diff($filter_html_after)
->allowsNothing());
$this->assertTrue($filter_html_after->diff($filter_html_before)
->allowsNothing());
}
// 4. After: text format and editor still form a valid pair.
$this->assertSame([], array_map(function (ConstraintViolation $v) {
return (string) $v->getMessage();
}, iterator_to_array(CKEditor5::validatePair($editor_after, $filter_format_after))));
}
/**
* Data provider for ::test().
*
* @return array
* The test cases.
*/
public function provider() : array {
// There are 3 aspects that need to be verified, each can be true or false,
// making for 8 test cases in total.
$test_cases = [];
foreach ([
TRUE,
FALSE,
] as $filter_html_is_enabled) {
$test_case_label_part_one = sprintf("filter_html %s", $filter_html_is_enabled ? 'enabled' : 'disabled');
foreach ([
TRUE,
FALSE,
] as $image_uploads_enabled) {
$test_case_label_part_two = sprintf("image uploads %s", $image_uploads_enabled ? 'enabled' : 'disabled');
foreach ([
TRUE,
FALSE,
] as $source_editing_already_enabled) {
$test_case_label_part_three = sprintf("sourceEditing initially %s", $source_editing_already_enabled ? 'enabled' : 'disabled');
// Generate the test case.
$label = implode(', ', [
$test_case_label_part_one,
$test_case_label_part_two,
$test_case_label_part_three,
]);
$test_cases[$label] = [
'filter_html' => $filter_html_is_enabled,
'image uploads' => $image_uploads_enabled,
'sourceEditing already enabled' => $source_editing_already_enabled,
'expected sourceEditing additions' => $image_uploads_enabled ? [] : [
'<img data-entity-uuid data-entity-type>',
],
];
}
}
}
return $test_cases;
}
/**
* Gets the configured HTML restrictions for the Source Editing plugin.
*
* @param \Drupal\editor\EditorInterface $editor
* Text editor configured to use CKEditor 5, with Source Editing enabled.
*
* @return \Drupal\ckeditor5\HTMLRestrictions
* The configured HTML restrictions.
*/
private static function getSourceEditingRestrictions(EditorInterface $editor) : HTMLRestrictions {
$settings = $editor->getSettings();
$source_editing_allowed_tags = $settings['plugins']['ckeditor5_sourceEditing']['allowed_tags'];
return HTMLRestrictions::fromString(implode(' ', $source_editing_allowed_tags));
}
/**
* Gets the configured restrictions for the `filter_html` filter plugin.
*
* @param \Drupal\filter\FilterFormatInterface $format
* Text format configured to use `filter_html`.
*
* @return \Drupal\ckeditor5\HTMLRestrictions
* The configured HTML restrictions.
*/
private static function getFilterHtmlRestrictions(FilterFormatInterface $format) : HTMLRestrictions {
$allowed_html = $format->filters('filter_html')
->getConfiguration()['settings']['allowed_html'];
return HTMLRestrictions::fromString($allowed_html);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
AssertLegacyTrait::assert | Deprecated | protected | function | ||||
AssertLegacyTrait::assertCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was present in the last response. | |||
AssertLegacyTrait::assertElementNotPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is not present. | |||
AssertLegacyTrait::assertElementPresent | Deprecated | protected | function | Asserts that the element with the given CSS selector is present. | |||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertEscaped | Deprecated | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertField | Deprecated | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertLegacyTrait::assertFieldById | Deprecated | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertLegacyTrait::assertFieldByName | Deprecated | protected | function | Asserts that a field exists with the given name and value. | |||
AssertLegacyTrait::assertFieldByXPath | Deprecated | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertLegacyTrait::assertFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertLegacyTrait::assertFieldsByValue | Deprecated | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertLegacyTrait::assertHeader | Deprecated | protected | function | Checks that current response header equals value. | |||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | ||||
AssertLegacyTrait::assertLink | Deprecated | protected | function | Passes if a link with the specified label is found. | |||
AssertLegacyTrait::assertLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertLegacyTrait::assertNoCacheTag | Deprecated | protected | function | Asserts whether an expected cache tag was absent in the last response. | |||
AssertLegacyTrait::assertNoEscaped | Deprecated | protected | function | Passes if the raw text is not found escaped on the loaded page. | |||
AssertLegacyTrait::assertNoField | Deprecated | protected | function | Asserts that a field does NOT exist with the given name or ID. | |||
AssertLegacyTrait::assertNoFieldById | Deprecated | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertLegacyTrait::assertNoFieldByName | Deprecated | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertLegacyTrait::assertNoFieldByXPath | Deprecated | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertLegacyTrait::assertNoFieldChecked | Deprecated | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertLegacyTrait::assertNoLink | Deprecated | protected | function | Passes if a link with the specified label is not found. | |||
AssertLegacyTrait::assertNoLinkByHref | Deprecated | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertLegacyTrait::assertNoOption | Deprecated | protected | function | Asserts that a select option does NOT exist in the current page. | |||
AssertLegacyTrait::assertNoPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |||
AssertLegacyTrait::assertNoRaw | Deprecated | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoText | Deprecated | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | ||||
AssertLegacyTrait::assertNoUniqueText | Deprecated | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertLegacyTrait::assertOption | Deprecated | protected | function | Asserts that a select option in the current page exists. | |||
AssertLegacyTrait::assertOptionByText | Deprecated | protected | function | Asserts that a select option with the visible text exists. | |||
AssertLegacyTrait::assertOptionSelected | Deprecated | protected | function | Asserts that a select option in the current page is checked. | |||
AssertLegacyTrait::assertPattern | Deprecated | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertLegacyTrait::assertRaw | Deprecated | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertLegacyTrait::assertResponse | Deprecated | protected | function | Asserts the page responds with the specified response code. | |||
AssertLegacyTrait::assertText | Deprecated | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertLegacyTrait::assertTextHelper | Deprecated | protected | function | Helper for assertText and assertNoText. | |||
AssertLegacyTrait::assertTitle | Deprecated | protected | function | Pass if the page title is the given string. | |||
AssertLegacyTrait::assertUniqueText | Deprecated | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertLegacyTrait::assertUrl | Deprecated | protected | function | Passes if the internal browser's URL matches the given path. | |||
AssertLegacyTrait::buildXPathQuery | Deprecated | protected | function | Builds an XPath query. | |||
AssertLegacyTrait::constructFieldXpath | Deprecated | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertLegacyTrait::getAllOptions | Deprecated | protected | function | Get all option elements, including nested options, in a select. | |||
AssertLegacyTrait::getRawContent | Deprecated | protected | function | Gets the current raw content. | |||
AssertLegacyTrait::pass | Deprecated | protected | function | ||||
AssertLegacyTrait::verbose | Deprecated | protected | function | ||||
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::$htmlOutputFile | protected | property | The file name to write the list of URLs to. | ||||
BrowserHtmlDebugTrait::$htmlOutputTestId | protected | property | HTML output test ID. | ||||
BrowserHtmlDebugTrait::formatHtmlOutputHeaders | protected | function | Formats HTTP headers as string for HTML output logging. | ||||
BrowserHtmlDebugTrait::getHtmlOutputHeaders | protected | function | Returns headers in HTML output format. | 1 | |||
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::$customTranslations | protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | ||||
BrowserTestBase::$mink | protected | property | Mink session manager. | ||||
BrowserTestBase::$minkDefaultDriverArgs | protected | property | Mink default driver params. | ||||
BrowserTestBase::$minkDefaultDriverClass | protected | property | Mink class for the default driver to use. | 1 | |||
BrowserTestBase::$originalContainer | protected | property | The original container. | ||||
BrowserTestBase::$originalShutdownCallbacks | protected | property | The original array of shutdown function callbacks. | ||||
BrowserTestBase::$preserveGlobalState | protected | property | |||||
BrowserTestBase::$profile | protected | property | The profile to install as a basis for testing. | 37 | |||
BrowserTestBase::$runTestInSeparateProcess | protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. |
||||
BrowserTestBase::$timeLimit | protected | property | Time limit in seconds for the test. | ||||
BrowserTestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | ||||
BrowserTestBase::cleanupEnvironment | protected | function | Clean up the Simpletest environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
BrowserTestBase::drupalGetHeader | Deprecated | protected | function | Gets the value of an HTTP response header. | |||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | ||||
BrowserTestBase::getDrupalSettings | protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 | |||
BrowserTestBase::getHttpClient | protected | function | Obtain the HTTP client for the system under test. | ||||
BrowserTestBase::getMinkDriverArgs | protected | function | Gets the Mink driver args from an environment variable. | 1 | |||
BrowserTestBase::getOptions | 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::initMink | protected | function | Initializes Mink sessions. | 1 | |||
BrowserTestBase::registerSessions | protected | function | Registers additional Mink sessions. | ||||
BrowserTestBase::setUpAppRoot | protected | function | Sets up the root application path. | ||||
BrowserTestBase::setUpBeforeClass | public static | function | 1 | ||||
BrowserTestBase::tearDown | protected | function | 3 | ||||
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::__sleep | public | function | Prevents serializing any properties. | ||||
CKEditor5TestTrait::assertEditorButtonDisabled | protected | function | Asserts a CKEditor button is disabled. | ||||
CKEditor5TestTrait::assertEditorButtonEnabled | protected | function | Asserts a CKEditor button is enabled. | ||||
CKEditor5TestTrait::assertVisibleBalloon | protected | function | Asserts a particular balloon is visible. | ||||
CKEditor5TestTrait::getBalloonButton | protected | function | Gets a button from the currently visible balloon. | ||||
CKEditor5TestTrait::getEditorButton | protected | function | Waits for a CKEditor button and returns it when available and visible. | ||||
CKEditor5TestTrait::getEditorDataAsDom | protected | function | Gets CKEditor 5 instance data as a PHP DOMDocument. | ||||
CKEditor5TestTrait::getEditorDataAsHtmlString | protected | function | Gets CKEditor 5 instance data as a HTML string. | ||||
CKEditor5TestTrait::pressEditorButton | protected | function | Clicks a CKEditor button. | ||||
CKEditor5TestTrait::selectTextInsideElement | protected | function | Selects text inside an element. | ||||
CKEditor5TestTrait::waitForEditor | protected | function | Waits for CKEditor to initialize. | ||||
CKEditor5UpdateImageToolbarItemTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
CKEditor5UpdateImageToolbarItemTest::getFilterHtmlRestrictions | private static | function | Gets the configured restrictions for the `filter_html` filter plugin. | ||||
CKEditor5UpdateImageToolbarItemTest::getSourceEditingRestrictions | private static | function | Gets the configured HTML restrictions for the Source Editing plugin. | ||||
CKEditor5UpdateImageToolbarItemTest::provider | public | function | Data provider for ::test(). | ||||
CKEditor5UpdateImageToolbarItemTest::setDatabaseDumpFiles | protected | function | Set database dump files to be used. | Overrides UpdatePathTestBase::setDatabaseDumpFiles | |||
CKEditor5UpdateImageToolbarItemTest::test | public | function | Tests that `uploadImage` toolbar item is updated to `drupalInsertImage`. | ||||
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 | ||
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::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | ||||
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. | ||||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 22 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
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 | |||
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. | ||||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 1 | |||
RequirementsPageTrait::assertErrorSummaries | protected | function | Asserts the given error summaries are present on the page. | ||||
RequirementsPageTrait::assertRequirementSummaries | protected | function | Asserts the given requirements section summaries are present on the page. | ||||
RequirementsPageTrait::assertWarningSummaries | protected | function | Asserts the given warning summaries are present on the page. | ||||
RequirementsPageTrait::continueOnExpectedWarnings | protected | function | Continues installation when the expected warnings are found. | ||||
RequirementsPageTrait::updateRequirementsProblem | protected | function | Handles the update requirements page. | ||||
SchemaCheckTestTrait::assertConfigSchema | public | function | Asserts the TypedConfigManager has a valid schema for the configuration. | ||||
SchemaCheckTestTrait::assertConfigSchemaByName | public | function | Asserts configuration, specified by name, has a valid schema. | ||||
SchemaCheckTrait::$configName | protected | property | The configuration object name under test. | ||||
SchemaCheckTrait::$schema | protected | property | The config schema wrapper object for the configuration object under test. | ||||
SchemaCheckTrait::checkConfigSchema | public | function | Checks the TypedConfigManager has a valid schema for the configuration. | ||||
SchemaCheckTrait::checkValue | protected | function | Helper method to check data type. | ||||
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::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. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 1 | |||
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::$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::getDatabaseConnection | public static | function | Returns the database connection to the site running Simpletest. | ||||
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::assertSession | public | function | Returns WebAssert object. | 1 | |||
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. | 2 | |||
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::drupalPostForm | Deprecated | protected | function | Executes a form submission. | |||
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. | ||||
UpdatePathTestBase::$databaseDumpFiles | protected | property | The file path(s) to the dumped database(s) to load into the child site. | ||||
UpdatePathTestBase::$loadedModules | protected | property | Array of modules loaded when the test starts. | ||||
UpdatePathTestBase::$modules | protected static | property | Modules to enable after the database is loaded. | Overrides BrowserTestBase::$modules | 4 | ||
UpdatePathTestBase::$pendingUpdates | protected | property | Flag to indicate whether there are pending updates or not. | ||||
UpdatePathTestBase::$strictConfigSchema | protected | property | Disable strict config schema checking. | Overrides TestSetupTrait::$strictConfigSchema | |||
UpdatePathTestBase::$updateUrl | protected | property | The update URL. | ||||
UpdatePathTestBase::$upgradedSite | protected | property | Flag that indicates whether the child site has been updated. | ||||
UpdatePathTestBase::$upgradeErrors | protected | property | Array of errors triggered during the update process. | ||||
UpdatePathTestBase::$zlibInstalled | protected | property | Flag to indicate whether zlib is installed or not. | ||||
UpdatePathTestBase::doInstall | protected | function | Execute the non-interactive installer. | Overrides FunctionalTestSetupTrait::doInstall | |||
UpdatePathTestBase::initFrontPage | protected | function | Visits the front page when initializing Mink. | Overrides BrowserTestBase::initFrontPage | |||
UpdatePathTestBase::installDrupal | public | function | Installs Drupal into the Simpletest site. | Overrides BrowserTestBase::installDrupal | |||
UpdatePathTestBase::prepareSettings | protected | function | Add settings that are missed since the installer isn't run. | Overrides FunctionalTestSetupTrait::prepareSettings | 1 | ||
UpdatePathTestBase::replaceUser1 | protected | function | Replace User 1 with the user created here. | 1 | |||
UpdatePathTestBase::runDbTasks | protected | function | Runs the install database tasks for the driver used by the test runner. | 1 | |||
UpdatePathTestBase::runUpdates | protected | function | Helper function to run pending database updates. | ||||
UpdatePathTestBase::setUp | protected | function | Overrides BrowserTestBase::setUp() for update testing. | Overrides BrowserTestBase::setUp | |||
UpdatePathTestTrait::$checkFailedUpdates | protected | property | Fail the test if there are failed updates. | ||||
UpdatePathTestTrait::doSelectionTest | protected | function | Tests the selection page. | 5 | |||
UpdatePathTestTrait::ensureUpdatesToRun | protected | function | Installs the update_script_test module and makes an update available. | ||||
UpdatePathTestTrait::runUpdates | protected | function | Helper function to run pending database updates. | Aliased as: doRunUpdates | |||
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 | |||
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. | ||||
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.