class BlockVisibilityTest in Drupal 8

Tests the block_visibility process plugin.

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

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\migrate\Unit\MigrateTestCase
    • class \Drupal\Tests\migrate\Unit\process\MigrateProcessTestCase
      • class \Drupal\Tests\block\Unit\Plugin\migrate\process\BlockVisibilityTest

File

core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php, line 17

Namespace

Drupal\Tests\block\Unit\Plugin\migrate\process

class BlockVisibilityTest extends MigrateProcessTestCase {

  /**
   * The module handler.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this->moduleHandler = $this
      ->prophesize(ModuleHandlerInterface::class);
    $migrate_lookup = $this
      ->prophesize(MigrateLookupInterface::class);
    $this->plugin = new BlockVisibility([], 'block_visibility_pages', [], $this->moduleHandler
      ->reveal(), $migrate_lookup
      ->reveal());
  }

  /**
   * @covers ::transform
   */
  public function testTransformNoData() {
    $transformed_value = $this->plugin
      ->transform([
      0,
      '',
      [],
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertEmpty($transformed_value);
  }

  /**
   * @covers ::transform
   */
  public function testTransformSinglePageWithFront() {
    $visibility = $this->plugin
      ->transform([
      0,
      '<front>',
      [],
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame('request_path', $visibility['request_path']['id']);
    $this
      ->assertTrue($visibility['request_path']['negate']);
    $this
      ->assertSame('<front>', $visibility['request_path']['pages']);
  }

  /**
   * @covers ::transform
   */
  public function testTransformMultiplePagesWithFront() {
    $visibility = $this->plugin
      ->transform([
      1,
      "foo\n/bar\rbaz\r\n<front>",
      [],
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $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']);
  }

  /**
   * @covers ::transform
   */
  public function testTransformPhpEnabled() {
    $this->moduleHandler
      ->moduleExists('php')
      ->willReturn(TRUE);
    $visibility = $this->plugin
      ->transform([
      2,
      '<?php',
      [],
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertSame('php', $visibility['php']['id']);
    $this
      ->assertFalse($visibility['php']['negate']);
    $this
      ->assertSame('<?php', $visibility['php']['php']);
  }

  /**
   * @covers ::transform
   */
  public function testTransformPhpDisabled() {
    $this->moduleHandler
      ->moduleExists('php')
      ->willReturn(FALSE);
    $transformed_value = $this->plugin
      ->transform([
      2,
      '<?php',
      [],
    ], $this->migrateExecutable, $this->row, 'destination_property');
    $this
      ->assertEmpty($transformed_value);
  }

  /**
   * @covers ::transform
   */
  public function testTransformException() {
    $this->moduleHandler
      ->moduleExists('php')
      ->willReturn(FALSE);
    $migrate_lookup = $this
      ->prophesize(MigrateLookupInterface::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(), $migrate_lookup
      ->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, 'destination_property');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockVisibilityTest::$moduleHandler	protected	property	The module handler.
BlockVisibilityTest::setUp	protected	function	Overrides MigrateProcessTestCase::setUp
BlockVisibilityTest::testTransformException	public	function	@covers ::transform
BlockVisibilityTest::testTransformMultiplePagesWithFront	public	function	@covers ::transform
BlockVisibilityTest::testTransformNoData	public	function	@covers ::transform
BlockVisibilityTest::testTransformPhpDisabled	public	function	@covers ::transform
BlockVisibilityTest::testTransformPhpEnabled	public	function	@covers ::transform
BlockVisibilityTest::testTransformSinglePageWithFront	public	function	@covers ::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.