class LegacyBlockVisibilityTest

Tests the block_visibility process plugin.

@coversDefaultClass \Drupal\block\Plugin\migrate\process\BlockVisibility

@group block @group legacy

Hierarchy

Expanded class hierarchy of LegacyBlockVisibilityTest

File

core/modules/block/tests/src/Unit/Plugin/migrate/process/LegacyBlockVisibilityTest.php, line 21

Namespace

Drupal\Tests\block\Unit\Plugin\migrate\process
View source
class LegacyBlockVisibilityTest extends MigrateProcessTestCase {
    
    /**
     * The module handler.
     *
     * @var \Drupal\Core\Extension\ModuleHandlerInterface
     */
    protected $moduleHandler;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() {
        parent::setUp();
        $migrate_lookup = $this->prophesize(MigrateLookupInterface::class);
        $container = new ContainerBuilder();
        $container->set('migrate.lookup', $migrate_lookup->reveal());
        \Drupal::setContainer($container);
        $this->moduleHandler = $this->prophesize(ModuleHandlerInterface::class);
        $migration_plugin = $this->prophesize(MigrateProcessInterface::class);
        $this->plugin = new BlockVisibility([], 'block_visibility_pages', [], $this->moduleHandler
            ->reveal(), $migration_plugin->reveal());
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformNoData() {
        $transformed_value = $this->plugin
            ->transform([
            0,
            '',
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
        $this->assertEmpty($transformed_value);
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformSinglePageWithFront() {
        $visibility = $this->plugin
            ->transform([
            0,
            '<front>',
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
        $this->assertSame('request_path', $visibility['request_path']['id']);
        $this->assertTrue($visibility['request_path']['negate']);
        $this->assertSame('<front>', $visibility['request_path']['pages']);
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformMultiplePagesWithFront() {
        $visibility = $this->plugin
            ->transform([
            1,
            "foo\n/bar\rbaz\r\n<front>",
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
        $this->assertSame('request_path', $visibility['request_path']['id']);
        $this->assertFalse($visibility['request_path']['negate']);
        $this->assertSame("/foo\n/bar\n/baz\n<front>", $visibility['request_path']['pages']);
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformPhpEnabled() {
        $this->moduleHandler
            ->moduleExists('php')
            ->willReturn(TRUE);
        $visibility = $this->plugin
            ->transform([
            2,
            '<?php',
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
        $this->assertSame('php', $visibility['php']['id']);
        $this->assertFalse($visibility['php']['negate']);
        $this->assertSame('<?php', $visibility['php']['php']);
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformPhpDisabled() {
        $this->moduleHandler
            ->moduleExists('php')
            ->willReturn(FALSE);
        $transformed_value = $this->plugin
            ->transform([
            2,
            '<?php',
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
        $this->assertEmpty($transformed_value);
    }
    
    /**
     * Tests Transform.
     *
     * @covers ::transform
     *
     * @expectedDeprecation Passing a migration process plugin as the fifth argument to Drupal\block\Plugin\migrate\process\BlockVisibility::__construct is deprecated in drupal:8.8.0 and will throw an error in drupal:9.0.0. Pass the migrate.lookup service instead. See https://www.drupal.org/node/3047268
     */
    public function testTransformException() {
        $this->moduleHandler
            ->moduleExists('php')
            ->willReturn(FALSE);
        $migration_plugin = $this->prophesize(MigrateProcessInterface::class);
        $this->row = $this->getMockBuilder('Drupal\\migrate\\Row')
            ->disableOriginalConstructor()
            ->setMethods([
            'getSourceProperty',
        ])
            ->getMock();
        $this->row
            ->expects($this->exactly(2))
            ->method('getSourceProperty')
            ->willReturnMap([
            [
                'bid',
                99,
            ],
            [
                'module',
                'foobar',
            ],
        ]);
        $this->plugin = new BlockVisibility([
            'skip_php' => TRUE,
        ], 'block_visibility_pages', [], $this->moduleHandler
            ->reveal(), $migration_plugin->reveal());
        $this->expectException(MigrateSkipRowException::class);
        $this->expectExceptionMessage("The block with bid '99' from module 'foobar' will have no PHP or request_path visibility configuration.");
        $this->plugin
            ->transform([
            2,
            '<?php',
            [],
        ], $this->migrateExecutable, $this->row, 'destinationproperty');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
LegacyBlockVisibilityTest::$moduleHandler protected property The module handler.
LegacyBlockVisibilityTest::setUp protected function Overrides MigrateProcessTestCase::setUp
LegacyBlockVisibilityTest::testTransformException public function Tests Transform.
LegacyBlockVisibilityTest::testTransformMultiplePagesWithFront public function Tests Transform.
LegacyBlockVisibilityTest::testTransformNoData public function Tests Transform.
LegacyBlockVisibilityTest::testTransformPhpDisabled public function Tests Transform.
LegacyBlockVisibilityTest::testTransformPhpEnabled public function Tests Transform.
LegacyBlockVisibilityTest::testTransformSinglePageWithFront public function Tests Transform.
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. 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.
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.

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