You are here

Home » API reference » Acquia Content Hub 8.2 » LinkFieldSerializerTest.php

class LinkFieldSerializerTest in Acquia Content Hub 8.2

Tests Link Field Serialization.

@group acquia_contenthub @coversDefaultClass \Drupal\acquia_contenthub\EventSubscriber\SerializeContentField\LinkFieldSerializer

@requires module depcalc

@package Drupal\Tests\acquia_contenthub\Kernel\EventSubscriber\SerializeContentField

Hierarchy

Expanded class hierarchy of LinkFieldSerializerTest

File

tests/src/Kernel/EventSubscriber/SerializeContentField/LinkFieldSerializerTest.php, line 27

Namespace

Drupal\Tests\acquia_contenthub\Kernel\EventSubscriber\SerializeContentField
View source 
class LinkFieldSerializerTest extends EntityKernelTestBase {
  use DrupalVersion;
  use NodeCreationTrait;
  use ContentTypeCreationTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'acquia_contenthub',
    'depcalc',
    'filter',
    'language',
    'link',
    'node',
    'text',
  ];

  /**
   * The LinkFieldSerializer object.
   *
   * @var \Drupal\acquia_contenthub\EventSubscriber\SerializeContentField\LinkFieldSerializer
   */
  protected $serializer;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    if (version_compare(\Drupal::VERSION, '9.0', '>=')) {
      static::$modules[] = 'path_alias';
    }
    parent::setUp();
    if (version_compare(\Drupal::VERSION, '8.8.0', '>=')) {
      $this
        ->installEntitySchema('path_alias');
    }
    $this
      ->installEntitySchema('node_type');
    $this
      ->installConfig([
      'node',
      'filter',
    ]);
    $this
      ->installEntitySchema('field_config');
    $this
      ->installSchema('node', 'node_access');
    $this
      ->installSchema('user', 'users_data');
    $this
      ->createContentType([
      'type' => 'page',
      'name' => 'Page',
    ])
      ->save();
    $field_storage = FieldStorageConfig::create([
      'field_name' => 'link',
      'entity_type' => 'node',
      'type' => 'link',
      'cardinality' => -1,
    ]);
    $field_storage
      ->save();
    $field = FieldConfig::create([
      'field_storage' => $field_storage,
      'bundle' => 'page',
      'label' => 'link',
      'settings' => [
        'link_type' => LinkItemInterface::LINK_GENERIC,
      ],
    ]);
    $field
      ->save();
    $field2_storage = FieldStorageConfig::create([
      'field_name' => 'link2',
      'entity_type' => 'node',
      'type' => 'link',
      'cardinality' => -1,
    ]);
    $field2_storage
      ->save();
    $field2 = FieldConfig::create([
      'field_storage' => $field2_storage,
      'bundle' => 'page',
      'label' => 'link',
      'settings' => [
        'link_type' => LinkItemInterface::LINK_GENERIC,
      ],
    ]);
    $field2
      ->save();
    $this->serializer = new LinkFieldSerializer();
  }

  /**
   * Wrapper class that asserts that an array has a specified subset.
   *
   * @todo When Drupal 9/PHPUnit 9 is standard, this method can be removed and
   * the tests need to be refactored to use the DMSAssertArraySubset library.
   *
   * @param array|ArrayAccess $subset
   *   Subset for assertion.
   * @param array|ArrayAccess $array
   *   Array for assertion.
   * @param bool $checkForObjectIdentity
   *   Boolean to check for object identity.
   * @param string $message
   *   Message used for assertion.
   *
   * @codeCoverageIgnore
   *
   * @throws \Exception
   */
  protected function assertArraySubsetWrapper($subset, $array, bool $checkForObjectIdentity = FALSE, string $message = '') : void {
    if (class_exists(DMSAssert::class)) {
      DMSAssert::assertArraySubset($subset, $array, $checkForObjectIdentity, $message);
    }
    else {
      $this
        ->assertArraySubset($subset, $array, $checkForObjectIdentity, $message);
    }
  }

  /**
   * Test cases when empty data should be returned.
   *
   * @param string $field
   *   The field name.
   * @param string $message
   *   The message to display in case of failure.
   *
   * @covers ::onSerializeContentField
   * @dataProvider emptyDataCases
   *
   * @throws \Exception
   */
  public function testOnSerializeContentFieldEmptyData(string $field, string $message) : void {
    $node = $this
      ->createNode();
    $node_cdf = $this->container
      ->get('acquia_contenthub_common_actions')
      ->getLocalCdfDocument($node)
      ->getCdfEntity($node
      ->uuid());
    $event = new SerializeCdfEntityFieldEvent($node, $field, $node
      ->get($field), $node_cdf);
    $this->serializer
      ->onSerializeContentField($event);
    $data = $event
      ->getFieldData();
    $this
      ->assertNull($data['value']['en'][0]);
  }

  /**
   * Provides cases when empty field data should be returned.
   *
   * @return array
   *   The test cases.
   */
  public function emptyDataCases() : array {
    return [
      [
        'link',
        'No link has been added to the node.',
      ],
      [
        'body',
        'The field is not link type, data is empty.',
      ],
    ];
  }

  /**
   * @covers ::onSerializeContentField
   */
  public function testOnSerializeContentFieldMultiLang() : void {
    ConfigurableLanguage::create([
      'id' => 'hu',
      'label' => 'HU',
    ])
      ->save();
    ConfigurableLanguage::create([
      'id' => 'es',
      'label' => 'ES',
    ])
      ->save();

    // Create main node with translations.
    $node = $this
      ->createNode();
    $node
      ->addTranslation('hu', [
      'title' => 'Title - HU',
      'body' => 'Body - HU',
    ])
      ->save();
    $node
      ->addTranslation('es', [
      'title' => 'Title - ES',
      'body' => 'Body - ES',
    ])
      ->save();

    // Provide a couple of referable nodes with translations.
    $referred_node = $this
      ->createNode();
    $referred_node
      ->addTranslation('hu', [
      'title' => 'Title - HU',
      'body' => 'Body - HU',
    ])
      ->save();
    $translated_node = $referred_node
      ->getTranslation('hu');
    $referred_node_2 = $this
      ->createNode();
    $referred_node_2
      ->addTranslation('es', [
      'title' => 'Title - ES',
      'body' => 'Body - ES',
    ])
      ->save();
    $translated_node_2 = $referred_node_2
      ->getTranslation('es');

    // Add referable nodes to the main node with their translation and
    // original language.
    $trans_node_hu = $node
      ->getTranslation('hu');
    $trans_node_hu
      ->get('link')
      ->appendItem([
      'uri' => "entity:node/{$translated_node->id()}",
      'title' => $translated_node
        ->label(),
    ]);
    $trans_node_es = $node
      ->getTranslation('es');
    $trans_node_es
      ->get('link')
      ->appendItem([
      'uri' => "entity:node/{$translated_node_2->id()}",
      'title' => $translated_node_2
        ->label(),
    ]);
    $node
      ->get('link')
      ->appendItem([
      'uri' => "entity:node/{$referred_node->id()}",
      'title' => $referred_node
        ->label(),
    ]);
    $node
      ->get('link')
      ->appendItem([
      'uri' => "entity:node/{$referred_node_2->id()}",
      'title' => $referred_node_2
        ->label(),
    ]);
    $node
      ->save();
    $node_cdf = $this->container
      ->get('acquia_contenthub_common_actions')
      ->getLocalCdfDocument($node)
      ->getCdfEntity($node
      ->uuid());
    $event = new SerializeCdfEntityFieldEvent($node, 'link', $node
      ->get('link'), $node_cdf);
    $this->serializer
      ->onSerializeContentField($event);
    $data = $event
      ->getFieldData()['value'];

    // All translation must be present in the field data.
    $this
      ->assertArraySubsetWrapper([
      'en',
      'es',
      'hu',
    ], array_keys($data));
    $this
      ->assertCount(2, $data['en']);
    $this
      ->assertCount(1, $data['es']);
    $this
      ->assertCount(1, $data['hu']);
    $expected = [
      [
        'uri' => $referred_node
          ->uuid(),
      ],
      [
        'uri' => $referred_node_2
          ->uuid(),
      ],
    ];
    $this
      ->assertArraySubsetWrapper($expected, $data['en']);
    $referred_node_2
      ->delete();
    $event = new SerializeCdfEntityFieldEvent($node, 'link', $node
      ->get('link'), $node_cdf);
    $this->serializer
      ->onSerializeContentField($event);
    $data = $event
      ->getFieldData()['value'];
    $this
      ->assertArraySubsetWrapper([
      'en',
      'hu',
    ], array_keys($data));
    $this
      ->assertCount(1, $data['hu']);
    $this
      ->assertCount(1, $data['en']);
    $expected = [
      [
        'uri' => $referred_node
          ->uuid(),
      ],
    ];
    $this
      ->assertArraySubsetWrapper($expected, $data['en']);
    $event = new SerializeCdfEntityFieldEvent($node, 'link2', $node
      ->get('link2'), $node_cdf);
    $this->serializer
      ->onSerializeContentField($event);
    $data = $event
      ->getFieldData()['value'];
    $this
      ->assertArraySubsetWrapper([
      'en',
      'es',
      'hu',
    ], array_keys($data));
    $this
      ->assertCount(1, $data['hu']);
    $this
      ->assertCount(1, $data['es']);
    $this
      ->assertCount(1, $data['en']);
    $this
      ->assertNull($data['hu'][0]);
    $this
      ->assertNull($data['es'][0]);
    $this
      ->assertNull($data['en'][0]);
  }

}

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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. 1
DeprecatedServicePropertyTrait::__get public function Allows to access deprecated/removed properties.
DrupalVersion::getDrupalVersion protected function Get the current version of Drupal to identify fixtures for tests.
EntityKernelTestBase::$deprecatedProperties protected property The list of deprecated services.
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.
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::__sleep public function Prevents serializing any properties.
LinkFieldSerializerTest::$modules public static property Modules to enable. Overrides EntityKernelTestBase::$modules
LinkFieldSerializerTest::$serializer protected property The LinkFieldSerializer object.
LinkFieldSerializerTest::assertArraySubsetWrapper protected function Wrapper class that asserts that an array has a specified subset.
LinkFieldSerializerTest::emptyDataCases public function Provides cases when empty field data should be returned.
LinkFieldSerializerTest::setUp protected function Overrides EntityKernelTestBase::setUp
LinkFieldSerializerTest::testOnSerializeContentFieldEmptyData public function Test cases when empty data should be returned.
LinkFieldSerializerTest::testOnSerializeContentFieldMultiLang public function @covers ::onSerializeContentField
NodeCreationTrait::createNode protected function Creates a node based on default settings.
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title.
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.
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.
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