class NodeTitleFailoverTest in Freelinking 8.3

Tests the failover options for nodetitle plugin.

@group freelinking

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses PhpunitCompatibilityTrait
  • class \Drupal\Tests\freelinking\Unit\Plugin\freelinking\NodeTestBase
    • class \Drupal\Tests\freelinking\Unit\Plugin\freelinking\NodeTitleFailoverTest

File

tests/src/Unit/Plugin/freelinking/NodeTitleFailoverTest.php, line 15

Namespace

Drupal\Tests\freelinking\Unit\Plugin\freelinking

class NodeTitleFailoverTest extends NodeTestBase {

  /**
   * Mock container.
   *
   * @var \Drupal\Core\DependencyInjection\Container
   */
  protected $container;

  /**
   * Tranlation interface mock.
   *
   * @var \Drupal\Core\StringTranslation\TranslationInterface
   */
  protected $translationInterfaceMock;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {

    // Mock the translation service.
    $tProphet = $this
      ->prophesize('\\Drupal\\Core\\StringTranslation\\TranslationInterface');
    $tProphet
      ->translateString(Argument::any())
      ->willReturn('Click to view a local node');
    $this->translationInterfaceMock = $tProphet
      ->reveal();

    // Mock Entity Type Manager.
    $entityManagerProphet = $this
      ->prophesize('\\Drupal\\Core\\Entity\\EntityTypeManagerInterface');

    // Mock Entity Query via Mock Builder to support chaining.
    $entityQuery = $this
      ->getMockBuilder('\\Drupal\\Core\\Entity\\Query\\QueryInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $entityQuery
      ->expects($this
      ->any())
      ->method('condition')
      ->willReturnSelf();
    $entityQuery
      ->expects($this
      ->any())
      ->method('accessCheck')
      ->willReturnSelf();
    $entityQuery
      ->expects($this
      ->any())
      ->method('execute')
      ->willReturn([]);

    // Mock Node Storage.
    $nodeStorageProphet = $this
      ->prophesize('\\Drupal\\node\\NodeStorageInterface');
    $nodeStorageProphet
      ->getQuery('AND')
      ->willReturn($entityQuery);

    // Mock Entity Type Manager getStorage.
    $entityManagerProphet
      ->getStorage('node')
      ->wilLReturn($nodeStorageProphet
      ->reveal());

    // Mock Module Handler.
    $moduleHandlerProphet = $this
      ->prophesize('\\Drupal\\Core\\Extension\\ModuleHandlerInterface');
    $moduleHandlerProphet
      ->moduleExists('search')
      ->willReturn(TRUE);
    $moduleHandlerProphet
      ->moduleExists('freelinking_prepopulate')
      ->willReturn(TRUE);

    // Mock Path Validator.
    $pathValidatorProphet = $this
      ->prophesize('\\Drupal\\Core\\Path\\PathValidatorInterface');
    $container = new ContainerBuilder();
    $container
      ->set('string_translation', $this->translationInterfaceMock);
    $container
      ->set('entity_type.manager', $entityManagerProphet
      ->reveal());
    $container
      ->set('path.validator', $pathValidatorProphet
      ->reveal());
    $container
      ->set('module_handler', $moduleHandlerProphet
      ->reveal());
    \Drupal::setContainer($container);
    $this->container = $container;
  }

  /**
   * Assert that failover option displays correctly.
   *
   * @param string $failoverOption
   *   The failover option to test.
   * @param array $expected
   *   The expected render array.
   *
   * @dataProvider failoverProvider
   */
  public function testFailover($failoverOption, array $expected) {
    $plugin = NodeTitle::create($this->container, [
      'settings' => [
        'nodetypes' => [],
        'failover' => $failoverOption,
      ],
    ], 'nodetitle', []);

    // Mock the parsed target array.
    $target = [
      'dest' => 'Test Node',
      'language' => $this
        ->getDefaultLanguage(),
      'target' => 'Test Node|Test Node',
    ];

    // Populate #url for the search test because container.
    if ($failoverOption === 'error') {
      $expected['#message'] = new TranslatableMarkup('Node title %target does not exist', [
        '%target' => 'Test Node',
      ], [], $this->translationInterfaceMock);
    }
    $link = $plugin
      ->buildLink($target);
    $this
      ->assertEquals($expected, $link);
  }

  /**
   * Provide test parameters for ::testFailover.
   *
   * @return array
   *   An array of options and expected values.
   */
  public function failoverProvider() {
    $noneExpected = [
      '#markup' => '[[nodetitle:Test Node|Test Node]]',
    ];
    $showTextExpected = [
      'error' => 'showtext',
    ];
    $searchExpected = [
      'error' => 'search',
    ];
    $prepopulateExpected = [
      'error' => 'prepopulate',
    ];
    $errorExpected = [
      '#theme' => 'freelink_error',
      '#plugin' => 'nodetitle',
    ];
    return [
      [
        '_none',
        $noneExpected,
      ],
      [
        'showtext',
        $showTextExpected,
      ],
      [
        'search',
        $searchExpected,
      ],
      [
        'prepopulate',
        $prepopulateExpected,
      ],
      [
        'error',
        $errorExpected,
      ],
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
NodeTestBase::getDefaultLanguage	public static	function	Get a language object to pass into the plugin.
NodeTitleFailoverTest::$container	protected	property	Mock container.
NodeTitleFailoverTest::$translationInterfaceMock	protected	property	Tranlation interface mock.
NodeTitleFailoverTest::failoverProvider	public	function	Provide test parameters for ::testFailover.
NodeTitleFailoverTest::setUp	protected	function	Overrides UnitTestCase::setUp
NodeTitleFailoverTest::testFailover	public	function	Assert that failover option displays correctly.
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.