You are here

Home » API reference » Acquia Content Hub 8 » ContentHubEntitiesTrackingTest.php

class ContentHubEntitiesTrackingTest in Acquia Content Hub 8

PHPUnit tests for the ContentHubEntitiesTracking class.

@coversDefaultClass \Drupal\acquia_contenthub\ContentHubEntitiesTracking

@group acquia_contenthub

Hierarchy

Expanded class hierarchy of ContentHubEntitiesTrackingTest

File

tests/src/Unit/ContentHubEntitiesTrackingTest.php, line 16

Namespace

Drupal\Tests\acquia_contenthub\Unit
View source 
class ContentHubEntitiesTrackingTest extends UnitTestCase {

  /**
   * Content Hub Entities Tracking.
   *
   * @var \Drupal\acquia_contenthub\ContentHubEntitiesTracking
   */
  protected $contentHubEntitiesTracking;

  /**
   * The Site Origin.
   *
   * @var string
   */
  protected $siteOrigin = '22222222-2222-2222-2222-222222222222';

  /**
   * Loads a ContentHubEntitiesTracking object.
   *
   * @param array|null $database_entity
   *   An entity array, that would come as result of a query to the database.
   * @param string|null $site_origin
   *   The site origin.
   *
   * @return \Drupal\acquia_contenthub\ContentHubEntitiesTracking
   *   The loaded object.
   */
  protected function getContentHubEntitiesTrackingService($database_entity = NULL, $site_origin = NULL) {

    // If Site Origin is not set, use default.
    $site_origin = isset($site_origin) ? $site_origin : $this->siteOrigin;
    $database = $this
      ->getMockBuilder('\\Drupal\\Core\\Database\\Connection')
      ->disableOriginalConstructor()
      ->getMock();

    // If we do not provide a database entity, do not use database.
    if (isset($database_entity)) {
      $select = $this
        ->createMock('\\Drupal\\Core\\Database\\Query\\SelectInterface');
      $select
        ->expects($this
        ->any())
        ->method('fields')
        ->with('ci')
        ->will($this
        ->returnSelf());
      $execute = $this
        ->createMock('\\Drupal\\Core\\Executable\\ExecutableInterface');
      $select
        ->expects($this
        ->any())
        ->method('condition')
        ->with('entity_uuid', $database_entity['entity_uuid'])
        ->will($this
        ->returnValue($execute));
      $statement = $this
        ->createMock('\\Drupal\\Core\\Database\\StatementInterface');
      $statement
        ->expects($this
        ->any())
        ->method('fetchAssoc')
        ->willReturn($database_entity);
      $execute
        ->expects($this
        ->any())
        ->method('execute')
        ->will($this
        ->returnValue($statement));
      $database
        ->expects($this
        ->any())
        ->method('select')
        ->withAnyParameters()
        ->will($this
        ->returnValue($select));
    }
    $admin_config = $this
      ->getMockBuilder('\\Drupal\\Core\\Config\\ImmutableConfig')
      ->disableOriginalConstructor()
      ->getMock();
    $admin_config
      ->method('get')
      ->with('origin')
      ->willReturn($site_origin);
    $config_factory = $this
      ->getMockBuilder('Drupal\\Core\\Config\\ConfigFactoryInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $config_factory
      ->method('get')
      ->with('acquia_contenthub.admin_settings')
      ->willReturn($admin_config);
    return new ContentHubEntitiesTracking($database, $config_factory);
  }

  /**
   * Test for Exported Entities.
   *
   * @covers ::setExportedEntity
   */
  public function testSetExportedEntity() {
    $entity = (object) [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-000000000000',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '11111111-1111-1111-1111-111111111111',
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService();
    $this->contentHubEntitiesTracking
      ->setExportedEntity($entity->entity_type, $entity->entity_id, $entity->entity_uuid, $entity->modified, $entity->origin);

    // Running basic tests.
    $this
      ->assertEquals($entity->entity_type, $this->contentHubEntitiesTracking
      ->getEntityType());
    $this
      ->assertEquals($entity->entity_id, $this->contentHubEntitiesTracking
      ->getEntityId());
    $this
      ->assertEquals($entity->entity_uuid, $this->contentHubEntitiesTracking
      ->getUuid());
    $this
      ->assertEquals($entity->modified, $this->contentHubEntitiesTracking
      ->getModified());
    $this
      ->assertEquals($entity->origin, $this->contentHubEntitiesTracking
      ->getOrigin());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isInitiated());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isExported());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isReindex());
    $this->contentHubEntitiesTracking
      ->setExported();
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isInitiated());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isReindex());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isQueued());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isExported());
    $modified = '2017-11-04T20:51:45+00:00';
    $this->contentHubEntitiesTracking
      ->setModified($modified);
    $this
      ->assertEquals($modified, $this->contentHubEntitiesTracking
      ->getModified());

    // Assigning a Database Entity.
    $database_entity = [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-111111112222',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '11111111-1111-1111-1111-111111111111',
      'status_export' => ContentHubEntitiesTracking::INITIATED,
      'status_import' => '',
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService($database_entity);

    // Trying to load an imported entity should return false.
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->loadImportedByUuid($database_entity['entity_uuid']));

    // Loading an exported entity should work.
    $this->contentHubEntitiesTracking
      ->loadExportedByUuid($database_entity['entity_uuid']);
    $this
      ->assertEquals($database_entity['entity_type'], $this->contentHubEntitiesTracking
      ->getEntityType());
    $this
      ->assertEquals($database_entity['entity_id'], $this->contentHubEntitiesTracking
      ->getEntityId());
    $this
      ->assertEquals($database_entity['entity_uuid'], $this->contentHubEntitiesTracking
      ->getUuid());
    $this
      ->assertEquals($database_entity['modified'], $this->contentHubEntitiesTracking
      ->getModified());
    $this
      ->assertEquals($database_entity['origin'], $this->contentHubEntitiesTracking
      ->getOrigin());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isInitiated());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isQueued());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isExported());
    $this->contentHubEntitiesTracking
      ->setQueued();
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isQueued());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isExported());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isInitiated());
  }

  /**
   * Test for Imported Entities.
   *
   * @covers ::setImportedEntity
   */
  public function testSetImportedEntity() {
    $entity = (object) [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-000000000000',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '11111111-1111-1111-1111-111111111111',
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService();
    $this->contentHubEntitiesTracking
      ->setImportedEntity($entity->entity_type, $entity->entity_id, $entity->entity_uuid, $entity->modified, $entity->origin);

    // Running basic tests.
    $this
      ->assertEquals($entity->entity_type, $this->contentHubEntitiesTracking
      ->getEntityType());
    $this
      ->assertEquals($entity->entity_id, $this->contentHubEntitiesTracking
      ->getEntityId());
    $this
      ->assertEquals($entity->entity_uuid, $this->contentHubEntitiesTracking
      ->getUuid());
    $this
      ->assertEquals($entity->modified, $this->contentHubEntitiesTracking
      ->getModified());
    $this
      ->assertEquals($entity->origin, $this->contentHubEntitiesTracking
      ->getOrigin());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isPendingSync());
    $this->contentHubEntitiesTracking
      ->setLocalChange();
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isPendingSync());
    $this->contentHubEntitiesTracking
      ->setPendingSync();
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isPendingSync());
    $modified = '2017-11-04T20:51:45+00:00';
    $this->contentHubEntitiesTracking
      ->setModified($modified);
    $this
      ->assertEquals($modified, $this->contentHubEntitiesTracking
      ->getModified());

    // Assigning a Database Entity.
    $database_entity = [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-111111111111',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '11111111-1111-1111-1111-111111111111',
      'status_export' => '',
      'status_import' => ContentHubEntitiesTracking::AUTO_UPDATE_DISABLED,
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService($database_entity);

    // Trying to load an exported entity should return false.
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->loadExportedByUuid($database_entity['entity_uuid']));

    // Trying to load an imported entity should work.
    $this->contentHubEntitiesTracking
      ->loadImportedByUuid($database_entity['entity_uuid']);
    $this
      ->assertEquals($database_entity['entity_type'], $this->contentHubEntitiesTracking
      ->getEntityType());
    $this
      ->assertEquals($database_entity['entity_id'], $this->contentHubEntitiesTracking
      ->getEntityId());
    $this
      ->assertEquals($database_entity['entity_uuid'], $this->contentHubEntitiesTracking
      ->getUuid());
    $this
      ->assertEquals($database_entity['modified'], $this->contentHubEntitiesTracking
      ->getModified());
    $this
      ->assertEquals($database_entity['origin'], $this->contentHubEntitiesTracking
      ->getOrigin());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isPendingSync());
  }

  /**
   * Test for Imported Dependent Entity.
   *
   * @covers ::setDependent
   * @covers ::isDependent
   *
   * @expectedException \Exception
   *
   * @expectedExceptionCode 0
   *
   * @expectedExceptionMessage The "IS_DEPENDENT" status is immutable, and cannot be set again.
   */
  public function testImportedDependentEntity() {
    $entity = (object) [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-000000000000',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '11111111-1111-1111-1111-111111111111',
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService();
    $this->contentHubEntitiesTracking
      ->setImportedEntity($entity->entity_type, $entity->entity_id, $entity->entity_uuid, $entity->modified, $entity->origin);
    $this->contentHubEntitiesTracking
      ->setDependent();
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isPendingSync());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isDependent());

    // Set to another status should produce an Exception.
    $this
      ->expectException(\Exception::class);
    $this
      ->expectExceptionMessage('The "IS_DEPENDENT" status is immutable, and cannot be set again.');
    $this->contentHubEntitiesTracking
      ->setLocalChange();
  }

  /**
   * Test for service-level caching.
   *
   * @covers ::setImportedEntity
   */
  public function testServiceLevelCaching() {
    $entity1 = (object) [
      'entity_type' => 'node',
      'entity_id' => 1,
      'entity_uuid' => '00000000-0000-0000-0000-000000000000',
      'modified' => '2016-12-09T20:51:45+00:00',
      'origin' => '22222222-2222-2222-2222-222222222222',
    ];
    $entity2 = (object) [
      'entity_type' => 'node',
      'entity_id' => 2,
      'entity_uuid' => '11111111-1111-1111-1111-111111111111',
      'modified' => '2016-12-10T20:51:45+00:00',
      'origin' => '22222222-2222-2222-2222-222222222222',
    ];
    $this->contentHubEntitiesTracking = $this
      ->getContentHubEntitiesTrackingService();
    $this->contentHubEntitiesTracking
      ->setImportedEntity($entity1->entity_type, $entity1->entity_id, $entity1->entity_uuid, $entity1->modified, $entity1->origin);
    $this->contentHubEntitiesTracking
      ->setImportedEntity($entity2->entity_type, $entity2->entity_id, $entity2->entity_uuid, $entity2->modified, $entity2->origin);
    $this->contentHubEntitiesTracking
      ->loadExportedByDrupalEntity($entity1->entity_type, $entity1->entity_id);
    $this
      ->assertEquals($entity1->entity_type, $this->contentHubEntitiesTracking
      ->getEntityType());
    $this
      ->assertEquals($entity1->entity_id, $this->contentHubEntitiesTracking
      ->getEntityId());
    $this
      ->assertEquals($entity1->entity_uuid, $this->contentHubEntitiesTracking
      ->getUuid());
    $this
      ->assertEquals($entity1->modified, $this->contentHubEntitiesTracking
      ->getModified());
    $this
      ->assertEquals($entity1->origin, $this->contentHubEntitiesTracking
      ->getOrigin());
    $this
      ->assertTrue($this->contentHubEntitiesTracking
      ->isAutoUpdate());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->hasLocalChange());
    $this
      ->assertFalse($this->contentHubEntitiesTracking
      ->isPendingSync());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ContentHubEntitiesTrackingTest::$contentHubEntitiesTracking protected property Content Hub Entities Tracking.
ContentHubEntitiesTrackingTest::$siteOrigin protected property The Site Origin.
ContentHubEntitiesTrackingTest::getContentHubEntitiesTrackingService protected function Loads a ContentHubEntitiesTracking object.
ContentHubEntitiesTrackingTest::testImportedDependentEntity public function Test for Imported Dependent Entity.
ContentHubEntitiesTrackingTest::testServiceLevelCaching public function Test for service-level caching.
ContentHubEntitiesTrackingTest::testSetExportedEntity public function Test for Exported Entities.
ContentHubEntitiesTrackingTest::testSetImportedEntity public function Test for Imported Entities.
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.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals protected function Asserts if two arrays are equal by sorting them first.
UnitTestCase::getBlockMockWithMachineName Deprecated protected function Mocks a block with a block plugin. 1
UnitTestCase::getClassResolverStub protected function Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub public function Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub public function Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator protected function Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator protected function Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName public function Generates a unique random string containing letters and numbers.
UnitTestCase::setUp protected function 340