class EditorFileUsageTest

Same name in other branches
  1. 9 core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php \Drupal\Tests\editor\Kernel\EditorFileUsageTest
  2. 8.9.x core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php \Drupal\Tests\editor\Kernel\EditorFileUsageTest
  3. 11.x core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php \Drupal\Tests\editor\Kernel\EditorFileUsageTest

Tests tracking of file usage by the Text Editor module.

@group editor

Hierarchy

Expanded class hierarchy of EditorFileUsageTest

File

core/modules/editor/tests/src/Kernel/EditorFileUsageTest.php, line 22

Namespace

Drupal\Tests\editor\Kernel
View source
class EditorFileUsageTest extends EntityKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'editor',
        'editor_test',
        'node',
        'file',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('file');
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installSchema('file', [
            'file_usage',
        ]);
        $this->installConfig([
            'node',
        ]);
        // Add text formats.
        $filtered_html_format = FilterFormat::create([
            'format' => 'filtered_html',
            'name' => 'Filtered HTML',
            'weight' => 0,
            'filters' => [],
        ]);
        $filtered_html_format->save();
        // Set cardinality for body field.
        FieldStorageConfig::loadByName('node', 'body')->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
            ->save();
        // Set up text editor.
        $editor = Editor::create([
            'format' => 'filtered_html',
            'editor' => 'unicorn',
        ]);
        $editor->save();
        // Create a node type for testing.
        $type = NodeType::create([
            'type' => 'page',
            'name' => 'page',
        ]);
        $type->save();
        node_add_body_field($type);
        FieldStorageConfig::create([
            'field_name' => 'description',
            'entity_type' => 'node',
            'type' => 'editor_test_text_long',
            'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
        ])->save();
        FieldConfig::create([
            'field_name' => 'description',
            'entity_type' => 'node',
            'bundle' => 'page',
            'label' => 'Description',
        ])->save();
    }
    
    /**
     * Tests file save operations when node with referenced files is saved.
     */
    public function testFileSaveOperations() : void {
        $permanent_image = File::create([
            'uri' => 'core/misc/druplicon.png',
            'status' => 1,
        ]);
        $permanent_image->save();
        $temporary_image = File::create([
            'uri' => 'core/misc/tree.png',
            'status' => 0,
        ]);
        $temporary_image->save();
        $body_value = '<img data-entity-type="file" data-entity-uuid="' . $permanent_image->uuid() . '" />';
        $body_value .= '<img data-entity-type="file" data-entity-uuid="' . $temporary_image->uuid() . '" />';
        $body[] = [
            'value' => $body_value,
            'format' => 'filtered_html',
        ];
        $node = Node::create([
            'type' => 'page',
            'title' => 'test',
            'body' => $body,
            'uid' => 1,
        ]);
        $node->save();
        $file_save_count = \Drupal::state()->get('editor_test.file_save_count', []);
        $this->assertEquals(1, $file_save_count[$permanent_image->getFilename()]);
        $this->assertEquals(2, $file_save_count[$temporary_image->getFilename()]);
        // Assert both images are now permanent.
        $permanent_image = File::load($permanent_image->id());
        $temporary_image = File::load($temporary_image->id());
        $this->assertTrue($permanent_image->isPermanent(), 'Permanent image was saved as permanent.');
        $this->assertTrue($temporary_image->isPermanent(), 'Temporary image was saved as permanent.');
    }
    
    /**
     * Tests the configurable text editor manager.
     */
    public function testEditorEntityHooks() : void {
        $image_paths = [
            0 => 'core/misc/druplicon.png',
            1 => 'core/misc/tree.png',
            2 => 'core/misc/help.png',
        ];
        $image_entities = [];
        foreach ($image_paths as $key => $image_path) {
            $image = File::create();
            $image->setFileUri($image_path);
            $image->setFilename(\Drupal::service('file_system')->basename($image->getFileUri()));
            $image->save();
            $file_usage = $this->container
                ->get('file.usage');
            $this->assertSame([], $file_usage->listUsage($image), 'The image ' . $image_paths[$key] . ' has zero usages.');
            $image_entities[] = $image;
        }
        $body = [];
        $description = [];
        foreach ($image_entities as $key => $image_entity) {
            // Don't be rude, say hello.
            $body_value = '<p>Hello, world!</p>';
            // Test handling of a valid image entry.
            $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="' . $image_entity->uuid() . '" />';
            // Test handling of an invalid data-entity-uuid attribute.
            $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="invalid-entity-uuid-value" />';
            // Test handling of an invalid data-entity-type attribute.
            $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="invalid-entity-type-value" data-entity-uuid="' . $image_entity->uuid() . '" />';
            // Test handling of a non-existing UUID.
            $body_value .= '<img src="awesome-llama-' . $key . '.jpg" data-entity-type="file" data-entity-uuid="30aac704-ba2c-40fc-b609-9ed121aa90f4" />';
            $body[] = [
                'value' => $body_value,
                'format' => 'filtered_html',
            ];
            $description[] = [
                'value' => 'something',
                'format' => 'filtered_html',
            ];
        }
        // Test editor_entity_insert(): increment.
        $this->createUser();
        $node = $node = Node::create([
            'type' => 'page',
            'title' => 'test',
            'body' => $body,
            'description' => $description,
            'uid' => 1,
        ]);
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '1',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 1 usage.');
        }
        // Test editor_entity_update(): increment, twice, by creating new revisions.
        $node->setNewRevision(TRUE);
        $node->save();
        $second_revision_id = $node->getRevisionId();
        $node->setNewRevision(TRUE);
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '3',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
        }
        // Test hook_entity_update(): decrement, by modifying the last revision:
        // remove the data-entity-type attribute from the body field.
        $original_values = [];
        for ($i = 0; $i < count($image_entities); $i++) {
            $original_value = $node->body[$i]->value;
            $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
            $node->body[$i]->value = $new_value;
            $original_values[$i] = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Test editor_entity_update(): increment again by creating a new revision:
        // read the data- attributes to the body field.
        $node->setNewRevision(TRUE);
        foreach ($original_values as $key => $original_value) {
            $node->body[$key]->value = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '3',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
        }
        // Test hook_entity_update(): decrement, by modifying the last revision:
        // remove the data-entity-uuid attribute from the body field.
        foreach ($original_values as $key => $original_value) {
            $original_value = $node->body[$key]->value;
            $new_value = str_replace('data-entity-type', 'data-entity-type-modified', $original_value);
            $node->body[$key]->value = $new_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Test hook_entity_update(): increment, by modifying the last revision:
        // read the data- attributes to the body field.
        foreach ($original_values as $key => $original_value) {
            $node->body[$key]->value = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '3',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 3 usages.');
        }
        // Test editor_entity_revision_delete(): decrement, by deleting a revision.
        $this->container
            ->get('entity_type.manager')
            ->getStorage('node')
            ->deleteRevision($second_revision_id);
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Populate both the body and summary. Because this will be the same
        // revision of the same node, it will record only one usage.
        foreach ($original_values as $key => $original_value) {
            $node->body[$key]->value = $original_value;
            $node->body[$key]->summary = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Empty out the body value, but keep the summary. The number of usages
        // should not change.
        foreach ($original_values as $key => $original_value) {
            $node->body[$key]->value = '';
            $node->body[$key]->summary = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Empty out the body and summary. The number of usages should decrease by
        // one.
        foreach ($original_values as $key => $original_value) {
            $node->body[$key]->value = '';
            $node->body[$key]->summary = '';
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '1',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 1 usage.');
        }
        // Set the field of a custom field type that is a subclass of
        // Drupal\text\Plugin\Field\FieldType\TextItemBase. The number of usages
        // should increase by one.
        foreach ($original_values as $key => $original_value) {
            $node->description[$key]->value = $original_value;
        }
        $node->save();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([
                'editor' => [
                    'node' => [
                        1 => '2',
                    ],
                ],
            ], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has 2 usages.');
        }
        // Test editor_entity_delete().
        $node->delete();
        foreach ($image_entities as $key => $image_entity) {
            $this->assertSame([], $file_usage->listUsage($image_entity), 'The image ' . $image_paths[$key] . ' has zero usages again.');
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
EditorFileUsageTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
EditorFileUsageTest::setUp protected function Overrides EntityKernelTestBase::setUp
EditorFileUsageTest::testEditorEntityHooks public function Tests the configurable text editor manager.
EditorFileUsageTest::testFileSaveOperations public function Tests file save operations when node with referenced files is saved.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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