class ProcessFieldTest in Drupal 8

Tests the ProcessField migrate process plugin.

@coversDefaultClass \Drupal\field\Plugin\migrate\process\ProcessField @group field @group legacy

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\migrate\Unit\MigrateTestCase
    • class \Drupal\Tests\field\Unit\Plugin\migrate\process\ProcessFieldTest

File

core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php, line 23

Namespace

Drupal\Tests\field\Unit\Plugin\migrate\process

class ProcessFieldTest extends MigrateTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    $this->cckFieldManager = $this
      ->prophesize(MigrateCckFieldPluginManagerInterface::class);
    $this->fieldManager = $this
      ->prophesize(MigrateFieldPluginManagerInterface::class);
    $this->fieldPlugin = $this
      ->prophesize(MigrateFieldInterface::class);
    $this->migrateExecutable = $this
      ->prophesize(MigrateExecutable::class);
    $this->migration = $this
      ->prophesize(MigrationInterface::class);
    $this->row = $this
      ->prophesize(Row::class);
    $this->fieldManager
      ->getPluginIdFromFieldType('foo', [], $this->migration
      ->reveal())
      ->willReturn('foo');
    $this->fieldManager
      ->createInstance('foo', [], $this->migration
      ->reveal())
      ->willReturn($this->fieldPlugin);
    parent::setUp();
  }

  /**
   * Tests the transform method.
   *
   * @param string $method
   *   The method to call.
   * @param string $value
   *   The value to process.
   * @param mixed $expected_value
   *   The expected transformed value.
   * @param string $migrate_exception
   *   The MigrateException message to expect.
   * @param bool $plugin_not_found
   *   Whether the field plugin is not found.
   *
   * @covers ::transform
   * @dataProvider providerTestTransform
   */
  public function testTransform($method, $value, $expected_value, $migrate_exception = '', $plugin_not_found = FALSE) {
    if ($method) {
      $this->fieldPlugin
        ->{$method}($this->row
        ->reveal())
        ->willReturn($expected_value);
    }
    $this->plugin = new ProcessField([
      'method' => $method,
    ], $value, [], $this->cckFieldManager
      ->reveal(), $this->fieldManager
      ->reveal(), $this->migration
      ->reveal());
    if ($migrate_exception) {
      $this
        ->expectException(MigrateException::class);
      $this
        ->expectExceptionMessage($migrate_exception);
    }
    if ($plugin_not_found) {
      $exception = new PluginNotFoundException('foo');
      $this->cckFieldManager
        ->getPluginIdFromFieldType()
        ->willThrow($exception);
      $this->fieldManager
        ->getPluginIdFromFieldType()
        ->willThrow($exception);
    }
    $transformed_value = $this->plugin
      ->transform($value, $this->migrateExecutable
      ->reveal(), $this->row
      ->reveal(), 'foo');
    $this
      ->assertSame($transformed_value, $expected_value);
  }

  /**
   * Provides data for the transform method test.
   *
   * @return array
   *   - The method to call.
   *   - The value to process.
   *   - The expected transformed value.
   *   - The MigrateException message to expect.
   *   - Whether the field plugin is not found.
   */
  public function providerTestTransform() {
    return [
      // Tests the getFieldType() method.
      [
        'method' => 'getFieldType',
        'value' => 'foo',
        'expected_value' => 'bar',
      ],
      // Tests the getFieldFormatterMap() method.
      [
        'method' => 'getFieldFormatterMap',
        'value' => 'foo',
        'expected_value' => [
          'foo' => 'bar',
        ],
      ],
      // Tests the getFieldWidgetMap() method.
      [
        'method' => 'getFieldWidgetMap',
        'value' => 'foo',
        'expected_value' => [
          'foo' => 'bar',
        ],
      ],
      // Tests that an exception is thrown if the value is not a string.
      [
        'method' => 'getFieldType',
        'value' => [
          'foo',
        ],
        'expected_value' => '',
        'migrate_exception' => 'The input value must be a string.',
      ],
      // Tests that an exception is thrown if no method name is provided.
      [
        'method' => '',
        'value' => '',
        'expected_value' => '',
        'migrate_exception' => 'You need to specify the name of a method to be called on the Field plugin.',
      ],
      // Tests that NULL is returned if no field plugin is found.
      [
        'method' => 'getFieldType',
        'value' => 'foo',
        'expected_value' => NULL,
        'migrate_exception' => '',
        'plugin_not_found' => TRUE,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
MigrateTestCase::$idMap	protected	property	The migration ID map.
MigrateTestCase::$migrationConfiguration	protected	property	An array of migration configuration values.	16
MigrateTestCase::$migrationStatus	protected	property	Local store for mocking setStatus()/getStatus().
MigrateTestCase::createSchemaFromRow	protected	function	Generates a table schema from a row.
MigrateTestCase::getDatabase	protected	function	Gets an SQLite database connection object for use in tests.
MigrateTestCase::getMigration	protected	function	Retrieves a mocked migration.	1
MigrateTestCase::getValue	protected	function	Gets the value on a row for a given key.	1
MigrateTestCase::queryResultTest	public	function	Tests a query.
MigrateTestCase::retrievalAssertHelper	protected	function	Asserts tested values during test retrieval.
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.
ProcessFieldTest::providerTestTransform	public	function	Provides data for the transform method test.
ProcessFieldTest::setUp	protected	function	Overrides UnitTestCase::setUp
ProcessFieldTest::testTransform	public	function	Tests the transform method.
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.