class ExplodeTest in Drupal 10

Tests the Explode process plugin.

@group migrate

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\migrate\Unit\MigrateTestCase
    • class \Drupal\Tests\migrate\Unit\process\MigrateProcessTestCase
      • class \Drupal\Tests\migrate\Unit\process\ExplodeTest

File

core/modules/migrate/tests/src/Unit/process/ExplodeTest.php, line 14

Namespace

Drupal\Tests\migrate\Unit\process

class ExplodeTest extends MigrateProcessTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    $configuration = [
      'delimiter' => ',',
    ];
    $this->plugin = new Explode($configuration, 'map', []);
    parent::setUp();
  }

  /**
   * Tests explode transform process works.
   */
  public function testTransform() {
    $value = $this->plugin
      ->transform('foo,bar,tik', $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame([
      'foo',
      'bar',
      'tik',
    ], $value);
  }

  /**
   * Tests explode transform process works with a limit.
   */
  public function testTransformLimit() {
    $plugin = new Explode([
      'delimiter' => '_',
      'limit' => 2,
    ], 'map', []);
    $value = $plugin
      ->transform('foo_bar_tik', $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame([
      'foo',
      'bar_tik',
    ], $value);
  }

  /**
   * Tests if the explode process can be chained with handles_multiple process.
   */
  public function testChainedTransform() {
    $exploded = $this->plugin
      ->transform('One,Two,Three', $this->migrateExecutable, $this->row, 'destination_property');
    $concat = new Concat([], 'map', []);
    $concatenated = $concat
      ->transform($exploded, $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame('OneTwoThree', $concatenated);
  }

  /**
   * Tests explode fails properly on non-strings.
   */
  public function testExplodeWithNonString() {
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('is not a string');
    $this->plugin
      ->transform([
      'foo',
    ], $this->migrateExecutable, $this->row, 'destination_property');
  }

  /**
   * Tests that explode works on non-strings but with strict set to FALSE.
   *
   * @dataProvider providerExplodeWithNonStrictAndEmptySource
   */
  public function testExplodeWithNonStrictAndEmptySource($value, $expected) {
    $plugin = new Explode([
      'delimiter' => '|',
      'strict' => FALSE,
    ], 'map', []);
    $processed = $plugin
      ->transform($value, $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame($expected, $processed);
  }

  /**
   * Data provider for ::testExplodeWithNonStrictAndEmptySource().
   */
  public function providerExplodeWithNonStrictAndEmptySource() {
    return [
      'normal_string' => [
        'a|b|c',
        [
          'a',
          'b',
          'c',
        ],
      ],
      'integer_cast_to_string' => [
        123,
        [
          '123',
        ],
      ],
      'zero_integer_cast_to_string' => [
        0,
        [
          '0',
        ],
      ],
      'true_cast_to_string' => [
        TRUE,
        [
          '1',
        ],
      ],
      'null_empty_array' => [
        NULL,
        [],
      ],
      'false_empty_array' => [
        FALSE,
        [],
      ],
      'empty_string_empty_array' => [
        '',
        [],
      ],
    ];
  }

  /**
   * Tests that explode raises an exception when the value cannot be casted to
   * string.
   */
  public function testExplodeWithNonStrictAndNonCastable() {
    $plugin = new Explode([
      'delimiter' => '|',
      'strict' => FALSE,
    ], 'map', []);
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('cannot be casted to a string');
    $processed = $plugin
      ->transform([
      'foo',
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame([
      'foo',
    ], $processed);
  }

  /**
   * Tests that explode with an empty string and strict check returns a
   * non-empty array.
   */
  public function testExplodeWithStrictAndEmptyString() {
    $plugin = new Explode([
      'delimiter' => '|',
    ], 'map', []);
    $processed = $plugin
      ->transform('', $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame([
      '',
    ], $processed);
  }

  /**
   * Tests explode fails with empty delimiter.
   */
  public function testExplodeWithEmptyDelimiter() {
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('delimiter is empty');
    $plugin = new Explode([
      'delimiter' => '',
    ], 'map', []);
    $plugin
      ->transform('foo,bar', $this->migrateExecutable, $this->row, 'destination_property');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ExplodeTest::providerExplodeWithNonStrictAndEmptySource	public	function	Data provider for ::testExplodeWithNonStrictAndEmptySource().
ExplodeTest::setUp	protected	function	Overrides MigrateProcessTestCase::setUp
ExplodeTest::testChainedTransform	public	function	Tests if the explode process can be chained with handles_multiple process.
ExplodeTest::testExplodeWithEmptyDelimiter	public	function	Tests explode fails with empty delimiter.
ExplodeTest::testExplodeWithNonStrictAndEmptySource	public	function	Tests that explode works on non-strings but with strict set to FALSE.
ExplodeTest::testExplodeWithNonStrictAndNonCastable	public	function	Tests that explode raises an exception when the value cannot be casted to string.
ExplodeTest::testExplodeWithNonString	public	function	Tests explode fails properly on non-strings.
ExplodeTest::testExplodeWithStrictAndEmptyString	public	function	Tests that explode with an empty string and strict check returns a non-empty array.
ExplodeTest::testTransform	public	function	Tests explode transform process works.
ExplodeTest::testTransformLimit	public	function	Tests explode transform process works with a limit.
MigrateProcessTestCase::$migrateExecutable	protected	property
MigrateProcessTestCase::$plugin	protected	property
MigrateProcessTestCase::$row	protected	property
MigrateTestCase::$idMap	protected	property	The migration ID map.
MigrateTestCase::$migrationConfiguration	protected	property	An array of migration configuration values.	5
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.
UnitTestCase::$randomGenerator	protected	property	The random generator.
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::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