EntityRevisionTest.php in Drupal 8

Contains \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest.

Namespace

Drupal\Tests\migrate\Unit\destination

File

core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php

<?php

/**
 * @file
 * Contains \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest.
 */
namespace Drupal\Tests\migrate\Unit\destination;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\migrate\Plugin\MigrationInterface;
use Drupal\migrate\Plugin\migrate\destination\EntityRevision as RealEntityRevision;
use Drupal\migrate\Row;
use Drupal\Tests\UnitTestCase;

/**
 * Tests entity revision destination.
 *
 * @group migrate
 * @coversDefaultClass \Drupal\migrate\Plugin\migrate\destination\EntityRevision
 */
class EntityRevisionTest extends UnitTestCase {

  /**
   * @var \Drupal\migrate\Plugin\MigrationInterface
   */
  protected $migration;

  /**
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * @var \Drupal\Core\Entity\EntityFieldManagerInterface
   */
  protected $entityFieldManager;

  /**
   * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
   */
  protected $fieldTypeManager;
  protected function setUp() {
    parent::setUp();

    // Setup mocks to be used when creating a revision destination.
    $this->migration = $this
      ->prophesize(MigrationInterface::class);
    $this->storage = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityStorageInterface');
    $entity_type = $this
      ->prophesize(EntityTypeInterface::class);
    $entity_type
      ->getSingularLabel()
      ->willReturn('crazy');
    $entity_type
      ->getPluralLabel()
      ->willReturn('craziness');
    $this->storage
      ->getEntityType()
      ->willReturn($entity_type
      ->reveal());
    $this->entityFieldManager = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityFieldManagerInterface');
    $this->fieldTypeManager = $this
      ->prophesize('\\Drupal\\Core\\Field\\FieldTypePluginManagerInterface');
  }

  /**
   * Test that passed old destination values are used by default.
   *
   * @covers ::getEntity
   */
  public function testGetEntityDestinationValues() {
    $destination = $this
      ->getEntityRevisionDestination([]);

    // Return a dummy because we don't care what gets called.
    $entity = $this
      ->prophesize('\\Drupal\\Core\\Entity\\RevisionableInterface');

    // Assert that the first ID from the destination values is used to load the
    // entity.
    $this->storage
      ->loadRevision(12)
      ->shouldBeCalled()
      ->willReturn($entity
      ->reveal());
    $row = new Row();
    $this
      ->assertEquals($entity
      ->reveal(), $destination
      ->getEntity($row, [
      12,
      13,
    ]));
  }

  /**
   * Test that revision updates update.
   *
   * @covers ::getEntity
   */
  public function testGetEntityUpdateRevision() {
    $destination = $this
      ->getEntityRevisionDestination([]);
    $entity = $this
      ->prophesize('\\Drupal\\Core\\Entity\\RevisionableInterface');
    $entity_type = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $entity_type
      ->getKey('id')
      ->willReturn('nid');
    $entity_type
      ->getKey('revision')
      ->willReturn('vid');
    $this->storage
      ->getEntityType()
      ->willReturn($entity_type
      ->reveal());

    // Assert we load the correct revision.
    $this->storage
      ->loadRevision(2)
      ->shouldBeCalled()
      ->willReturn($entity
      ->reveal());

    // Make sure its set as an update and not the default revision.
    $entity
      ->setNewRevision(FALSE)
      ->shouldBeCalled();
    $entity
      ->isDefaultRevision(FALSE)
      ->shouldBeCalled();
    $row = new Row([
      'nid' => 1,
      'vid' => 2,
    ], [
      'nid' => 1,
      'vid' => 2,
    ]);
    $row
      ->setDestinationProperty('vid', 2);
    $this
      ->assertEquals($entity
      ->reveal(), $destination
      ->getEntity($row, []));
  }

