You are here

Home » API reference » Acquia Lift Connector 8.4 » PublishOnlyRenderedTest.php

class PublishOnlyRenderedTest in Acquia Lift Connector 8.4

Class PublishOnlyRenderedTest.

@group acquia_lift_publisher

@coversDefaultClass \Drupal\acquia_lift_publisher\EventSubscriber\Publish\PublishOnlyRendered

@requires module depcalc

Hierarchy

Expanded class hierarchy of PublishOnlyRenderedTest

File

modules/acquia_lift_publisher/tests/src/Kernel/EventSubscriber/Publish/PublishOnlyRenderedTest.php, line 34

Namespace

Drupal\Tests\acquia_lift_publisher\Kernel\EventSubscriber\Publish
View source 
class PublishOnlyRenderedTest extends KernelTestBase {
  use ContentTypeCreationTrait;
  use NodeCreationTrait;
  use RandomGeneratorTrait;

  /**
   * Acquia Lift publisher settings.
   *
   * @var \Drupal\Core\Config\Config
   */
  private $publisherSettings;

  /**
   * The event dispatcher.
   *
   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
   */
  private $eventDispatcher;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'acquia_contenthub',
    'acquia_contenthub_publisher',
    'acquia_lift',
    'acquia_lift_publisher',
    'depcalc',
    'field',
    'filter',
    'image',
    'node',
    'path_alias',
    'system',
    'taxonomy',
    'text',
    'user',
  ];

  /**
   * {@inheritdoc}
   */
  public function register(ContainerBuilder $container) {
    $client = $this
      ->prophesize(ContentHubClient::class);
    $client
      ->getEntities(Argument::type('array'))
      ->willReturn(new CDFDocument());
    $settings = $this
      ->prophesize(Settings::class);
    $settings
      ->getUuid()
      ->willReturn('93b95dc0-116a-477c-9a76-5944998295c1');
    $client_factory = $this
      ->prophesize(ClientFactory::class);
    $client_factory
      ->getClient()
      ->willReturn($client
      ->reveal());
    $client_factory
      ->getSettings()
      ->willReturn($settings
      ->reveal());
    $container
      ->set('acquia_contenthub.client.factory', $client_factory
      ->reveal());
    parent::register($container);
  }

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installSchema('acquia_contenthub_publisher', [
      'acquia_contenthub_publisher_export_tracking',
    ]);
    $this
      ->installEntitySchema('path_alias');
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('entity_view_mode');
    $this
      ->installEntitySchema('entity_view_display');
    $this
      ->installEntitySchema('field_config');
    $this
      ->installEntitySchema('user');
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installConfig([
      'acquia_lift_publisher',
      'image',
      'node',
      'filter',
      'system',
    ]);
    $this
      ->createContentType([
      'type' => 'article',
      'name' => 'article',
    ]);
    $this->publisherSettings = $this->container
      ->get('config.factory')
      ->getEditable(ContentPublishingForm::CONFIG_NAME);
    $this->eventDispatcher = \Drupal::service('event_dispatcher');
  }

  /**
   * Tests default configuration content.
   */
  public function testDefaultConfiguration() {
    $pers_content_only = $this->publisherSettings
      ->get(ContentPublishingForm::$pushSettingField);
    $this
      ->assertTrue($pers_content_only, 'Personalized content push is active after installing module.');
  }

  /**
   * @covers ::onEnqueueCandidateEntity
   *
   * @throws \Exception
   */
  public function testOnEnqueueCandidateEntity() {
    $entity = $this
      ->createNode([
      'title' => 'Test title',
      'type' => 'article',
    ]);

    // Set up entity view display for rendered entity creation.
    EntityViewDisplay::create([
      'id' => 'node.article',
      'targetEntityType' => 'node',
      'bundle' => 'article',
      'label' => 'Full',
      'mode' => 'full',
    ])
      ->save();
    $operation = 'insert';
    $event = new ContentHubEntityEligibilityEvent($entity, $operation);
    $this->eventDispatcher
      ->dispatch(ContentHubPublisherEvents::ENQUEUE_CANDIDATE_ENTITY, $event);
    $this
      ->assertFalse($event
      ->getEligibility(), 'Entity not eligible due to the default publishing configuration');

    // Enable entity view display for the article, check if the entity is
    // eligible.
    $this->publisherSettings
      ->set('view_modes', [
      'node' => [
        'article' => [
          'full' => 1,
        ],
      ],
    ]);
    $this
      ->savePublisherSettings();
    $event = new ContentHubEntityEligibilityEvent($entity, $operation);
    $this->eventDispatcher
      ->dispatch(ContentHubPublisherEvents::ENQUEUE_CANDIDATE_ENTITY, $event);
    $this
      ->assertTrue($event
      ->getEligibility(), 'Entity is renderable, therefore eligible.');
  }

  /**
   * @covers ::onPrunePublishCdfEntities
   *
   * @throws \Exception
   */
  public function testOnPrunePublishCdfEntities() {
    $client = $this->container
      ->get('acquia_contenthub.client.factory')
      ->getClient();

    // Provide mock data.
    $cdf_mock = $this
      ->getCdfMock();
    $document = new CDFDocument(...$cdf_mock->original);
    $unfiltered = $document
      ->getEntities();
    $event = new PrunePublishCdfEntitiesEvent($client, $document, '175b8909-b873-4e8d-b054-896ba0293c46');
    $this->eventDispatcher
      ->dispatch(AcquiaContentHubEvents::PRUNE_PUBLISH_CDF_ENTITIES, $event);
    $pruned = $event
      ->getDocument()
      ->getEntities();
    $this
      ->assertGreaterThan($pruned, $unfiltered, 'Unnecessary content was removed from the CDF document');

    // Add the pruned CDF to the CDF test object, carry out assertions.
    $cdf_mock->pruned = $pruned;
    $this
      ->assertContainsOnlyRequiredCdfs($cdf_mock);
  }

  /**
   * Saves publisher configuration.
   *
   * @throws \Exception
   */
  private function savePublisherSettings() : void {
    $this->publisherSettings
      ->save();
    $this->container
      ->get('acquia_lift_publisher.publishing_settings')
      ->setData($this->publisherSettings
      ->getRawData());
  }

  /**
   * Asserts that the pruned CDF document only contains the required entities.
   *
   * @param object $cdf_mock
   *   The CDF test object to run the assertions against.
   */
  private function assertContainsOnlyRequiredCdfs(\stdClass $cdf_mock) {
    $orig_rendered_entity1 = $cdf_mock->rendered_entities[0]
      ->getUuid();
    $orig_rendered_entity2 = $cdf_mock->rendered_entities[1]
      ->getUuid();
    $pruned = $cdf_mock->pruned;
    $this
      ->addToAssertionCount(1);
    if (!isset($pruned[$orig_rendered_entity1], $pruned[$orig_rendered_entity2])) {
      throw new AssertionFailedError('CDF document contains the rendered entities');
    }
    $expected = $cdf_mock->expected;
    $sorter = function (CDFObject $cdf1, CDFObject $cdf2) {
      return $cdf1
        ->getUuid() <=> $cdf2
        ->getUuid();
    };
    usort($expected, $sorter);
    usort($pruned, $sorter);
    $this
      ->assertEquals($expected, array_values($pruned), 'The CDF document contains only the rendered entities, its source entity and the source entity tags.');
  }

  /**
   * Returns a testable CDF object.
   *
   * @return object
   *   The object containing the original CDF array, the rendered entity and
   *   the source entity.
   *
   * @throws \Exception
   */
  private function getCdfMock() : \stdClass {
    $uuid = \Drupal::getContainer()
      ->get('uuid');
    $time = time();
    $cdfs = [];

    // Add random CDFs.
    $no_cdfs = 11;
    $origin = $uuid
      ->generate();
    for ($i = 0; $i < $no_cdfs; $i++) {
      $cdfs[] = new CDFObject('drupal8_content_entity', $uuid
        ->generate(), $time, $time, $origin);
    }
    $source_entity = new CDFObject('drupal8_content_entity', $uuid
      ->generate(), $time, $time, $origin);
    $cdfs[] = $source_entity;

    // Add a few tags to source entity.
    $tags = array_slice($cdfs, 0, 3);
    $tag_uuids = [];

    /** @var \Acquia\ContentHubClient\CDF\CDFObject $tag */
    foreach ($tags as $tag) {
      $tag_uuids[] = $tag
        ->getUuid();
    }
    $source_entity
      ->addAttribute('tags', CDFAttribute::TYPE_ARRAY_REFERENCE, $tag_uuids);
    $rendered1 = new CDFObject('rendered_entity', $uuid
      ->generate(), $time, $time, $origin);
    $rendered1
      ->addAttribute('source_entity', CDFAttribute::TYPE_STRING, $source_entity
      ->getUuid());
    $rendered2 = new CDFObject('rendered_entity', $uuid
      ->generate(), $time, $time, $origin);
    $rendered2
      ->addAttribute('source_entity', CDFAttribute::TYPE_STRING, $source_entity
      ->getUuid());
    $cdfs[] = $rendered1;
    $cdfs[] = $rendered2;

    // Construct an easily testable object containing the original CDF array,
    // the rendered entity, and its source entity.
    $cdf_mock = new \stdClass();
    $cdf_mock->original = $cdfs;
    $cdf_mock->rendered_entities = [
      $rendered1,
      $rendered2,
    ];
    $cdf_mock->expected = array_merge([
      $source_entity,
    ], $tags, $cdf_mock->rendered_entities);
    return $cdf_mock;
  }

}

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
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::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.
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.
PublishOnlyRenderedTest::$eventDispatcher private property The event dispatcher.
PublishOnlyRenderedTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
PublishOnlyRenderedTest::$publisherSettings private property Acquia Lift publisher settings.
PublishOnlyRenderedTest::assertContainsOnlyRequiredCdfs private function Asserts that the pruned CDF document only contains the required entities.
PublishOnlyRenderedTest::getCdfMock private function Returns a testable CDF object.
PublishOnlyRenderedTest::register public function Registers test-specific services. Overrides KernelTestBase::register
PublishOnlyRenderedTest::savePublisherSettings private function Saves publisher configuration.
PublishOnlyRenderedTest::setUp protected function Overrides KernelTestBase::setUp
PublishOnlyRenderedTest::testDefaultConfiguration public function Tests default configuration content.
PublishOnlyRenderedTest::testOnEnqueueCandidateEntity public function @covers ::onEnqueueCandidateEntity
PublishOnlyRenderedTest::testOnPrunePublishCdfEntities public function @covers ::onPrunePublishCdfEntities
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.