class ImageAdminStylesTest
Same name in this branch
- 10 core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
Same name in other branches
- 9 core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
- 9 core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest
- 8.9.x core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
- 8.9.x core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest
- 11.x core/modules/image/tests/src/FunctionalJavascript/ImageAdminStylesTest.php \Drupal\Tests\image\FunctionalJavascript\ImageAdminStylesTest
- 11.x core/modules/image/tests/src/Functional/ImageAdminStylesTest.php \Drupal\Tests\image\Functional\ImageAdminStylesTest
Tests creation, deletion, and editing of image styles and effects.
@group image @group #slow
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\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\Tests\image\Functional\ImageFieldTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\image\Kernel\ImageFieldCreationTrait
- class \Drupal\Tests\image\Functional\ImageAdminStylesTest extends \Drupal\Tests\image\Functional\ImageFieldTestBase uses \Drupal\Tests\TestFileCreationTrait
- class \Drupal\Tests\image\Functional\ImageFieldTestBase extends \Drupal\Tests\BrowserTestBase uses \Drupal\Tests\image\Kernel\ImageFieldCreationTrait
Expanded class hierarchy of ImageAdminStylesTest
File
-
core/
modules/ image/ tests/ src/ Functional/ ImageAdminStylesTest.php, line 21
Namespace
Drupal\Tests\image\FunctionalView source
class ImageAdminStylesTest extends ImageFieldTestBase {
use TestFileCreationTrait {
getTestFiles as drupalGetTestFiles;
compareFiles as drupalCompareFiles;
}
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* Given an image style, generate an image.
*/
public function createSampleImage(ImageStyleInterface $style) {
static $file_path;
// First, we need to make sure we have an image in our testing
// file directory. Copy over an image on the first run.
if (!isset($file_path)) {
$files = $this->drupalGetTestFiles('image');
$file = reset($files);
$file_path = \Drupal::service('file_system')->copy($file->uri, 'public://');
}
return $style->buildUrl($file_path) ? $file_path : FALSE;
}
/**
* Count the number of images currently create for a style.
*/
public function getImageCount(ImageStyleInterface $style) {
$count = 0;
if (is_dir('public://styles/' . $style->id())) {
$count = count(\Drupal::service('file_system')->scanDirectory('public://styles/' . $style->id(), '/.*/'));
}
return $count;
}
/**
* Tests creating an image style with a numeric name.
*/
public function testNumericStyleName() : void {
$style_name = rand();
$style_label = $this->randomString();
$edit = [
'name' => $style_name,
'label' => $style_label,
];
$this->drupalGet('admin/config/media/image-styles/add');
$this->submitForm($edit, 'Create new style');
$this->assertSession()
->statusMessageContains("Style {$style_label} was created.", 'status');
$options = image_style_options();
$this->assertArrayHasKey($style_name, $options);
}
/**
* General test to add a style, add/remove/edit effects to it, then delete it.
*/
public function testStyle() : void {
$admin_path = 'admin/config/media/image-styles';
// Setup a style to be created and effects to add to it.
$style_name = $this->randomMachineName(10);
$style_label = $this->randomString();
$style_path = $admin_path . '/manage/' . $style_name;
$effect_edits = [
'image_resize' => [
'width' => 100,
'height' => 101,
],
'image_scale' => [
'width' => 110,
'height' => 111,
'upscale' => 1,
],
'image_scale_and_crop' => [
'width' => 120,
'height' => 121,
],
'image_crop' => [
'width' => 130,
'height' => 131,
'anchor' => 'left-top',
],
'image_desaturate' => [],
'image_rotate' => [
'degrees' => 5,
'random' => 1,
'bgcolor' => '#FFFF00',
],
];
// Add style form.
$edit = [
'name' => $style_name,
'label' => $style_label,
];
$this->drupalGet($admin_path . '/add');
$this->submitForm($edit, 'Create new style');
$this->assertSession()
->statusMessageContains("Style {$style_label} was created.", 'status');
// Ensure that the expected entity operations are there.
$this->drupalGet($admin_path);
$this->assertSession()
->linkByHrefExists($style_path);
$this->assertSession()
->linkByHrefExists($style_path . '/flush');
$this->assertSession()
->linkByHrefExists($style_path . '/delete');
// Add effect form.
// Add each sample effect to the style.
foreach ($effect_edits as $effect => $edit) {
$edit_data = [];
foreach ($edit as $field => $value) {
$edit_data['data[' . $field . ']'] = $value;
}
// Add the effect.
$this->drupalGet($style_path);
$this->submitForm([
'new' => $effect,
], 'Add');
if (!empty($edit)) {
$effect_label = \Drupal::service('plugin.manager.image.effect')->createInstance($effect)
->label();
$this->assertSession()
->pageTextContains("Add {$effect_label} effect to style {$style_label}");
$this->submitForm($edit_data, 'Add effect');
}
}
// Load the saved image style.
$style = ImageStyle::load($style_name);
// Ensure that third party settings were added to the config entity.
// These are added by a hook_image_style_presave() implemented in
// image_module_test module.
$this->assertEquals('bar', $style->getThirdPartySetting('image_module_test', 'foo'), 'Third party settings were added to the image style.');
// Ensure that the image style URI matches our expected path.
$style_uri_path = $style->toUrl()
->toString();
$this->assertStringContainsString($style_path, $style_uri_path, 'The image style URI is correct.');
// Confirm that all effects on the image style have settings that match
// what was saved.
$uuids = [];
foreach ($style->getEffects() as $uuid => $effect) {
// Store the uuid for later use.
$uuids[$effect->getPluginId()] = $uuid;
$effect_configuration = $effect->getConfiguration();
foreach ($effect_edits[$effect->getPluginId()] as $field => $value) {
$this->assertEquals($effect_configuration['data'][$field], $value, "The {$field} field in the {$effect->getPluginId()} effect has the correct value of {$value}.");
}
}
// Assert that every effect was saved.
foreach (array_keys($effect_edits) as $effect_name) {
$this->assertTrue(isset($uuids[$effect_name]), "A {$effect_name} effect was saved with ID {$uuids[$effect_name]}");
}
// Image style overview form (ordering and renaming).
// Confirm the order of effects is maintained according to the order we
// added the fields.
$effect_edits_order = array_keys($effect_edits);
$order_correct = TRUE;
$index = 0;
foreach ($style->getEffects() as $effect) {
if ($effect_edits_order[$index] != $effect->getPluginId()) {
$order_correct = FALSE;
}
$index++;
}
$this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
// Test the style overview form.
// Change the name of the style and adjust the weights of effects.
$style_name = $this->randomMachineName(10);
$style_label = $this->randomMachineName();
$weight = count($effect_edits);
$edit = [
'name' => $style_name,
'label' => $style_label,
];
foreach ($style->getEffects() as $uuid => $effect) {
$edit['effects[' . $uuid . '][weight]'] = $weight;
$weight--;
}
// Create an image to make sure it gets flushed after saving.
$image_path = $this->createSampleImage($style);
$this->assertEquals(1, $this->getImageCount($style), "Image style {$style->label()} image {$image_path} successfully generated.");
$this->drupalGet($style_path);
$this->submitForm($edit, 'Save');
// Note that after changing the style name, the style path is changed.
$style_path = 'admin/config/media/image-styles/manage/' . $style_name;
// Check that the URL was updated.
$this->drupalGet($style_path);
$this->assertSession()
->titleEquals("Edit style {$style_label} | Drupal");
// Check that the available image effects are properly sorted.
$option = $this->assertSession()
->selectExists('edit-new--2')
->findAll('css', 'option');
$this->assertEquals('Ajax test', $option[1]->getText(), '"Ajax test" is the first selectable effect.');
// Check that the image was flushed after updating the style.
// This is especially important when renaming the style. Make sure that
// the old image directory has been deleted.
$this->assertEquals(0, $this->getImageCount($style), "Image style {$style->label()} was flushed after renaming the style and updating the order of effects.");
// Load the style by the new name with the new weights.
$style = ImageStyle::load($style_name);
// Confirm the new style order was saved.
$effect_edits_order = array_reverse($effect_edits_order);
$order_correct = TRUE;
$index = 0;
foreach ($style->getEffects() as $effect) {
if ($effect_edits_order[$index] != $effect->getPluginId()) {
$order_correct = FALSE;
}
$index++;
}
$this->assertTrue($order_correct, 'The order of the effects is correctly set by default.');
// Image effect deletion form.
// Create an image to make sure it gets flushed after deleting an effect.
$image_path = $this->createSampleImage($style);
$this->assertEquals(1, $this->getImageCount($style), "Image style {$style->label()} image {$image_path} successfully generated.");
// Delete the 'image_crop' effect from the style.
$this->drupalGet($style_path . '/effects/' . $uuids['image_crop'] . '/delete');
$this->submitForm([], 'Delete');
// Confirm that the form submission was successful.
$this->assertSession()
->statusCodeEquals(200);
$image_crop_effect = $style->getEffect($uuids['image_crop']);
$this->assertSession()
->statusMessageContains("The image effect {$image_crop_effect->label()} has been deleted.", 'status');
// Confirm that there is no longer a link to the effect.
$this->assertSession()
->linkByHrefNotExists($style_path . '/effects/' . $uuids['image_crop'] . '/delete');
// Refresh the image style information and verify that the effect was
// actually deleted.
$entity_type_manager = $this->container
->get('entity_type.manager');
$style = $entity_type_manager->getStorage('image_style')
->loadUnchanged($style->id());
$this->assertFalse($style->getEffects()
->has($uuids['image_crop']), "Effect with ID {$uuids['image_crop']} no longer found on image style {$style->label()}");
// Additional test on Rotate effect, for transparent background.
$edit = [
'data[degrees]' => 5,
'data[random]' => 0,
'data[bgcolor]' => '',
];
$this->drupalGet($style_path);
$this->submitForm([
'new' => 'image_rotate',
], 'Add');
$this->submitForm($edit, 'Add effect');
$entity_type_manager = $this->container
->get('entity_type.manager');
$style = $entity_type_manager->getStorage('image_style')
->loadUnchanged($style_name);
$this->assertCount(6, $style->getEffects(), 'Rotate effect with transparent background was added.');
// Style deletion form.
// Delete the style.
$this->drupalGet($style_path . '/delete');
$this->submitForm([], 'Delete');
// Confirm the style directory has been removed.
$directory = 'public://styles/' . $style_name;
$this->assertDirectoryDoesNotExist($directory);
$this->assertNull(ImageStyle::load($style_name), "Image style {$style->label()} successfully deleted.");
// Test empty text when there are no image styles.
// Delete all image styles.
foreach (ImageStyle::loadMultiple() as $image_style) {
$image_style->delete();
}
// Confirm that the empty text is correct on the image styles page.
$this->drupalGet($admin_path);
$this->assertSession()
->pageTextContains("There are currently no styles. Add a new one.");
$this->assertSession()
->linkByHrefExists(Url::fromRoute('image.style_add')->toString());
}
/**
* Tests deleting a style and choosing a replacement style.
*/
public function testStyleReplacement() : void {
// Create a new style.
$style_name = $this->randomMachineName(10);
$style_label = $this->randomString();
$style = ImageStyle::create([
'name' => $style_name,
'label' => $style_label,
]);
$style->save();
$style_path = 'admin/config/media/image-styles/manage/';
// Create an image field that uses the new style.
$field_name = $this->randomMachineName(10);
$this->createImageField($field_name, 'node', 'article');
\Drupal::service('entity_display.repository')->getViewDisplay('node', 'article')
->setComponent($field_name, [
'type' => 'image',
'settings' => [
'image_style' => $style_name,
],
])
->save();
// Create a new node with an image attached.
$test_image = current($this->drupalGetTestFiles('image'));
$nid = $this->uploadNodeImage($test_image, $field_name, 'article', $this->randomMachineName());
$node = Node::load($nid);
// Get node field original image URI.
$fid = $node->get($field_name)->target_id;
$original_uri = File::load($fid)->getFileUri();
// Test that image is displayed using newly created style.
/** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
$file_url_generator = \Drupal::service('file_url_generator');
$this->drupalGet('node/' . $nid);
$this->assertSession()
->responseContains($file_url_generator->transformRelative($style->buildUrl($original_uri)));
// Rename the style and make sure the image field is updated.
$new_style_name = $this->randomMachineName(10);
$new_style_label = $this->randomString();
$edit = [
'name' => $new_style_name,
'label' => $new_style_label,
];
$this->drupalGet($style_path . $style_name);
$this->submitForm($edit, 'Save');
$this->assertSession()
->statusMessageContains('Changes to the style have been saved.', 'status');
$this->drupalGet('node/' . $nid);
// Reload the image style using the new name.
$style = ImageStyle::load($new_style_name);
$this->assertSession()
->responseContains($file_url_generator->transformRelative($style->buildUrl($original_uri)));
// Delete the style and choose a replacement style.
$edit = [
'replacement' => 'thumbnail',
];
$this->drupalGet($style_path . $new_style_name . '/delete');
$this->submitForm($edit, 'Delete');
$this->assertSession()
->statusMessageContains("The image style {$new_style_label} has been deleted.", 'status');
$replacement_style = ImageStyle::load('thumbnail');
$this->drupalGet('node/' . $nid);
$this->assertSession()
->responseContains($file_url_generator->transformRelative($replacement_style->buildUrl($original_uri)));
}
/**
* Verifies that editing an image effect does not cause it to be duplicated.
*/
public function testEditEffect() : void {
// Add a scale effect.
$style_name = 'test_style_effect_edit';
$this->drupalGet('admin/config/media/image-styles/add');
$this->submitForm([
'label' => 'Test style effect edit',
'name' => $style_name,
], 'Create new style');
$this->submitForm([
'new' => 'image_scale_and_crop',
], 'Add');
$this->submitForm([
'data[width]' => '300',
'data[height]' => '200',
], 'Add effect');
$this->assertSession()
->pageTextContains('Scale and crop 300×200');
// There should normally be only one edit link on this page initially.
$this->clickLink('Edit');
$this->assertSession()
->pageTextContains("Edit Scale and crop effect on style Test style effect edit");
$this->submitForm([
'data[width]' => '360',
'data[height]' => '240',
], 'Update effect');
$this->assertSession()
->pageTextContains('Scale and crop 360×240');
// Check that the previous effect is replaced.
$this->assertSession()
->pageTextNotContains('Scale and crop 300×200');
// Add another scale effect.
$this->drupalGet('admin/config/media/image-styles/add');
$this->submitForm([
'label' => 'Test style scale edit scale',
'name' => 'test_style_scale_edit_scale',
], 'Create new style');
$this->submitForm([
'new' => 'image_scale',
], 'Add');
$this->submitForm([
'data[width]' => '12',
'data[height]' => '19',
], 'Add effect');
// Edit the scale effect that was just added.
$this->clickLink('Edit');
$this->assertSession()
->pageTextContains("Edit Scale effect on style Test style scale edit scale");
$this->submitForm([
'data[width]' => '24',
'data[height]' => '19',
], 'Update effect');
// Add another scale effect and make sure both exist. Click through from
// the overview to make sure that it is possible to add new effect then.
$this->drupalGet('admin/config/media/image-styles');
$rows = $this->xpath('//table/tbody/tr');
$i = 0;
foreach ($rows as $row) {
if ($row->find('css', 'td')
->getText() === 'Test style scale edit scale') {
$this->clickLink('Edit', $i);
break;
}
$i++;
}
$this->submitForm([
'new' => 'image_scale',
], 'Add');
$this->submitForm([
'data[width]' => '12',
'data[height]' => '19',
], 'Add effect');
$this->assertSession()
->pageTextContains('Scale 24×19');
$this->assertSession()
->pageTextContains('Scale 12×19');
// Try to edit a nonexistent effect.
$uuid = $this->container
->get('uuid');
$this->drupalGet('admin/config/media/image-styles/manage/' . $style_name . '/effects/' . $uuid->generate());
$this->assertSession()
->statusCodeEquals(404);
}
/**
* Tests flush user interface.
*/
public function testFlushUserInterface() : void {
$admin_path = 'admin/config/media/image-styles';
// Create a new style.
$style_name = $this->randomMachineName(10);
$style = ImageStyle::create([
'name' => $style_name,
'label' => $this->randomString(),
]);
$style->save();
// Create an image to make sure it gets flushed.
$files = $this->drupalGetTestFiles('image');
$image_uri = $files[0]->uri;
$derivative_uri = $style->buildUri($image_uri);
$this->assertTrue($style->createDerivative($image_uri, $derivative_uri));
$this->assertEquals(1, $this->getImageCount($style));
// Go to image styles list page and check if the flush operation link
// exists.
$this->drupalGet($admin_path);
$flush_path = $admin_path . '/manage/' . $style_name . '/flush';
$this->assertSession()
->linkByHrefExists($flush_path);
// Flush the image style derivatives using the user interface.
$this->drupalGet($flush_path);
$this->submitForm([], 'Flush');
// The derivative image file should have been deleted.
$this->assertEquals(0, $this->getImageCount($style));
}
/**
* Tests image style configuration import that does a delete.
*/
public function testConfigImport() : void {
// Create a new style.
$style_name = $this->randomMachineName(10);
$style_label = $this->randomString();
$style = ImageStyle::create([
'name' => $style_name,
'label' => $style_label,
]);
$style->save();
// Create an image field that uses the new style.
$field_name = $this->randomMachineName(10);
$this->createImageField($field_name, 'node', 'article');
\Drupal::service('entity_display.repository')->getViewDisplay('node', 'article')
->setComponent($field_name, [
'type' => 'image',
'settings' => [
'image_style' => $style_name,
],
])
->save();
// Create a new node with an image attached.
$test_image = current($this->drupalGetTestFiles('image'));
$nid = $this->uploadNodeImage($test_image, $field_name, 'article', $this->randomMachineName());
$node = Node::load($nid);
// Get node field original image URI.
$fid = $node->get($field_name)->target_id;
$original_uri = File::load($fid)->getFileUri();
// Test that image is displayed using newly created style.
$this->drupalGet('node/' . $nid);
$this->assertSession()
->responseContains(\Drupal::service('file_url_generator')->transformRelative($style->buildUrl($original_uri)));
// Copy config to sync, and delete the image style.
$sync = $this->container
->get('config.storage.sync');
$active = $this->container
->get('config.storage');
// Remove the image field from the display, to avoid a dependency error
// during import.
EntityViewDisplay::load('node.article.default')->removeComponent($field_name)
->save();
$this->copyConfig($active, $sync);
$sync->delete('image.style.' . $style_name);
$this->configImporter()
->import();
$this->assertNull(ImageStyle::load($style_name), 'Style deleted after config import.');
$this->assertEquals(0, $this->getImageCount($style), 'Image style was flushed after being deleted by config import.');
}
/**
* Tests access for the image style listing.
*/
public function testImageStyleAccess() : void {
$style = ImageStyle::create([
'name' => 'style_foo',
'label' => $this->randomString(),
]);
$style->save();
$this->drupalGet('admin/config/media/image-styles');
$this->clickLink('Edit');
$this->assertSession()
->pageTextContains("Select a new effect");
}
/**
* Tests the display of preview images using a private scheme.
*/
public function testPreviewImageShowInPrivateScheme() : void {
$this->config('system.file')
->set('default_scheme', 'private')
->save();
/** @var \Drupal\Core\File\FileUrlGeneratorInterface $file_url_generator */
$file_url_generator = \Drupal::service('file_url_generator');
// Get the original preview image file in core config.
$original_path = $this->config('image.settings')
->get('preview_image');
$style = ImageStyle::create([
'name' => 'test_foo',
'label' => 'test foo',
]);
$style->save();
// Build the derivative preview image file with the Image Style.
// @see template_preprocess_image_style_preview()
$preview_file = $style->buildUri($original_path);
$style->createDerivative($original_path, $preview_file);
// Check if the derivative image exists.
$this->assertFileExists($preview_file);
// Generate itok token for the preview image.
$itok = $style->getPathToken('private://' . $original_path);
$url = $file_url_generator->generateAbsoluteString($preview_file);
$url .= '?itok=' . $itok;
// Check if the preview image with style is shown.
$this->drupalGet($url);
$this->assertSession()
->statusCodeEquals(200);
$this->assertSession()
->responseHeaderContains('Content-Type', 'image/png');
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | |||
BrowserHtmlDebugTrait::$htmlOutputBaseUrl | protected | property | The Base URI to use for links to the output files. | ||||
BrowserHtmlDebugTrait::$htmlOutputClassName | protected | property | Class name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounter | protected | property | Counter for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounterStorage | protected | property | Counter storage for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputDirectory | protected | property | Directory name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputEnabled | protected | property | HTML output enabled. | ||||
BrowserHtmlDebugTrait::$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 SettingsEditor::rewrite(). | ||||
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. | 40 | |||
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 test environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | ||||
BrowserTestBase::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::initFrontPage | protected | function | Visits the front page when initializing Mink. | 3 | |||
BrowserTestBase::initMink | protected | function | Initializes Mink sessions. | 1 | |||
BrowserTestBase::installDrupal | public | function | Installs Drupal into the test site. | 2 | |||
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::__get | public | function | |||||
BrowserTestBase::__sleep | public | function | Prevents serializing any properties. | ||||
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::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 10 | |||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 2 | |||
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. | 1 | |||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when the test installs Drupal. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 28 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 4 | |||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | ||||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | ||||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | ||||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | ||||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | ||||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | 1 | |||
ImageAdminStylesTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
ImageAdminStylesTest::createSampleImage | public | function | Given an image style, generate an image. | ||||
ImageAdminStylesTest::getImageCount | public | function | Count the number of images currently create for a style. | ||||
ImageAdminStylesTest::testConfigImport | public | function | Tests image style configuration import that does a delete. | ||||
ImageAdminStylesTest::testEditEffect | public | function | Verifies that editing an image effect does not cause it to be duplicated. | ||||
ImageAdminStylesTest::testFlushUserInterface | public | function | Tests flush user interface. | ||||
ImageAdminStylesTest::testImageStyleAccess | public | function | Tests access for the image style listing. | ||||
ImageAdminStylesTest::testNumericStyleName | public | function | Tests creating an image style with a numeric name. | ||||
ImageAdminStylesTest::testPreviewImageShowInPrivateScheme | public | function | Tests the display of preview images using a private scheme. | ||||
ImageAdminStylesTest::testStyle | public | function | General test to add a style, add/remove/edit effects to it, then delete it. | ||||
ImageAdminStylesTest::testStyleReplacement | public | function | Tests deleting a style and choosing a replacement style. | ||||
ImageFieldCreationTrait::createImageField | protected | function | Create a new image field. | ||||
ImageFieldTestBase::$adminUser | protected | property | A user with permissions to administer content types and image styles. | ||||
ImageFieldTestBase::$modules | protected static | property | Modules to install. | Overrides BrowserTestBase::$modules | 4 | ||
ImageFieldTestBase::getLastFileId | protected | function | Retrieves the fid of the last inserted file. | ||||
ImageFieldTestBase::previewNodeImage | public | function | Preview an image in a node. | ||||
ImageFieldTestBase::setUp | protected | function | Overrides BrowserTestBase::setUp | 3 | |||
ImageFieldTestBase::uploadNodeImage | public | function | Upload an image to a node. | ||||
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::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 | Deprecated | public | function | Callback for random string validation. | |||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 2 | |||
SessionTestTrait::$sessionName | protected | property | The name of the session cookie. | ||||
SessionTestTrait::generateSessionName | protected | function | Generates a session cookie name. | ||||
SessionTestTrait::getSessionName | protected | function | Returns the session name in use on the child site. | ||||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||||
TestFileCreationTrait::$generatedTestFiles | protected | property | Whether the files were copied to the test files directory. | ||||
TestFileCreationTrait::compareFiles | protected | function | Compares two files based on size and file name. | Aliased as: drupalCompareFiles | |||
TestFileCreationTrait::generateFile | public static | function | Generates a test file. | ||||
TestFileCreationTrait::getTestFiles | protected | function | Gets a list of files that can be used in tests. | Aliased as: drupalGetTestFiles | |||
TestRequirementsTrait::checkModuleRequirements | Deprecated | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | Deprecated | 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. | 2 | |||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$databasePrefix | protected | property | The database prefix of this test run. | ||||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | ||||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | ||||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | ||||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | ||||
TestSetupTrait::$root | protected | property | The app root. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 4 | |||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | ||||
TestSetupTrait::$testId | protected | property | The test run ID. | ||||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||||
TestSetupTrait::getDatabaseConnection | Deprecated | public static | function | Returns the database connection to the site under test. | |||
TestSetupTrait::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | 1 | |||
UiHelperTrait::$loggedInUser | protected | property | The current user logged in using the Mink controlled browser. | ||||
UiHelperTrait::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | ||||
UiHelperTrait::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | ||||
UiHelperTrait::$useOneTimeLoginLinks | protected | property | Use one-time login links instead of submitting the login form. | 3 | |||
UiHelperTrait::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. | 3 | |||
UiHelperTrait::drupalLogin | protected | function | Logs in a user using the Mink controlled browser. | ||||
UiHelperTrait::drupalLogout | protected | function | Logs a user out of the Mink controlled browser and confirms. | ||||
UiHelperTrait::drupalResetSession | protected | function | Resets the current active session back to Anonymous session. | ||||
UiHelperTrait::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | ||||
UiHelperTrait::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||||
UiHelperTrait::getTextContent | protected | function | Retrieves the plain-text content from the current page. | ||||
UiHelperTrait::getUrl | protected | function | Get the current URL from the browser. | ||||
UiHelperTrait::isTestUsingGuzzleClient | protected | function | Determines if test is using DrupalTestBrowser. | ||||
UiHelperTrait::prepareRequest | protected | function | Prepare for a request to testing site. | 1 | |||
UiHelperTrait::submitForm | protected | function | Fills and submits a form. | ||||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | ||||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | ||||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | |||
UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | |||
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.