class SkipOnEmptyTest

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

Tests the skip on empty process plugin.

@group migrate @coversDefaultClass \Drupal\migrate\Plugin\migrate\process\SkipOnEmpty

Hierarchy

Expanded class hierarchy of SkipOnEmptyTest

File

core/modules/migrate/tests/src/Unit/process/SkipOnEmptyTest.php, line 16

Namespace

Drupal\Tests\migrate\Unit\process
View source
class SkipOnEmptyTest extends MigrateProcessTestCase {
    
    /**
     * @covers ::process
     */
    public function testProcessSkipsOnEmpty() : void {
        $configuration['method'] = 'process';
        $plugin = new SkipOnEmpty($configuration, 'skip_on_empty', []);
        $this->assertFalse($plugin->isPipelineStopped());
        $plugin->transform('', $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertTrue($plugin->isPipelineStopped());
    }
    
    /**
     * @covers ::process
     */
    public function testProcessBypassesOnNonEmpty() : void {
        $configuration['method'] = 'process';
        $plugin = new SkipOnEmpty($configuration, 'skip_on_empty', []);
        $value = $plugin->transform(' ', $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertSame(' ', $value);
        $this->assertFalse($plugin->isPipelineStopped());
    }
    
    /**
     * @covers ::row
     */
    public function testRowSkipsOnEmpty() : void {
        $configuration['method'] = 'row';
        $this->expectException(MigrateSkipRowException::class);
        (new SkipOnEmpty($configuration, 'skip_on_empty', []))->transform('', $this->migrateExecutable, $this->row, 'destination_property');
    }
    
    /**
     * @covers ::row
     */
    public function testRowBypassesOnNonEmpty() : void {
        $configuration['method'] = 'row';
        $value = (new SkipOnEmpty($configuration, 'skip_on_empty', []))->transform(' ', $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertSame(' ', $value);
    }
    
    /**
     * Tests that a skip row exception without a message is raised.
     *
     * @covers ::row
     */
    public function testRowSkipWithoutMessage() : void {
        $configuration = [
            'method' => 'row',
        ];
        $process = new SkipOnEmpty($configuration, 'skip_on_empty', []);
        $this->expectException(MigrateSkipRowException::class);
        $process->transform('', $this->migrateExecutable, $this->row, 'destination_property');
    }
    
    /**
     * Tests that a skip row exception with a message is raised.
     *
     * @covers ::row
     */
    public function testRowSkipWithMessage() : void {
        $configuration = [
            'method' => 'row',
            'message' => 'The value is empty',
        ];
        $process = new SkipOnEmpty($configuration, 'skip_on_empty', []);
        $this->expectException(MigrateSkipRowException::class);
        $this->expectExceptionMessage('The value is empty');
        $process->transform('', $this->migrateExecutable, $this->row, 'destination_property');
    }
    
    /**
     * Tests repeated execution of a process plugin can reset the pipeline stoppage correctly.
     */
    public function testMultipleTransforms() : void {
        $configuration['method'] = 'process';
        $plugin = new SkipOnEmpty($configuration, 'skip_on_empty', []);
        // Confirm transform will stop the pipeline.
        $value = $plugin->transform('', $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertNull($value);
        $this->assertTrue($plugin->isPipelineStopped());
        // Restart the pipeline and test again.
        $plugin->reset();
        $this->assertFalse($plugin->isPipelineStopped());
        $value = $plugin->transform(' ', $this->migrateExecutable, $this->row, 'destination_property');
        $this->assertSame(' ', $value);
        $this->assertFalse($plugin->isPipelineStopped());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
MigrateProcessTestCase::$migrateExecutable protected property
MigrateProcessTestCase::$plugin protected property 1
MigrateProcessTestCase::$row protected property
MigrateProcessTestCase::setUp protected function Overrides UnitTestCase::setUp 17
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.
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.
SkipOnEmptyTest::testMultipleTransforms public function Tests repeated execution of a process plugin can reset the pipeline stoppage correctly.
SkipOnEmptyTest::testProcessBypassesOnNonEmpty public function @covers ::process
SkipOnEmptyTest::testProcessSkipsOnEmpty public function @covers ::process
SkipOnEmptyTest::testRowBypassesOnNonEmpty public function @covers ::row
SkipOnEmptyTest::testRowSkipsOnEmpty public function @covers ::row
SkipOnEmptyTest::testRowSkipWithMessage public function Tests that a skip row exception with a message is raised.
SkipOnEmptyTest::testRowSkipWithoutMessage public function Tests that a skip row exception without a message is raised.
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.