You are here

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

class UnserializationTest in Acquia Content Hub 8.2

Tests that entities are properly unserialized.

@group acquia_contenthub

@package Drupal\Tests\acquia_contenthub\Kernel

Hierarchy

Expanded class hierarchy of UnserializationTest

File

tests/src/Kernel/UnserializationTest.php, line 29

Namespace

Drupal\Tests\acquia_contenthub\Kernel
View source 
class UnserializationTest extends EntityKernelTestBase {
  use DrupalVersion;

  /**
   * Sample View Mode UUID.
   */
  const CLIENT_UUID_1 = 'fefd7eda-4244-4fe4-b9b5-b15b89c61aa8';

  /**
   * Sample Taxonomy Term UUID.
   */
  const CLIENT_UUID_2 = 'de9606dc-56fa-4b09-bcb1-988533edc814';

  /**
   * Sample Vocabulary UUID.
   */
  const CLIENT_UUID_3 = '22dc8835-7b14-4b08-b25d-eae99e1d4d91';

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'user',
    'file',
    'node',
    'field',
    'taxonomy',
    'depcalc',
    'acquia_contenthub',
    'acquia_contenthub_subscriber',
  ];

  /**
   * Queue worker instance.
   *
   * @var \Drupal\acquia_contenthub_subscriber\Plugin\QueueWorker\ContentHubImportQueueWorker
   */
  protected $contentHubImportQueueWorker;

  /**
   * Client instance.
   *
   * @var \Acquia\ContentHubClient\ContentHubClient|\PHPUnit\Framework\MockObject\MockObject
   */
  protected $contentHubClient;

  /**
   * Client settings.
   *
   * @var \Acquia\ContentHubClient\Settings
   */
  protected $settings;

  /**
   * {@inheritdoc}
   *
   * @throws \Exception
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installSchema('acquia_contenthub_subscriber', [
      'acquia_contenthub_subscriber_import_tracking',
    ]);
    $this->contentHubClient = $this
      ->prophesize(ContentHubClient::class);
    $this->settings = $this
      ->prophesize(Settings::class);
    $this->settings
      ->getWebhook('uuid')
      ->willReturn('foo');
    $this->settings
      ->getName()
      ->willReturn('foo');
    $this->settings
      ->getUuid()
      ->willReturn(self::CLIENT_UUID_1);
    $client_factory_mock = $this
      ->prophesize(ClientFactory::class);
    $client_factory_mock
      ->getClient()
      ->willReturn($this->contentHubClient);
    $client_factory_mock
      ->getSettings()
      ->willReturn($this->settings
      ->reveal());
    $this->container
      ->set('acquia_contenthub.client.factory', $client_factory_mock
      ->reveal());
    $subscriber_tracker_mock = $this
      ->prophesize(SubscriberTracker::class);
    $this->container
      ->set('acquia_contenthub_subscriber.tracker', $subscriber_tracker_mock
      ->reveal());
    $logger_channel_mock = $this
      ->prophesize(LoggerChannelInterface::class);
    $this->container
      ->set('acquia_contenthub.logger_channel', $logger_channel_mock
      ->reveal());
    $common = $this
      ->getMockBuilder(ContentHubCommonActions::class)
      ->setConstructorArgs([
      $this->container
        ->get('event_dispatcher'),
      $this->container
        ->get('entity.cdf.serializer'),
      $this->container
        ->get('entity.dependency.calculator'),
      $this->container
        ->get('acquia_contenthub.client.factory'),
      $this->container
        ->get('logger.factory'),
      $this->container
        ->get('config.factory'),
    ])
      ->setMethods([
      'getUpdateDbStatus',
    ])
      ->getMock();
    $this->container
      ->set('acquia_contenthub_common_actions', $common);
    $this->contentHubImportQueueWorker = $this
      ->getMockBuilder(ContentHubImportQueueWorker::class)
      ->setConstructorArgs([
      $this->container
        ->get('event_dispatcher'),
      $this->container
        ->get('acquia_contenthub_common_actions'),
      $this->container
        ->get('acquia_contenthub.client.factory'),
      $this->container
        ->get('acquia_contenthub_subscriber.tracker'),
      $this->container
        ->get('logger.factory'),
      $this->container
        ->get('config.factory'),
      [],
      NULL,
      NULL,
    ])
      ->setMethods(NULL)
      ->getMock();
  }

  /**
   * Tests configuration entity unserialization.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \ReflectionException
   */
  public function testConfigEntityUnserialization() {
    $cdf_document = $this
      ->createCDFDocumentFromFixture('view_modes.json');
    $this->contentHubClient
      ->getEntities([
      self::CLIENT_UUID_1 => self::CLIENT_UUID_1,
    ])
      ->willReturn($cdf_document);
    $this->contentHubClient
      ->getInterestsByWebhook(Argument::type('string'))
      ->willReturn([
      self::CLIENT_UUID_1,
    ]);
    $this
      ->initializeContentHubClientExpectation($cdf_document);
    $this->contentHubClient
      ->addEntitiesToInterestList("foo", [
      self::CLIENT_UUID_1,
    ])
      ->willReturn(new Response());
    $item = new \stdClass();
    $item->uuids = implode(', ', [
      self::CLIENT_UUID_1,
    ]);
    $this->contentHubImportQueueWorker
      ->processItem($item);
    $view_mode = EntityViewMode::load('node.teaser');
    $this
      ->assertNotEmpty($view_mode
      ->id());
  }

  /**
   * Tests content entity unserialization.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   * @throws \ReflectionException
   *
   * @see _acquia_contenthub_publisher_enqueue_entity()
   */
  public function testTaxonomyTermUnserialization() {
    $cdf_document = $this
      ->createCDFDocumentFromFixture('taxonomy.json');
    $this->contentHubClient
      ->getEntities([
      self::CLIENT_UUID_2 => self::CLIENT_UUID_2,
    ])
      ->willReturn($cdf_document);
    $this->contentHubClient
      ->getInterestsByWebhook(Argument::type('string'))
      ->willReturn([
      self::CLIENT_UUID_2,
    ]);
    $this
      ->initializeContentHubClientExpectation($cdf_document);
    $this->contentHubClient
      ->addEntitiesToInterestList("foo", [
      self::CLIENT_UUID_3,
      self::CLIENT_UUID_2,
    ])
      ->willReturn(new Response());
    $item = new \stdClass();
    $item->uuids = implode(', ', [
      self::CLIENT_UUID_2,
    ]);
    $this->contentHubImportQueueWorker
      ->processItem($item);

    // Checks that vocabulary has been imported.
    $vocabulary = Vocabulary::load('tags');
    $this
      ->assertNotEmpty($vocabulary
      ->id());
    $this
      ->assertEquals('Tags', $vocabulary
      ->label());

    // Checks that taxonomy has been imported.

    /** @var \Drupal\taxonomy\Entity\Term[] $taxonomy_terms */
    $taxonomy_terms = \Drupal::entityTypeManager()
      ->getStorage('taxonomy_term')
      ->loadByProperties([
      'name' => 'tag1',
    ]);
    $this
      ->assertNotEmpty($taxonomy_terms);
    $taxonomy_term = current($taxonomy_terms);
    $this
      ->assertNotEmpty($taxonomy_term
      ->id());
  }

  /**
   * Creates CDF document from fixture.
   *
   * @param string $fixture_filename
   *   Fixture file name.
   *
   * @return \Acquia\ContentHubClient\CDFDocument
   *   CDF document.
   *
   * @throws \ReflectionException
   */
  protected function createCdfDocumentFromFixture($fixture_filename) : CDFDocument {
    $version_directory = $this
      ->getDrupalVersion();
    $path_to_fixture = sprintf("%s/tests/fixtures/import/{$version_directory}/%s", drupal_get_path('module', 'acquia_contenthub'), $fixture_filename);
    $json = file_get_contents($path_to_fixture);
    $data = Json::decode($json);
    $document_parts = [];
    foreach ($data['entities'] as $entity) {
      $document_parts[] = $this
        ->populateCdfObject($entity);
    }
    $cdf_document = new CDFDocument(...$document_parts);
    return $cdf_document;
  }

  /**
   * Populates CDF object from array.
   *
   * @param array $entity
   *   Entity.
   *
   * @return \Acquia\ContentHubClient\CDF\CDFObject
   *   Populated CDF object.
   *
   * @throws \Exception
   * @throws \ReflectionException
   *
   * @see \Acquia\ContentHubClient\ContentHubClient::getEntities()
   */
  protected function populateCdfObject(array $entity) : CDFObject {
    $object = new CDFObject($entity['type'], $entity['uuid'], $entity['created'], $entity['modified'], $entity['origin'], $entity['metadata']);
    foreach ($entity['attributes'] as $attribute_name => $values) {

      // Refactor ClientHub.php: get rid of duplicated code blocks.
      if (!($attribute = $object
        ->getAttribute($attribute_name))) {
        $class = !empty($object
          ->getMetadata()['attributes'][$attribute_name]) ? $object
          ->getMetadata()['attributes'][$attribute_name]['class'] : FALSE;
        if ($class && class_exists($class)) {
          $object
            ->addAttribute($attribute_name, $values['type'], NULL, 'und', $class);
        }
        else {
          $object
            ->addAttribute($attribute_name, $values['type'], NULL);
        }
        $attribute = $object
          ->getAttribute($attribute_name);
      }
      $value_property = (new \ReflectionClass($attribute))
        ->getProperty('value');
      $value_property
        ->setAccessible(TRUE);
      $value_property
        ->setValue($attribute, $values['value']);
    }
    return $object;
  }

  /**
   * Client expectation.
   *
   * @param \Acquia\ContentHubClient\CDFDocument $cdf_document
   *   CDF Document for client.
   *
   * @throws \Exception
   */
  private function initializeContentHubClientExpectation(CDFDocument $cdf_document) : void {
    $this->contentHubClient
      ->getSettings()
      ->willReturn($this->settings);
    $cdf_entity = current($cdf_document
      ->getEntities());
    $this->contentHubClient
      ->getEntity(self::CLIENT_UUID_1)
      ->willReturn($cdf_entity);
    $this->contentHubClient
      ->putEntities($cdf_entity)
      ->willReturn(NULL);
  }

}

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.
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.
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.
UnserializationTest::$contentHubClient protected property Client instance.
UnserializationTest::$contentHubImportQueueWorker protected property Queue worker instance.
UnserializationTest::$modules public static property Modules to enable. Overrides EntityKernelTestBase::$modules 1
UnserializationTest::$settings protected property Client settings.
UnserializationTest::CLIENT_UUID_1 constant Sample View Mode UUID.
UnserializationTest::CLIENT_UUID_2 constant Sample Taxonomy Term UUID.
UnserializationTest::CLIENT_UUID_3 constant Sample Vocabulary UUID.
UnserializationTest::createCdfDocumentFromFixture protected function Creates CDF document from fixture.
UnserializationTest::initializeContentHubClientExpectation private function Client expectation.
UnserializationTest::populateCdfObject protected function Populates CDF object from array.
UnserializationTest::setUp protected function Overrides EntityKernelTestBase::setUp 1
UnserializationTest::testConfigEntityUnserialization public function Tests configuration entity unserialization.
UnserializationTest::testTaxonomyTermUnserialization public function Tests content entity unserialization.
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