EntityContentBaseTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\migrate\Unit\Plugin\migrate\destination;

use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Field\FieldTypePluginManagerInterface;
use Drupal\Core\Session\AccountSwitcherInterface;
use Drupal\migrate\MigrateException;
use Drupal\migrate\Plugin\migrate\destination\EntityContentBase;
use Drupal\migrate\Plugin\MigrateIdMapInterface;
use Drupal\migrate\Row;
use PHPUnit\Framework\Attributes\CoversClass;
use PHPUnit\Framework\Attributes\Group;
use Prophecy\Argument;

/**
 * Tests base entity migration destination functionality.
 */
class EntityContentBaseTest extends EntityTestBase {
  
  /**
   * Tests basic entity save.
   *
   * @legacy-covers ::import
   */
  public function testImport() : void {
    $bundles = [];
    $destination = new EntityTestDestination([], '', [], $this->migration
      ->reveal(), $this->storage
      ->reveal(), $bundles, $this->entityFieldManager
      ->reveal(), $this->prophesize(FieldTypePluginManagerInterface::class)
      ->reveal(), $this->prophesize(AccountSwitcherInterface::class)
      ->reveal(), $this->prophesize(EntityTypeBundleInfoInterface::class)
      ->reveal());
    $entity = $this->prophesize(ContentEntityInterface::class);
    $entity->isValidationRequired()
      ->shouldBeCalledTimes(1);
    // Assert that save is called.
    $entity->save()
      ->shouldBeCalledTimes(1);
    // Syncing should be set once.
    $entity->setSyncing(Argument::exact(TRUE))
      ->shouldBeCalledTimes(1);
    // Set an id for the entity.
    $entity->id()
      ->willReturn(5);
    $destination->setEntity($entity->reveal());
    // Ensure the id is saved entity id is returned from import.
    $this->assertEquals([
      5,
    ], $destination->import(new Row()));
    // Assert that import set the rollback action.
    $this->assertEquals(MigrateIdMapInterface::ROLLBACK_DELETE, $destination->rollbackAction());
  }
  
  /**
   * Tests row skipping when we can't get an entity to save.
   *
   * @legacy-covers ::import
   */
  public function testImportEntityLoadFailure() : void {
    $bundles = [];
    $destination = new EntityTestDestination([], '', [], $this->migration
      ->reveal(), $this->storage
      ->reveal(), $bundles, $this->entityFieldManager
      ->reveal(), $this->prophesize(FieldTypePluginManagerInterface::class)
      ->reveal(), $this->prophesize(AccountSwitcherInterface::class)
      ->reveal(), $this->prophesize(EntityTypeBundleInfoInterface::class)
      ->reveal());
    $destination->setEntity(FALSE);
    $this->expectException(MigrateException::class);
    $this->expectExceptionMessage('Unable to get entity');
    $destination->import(new Row());
  }
  
  /**
   * Tests that translation destination fails for untranslatable entities.
   */
  public function testUntranslatable() : void {
    // An entity type without a language.
    $this->entityType
      ->getKey('langcode')
      ->willReturn('');
    $this->entityType
      ->getKey('id')
      ->willReturn('id');
    $this->entityFieldManager
      ->getBaseFieldDefinitions('foo')
      ->willReturn([
      'id' => BaseFieldDefinitionTest::create('integer'),
    ]);
    $destination = new EntityTestDestination([
      'translations' => TRUE,
    ], '', [], $this->migration
      ->reveal(), $this->storage
      ->reveal(), [], $this->entityFieldManager
      ->reveal(), $this->prophesize(FieldTypePluginManagerInterface::class)
      ->reveal(), $this->prophesize(AccountSwitcherInterface::class)
      ->reveal(), $this->prophesize(EntityTypeBundleInfoInterface::class)
      ->reveal());
    $this->expectException(MigrateException::class);
    $this->expectExceptionMessage('The "foo" entity type does not support translations.');
    $destination->getIds();
  }

}

/**
 * Stub class for testing EntityContentBase methods.
 *
 * We want to test things without testing the base class implementations.
 */
class EntityTestDestination extends EntityContentBase {
  
  /**
   * The test entity.
   *
   * @var \Drupal\migrate\Plugin\migrate\destination\EntityContentBase|null
   */
  private $entity = NULL;
  
  /**
   * Sets the test entity.
   */
  public function setEntity($entity) : void {
    $this->entity = $entity;
  }
  
  /**
   * Gets the test entity.
   */
  protected function getEntity(Row $row, array $old_destination_id_values) {
    return $this->entity;
  }
  
  /**
   * Gets the test entity ID.
   */
  public static function getEntityTypeId($plugin_id) {
    return 'foo';
  }

}