class ProcessFieldTest

Same name in other branches
  1. 9 core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php \Drupal\Tests\field\Unit\Plugin\migrate\process\ProcessFieldTest
  2. 8.9.x core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php \Drupal\Tests\field\Unit\Plugin\migrate\process\ProcessFieldTest
  3. 11.x core/modules/field/tests/src/Unit/Plugin/migrate/process/ProcessFieldTest.php \Drupal\Tests\field\Unit\Plugin\migrate\process\ProcessFieldTest

Tests the ProcessField migrate process plugin.

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

Hierarchy

Expanded class hierarchy of ProcessFieldTest

File

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

Namespace

Drupal\Tests\field\Unit\Plugin\migrate\process
View source
class ProcessFieldTest extends MigrateTestCase {
    
    /**
     * @var \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface|\Prophecy\Prophecy\ObjectProphecy
     */
    protected MigrateFieldPluginManagerInterface|ObjectProphecy $fieldManager;
    
    /**
     * @var \Drupal\migrate_drupal\Plugin\MigrateFieldInterface|\Prophecy\Prophecy\ObjectProphecy
     */
    protected MigrateFieldInterface|ObjectProphecy $fieldPlugin;
    
    /**
     * @var \Drupal\migrate\MigrateExecutable|\Prophecy\Prophecy\ObjectProphecy
     */
    protected MigrateExecutable|ObjectProphecy $migrateExecutable;
    
    /**
     * @var \Drupal\migrate\Plugin\MigrationInterface|\Prophecy\Prophecy\ObjectProphecy
     */
    protected MigrationInterface|ObjectProphecy $migration;
    
    /**
     * @var \Drupal\migrate\Row|\Prophecy\Prophecy\ObjectProphecy
     */
    protected Row|ObjectProphecy $row;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        $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) : void {
        if ($method) {
            $this->fieldPlugin
                ->{$method}($this->row
                ->reveal())
                ->willReturn($expected_value);
        }
        $plugin = new ProcessField([
            'method' => $method,
        ], $value, [], $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->fieldManager
                ->getPluginIdFromFieldType()
                ->willThrow($exception);
        }
        $transformed_value = $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 static 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

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
MigrateTestCase::$idMap protected property The migration ID map.
MigrateTestCase::$migrationConfiguration protected property An array of migration configuration values. 10
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.
MigrateTestCase::getValue protected function Gets the value on a row for a given key.
MigrateTestCase::queryResultTest public function Tests a query.
MigrateTestCase::retrievalAssertHelper protected function Asserts tested values during test retrieval.
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.
ProcessFieldTest::$fieldManager protected property
ProcessFieldTest::$fieldPlugin protected property
ProcessFieldTest::$migrateExecutable protected property
ProcessFieldTest::$migration protected property
ProcessFieldTest::$row protected property
ProcessFieldTest::providerTestTransform public static function Provides data for the transform method test.
ProcessFieldTest::setUp protected function Overrides UnitTestCase::setUp
ProcessFieldTest::testTransform public function Tests the transform method.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
UnitTestCase::$root protected property The app root. 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::getStringTranslationStub public function Returns a stub translation manager that just returns the passed string.
UnitTestCase::setUpBeforeClass public static function
UnitTestCase::__get public function

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