class EntityRevisionTest

Same name in this branch
  1. 9 core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\Plugin\migrate\destination\EntityRevisionTest
  2. 9 core/modules/migrate/tests/src/Kernel/Plugin/EntityRevisionTest.php \Drupal\Tests\migrate\Kernel\Plugin\EntityRevisionTest
Same name in other branches
  1. 8.9.x core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest
  2. 8.9.x core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\Plugin\migrate\destination\EntityRevisionTest
  3. 8.9.x core/modules/migrate/tests/src/Kernel/Plugin/EntityRevisionTest.php \Drupal\Tests\migrate\Kernel\Plugin\EntityRevisionTest
  4. 10 core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest
  5. 10 core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\Plugin\migrate\destination\EntityRevisionTest
  6. 10 core/modules/migrate/tests/src/Kernel/Plugin/EntityRevisionTest.php \Drupal\Tests\migrate\Kernel\Plugin\EntityRevisionTest
  7. 11.x core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\destination\EntityRevisionTest
  8. 11.x core/modules/migrate/tests/src/Unit/Plugin/migrate/destination/EntityRevisionTest.php \Drupal\Tests\migrate\Unit\Plugin\migrate\destination\EntityRevisionTest
  9. 11.x core/modules/migrate/tests/src/Kernel/Plugin/EntityRevisionTest.php \Drupal\Tests\migrate\Kernel\Plugin\EntityRevisionTest

Tests entity revision destination.

@group migrate @coversDefaultClass \Drupal\migrate\Plugin\migrate\destination\EntityRevision

Hierarchy

Expanded class hierarchy of EntityRevisionTest

File

core/modules/migrate/tests/src/Unit/destination/EntityRevisionTest.php, line 25

Namespace

Drupal\Tests\migrate\Unit\destination
View source
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;
    
    /**
     * A mock account switcher.
     *
     * @var \Prophecy\Prophecy\ObjectProphecy|\Drupal\Core\Session\AccountSwitcherInterface
     */
    protected $accountSwitcher;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        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');
        $this->accountSwitcher = $this->prophesize(AccountSwitcherInterface::class);
    }
    
    /**
     * Tests 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,
        ]));
    }
    
    /**
     * Tests 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, []));
    }
    
    /**
     * Tests 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, []));
    }
    
    /**
     * Tests 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, []));
    }
    
    /**
     * Tests 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(), $this->accountSwitcher
            ->reveal());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
EntityRevisionTest::$accountSwitcher protected property A mock account switcher.
EntityRevisionTest::$entityFieldManager protected property
EntityRevisionTest::$fieldTypeManager protected property
EntityRevisionTest::$migration protected property
EntityRevisionTest::$storage protected property
EntityRevisionTest::getEntityRevisionDestination protected function Helper method to create an entity revision destination with mock services.
EntityRevisionTest::setUp protected function Overrides UnitTestCase::setUp
EntityRevisionTest::testGetEntityDestinationValues public function Tests that passed old destination values are used by default.
EntityRevisionTest::testGetEntityLoadFailure public function Tests entity load failure.
EntityRevisionTest::testGetEntityNewRevision public function Tests that new revisions are flagged to be written as new.
EntityRevisionTest::testGetEntityUpdateRevision public function Tests that revision updates update.
EntityRevisionTest::testSave public function Tests entity revision save.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator protected property The random generator.
UnitTestCase::$root protected property The app root. 1
UnitTestCase::assertArrayEquals Deprecated protected function Asserts if two arrays are equal by sorting them first.
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::setUpBeforeClass public static function

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.