class SubstrTest in Drupal 9

Tests the substr plugin.

@coversDefaultClass \Drupal\migrate\Plugin\migrate\process\Substr

@group migrate

Hierarchy

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

File

core/modules/migrate/tests/src/Unit/process/SubstrTest.php, line 17

Namespace

Drupal\Tests\migrate\Unit\process

class SubstrTest extends MigrateProcessTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
  }

  /**
   * Tests Substr plugin based on providerTestSubstr() values.
   *
   * @dataProvider providerTestSubstr
   */
  public function testSubstr($start = NULL, $length = NULL, $expected = NULL) {
    $configuration['start'] = $start;
    $configuration['length'] = $length;
    $this->plugin = new Substr($configuration, 'map', []);
    $value = $this->plugin
      ->transform('Captain Janeway', $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame($expected, $value);
  }

  /**
   * Data provider for testSubstr().
   */
  public function providerTestSubstr() {
    return [
      // Tests with valid start and length values.
      [
        0,
        7,
        'Captain',
      ],
      // Tests with valid start > 0 and valid length.
      [
        6,
        3,
        'n J',
      ],
      // Tests with valid start < 0 and valid length.
      [
        -7,
        4,
        'Jane',
      ],
      // Tests without start value and valid length value.
      [
        NULL,
        7,
        'Captain',
      ],
      // Tests with valid start value and no length value.
      [
        1,
        NULL,
        'aptain Janeway',
      ],
      // Tests without both start and length values.
      [
        NULL,
        NULL,
        'Captain Janeway',
      ],
    ];
  }

  /**
   * Tests invalid input type.
   */
  public function testSubstrFail() {
    $configuration = [];
    $this->plugin = new Substr($configuration, 'map', []);
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('The input value must be a string.');
    $this->plugin
      ->transform([
      'Captain Janeway',
    ], $this->migrateExecutable, $this->row, 'destination_property');
  }

  /**
   * Tests that the start parameter is an integer.
   */
  public function testStartIsString() {
    $configuration['start'] = '2';
    $this->plugin = new Substr($configuration, 'map', []);
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('The start position configuration value should be an integer. Omit this key to capture from the beginning of the string.');
    $this->plugin
      ->transform([
      'foo',
    ], $this->migrateExecutable, $this->row, 'destination_property');
  }

  /**
   * Tests that the length parameter is an integer.
   */
  public function testLengthIsString() {
    $configuration['length'] = '1';
    $this->plugin = new Substr($configuration, 'map', []);
    $this
      ->expectException(MigrateException::class);
    $this
      ->expectExceptionMessage('The character length configuration value should be an integer. Omit this key to capture from the start position to the end of the string.');
    $this->plugin
      ->transform([
      'foo',
    ], $this->migrateExecutable, $this->row, 'destination_property');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
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.	7
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.
SubstrTest::providerTestSubstr	public	function	Data provider for testSubstr().
SubstrTest::setUp	protected	function	Overrides MigrateProcessTestCase::setUp
SubstrTest::testLengthIsString	public	function	Tests that the length parameter is an integer.
SubstrTest::testStartIsString	public	function	Tests that the start parameter is an integer.
SubstrTest::testSubstr	public	function	Tests Substr plugin based on providerTestSubstr() values.
SubstrTest::testSubstrFail	public	function	Tests invalid input type.
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