'); $this->assertSame('a heading edit', $this->testpage->heading); // Without formatting the tags are preserved but cleaned. $this->testpage->set_heading('a heading edit
', false); $this->assertSame('a heading edit
', $this->testpage->heading); } public function test_set_title() { // Exercise SUT. $this->testpage->set_title('a title'); // Validated. $this->assertSame('a title', $this->testpage->title); } public function test_default_pagelayout() { // Exercise SUT and Validate. $this->assertSame('base', $this->testpage->pagelayout); } public function test_set_pagelayout() { // Exercise SUT. $this->testpage->set_pagelayout('type'); // Validated. $this->assertSame('type', $this->testpage->pagelayout); } public function test_setting_course_sets_context() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $context = \context_course::instance($course->id); // Exercise SUT. $this->testpage->set_course($course); // Validated. $this->assertSame($context, $this->testpage->context); } public function test_set_category_top_level() { global $DB; // Setup fixture. $cat = $this->getDataGenerator()->create_category(); $catdbrecord = $DB->get_record('course_categories', array('id' => $cat->id)); // Exercise SUT. $this->testpage->set_category_by_id($cat->id); // Validated. $this->assertEquals($catdbrecord, $this->testpage->category); $this->assertSame(\context_coursecat::instance($cat->id), $this->testpage->context); } public function test_set_nested_categories() { global $DB; // Setup fixture. $topcat = $this->getDataGenerator()->create_category(); $topcatdbrecord = $DB->get_record('course_categories', array('id' => $topcat->id)); $subcat = $this->getDataGenerator()->create_category(array('parent'=>$topcat->id)); $subcatdbrecord = $DB->get_record('course_categories', array('id' => $subcat->id)); // Exercise SUT. $this->testpage->set_category_by_id($subcat->id); // Validated. $categories = $this->testpage->categories; $this->assertCount(2, $categories); $this->assertEquals($topcatdbrecord, array_pop($categories)); $this->assertEquals($subcatdbrecord, array_pop($categories)); } public function test_cm_null_initially() { // Validated. $this->assertNull($this->testpage->cm); } public function test_set_cm() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->testpage->set_cm($cm); // Validated. $this->assertEquals($cm->id, $this->testpage->cm->id); } public function test_cannot_set_activity_record_before_cm() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->expectException(\coding_exception::class); $this->testpage->set_activity_record($forum); } public function test_setting_cm_sets_context() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->testpage->set_cm($cm); // Validated. $this->assertSame(\context_module::instance($cm->id), $this->testpage->context); } public function test_activity_record_loaded_if_not_set() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->testpage->set_cm($cm); // Validated. unset($forum->cmid); $this->assertEquals($forum, $this->testpage->activityrecord); } public function test_set_activity_record() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); $this->testpage->set_cm($cm); // Exercise SUT. $this->testpage->set_activity_record($forum); // Validated. unset($forum->cmid); $this->assertEquals($forum, $this->testpage->activityrecord); } public function test_cannot_set_inconsistent_activity_record_course() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); $this->testpage->set_cm($cm); // Exercise SUT. $forum->course = 13; $this->expectException(\coding_exception::class); $this->testpage->set_activity_record($forum); } public function test_cannot_set_inconsistent_activity_record_instance() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); $this->testpage->set_cm($cm); // Exercise SUT. $forum->id = 13; $this->expectException(\coding_exception::class); $this->testpage->set_activity_record($forum); } public function test_setting_cm_sets_course() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->testpage->set_cm($cm); // Validated. $this->assertEquals($course->id, $this->testpage->course->id); } public function test_set_cm_with_course_and_activity_no_db() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // This only works without db if we already have modinfo cache // Exercise SUT. $this->testpage->set_cm($cm, $course, $forum); // Validated. $this->assertEquals($cm->id, $this->testpage->cm->id); $this->assertEquals($course->id, $this->testpage->course->id); unset($forum->cmid); $this->assertEquals($forum, $this->testpage->activityrecord); } public function test_cannot_set_cm_with_inconsistent_course() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $cm->course = 13; $this->expectException(\coding_exception::class); $this->testpage->set_cm($cm, $course); } public function test_get_activity_name() { // Setup fixture. $course = $this->getDataGenerator()->create_course(); $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id)); $cm = get_coursemodule_from_id('forum', $forum->cmid); // Exercise SUT. $this->testpage->set_cm($cm, $course, $forum); // Validated. $this->assertSame('forum', $this->testpage->activityname); } public function test_user_is_editing_on() { // We are relying on the fact that unit tests are always run by admin, to // ensure the user_allows_editing call returns true. // Setup fixture. global $USER; $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); $USER->editing = true; // Validated. $this->assertTrue($this->testpage->user_is_editing()); } public function test_user_is_editing_off() { // We are relying on the fact that unit tests are always run by admin, to // ensure the user_allows_editing call returns true. // Setup fixture. global $USER; $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); $USER->editing = false; // Validated. $this->assertFalse($this->testpage->user_is_editing()); } public function test_default_editing_capabilities() { $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); // Validated. $this->assertEquals(array('moodle/site:manageblocks'), $this->testpage->all_editing_caps()); } public function test_other_block_editing_cap() { $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); // Exercise SUT. $this->testpage->set_blocks_editing_capability('moodle/my:manageblocks'); // Validated. $this->assertEquals(array('moodle/my:manageblocks'), $this->testpage->all_editing_caps()); } public function test_other_editing_cap() { $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); // Exercise SUT. $this->testpage->set_other_editing_capability('moodle/course:manageactivities'); // Validated. $actualcaps = $this->testpage->all_editing_caps(); $expectedcaps = array('moodle/course:manageactivities', 'moodle/site:manageblocks'); $this->assertEquals(array_values($expectedcaps), array_values($actualcaps)); } public function test_other_editing_caps() { $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); // Exercise SUT. $this->testpage->set_other_editing_capability(array('moodle/course:manageactivities', 'moodle/site:other')); // Validated. $actualcaps = $this->testpage->all_editing_caps(); $expectedcaps = array('moodle/course:manageactivities', 'moodle/site:other', 'moodle/site:manageblocks'); $this->assertEquals(array_values($expectedcaps), array_values($actualcaps)); } /** * Test getting a renderer. */ public function test_get_renderer() { global $OUTPUT, $PAGE; $oldoutput = $OUTPUT; $oldpage = $PAGE; $PAGE = $this->testpage; $this->testpage->set_pagelayout('standard'); $this->assertEquals('standard', $this->testpage->pagelayout); // Initialise theme and output for the next tests. $this->testpage->initialise_theme_and_output(); // Check the generated $OUTPUT object is a core renderer. $this->assertInstanceOf('core_renderer', $OUTPUT); // Check we can get a core renderer if we explicitly request one (no component). $this->assertInstanceOf('core_renderer', $this->testpage->get_renderer('core')); // Check we get a CLI renderer if we request a maintenance renderer. The CLI target should take precedence. $this->assertInstanceOf('core_renderer_cli', $this->testpage->get_renderer('core', null, RENDERER_TARGET_MAINTENANCE)); // Check we can get a coures renderer if we explicitly request one (valid component). $this->assertInstanceOf('core_course_renderer', $this->testpage->get_renderer('core', 'course')); // Check a properly invalid component. try { $this->testpage->get_renderer('core', 'monkeys'); $this->fail('Request for renderer with invalid component didn\'t throw expected exception.'); } catch (\coding_exception $exception) { $this->assertEquals('monkeys', $exception->debuginfo); } $PAGE = $oldpage; $OUTPUT = $oldoutput; } /** * Tests getting a renderer with a maintenance layout. * * This layout has special hacks in place in order to deliver a "maintenance" renderer. */ public function test_get_renderer_maintenance() { global $OUTPUT, $PAGE; $oldoutput = $OUTPUT; $oldpage = $PAGE; $PAGE = $this->testpage; $this->testpage->set_pagelayout('maintenance'); $this->assertEquals('maintenance', $this->testpage->pagelayout); // Initialise theme and output for the next tests. $this->testpage->initialise_theme_and_output(); // Check the generated $OUTPUT object is a core cli renderer. // It shouldn't be maintenance because there the cli target should take greater precedence. $this->assertInstanceOf('core_renderer_cli', $OUTPUT); // Check we can get a core renderer if we explicitly request one (no component). $this->assertInstanceOf('core_renderer', $this->testpage->get_renderer('core')); // Check we get a CLI renderer if we request a maintenance renderer. The CLI target should take precedence. $this->assertInstanceOf('core_renderer_cli', $this->testpage->get_renderer('core', null, RENDERER_TARGET_MAINTENANCE)); // Check we can get a coures renderer if we explicitly request one (valid component). $this->assertInstanceOf('core_course_renderer', $this->testpage->get_renderer('core', 'course')); try { $this->testpage->get_renderer('core', 'monkeys'); $this->fail('Request for renderer with invalid component didn\'t throw expected exception.'); } catch (\coding_exception $exception) { $this->assertEquals('monkeys', $exception->debuginfo); } $PAGE = $oldpage; $OUTPUT = $oldoutput; } public function test_render_to_cli() { global $OUTPUT; $footer = $OUTPUT->footer(); $this->assertEmpty($footer, 'cli output does not have a footer.'); } /** * Validate the theme value depending on the user theme and cohorts. * * @dataProvider get_user_theme_provider */ public function test_cohort_get_user_theme($usertheme, $sitetheme, $cohortthemes, $expected) { global $DB, $PAGE, $USER; $this->resetAfterTest(); // Enable cohort themes. set_config('allowuserthemes', 1); set_config('allowcohortthemes', 1); $systemctx = \context_system::instance(); set_config('theme', $sitetheme); // Create user. $user = $this->getDataGenerator()->create_user(array('theme' => $usertheme)); // Create cohorts and add user as member. $cohorts = array(); foreach ($cohortthemes as $cohorttheme) { $cohort = $this->getDataGenerator()->create_cohort(array('contextid' => $systemctx->id, 'name' => 'Cohort', 'idnumber' => '', 'description' => '', 'theme' => $cohorttheme)); $cohorts[] = $cohort; cohort_add_member($cohort->id, $user->id); } // Get the theme and compare to the expected. $this->setUser($user); // Initialise user theme. $USER = get_complete_user_data('id', $user->id); // Initialise site theme. $PAGE->reset_theme_and_output(); $PAGE->initialise_theme_and_output(); $result = $PAGE->theme->name; $this->assertEquals($expected, $result); } /** * Some user cases for validating the expected theme depending on the cohorts, site and user values. * * The result is an array of: * 'User case description' => [ * 'usertheme' => '', // User theme. * 'sitetheme' => '', // Site theme. * 'cohorts' => [], // Cohort themes. * 'expected' => '', // Expected value returned by cohort_get_user_cohort_theme. * ] * * @return array */ public function get_user_theme_provider() { return [ 'User not a member of any cohort' => [ 'usertheme' => '', 'sitetheme' => 'boost', 'cohorts' => [], 'expected' => 'boost', ], 'User member of one cohort which has a theme set' => [ 'usertheme' => '', 'sitetheme' => 'boost', 'cohorts' => [ 'classic', ], 'expected' => 'classic', ], 'User member of one cohort which has a theme set, and one without a theme' => [ 'usertheme' => '', 'sitetheme' => 'boost', 'cohorts' => [ 'classic', '', ], 'expected' => 'classic', ], 'User member of one cohort which has a theme set, and one with a different theme' => [ 'usertheme' => '', 'sitetheme' => 'boost', 'cohorts' => [ 'classic', 'someother', ], 'expected' => 'boost', ], 'User with a theme but not a member of any cohort' => [ 'usertheme' => 'classic', 'sitetheme' => 'boost', 'cohorts' => [], 'expected' => 'classic', ], 'User with a theme and member of one cohort which has a theme set' => [ 'usertheme' => 'classic', 'sitetheme' => 'boost', 'cohorts' => [ 'boost', ], 'expected' => 'classic', ], ]; } /** * Tests user_can_edit_blocks() returns the expected response. * @covers ::user_can_edit_blocks() */ public function test_user_can_edit_blocks() { global $DB; $systemcontext = \context_system::instance(); $this->testpage->set_context($systemcontext); $user = $this->getDataGenerator()->create_user(); $role = $DB->get_record('role', ['shortname' => 'teacher']); role_assign($role->id, $user->id, $systemcontext->id); $this->setUser($user); // Confirm expected response (false) when user does not have access to edit blocks. $capability = $this->testpage->all_editing_caps()[0]; assign_capability($capability, CAP_PROHIBIT, $role->id, $systemcontext, true); $this->assertFalse($this->testpage->user_can_edit_blocks()); // Give capability and confirm expected response (true) now user has access to edit blocks. assign_capability($capability, CAP_ALLOW, $role->id, $systemcontext, true); $this->assertTrue($this->testpage->user_can_edit_blocks()); } /** * Tests that calling force_lock_all_blocks() will cause user_can_edit_blocks() to return false, regardless of capabilities. * @covers ::force_lock_all_blocks() */ public function test_force_lock_all_blocks() { $this->testpage->set_context(\context_system::instance()); $this->setAdminUser(); // Confirm admin user has access to edit blocks. $this->assertTrue($this->testpage->user_can_edit_blocks()); // Force lock and confirm user can no longer edit, despite having the capability. $this->testpage->force_lock_all_blocks(); $this->assertFalse($this->testpage->user_can_edit_blocks()); } } /** * Test-specific subclass to make some protected things public. */ class testable_moodle_page extends moodle_page { public function initialise_default_pagetype($script = null) { parent::initialise_default_pagetype($script); } public function url_to_class_name($url) { return parent::url_to_class_name($url); } public function all_editing_caps() { return parent::all_editing_caps(); } }