  /**
   * Test that new revisions are flagged to be written as new.
   *
   * @covers ::getEntity
   */
  public function testGetEntityNewRevision() {
    $destination = $this
      ->getEntityRevisionDestination([]);
    $entity = $this
      ->prophesize('\\Drupal\\Core\\Entity\\RevisionableInterface');
    $entity_type = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $entity_type
      ->getKey('id')
      ->willReturn('nid');
    $entity_type
      ->getKey('revision')
      ->willReturn('vid');
    $this->storage
      ->getEntityType()
      ->willReturn($entity_type
      ->reveal());

    // Enforce is new should be disabled.
    $entity
      ->enforceIsNew(FALSE)
      ->shouldBeCalled();

    // And toggle this as new revision but not the default revision.
    $entity
      ->setNewRevision(TRUE)
      ->shouldBeCalled();
    $entity
      ->isDefaultRevision(FALSE)
      ->shouldBeCalled();

    // Assert we load the correct revision.
    $this->storage
      ->load(1)
      ->shouldBeCalled()
      ->willReturn($entity
      ->reveal());
    $row = new Row([
      'nid' => 1,
      'vid' => 2,
    ], [
      'nid' => 1,
      'vid' => 2,
    ]);
    $row
      ->setDestinationProperty('nid', 1);
    $this
      ->assertEquals($entity
      ->reveal(), $destination
      ->getEntity($row, []));
  }

  /**
   * Test entity load failure.
   *
   * @covers ::getEntity
   */
  public function testGetEntityLoadFailure() {
    $destination = $this
      ->getEntityRevisionDestination([]);
    $entity_type = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityTypeInterface');
    $entity_type
      ->getKey('id')
      ->willReturn('nid');
    $entity_type
      ->getKey('revision')
      ->willReturn('vid');
    $this->storage
      ->getEntityType()
      ->willReturn($entity_type
      ->reveal());

    // Return a failed load and make sure we don't fail and we return FALSE.
    $this->storage
      ->load(1)
      ->shouldBeCalled()
      ->willReturn(FALSE);
    $row = new Row([
      'nid' => 1,
      'vid' => 2,
    ], [
      'nid' => 1,
      'vid' => 2,
    ]);
    $row
      ->setDestinationProperty('nid', 1);
    $this
      ->assertFalse($destination
      ->getEntity($row, []));
  }

  /**
   * Test entity revision save.
   *
   * @covers ::save
   */
  public function testSave() {
    $entity = $this
      ->prophesize('\\Drupal\\Core\\Entity\\ContentEntityInterface');
    $entity
      ->save()
      ->shouldBeCalled();
    $entity
      ->getRevisionId()
      ->shouldBeCalled()
      ->willReturn(1234);
    $destination = $this
      ->getEntityRevisionDestination();
    $this
      ->assertEquals([
      1234,
    ], $destination
      ->save($entity
      ->reveal(), []));
  }

  /**
   * Helper method to create an entity revision destination with mock services.
   *
   * @see \Drupal\Tests\migrate\Unit\Destination\EntityRevision
   *
   * @param $configuration
   *   Configuration for the destination.
   * @param string $plugin_id
   *   The plugin id.
   * @param array $plugin_definition
   *   The plugin definition.
   *
   * @return \Drupal\Tests\migrate\Unit\destination\EntityRevision
   *   Mocked destination.
   */
  protected function getEntityRevisionDestination(array $configuration = [], $plugin_id = 'entity_revision', array $plugin_definition = []) {
    return new EntityRevision($configuration, $plugin_id, $plugin_definition, $this->migration
      ->reveal(), $this->storage
      ->reveal(), [], $this->entityFieldManager
      ->reveal(), $this->fieldTypeManager
      ->reveal());
  }

}

/**
 * Mock that exposes from internal methods for testing.
 */
class EntityRevision extends RealEntityRevision {

  /**
   * Allow public access for testing.
   */
  public function getEntity(Row $row, array $old_destination_id_values) {
    return parent::getEntity($row, $old_destination_id_values);
  }

  /**
   * Allow public access for testing.
   */
  public function save(ContentEntityInterface $entity, array $old_destination_id_values = []) {
    return parent::save($entity, $old_destination_id_values);
  }

  /**
   * Don't test method from base class.
   *
   * This method is from the parent and we aren't concerned with the inner
   * workings of its implementation which would trickle into mock assertions. An
   * empty implementation avoids this.
   */
  protected function updateEntity(EntityInterface $entity, Row $row) {
    return $entity;
  }

}

Classes

Name	Description
EntityRevision	Mock that exposes from internal methods for testing.
EntityRevisionTest	Tests entity revision destination.