mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-18 05:58:34 +01:00
Code Issues Projects Releases Wiki Activity

MDL-79338 core: add primary navigation hook tests

Browse Source
This commit is contained in:
Petr Skoda 2023-09-12 17:30:46 +02:00
parent b2a2d3dc66
commit f94ad6f65f
1 changed files with 123 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

123
lib/tests/hook/navigation/primary_extend_test.php
View File

@ -46,4 +46,127 @@ class primary_extend_test extends \advanced_testcase {
$hook->stop_propagation();
$this->assertTrue($hook->isPropagationStopped());
}
/**
* Test hook is triggered when initialising primary navigation menu.
* @covers \core\navigation\views\primary::initialise
*/
public function test_trigggering() {
global $PAGE;
$this->resetAfterTest();
$PAGE = new \moodle_page();
$PAGE->set_url('/');
$count = 0;
$receivedhook = null;
$testcallback = function(primary_extend $hook) use (&$receivedhook, &$count): void {
$count++;
$receivedhook = $hook;
};
$this->redirectHook(primary_extend::class, $testcallback);
$primarynav = new \core\navigation\views\primary($PAGE);
$this->assertSame(0, $count);
$this->assertNull($receivedhook);
$primarynav->initialise();
$this->assertSame(1, $count);
$this->assertInstanceOf(primary_extend::class, $receivedhook);
}
/**
* Verify that nothing except this hook modifies the primary menu.
* @covers \core\navigation\views\primary::initialise
*/
public function test_unsupported_hacks() {
global $PAGE;
$this->resetAfterTest();
$PAGE = new \moodle_page();
$PAGE->set_url('/');
$testcallback = function(primary_extend $hook): void {
// Nothing to do, propagation is stopped by hook redirection.
};
$this->redirectHook(primary_extend::class, $testcallback);
$primarynav = new \core\navigation\views\primary($PAGE);
$primarynav->initialise();
$this->assertSame(['home'], $primarynav->get_children_key_list(),
'Unsupported primary menu modification detected, use new primary_extend hook instead.');
$this->setAdminUser();
$primarynav = new \core\navigation\views\primary($PAGE);
$primarynav->initialise();
$this->assertSame(['home', 'myhome', 'mycourses'], $primarynav->get_children_key_list(),
'Unsupported primary menu modification detected, use new primary_extend hook instead.');
}
/**
* Test adding of primary menu items via hook.
* @covers \core\navigation\views\primary::initialise
*/
public function test_primary_menu_extending() {
global $PAGE;
$this->resetAfterTest();
$PAGE = new \moodle_page();
$PAGE->set_url('/');
$testcallback = function(primary_extend $hook): void {
$primaryview = $hook->get_primaryview();
$primaryview->add('Pokus', null);
};
$this->redirectHook(primary_extend::class, $testcallback);
$primarynav = new \core\navigation\views\primary($PAGE);
$primarynav->initialise();
$keys = $primarynav->get_children_key_list();
$this->assertCount(2, $keys);
$firstkey = array_shift($keys);
$this->assertSame('home', $firstkey);
$secondkey = array_shift($keys);
/** @var \navigation_node $pokus */
$pokus = $primarynav->get($secondkey);
$this->assertInstanceOf(\navigation_node::class, $pokus);
$this->assertSame('Pokus', $pokus->text);
}
/**
* Test replacing of the whole primary menu.
* @covers \core\navigation\views\primary::initialise
*/
public function test_primary_menu_replacing() {
global $PAGE;
$this->resetAfterTest();
$PAGE = new \moodle_page();
$PAGE->set_url('/');
$testcallback = function(primary_extend $hook): void {
$primaryview = $hook->get_primaryview();
$keys = $primaryview->get_children_key_list();
foreach ($keys as $key) {
$item = $primaryview->get($key);
$item->remove();
}
$primaryview->add('Pokus', null);
// Technically we do not need to stop because observers are overridden,
// but this can be used as an example for plugin that wants to stop
// adding of primary menu items from plugins.
$hook->stop_propagation();
};
$this->redirectHook(primary_extend::class, $testcallback);
$primarynav = new \core\navigation\views\primary($PAGE);
$primarynav->initialise();
$keys = $primarynav->get_children_key_list();
$this->assertCount(1, $keys);
$firstkey = array_shift($keys);
/** @var \navigation_node $pokus */
$pokus = $primarynav->get($firstkey);
$this->assertInstanceOf(\navigation_node::class, $pokus);
$this->assertSame('Pokus', $pokus->text);
}
}