class ForumNodeBreadcrumbBuilderTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/forum/tests/src/Unit/Breadcrumb/ForumNodeBreadcrumbBuilderTest.php \Drupal\Tests\forum\Unit\Breadcrumb\ForumNodeBreadcrumbBuilderTest
@coversDefaultClass \Drupal\forum\Breadcrumb\ForumNodeBreadcrumbBuilder @group forum
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \Drupal\Tests\PHPUnit_Framework_TestCase
- class \Drupal\Tests\forum\Unit\Breadcrumb\ForumNodeBreadcrumbBuilderTest
Expanded class hierarchy of ForumNodeBreadcrumbBuilderTest
File
- core/
modules/ forum/ tests/ src/ Unit/ Breadcrumb/ ForumNodeBreadcrumbBuilderTest.php, line 19 - Contains \Drupal\Tests\forum\Unit\Breadcrumb\ForumNodeBreadcrumbBuilderTest.
Namespace
Drupal\Tests\forum\Unit\BreadcrumbView source
class ForumNodeBreadcrumbBuilderTest extends UnitTestCase {
/**
* {@inheritdoc}
*/
public 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 ForumNodeBreadcrumbBuilder::applies().
*
* @param bool $expected
* ForumNodeBreadcrumbBuilder::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 = array()) {
// Make some test doubles.
$entity_manager = $this
->getMock('Drupal\\Core\\Entity\\EntityManagerInterface');
$config_factory = $this
->getConfigFactoryStub(array());
$forum_manager = $this
->getMock('Drupal\\forum\\ForumManagerInterface');
$forum_manager
->expects($this
->any())
->method('checkNodeType')
->will($this
->returnValue(TRUE));
// Make an object to test.
$builder = $this
->getMockBuilder('Drupal\\forum\\Breadcrumb\\ForumNodeBreadcrumbBuilder')
->setConstructorArgs(array(
$entity_manager,
$config_factory,
$forum_manager,
))
->setMethods(NULL)
->getMock();
$route_match = $this
->getMock('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().
*
* Note that this test is incomplete, because we can't mock NodeInterface.
*
* @return array
* Array of datasets for testApplies(). Structured as such:
* - ForumNodeBreadcrumbBuilder::applies() expected result.
* - ForumNodeBreadcrumbBuilder::applies() $attributes input array.
*/
public function providerTestApplies() {
// Send a Node mock, because NodeInterface cannot be mocked.
$mock_node = $this
->getMockBuilder('Drupal\\node\\Entity\\Node')
->disableOriginalConstructor()
->getMock();
return array(
array(
FALSE,
),
array(
FALSE,
'NOT.entity.node.canonical',
),
array(
FALSE,
'entity.node.canonical',
),
array(
FALSE,
'entity.node.canonical',
array(
array(
'node',
NULL,
),
),
),
array(
TRUE,
'entity.node.canonical',
array(
array(
'node',
$mock_node,
),
),
),
);
}
/**
* Tests ForumNodeBreadcrumbBuilder::build().
*
* @see \Drupal\forum\ForumNodeBreadcrumbBuilder::build()
* @covers ::build
*/
public function testBuild() {
// Build all our dependencies, backwards.
$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();
$forum_manager = $this
->getMockBuilder('Drupal\\forum\\ForumManagerInterface')
->disableOriginalConstructor()
->getMock();
$forum_manager
->expects($this
->at(0))
->method('getParents')
->will($this
->returnValue(array(
$term1,
)));
$forum_manager
->expects($this
->at(1))
->method('getParents')
->will($this
->returnValue(array(
$term1,
$term2,
)));
$prophecy = $this
->prophesize('Drupal\\taxonomy\\VocabularyInterface');
$prophecy
->label()
->willReturn('Forums');
$prophecy
->id()
->willReturn(5);
$prophecy
->getCacheTags()
->willReturn([
'taxonomy_vocabulary:5',
]);
$prophecy
->getCacheContexts()
->willReturn([]);
$prophecy
->getCacheMaxAge()
->willReturn(Cache::PERMANENT);
$vocab_storage = $this
->getMock('Drupal\\Core\\Entity\\EntityStorageInterface');
$vocab_storage
->expects($this
->any())
->method('load')
->will($this
->returnValueMap(array(
array(
'forums',
$prophecy
->reveal(),
),
)));
$entity_manager = $this
->getMockBuilder('Drupal\\Core\\Entity\\EntityManagerInterface')
->disableOriginalConstructor()
->getMock();
$entity_manager
->expects($this
->any())
->method('getStorage')
->will($this
->returnValueMap(array(
array(
'taxonomy_vocabulary',
$vocab_storage,
),
)));
$config_factory = $this
->getConfigFactoryStub(array(
'forum.settings' => array(
'vocabulary' => 'forums',
),
));
// Build a breadcrumb builder to test.
$breadcrumb_builder = $this
->getMock('Drupal\\forum\\Breadcrumb\\ForumNodeBreadcrumbBuilder', NULL, array(
$entity_manager,
$config_factory,
$forum_manager,
));
// Add a translation manager for t().
$translation_manager = $this
->getStringTranslationStub();
$property = new \ReflectionProperty('Drupal\\forum\\Breadcrumb\\ForumNodeBreadcrumbBuilder', 'stringTranslation');
$property
->setAccessible(TRUE);
$property
->setValue($breadcrumb_builder, $translation_manager);
// The forum node we need a breadcrumb back from.
$forum_node = $this
->getMockBuilder('Drupal\\node\\Entity\\Node')
->disableOriginalConstructor()
->getMock();
// Our data set.
$route_match = $this
->getMock('Drupal\\Core\\Routing\\RouteMatchInterface');
$route_match
->expects($this
->exactly(2))
->method('getParameter')
->with('node')
->will($this
->returnValue($forum_node));
// First test.
$expected1 = array(
Link::createFromRoute('Home', '<front>'),
Link::createFromRoute('Forums', 'forum.index'),
Link::createFromRoute('Something', 'forum.page', array(
'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_vocabulary:5',
], $breadcrumb
->getCacheTags());
$this
->assertEquals(Cache::PERMANENT, $breadcrumb
->getCacheMaxAge());
// Second test.
$expected2 = array(
Link::createFromRoute('Home', '<front>'),
Link::createFromRoute('Forums', 'forum.index'),
Link::createFromRoute('Something else', 'forum.page', array(
'taxonomy_term' => 2,
)),
Link::createFromRoute('Something', 'forum.page', array(
'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_vocabulary:5',
], $breadcrumb
->getCacheTags());
$this
->assertEquals(Cache::PERMANENT, $breadcrumb
->getCacheMaxAge());
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ForumNodeBreadcrumbBuilderTest:: |
public | function | Provides test data for testApplies(). | |
ForumNodeBreadcrumbBuilderTest:: |
public | function |
Overrides UnitTestCase:: |
|
ForumNodeBreadcrumbBuilderTest:: |
public | function | Tests ForumNodeBreadcrumbBuilder::applies(). | |
ForumNodeBreadcrumbBuilderTest:: |
public | function | Tests ForumNodeBreadcrumbBuilder::build(). | |
UnitTestCase:: |
protected | property | The random generator. | |
UnitTestCase:: |
protected | property | The app root. | |
UnitTestCase:: |
protected | function | Asserts if two arrays are equal by sorting them first. | |
UnitTestCase:: |
protected | function | Mocks a block with a block plugin. | |
UnitTestCase:: |
protected | function | Returns a stub class resolver. | |
UnitTestCase:: |
public | function | Returns a stub config factory that behaves according to the passed in array. | |
UnitTestCase:: |
public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase:: |
protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase:: |
protected | function | Gets the random generator for the utility methods. | |
UnitTestCase:: |
public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase:: |
public | function | Generates a unique random string containing letters and numbers. |