You are here

Home » API reference » Drupal 8 » ForumListingBreadcrumbBuilderTest.php

class ForumListingBreadcrumbBuilderTest in Drupal 8

@coversDefaultClass \Drupal\forum\Breadcrumb\ForumListingBreadcrumbBuilder @group forum

Hierarchy

Expanded class hierarchy of ForumListingBreadcrumbBuilderTest

File

core/modules/forum/tests/src/Unit/Breadcrumb/ForumListingBreadcrumbBuilderTest.php, line 16

Namespace

Drupal\Tests\forum\Unit\Breadcrumb
View source 
class ForumListingBreadcrumbBuilderTest extends UnitTestCase {

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $cache_contexts_manager = $this
      ->getMockBuilder('Drupal\\Core\\Cache\\Context\\CacheContextsManager')
      ->disableOriginalConstructor()
      ->getMock();
    $cache_contexts_manager
      ->method('assertValidTokens')
      ->willReturn(TRUE);
    $container = new Container();
    $container
      ->set('cache_contexts_manager', $cache_contexts_manager);
    \Drupal::setContainer($container);
  }

  /**
   * Tests ForumListingBreadcrumbBuilder::applies().
   *
   * @param bool $expected
   *   ForumListingBreadcrumbBuilder::applies() expected result.
   * @param string|null $route_name
   *   (optional) A route name.
   * @param array $parameter_map
   *   (optional) An array of parameter names and values.
   *
   * @dataProvider providerTestApplies
   * @covers ::applies
   */
  public function testApplies($expected, $route_name = NULL, $parameter_map = []) {

    // Make some test doubles.
    $entity_manager = $this
      ->createMock('Drupal\\Core\\Entity\\EntityManagerInterface');
    $config_factory = $this
      ->getConfigFactoryStub([]);
    $forum_manager = $this
      ->createMock('Drupal\\forum\\ForumManagerInterface');
    $translation_manager = $this
      ->createMock('Drupal\\Core\\StringTranslation\\TranslationInterface');

    // Make an object to test.
    $builder = $this
      ->getMockBuilder('Drupal\\forum\\Breadcrumb\\ForumListingBreadcrumbBuilder')
      ->setConstructorArgs([
      $entity_manager,
      $config_factory,
      $forum_manager,
      $translation_manager,
    ])
      ->setMethods(NULL)
      ->getMock();
    $route_match = $this
      ->createMock('Drupal\\Core\\Routing\\RouteMatchInterface');
    $route_match
      ->expects($this
      ->once())
      ->method('getRouteName')
      ->will($this
      ->returnValue($route_name));
    $route_match
      ->expects($this
      ->any())
      ->method('getParameter')
      ->will($this
      ->returnValueMap($parameter_map));
    $this
      ->assertEquals($expected, $builder
      ->applies($route_match));
  }

  /**
   * Provides test data for testApplies().
   *
   * @return array
   *   Array of datasets for testApplies(). Structured as such:
   *   - ForumListBreadcrumbBuilder::applies() expected result.
   *   - ForumListBreadcrumbBuilder::applies() $attributes input array.
   */
  public function providerTestApplies() {

    // Send a Node mock, because NodeInterface cannot be mocked.
    $mock_term = $this
      ->getMockBuilder('Drupal\\taxonomy\\Entity\\Term')
      ->disableOriginalConstructor()
      ->getMock();
    return [
      [
        FALSE,
      ],
      [
        FALSE,
        'NOT.forum.page',
      ],
      [
        FALSE,
        'forum.page',
      ],
      [
        TRUE,
        'forum.page',
        [
          [
            'taxonomy_term',
            'anything',
          ],
        ],
      ],
      [
        TRUE,
        'forum.page',
        [
          [
            'taxonomy_term',
            $mock_term,
          ],
        ],
      ],
    ];
  }

  /**
   * Tests ForumListingBreadcrumbBuilder::build().
   *
   * @see \Drupal\forum\ForumListingBreadcrumbBuilder::build()
   *
   * @covers ::build
   */
  public function testBuild() {

    // Build all our dependencies, backwards.
    $translation_manager = $this
      ->getMockBuilder('Drupal\\Core\\StringTranslation\\TranslationInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $prophecy = $this
      ->prophesize('Drupal\\taxonomy\\Entity\\Term');
    $prophecy
      ->label()
      ->willReturn('Something');
    $prophecy
      ->id()
      ->willReturn(1);
    $prophecy
      ->getCacheTags()
      ->willReturn([
      'taxonomy_term:1',
    ]);
    $prophecy
      ->getCacheContexts()
      ->willReturn([]);
    $prophecy
      ->getCacheMaxAge()
      ->willReturn(Cache::PERMANENT);
    $term1 = $prophecy
      ->reveal();
    $prophecy = $this
      ->prophesize('Drupal\\taxonomy\\Entity\\Term');
    $prophecy
      ->label()
      ->willReturn('Something else');
    $prophecy
      ->id()
      ->willReturn(2);
    $prophecy
      ->getCacheTags()
      ->willReturn([
      'taxonomy_term:2',
    ]);
    $prophecy
      ->getCacheContexts()
      ->willReturn([]);
    $prophecy
      ->getCacheMaxAge()
      ->willReturn(Cache::PERMANENT);
    $term2 = $prophecy
      ->reveal();
    $term_storage = $this
      ->getMockBuilder(TermStorageInterface::class)
      ->getMock();
    $term_storage
      ->expects($this
      ->at(0))
      ->method('loadAllParents')
      ->will($this
      ->returnValue([
      $term1,
    ]));
    $term_storage
      ->expects($this
      ->at(1))
      ->method('loadAllParents')
      ->will($this
      ->returnValue([
      $term1,
      $term2,
    ]));

    // The root forum.
    $prophecy = $this
      ->prophesize('Drupal\\taxonomy\\VocabularyInterface');
    $prophecy
      ->label()
      ->willReturn('Fora_is_the_plural_of_forum');
    $prophecy
      ->id()
      ->willReturn(5);
    $prophecy
      ->getCacheTags()
      ->willReturn([
      'taxonomy_vocabulary:5',
    ]);
    $prophecy
      ->getCacheContexts()
      ->willReturn([]);
    $prophecy
      ->getCacheMaxAge()
      ->willReturn(Cache::PERMANENT);
    $vocab_storage = $this
      ->createMock('Drupal\\Core\\Entity\\EntityStorageInterface');
    $vocab_storage
      ->expects($this
      ->any())
      ->method('load')
      ->will($this
      ->returnValueMap([
      [
        'forums',
        $prophecy
          ->reveal(),
      ],
    ]));
    $entity_manager = $this
      ->getMockBuilder('Drupal\\Core\\Entity\\EntityManagerInterface')
      ->disableOriginalConstructor()
      ->getMock();
    $entity_manager
      ->expects($this
      ->any())
      ->method('getStorage')
      ->will($this
      ->returnValueMap([
      [
        'taxonomy_vocabulary',
        $vocab_storage,
      ],
      [
        'taxonomy_term',
        $term_storage,
      ],
    ]));
    $config_factory = $this
      ->getConfigFactoryStub([
      'forum.settings' => [
        'vocabulary' => 'forums',
      ],
    ]);
    $forum_manager = $this
      ->createMock('Drupal\\forum\\ForumManagerInterface');

    // Build a breadcrumb builder to test.
    $breadcrumb_builder = new ForumListingBreadcrumbBuilder($entity_manager, $config_factory, $forum_manager, $translation_manager);

    // Add a translation manager for t().
    $translation_manager = $this
      ->getStringTranslationStub();
    $breadcrumb_builder
      ->setStringTranslation($translation_manager);

    // The forum listing we need a breadcrumb back from.
    $prophecy = $this
      ->prophesize('Drupal\\taxonomy\\Entity\\Term');
    $prophecy
      ->label()
      ->willReturn('You_should_not_see_this');
    $prophecy
      ->id()
      ->willReturn(23);
    $prophecy
      ->getCacheTags()
      ->willReturn([
      'taxonomy_term:23',
    ]);
    $prophecy
      ->getCacheContexts()
      ->willReturn([]);
    $prophecy
      ->getCacheMaxAge()
      ->willReturn(Cache::PERMANENT);
    $forum_listing = $prophecy
      ->reveal();

    // Our data set.
    $route_match = $this
      ->createMock('Drupal\\Core\\Routing\\RouteMatchInterface');
    $route_match
      ->expects($this
      ->exactly(2))
      ->method('getParameter')
      ->with('taxonomy_term')
      ->will($this
      ->returnValue($forum_listing));

    // First test.
    $expected1 = [
      Link::createFromRoute('Home', '<front>'),
      Link::createFromRoute('Fora_is_the_plural_of_forum', 'forum.index'),
      Link::createFromRoute('Something', 'forum.page', [
        'taxonomy_term' => 1,
      ]),
    ];
    $breadcrumb = $breadcrumb_builder
      ->build($route_match);
    $this
      ->assertEquals($expected1, $breadcrumb
      ->getLinks());
    $this
      ->assertEquals([
      'route',
    ], $breadcrumb
      ->getCacheContexts());
    $this
      ->assertEquals([
      'taxonomy_term:1',
      'taxonomy_term:23',
      'taxonomy_vocabulary:5',
    ], $breadcrumb
      ->getCacheTags());
    $this
      ->assertEquals(Cache::PERMANENT, $breadcrumb
      ->getCacheMaxAge());

    // Second test.
    $expected2 = [
      Link::createFromRoute('Home', '<front>'),
      Link::createFromRoute('Fora_is_the_plural_of_forum', 'forum.index'),
      Link::createFromRoute('Something else', 'forum.page', [
        'taxonomy_term' => 2,
      ]),
      Link::createFromRoute('Something', 'forum.page', [
        'taxonomy_term' => 1,
      ]),
    ];
    $breadcrumb = $breadcrumb_builder
      ->build($route_match);
    $this
      ->assertEquals($expected2, $breadcrumb
      ->getLinks());
    $this
      ->assertEquals([
      'route',
    ], $breadcrumb
      ->getCacheContexts());
    $this
      ->assertEquals([
      'taxonomy_term:1',
      'taxonomy_term:2',
      'taxonomy_term:23',
      'taxonomy_vocabulary:5',
    ], $breadcrumb
      ->getCacheTags());
    $this
      ->assertEquals(Cache::PERMANENT, $breadcrumb
      ->getCacheMaxAge());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ForumListingBreadcrumbBuilderTest::providerTestApplies public function Provides test data for testApplies().
ForumListingBreadcrumbBuilderTest::setUp protected function Overrides UnitTestCase::setUp
ForumListingBreadcrumbBuilderTest::testApplies public function Tests ForumListingBreadcrumbBuilder::applies().
ForumListingBreadcrumbBuilderTest::testBuild public function Tests ForumListingBreadcrumbBuilder::build().
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.