You are here

Home » API reference » Linkit 8.5 » LinkitEditorLinkDialogTest.php

class LinkitEditorLinkDialogTest in Linkit 8.5

Tests EditorLinkDialog validation and conversion functionality.

@group linkit

Hierarchy

Expanded class hierarchy of LinkitEditorLinkDialogTest

File

tests/src/Kernel/LinkitEditorLinkDialogTest.php, line 18

Namespace

Drupal\Tests\linkit\Kernel
View source 
class LinkitEditorLinkDialogTest extends LinkitKernelTestBase {
  use ProfileCreationTrait;

  /**
   * The linkit profile.
   *
   * @var \Drupal\linkit\ProfileInterface
   */
  protected $linkitProfile;

  /**
   * Editor for testing.
   *
   * @var \Drupal\editor\EditorInterface
   */
  protected $editor;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'editor',
    'ckeditor',
    'entity_test',
  ];

  /**
   * Sets up the test.
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('entity_test');
    $this
      ->installSchema('system', [
      'key_value_expire',
    ]);

    // Create a profile.
    $this->linkitProfile = $this
      ->createProfile();

    /** @var \Drupal\linkit\MatcherManager $matcherManager */
    $matcherManager = $this->container
      ->get('plugin.manager.linkit.matcher');

    // Add the entity_test matcher to the profile.

    /** @var \Drupal\linkit\MatcherInterface $plugin */
    $plugin = $matcherManager
      ->createInstance('entity:entity_test');
    $this->linkitProfile
      ->addMatcher($plugin
      ->getConfiguration());
    $this->linkitProfile
      ->save();

    // Add a text format.
    $format = FilterFormat::create([
      'format' => 'filtered_html',
      'name' => 'Filtered HTML',
      'weight' => 0,
      'filters' => [],
    ]);
    $format
      ->save();

    // Set up editor.
    $this->editor = Editor::create([
      'format' => 'filtered_html',
      'editor' => 'ckeditor',
    ]);
    $this->editor
      ->setSettings([
      'plugins' => [
        'drupallink' => [
          'linkit_enabled' => TRUE,
          'linkit_profile' => $this->linkitProfile
            ->id(),
        ],
      ],
    ]);
    $this->editor
      ->save();
  }

  /**
   * Tests adding a link.
   */
  public function testAdd() {
    $entity_label = $this
      ->randomString();

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    $entity = EntityTest::create([
      'name' => $entity_label,
    ]);
    $entity
      ->save();
    $form_object = new EditorLinkDialog();
    $input = [
      'editor_object' => [],
      'dialogOptions' => [
        'title' => 'Add Link',
        'dialogClass' => 'editor-link-dialog',
        'autoResize' => 'true',
      ],
      '_drupal_ajax' => '1',
      'ajax_page_state' => [
        'theme' => 'bartik',
        'theme_token' => 'some-token',
        'libraries' => '',
      ],
    ];
    $form_state = (new FormState())
      ->setRequestMethod('POST')
      ->setUserInput($input)
      ->addBuildInfo('args', [
      $this->editor,
    ]);

    /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
    $form_builder = $this->container
      ->get('form_builder');
    $form_id = $form_builder
      ->getFormId($form_object, $form_state);
    $form = $form_builder
      ->retrieveForm($form_id, $form_state);
    $form_builder
      ->prepareForm($form_id, $form, $form_state);
    $form_builder
      ->processForm($form_id, $form, $form_state);
    $this
      ->assertEquals('linkit.autocomplete', $form['attributes']['href']['#autocomplete_route_name'], 'Linkit is enabled on the linkit field.');
    $this
      ->assertEmpty($form['attributes']['href']['#default_value'], 'The linkit field is empty.');
    $form_state
      ->setValue([
      'attributes',
      'href',
    ], 'https://example.com/');
    $form_state
      ->setValue('href_dirty_check', '');
    $form_state
      ->setValue([
      'attributes',
      'data-entity-type',
    ], $this
      ->randomString());
    $form_state
      ->setValue([
      'attributes',
      'data-entity-uuid',
    ], $this
      ->randomString());
    $form_state
      ->setValue([
      'attributes',
      'data-entity-substitution',
    ], $this
      ->randomString());
    $form_builder
      ->submitForm($form_object, $form_state);
    $this
      ->assertEmpty($form_state
      ->getValue([
      'attributes',
      'data-entity-type',
    ]));
    $this
      ->assertEmpty($form_state
      ->getValue([
      'attributes',
      'data-entity-uuid',
    ]));
    $this
      ->assertEmpty($form_state
      ->getValue([
      'attributes',
      'data-entity-substitution',
    ]));
    $entity_url = $entity
      ->toUrl('canonical', [
      'path_processing' => FALSE,
    ])
      ->toString();
    $form_state
      ->setValue([
      'attributes',
      'href',
    ], $entity_url);
    $form_state
      ->setValue('href_dirty_check', $entity_url);
    $form_state
      ->setValue([
      'attributes',
      'data-entity-type',
    ], $entity
      ->getEntityTypeId());
    $form_state
      ->setValue([
      'attributes',
      'data-entity-uuid',
    ], $entity
      ->uuid());
    $form_state
      ->setValue([
      'attributes',
      'data-entity-substitution',
    ], SubstitutionManagerInterface::DEFAULT_SUBSTITUTION);
    $form_builder
      ->submitForm($form_object, $form_state);
    $this
      ->assertEquals($entity
      ->getEntityTypeId(), $form_state
      ->getValue([
      'attributes',
      'data-entity-type',
    ]), 'Attribute "data-entity-type" exists and has the correct value.');
    $this
      ->assertEquals($entity
      ->uuid(), $form_state
      ->getValue([
      'attributes',
      'data-entity-uuid',
    ]), 'Attribute "data-entity-uuid" exists and has the correct value.');
    $this
      ->assertEquals(SubstitutionManagerInterface::DEFAULT_SUBSTITUTION, $form_state
      ->getValue([
      'attributes',
      'data-entity-substitution',
    ]), 'Attribute "data-entity-substitution" exists and has the correct value.');
  }

  /**
   * Tests editing a link with data attributes.
   */
  public function testEditWithDataAttributes() {
    $entity_label = $this
      ->randomString();

    /** @var \Drupal\Core\Entity\EntityInterface $entity */
    $entity = EntityTest::create([
      'name' => $entity_label,
    ]);
    $entity
      ->save();
    $entity_url = $entity
      ->toUrl('canonical', [
      'path_processing' => FALSE,
    ])
      ->toString();
    $form_object = new EditorLinkDialog();
    $input = [
      'editor_object' => [
        'href' => $entity_url,
        'data-entity-type' => $entity
          ->getEntityTypeId(),
        'data-entity-uuid' => $entity
          ->uuid(),
        'data-entity-substitution' => SubstitutionManagerInterface::DEFAULT_SUBSTITUTION,
      ],
      'dialogOptions' => [
        'title' => 'Edit Link',
        'dialogClass' => 'editor-link-dialog',
        'autoResize' => 'true',
      ],
      '_drupal_ajax' => '1',
      'ajax_page_state' => [
        'theme' => 'bartik',
        'theme_token' => 'some-token',
        'libraries' => '',
      ],
    ];
    $form_state = (new FormState())
      ->setRequestMethod('POST')
      ->setUserInput($input)
      ->addBuildInfo('args', [
      $this->editor,
    ]);

    /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
    $form_builder = $this->container
      ->get('form_builder');
    $form_id = $form_builder
      ->getFormId($form_object, $form_state);
    $form = $form_builder
      ->retrieveForm($form_id, $form_state);
    $form_builder
      ->prepareForm($form_id, $form, $form_state);
    $form_builder
      ->processForm($form_id, $form, $form_state);
    $this
      ->assertEquals('linkit.autocomplete', $form['attributes']['href']['#autocomplete_route_name'], 'Linkit is enabled on the href field.');
    $this
      ->assertEquals($entity_url, $form['attributes']['href']['#default_value'], 'The href field has the url as default value.');
    $this
      ->assertEquals($entity
      ->getEntityTypeId(), $form_state
      ->getValue([
      'attributes',
      'data-entity-type',
    ]), 'Attribute "data-entity-type" exists and has the correct value.');
    $this
      ->assertEquals($entity
      ->uuid(), $form_state
      ->getValue([
      'attributes',
      'data-entity-uuid',
    ]), 'Attribute "data-entity-uuid" exists and has the correct value.');
    $this
      ->assertEquals(SubstitutionManagerInterface::DEFAULT_SUBSTITUTION, $form_state
      ->getValue([
      'attributes',
      'data-entity-substitution',
    ]), 'Attribute "data-entity-substitution" exists and has the correct value.');
  }

  /**
   * Tests editing a link without data attributes.
   */
  public function testEditWithoutDataAttributes() {
    $form_object = new EditorLinkDialog();
    $input = [
      'editor_object' => [
        'href' => 'http://example.com/',
      ],
      'dialogOptions' => [
        'title' => 'Edit Link',
        'dialogClass' => 'editor-link-dialog',
        'autoResize' => 'true',
      ],
      '_drupal_ajax' => '1',
      'ajax_page_state' => [
        'theme' => 'bartik',
        'theme_token' => 'some-token',
        'libraries' => '',
      ],
    ];
    $form_state = (new FormState())
      ->setRequestMethod('POST')
      ->setUserInput($input)
      ->addBuildInfo('args', [
      $this->editor,
    ]);

    /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */
    $form_builder = $this->container
      ->get('form_builder');
    $form_id = $form_builder
      ->getFormId($form_object, $form_state);
    $form = $form_builder
      ->retrieveForm($form_id, $form_state);
    $form_builder
      ->prepareForm($form_id, $form, $form_state);
    $form_builder
      ->processForm($form_id, $form, $form_state);
    $this
      ->assertEquals('linkit.autocomplete', $form['attributes']['href']['#autocomplete_route_name'], 'Linkit is enabled on the href field.');
    $this
      ->assertEquals('http://example.com/', $form['attributes']['href']['#default_value'], 'The href field default value is the external URI.');
    $this
      ->assertEmpty($form['attributes']['data-entity-type']['#default_value']);
    $this
      ->assertEmpty($form['attributes']['data-entity-uuid']['#default_value']);
    $this
      ->assertEmpty($form['attributes']['data-entity-substitution']['#default_value']);
  }

}

Members

Namesort descending Modifiers Type Description 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 the raw text IS NOT found escaped on the 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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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.
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. 7
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::$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. 6
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
KernelTestBase::stop 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 Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
LinkitEditorLinkDialogTest::$editor protected property Editor for testing.
LinkitEditorLinkDialogTest::$linkitProfile protected property The linkit profile.
LinkitEditorLinkDialogTest::$modules public static property Modules to enable. Overrides LinkitKernelTestBase::$modules
LinkitEditorLinkDialogTest::setUp protected function Sets up the test. Overrides LinkitKernelTestBase::setUp
LinkitEditorLinkDialogTest::testAdd public function Tests adding a link.
LinkitEditorLinkDialogTest::testEditWithDataAttributes public function Tests editing a link with data attributes.
LinkitEditorLinkDialogTest::testEditWithoutDataAttributes public function Tests editing a link without data attributes.
LinkitKernelTestBase::createUser protected function Creates a user.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
ProfileCreationTrait::createProfile protected function Creates a profile based on default settings.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.