class EditorIntegrationTest

Tests Edit module integration (Editor module's inline editing support).

@group quickedit @group legacy

Hierarchy

Expanded class hierarchy of EditorIntegrationTest

File

core/modules/quickedit/tests/src/Kernel/EditorIntegrationTest.php, line 24

Namespace

Drupal\Tests\quickedit\Kernel
View source
class EditorIntegrationTest extends QuickEditTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'editor',
        'editor_test',
    ];
    
    /**
     * The manager for editor plug-ins.
     *
     * @var \Drupal\Component\Plugin\PluginManagerInterface
     */
    protected $editorManager;
    
    /**
     * The metadata generator object to be tested.
     *
     * @var \Drupal\quickedit\MetadataGeneratorInterface
     */
    protected $metadataGenerator;
    
    /**
     * The editor selector object to be used by the metadata generator object.
     *
     * @var \Drupal\quickedit\EditorSelectorInterface
     */
    protected $editorSelector;
    
    /**
     * The access checker object to be used by the metadata generator object.
     *
     * @var \Drupal\quickedit\Access\QuickEditEntityFieldAccessCheckInterface
     */
    protected $accessChecker;
    
    /**
     * The name of the field used for tests.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Install the Filter module.
        // Create a field.
        $this->fieldName = 'field_textarea';
        $this->createFieldWithStorage($this->fieldName, 'text', 1, 'Long text field', [], 'text_textarea', [
            'size' => 42,
        ], 'text_default', []);
        // Create text format.
        $full_html_format = FilterFormat::create([
            'format' => 'full_html',
            'name' => 'Full HTML',
            'weight' => 1,
            'filters' => [],
        ]);
        $full_html_format->save();
        // Associate text editor with text format.
        $editor = Editor::create([
            'format' => $full_html_format->id(),
            'editor' => 'unicorn',
        ]);
        $editor->save();
        // Also create a text format without an associated text editor.
        FilterFormat::create([
            'format' => 'no_editor',
            'name' => 'No Text Editor',
            'weight' => 2,
            'filters' => [],
        ])->save();
    }
    
    /**
     * Returns the in-place editor that quickedit selects.
     *
     * @param int $entity_id
     *   An entity ID.
     * @param string $field_name
     *   A field name.
     * @param string $view_mode
     *   A view mode.
     *
     * @return string
     *   Returns the selected in-place editor.
     */
    protected function getSelectedEditor($entity_id, $field_name, $view_mode = 'default') {
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('entity_test');
        $storage->resetCache([
            $entity_id,
        ]);
        $entity = $storage->load($entity_id);
        $items = $entity->get($field_name);
        $options = \Drupal::service('entity_display.repository')->getViewDisplay('entity_test', 'entity_test', $view_mode)
            ->getComponent($field_name);
        return $this->editorSelector
            ->getEditor($options['type'], $items);
    }
    
    /**
     * Tests editor selection when the Editor module is present.
     *
     * Tests a textual field, with text filtering, with cardinality 1 and >1,
     * always with a ProcessedTextEditor plug-in present, but with varying text
     * format compatibility.
     */
    public function testEditorSelection() {
        $this->editorManager = $this->container
            ->get('plugin.manager.quickedit.editor');
        $this->editorSelector = $this->container
            ->get('quickedit.editor.selector');
        // Create an entity with values for this text field.
        $entity = EntityTest::create();
        $entity->{$this->fieldName}->value = 'Hello, world!';
        $entity->{$this->fieldName}->format = 'filtered_html';
        $entity->save();
        // Editor selection with cardinality 1, text format without associated text
        // editor.
        $this->assertEquals('form', $this->getSelectedEditor($entity->id(), $this->fieldName), "With cardinality 1, and the filtered_html text format, the 'form' editor is selected.");
        // Editor selection w/ cardinality 1, text format w/ associated text editor.
        $entity->{$this->fieldName}->format = 'full_html';
        $entity->save();
        $this->assertEquals('editor', $this->getSelectedEditor($entity->id(), $this->fieldName), "With cardinality 1, and the full_html text format, the 'editor' editor is selected.");
        // Editor selection with text processing, cardinality > 1.
        $this->fields->field_textarea_field_storage
            ->setCardinality(2);
        $this->fields->field_textarea_field_storage
            ->save();
        $this->assertEquals('form', $this->getSelectedEditor($entity->id(), $this->fieldName), "With cardinality >1, and both items using the full_html text format, the 'form' editor is selected.");
    }
    
    /**
     * Tests (custom) metadata when the formatted text editor is used.
     */
    public function testMetadata() {
        $this->editorManager = $this->container
            ->get('plugin.manager.quickedit.editor');
        $this->accessChecker = new MockQuickEditEntityFieldAccessCheck();
        $this->editorSelector = $this->container
            ->get('quickedit.editor.selector');
        $this->metadataGenerator = new MetadataGenerator($this->accessChecker, $this->editorSelector, $this->editorManager);
        // Create an entity with values for the field.
        $entity = EntityTest::create();
        $entity->{$this->fieldName}->value = 'Test';
        $entity->{$this->fieldName}->format = 'full_html';
        $entity->save();
        $entity = EntityTest::load($entity->id());
        // Verify metadata.
        $items = $entity->get($this->fieldName);
        \Drupal::state()->set('quickedit_test_field_access', 'forbidden');
        $this->assertSame([
            'access' => FALSE,
        ], $this->metadataGenerator
            ->generateFieldMetadata($items, 'default'));
        \Drupal::state()->set('quickedit_test_field_access', 'neutral');
        $this->assertSame([
            'access' => FALSE,
        ], $this->metadataGenerator
            ->generateFieldMetadata($items, 'default'));
        \Drupal::state()->set('quickedit_test_field_access', 'allowed');
        $metadata = $this->metadataGenerator
            ->generateFieldMetadata($items, 'default');
        $expected = [
            'access' => TRUE,
            'label' => 'Long text field',
            'editor' => 'editor',
            'custom' => [
                'format' => 'full_html',
                'formatHasTransformations' => FALSE,
            ],
        ];
        $this->assertEquals($expected, $metadata, 'The correct metadata (including custom metadata) is generated.');
    }
    
    /**
     * Tests in-place editor attachments when the Editor module is present.
     */
    public function testAttachments() {
        $this->editorSelector = $this->container
            ->get('quickedit.editor.selector');
        $editors = [
            'editor',
        ];
        $attachments = $this->editorSelector
            ->getEditorAttachments($editors);
        $this->assertSame([
            'library' => [
                'quickedit/quickedit.inPlaceEditor.formattedText',
            ],
        ], $attachments, "Expected attachments for Editor module's in-place editor found.");
    }
    
    /**
     * Tests GetUntransformedTextCommand AJAX command.
     */
    public function testGetUntransformedTextCommand() {
        $this->accessChecker = new MockQuickEditEntityFieldAccessCheck();
        $this->editorSelector = $this->container
            ->get('quickedit.editor.selector');
        $this->editorManager = $this->container
            ->get('plugin.manager.quickedit.editor');
        $this->metadataGenerator = new MetadataGenerator($this->accessChecker, $this->editorSelector, $this->editorManager);
        // Create an entity with values for the field.
        $entity = EntityTest::create();
        $entity->{$this->fieldName}->value = 'Test';
        $entity->{$this->fieldName}->format = 'full_html';
        $entity->save();
        $entity = EntityTest::load($entity->id());
        // Verify AJAX response.
        $controller = new QuickEditController($this->container
            ->get('tempstore.private'), $this->metadataGenerator, $this->editorSelector, $this->container
            ->get('renderer'), $this->container
            ->get('entity_display.repository'), $this->container
            ->get('entity.repository'));
        $request = new Request();
        $response = $controller->getUntransformedText($entity, $this->fieldName, LanguageInterface::LANGCODE_DEFAULT, 'default');
        $expected = [
            [
                'command' => 'editorGetUntransformedText',
                'data' => 'Test',
            ],
        ];
        $ajax_response_attachments_processor = \Drupal::service('ajax_response.attachments_processor');
        $subscriber = new AjaxResponseSubscriber($ajax_response_attachments_processor);
        $event = new ResponseEvent(\Drupal::service('http_kernel'), $request, HttpKernelInterface::MASTER_REQUEST, $response);
        $subscriber->onResponse($event);
        $this->assertEquals(Json::encode($expected), $response->getContent(), 'The GetUntransformedTextCommand AJAX command works correctly.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary 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::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
EditorIntegrationTest::$accessChecker protected property The access checker object to be used by the metadata generator object.
EditorIntegrationTest::$editorManager protected property The manager for editor plug-ins.
EditorIntegrationTest::$editorSelector protected property The editor selector object to be used by the metadata generator object.
EditorIntegrationTest::$fieldName protected property The name of the field used for tests.
EditorIntegrationTest::$metadataGenerator protected property The metadata generator object to be tested.
EditorIntegrationTest::$modules protected static property Modules to enable. Overrides QuickEditTestBase::$modules
EditorIntegrationTest::getSelectedEditor protected function Returns the in-place editor that quickedit selects.
EditorIntegrationTest::setUp protected function Sets the default field storage backend for fields created during tests. Overrides QuickEditTestBase::setUp
EditorIntegrationTest::testAttachments public function Tests in-place editor attachments when the Editor module is present.
EditorIntegrationTest::testEditorSelection public function Tests editor selection when the Editor module is present.
EditorIntegrationTest::testGetUntransformedTextCommand public function Tests GetUntransformedTextCommand AJAX command.
EditorIntegrationTest::testMetadata public function Tests (custom) metadata when the formatted text editor is used.
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.
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. 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 private function Bootstraps a kernel for a test.
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.
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. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 26
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. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
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.
QuickEditTestBase::$fields protected property Bag of created fields.
QuickEditTestBase::createFieldWithStorage protected function Creates a field.
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.
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.

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