BlockVisibilityTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\block\Unit\Plugin\migrate\process;

use Drupal\block\Plugin\migrate\process\BlockVisibility;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\migrate\MigrateLookupInterface;
use Drupal\migrate\MigrateSkipRowException;
use Drupal\Tests\migrate\Unit\process\MigrateProcessTestCase;

// cspell:ignore rbaz

/**
 * Tests the block_visibility process plugin.
 *
 * @coversDefaultClass \Drupal\block\Plugin\migrate\process\BlockVisibility
 * @group block
 */
class BlockVisibilityTest extends MigrateProcessTestCase {

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    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()
      ->onlyMethods([
      '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');
  }

}