. /** * Tests for class coursecat from lib/coursecatlib.php * * @package core * @category phpunit * @copyright 2013 Marina Glancy * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->libdir . '/coursecatlib.php'); /** * Functional test for accesslib.php * * Note: execution may take many minutes especially on slower servers. */ class coursecatlib_testcase extends advanced_testcase { var $roles; public function setUp() { parent::setUp(); $this->resetAfterTest(true); $user = $this->getDataGenerator()->create_user(); $this->setUser($user); } protected function get_roleid($context = null) { global $USER; if ($context === null) { $context = context_system::instance(); } if (is_object($context)) { $context = $context->id; } if (empty($this->roles)) { $this->roles = array(); } if (empty($this->roles[$USER->id])) { $this->roles[$USER->id] = array(); } if (empty($this->roles[$USER->id][$context])) { $this->roles[$USER->id][$context] = create_role('Role for '.$USER->id.' in '.$context, 'role'.$USER->id.'-'.$context, '-'); role_assign($this->roles[$USER->id][$context], $USER->id, $context); } return $this->roles[$USER->id][$context]; } protected function assign_capability($capability, $permission = CAP_ALLOW, $contextid = null) { if ($contextid === null) { $contextid = context_system::instance(); } if (is_object($contextid)) { $contextid = $contextid->id; } assign_capability($capability, $permission, $this->get_roleid($contextid), $contextid, true); accesslib_clear_all_caches_for_unit_testing(); } public function test_create_coursecat() { // Create the category $data = new stdClass(); $data->name = 'aaa'; $data->description = 'aaa'; $data->idnumber = ''; $category1 = coursecat::create($data); // Initially confirm that base data was inserted correctly $this->assertEquals($data->name, $category1->name); $this->assertEquals($data->description, $category1->description); $this->assertEquals($data->idnumber, $category1->idnumber); $this->assertGreaterThanOrEqual(1, $category1->sortorder); // Create two more categories and test the sortorder worked correctly $data->name = 'ccc'; $category2 = coursecat::create($data); $data->name = 'bbb'; $category3 = coursecat::create($data); $this->assertGreaterThan($category1->sortorder, $category2->sortorder); $this->assertGreaterThan($category2->sortorder, $category3->sortorder); } public function test_name_idnumber_exceptions() { try { coursecat::create(array('name' => '')); $this->fail('Missing category name exception expected in coursecat::create'); } catch (moodle_exception $e) { } $cat1 = coursecat::create(array('name' => 'Cat1', 'idnumber' => '1')); try { $cat1->update(array('name' => '')); $this->fail('Missing category name exception expected in coursecat::update'); } catch (moodle_exception $e) { } try { coursecat::create(array('name' => 'Cat2', 'idnumber' => '1')); $this->fail('Duplicate idnumber exception expected in coursecat::create'); } catch (moodle_exception $e) { } $cat2 = coursecat::create(array('name' => 'Cat2', 'idnumber' => '2')); try { $cat2->update(array('idnumber' => '1')); $this->fail('Duplicate idnumber exception expected in coursecat::update'); } catch (moodle_exception $e) { } } public function test_visibility() { $this->assign_capability('moodle/category:viewhiddencategories'); $this->assign_capability('moodle/category:manage'); // create category 1 initially hidden $category1 = coursecat::create(array('name' => 'Cat1', 'visible' => 0)); $this->assertEquals(0, $category1->visible); $this->assertEquals(0, $category1->visibleold); // create category 2 initially hidden as a child of hidden category 1 $category2 = coursecat::create(array('name' => 'Cat2', 'visible' => 0, 'parent' => $category1->id)); $this->assertEquals(0, $category2->visible); $this->assertEquals(0, $category2->visibleold); // create category 3 initially visible as a child of hidden category 1 $category3 = coursecat::create(array('name' => 'Cat3', 'visible' => 1, 'parent' => $category1->id)); $this->assertEquals(0, $category3->visible); $this->assertEquals(1, $category3->visibleold); // show category 1 and make sure that category 2 is hidden and category 3 is visible $category1->show(); $this->assertEquals(1, coursecat::get($category1->id)->visible); $this->assertEquals(0, coursecat::get($category2->id)->visible); $this->assertEquals(1, coursecat::get($category3->id)->visible); // create visible category 4 $category4 = coursecat::create(array('name' => 'Cat4')); $this->assertEquals(1, $category4->visible); $this->assertEquals(1, $category4->visibleold); // create visible category 5 as a child of visible category 4 $category5 = coursecat::create(array('name' => 'Cat5', 'parent' => $category4->id)); $this->assertEquals(1, $category5->visible); $this->assertEquals(1, $category5->visibleold); // hide category 4 and make sure category 5 is hidden too $category4->hide(); $this->assertEquals(0, $category4->visible); $this->assertEquals(0, $category4->visibleold); $category5 = coursecat::get($category5->id); // we have to re-read from DB $this->assertEquals(0, $category5->visible); $this->assertEquals(1, $category5->visibleold); // show category 4 and make sure category 5 is visible too $category4->show(); $this->assertEquals(1, $category4->visible); $this->assertEquals(1, $category4->visibleold); $category5 = coursecat::get($category5->id); // we have to re-read from DB $this->assertEquals(1, $category5->visible); $this->assertEquals(1, $category5->visibleold); // move category 5 under hidden category 2 and make sure it became hidden $category5->change_parent($category2->id); $this->assertEquals(0, $category5->visible); $this->assertEquals(1, $category5->visibleold); // re-read object for category 5 from DB and check again $category5 = coursecat::get($category5->id); $this->assertEquals(0, $category5->visible); $this->assertEquals(1, $category5->visibleold); // tricky one! Move hidden category 5 under visible category ("Top") and make sure it is still hidden // WHY? Well, different people may expect different behaviour here. So better keep it hidden $category5->change_parent(0); $this->assertEquals(0, $category5->visible); $this->assertEquals(1, $category5->visibleold); } public function test_hierarchy() { $this->assign_capability('moodle/category:viewhiddencategories'); $this->assign_capability('moodle/category:manage'); $category1 = coursecat::create(array('name' => 'Cat1')); $category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id)); $category3 = coursecat::create(array('name' => 'Cat3', 'parent' => $category1->id)); $category4 = coursecat::create(array('name' => 'Cat4', 'parent' => $category2->id)); // check function get_children() $this->assertEquals(array($category2->id, $category3->id), array_keys($category1->get_children())); // check function get_parents() $this->assertEquals(array($category1->id, $category2->id), $category4->get_parents()); // can not move category to itself or to it's children $this->assertFalse($category1->can_change_parent($category2->id)); $this->assertFalse($category2->can_change_parent($category2->id)); // can move category to grandparent $this->assertTrue($category4->can_change_parent($category1->id)); try { $category2->change_parent($category4->id); $this->fail('Exception expected - can not move category'); } catch (moodle_exception $e) { } $category4->change_parent(0); $this->assertEquals(array(), $category4->get_parents()); $this->assertEquals(array($category2->id, $category3->id), array_keys($category1->get_children())); $this->assertEquals(array(), array_keys($category2->get_children())); } public function test_update() { $category1 = coursecat::create(array('name' => 'Cat1')); $timecreated = $category1->timemodified; $this->assertEquals('Cat1', $category1->name); $this->assertTrue(empty($category1->description)); sleep(2); $testdescription = 'This is cat 1 а также русский текст'; $category1->update(array('description' => $testdescription)); $this->assertEquals($testdescription, $category1->description); $category1 = coursecat::get($category1->id); $this->assertEquals($testdescription, $category1->description); cache_helper::purge_by_event('changesincoursecat'); $category1 = coursecat::get($category1->id); $this->assertEquals($testdescription, $category1->description); $this->assertGreaterThan($timecreated, $category1->timemodified); } public function test_delete() { global $DB; $this->assign_capability('moodle/category:manage'); $this->assign_capability('moodle/course:create'); $initialcatid = $DB->get_field_sql('SELECT max(id) from {course_categories}'); $category1 = coursecat::create(array('name' => 'Cat1')); $category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id)); $category3 = coursecat::create(array('name' => 'Cat3')); $category4 = coursecat::create(array('name' => 'Cat4', 'parent' => $category2->id)); $course1 = $this->getDataGenerator()->create_course(array('category' => $category2->id)); $course2 = $this->getDataGenerator()->create_course(array('category' => $category4->id)); $course3 = $this->getDataGenerator()->create_course(array('category' => $category4->id)); $course4 = $this->getDataGenerator()->create_course(array('category' => $category1->id)); // Now we have // $category1 // $category2 // $category4 // $course2 // $course3 // $course1 // $course4 // $category3 // Login as another user to test course:delete capability (user who created course can delete it within 24h even without cap) $this->setUser($this->getDataGenerator()->create_user()); // Delete category 2 and move content to category 3 $this->assertFalse($category2->can_move_content_to($category3->id)); // no luck! // add necessary capabilities $this->assign_capability('moodle/course:create', CAP_ALLOW, context_coursecat::instance($category3->id)); $this->assign_capability('moodle/category:manage'); $this->assertTrue($category2->can_move_content_to($category3->id)); // hurray! $category2->delete_move($category3->id); // Make sure we have: // $category1 // $course4 // $category3 // $category4 // $course2 // $course3 // $course1 $this->assertNull(coursecat::get($category2->id, IGNORE_MISSING, true)); $this->assertEquals(array(), $category1->get_children()); $this->assertEquals(array($category4->id), array_keys($category3->get_children())); $this->assertEquals($category4->id, $DB->get_field('course', 'category', array('id' => $course2->id))); $this->assertEquals($category4->id, $DB->get_field('course', 'category', array('id' => $course3->id))); $this->assertEquals($category3->id, $DB->get_field('course', 'category', array('id' => $course1->id))); // Delete category 3 completely $this->assertFalse($category3->can_delete_full()); // no luck! // add necessary capabilities $this->assign_capability('moodle/course:delete', CAP_ALLOW, context_coursecat::instance($category3->id)); $this->assertTrue($category3->can_delete_full()); // hurray! $category3->delete_full(); // Make sure we have: // $category1 // $course4 // Note that we also have default 'Miscellaneous' category and default 'site' course $this->assertEquals(1, $DB->get_field_sql('SELECT count(*) FROM {course_categories} WHERE id > ?', array($initialcatid))); $this->assertEquals($category1->id, $DB->get_field_sql('SELECT max(id) FROM {course_categories}')); $this->assertEquals(1, $DB->get_field_sql('SELECT count(*) FROM {course} WHERE id <> ?', array(SITEID))); $this->assertEquals(array('id' => $course4->id, 'category' => $category1->id), (array)$DB->get_record_sql('SELECT id, category from {course} where id <> ?', array(SITEID))); } public function test_get_children() { $category1 = coursecat::create(array('name' => 'Cat1')); $category2 = coursecat::create(array('name' => 'Cat2', 'parent' => $category1->id)); $category3 = coursecat::create(array('name' => 'Cat3', 'parent' => $category1->id, 'visible' => 0)); $category4 = coursecat::create(array('name' => 'Cat4', 'idnumber' => '12', 'parent' => $category1->id)); $category5 = coursecat::create(array('name' => 'Cat5', 'idnumber' => '11', 'parent' => $category1->id, 'visible' => 0)); $category6 = coursecat::create(array('name' => 'Cat6', 'idnumber' => '10', 'parent' => $category1->id)); $category7 = coursecat::create(array('name' => 'Cat0', 'parent' => $category1->id)); $children = $category1->get_children(); // user does not have the capability to view hidden categories, so the list should be // 2,4,6,7 $this->assertEquals(array($category2->id, $category4->id, $category6->id, $category7->id), array_keys($children)); $this->assertEquals(4, $category1->get_children_count()); $children = $category1->get_children(array('offset' => 2)); $this->assertEquals(array($category6->id, $category7->id), array_keys($children)); $this->assertEquals(4, $category1->get_children_count()); $children = $category1->get_children(array('limit' => 2)); $this->assertEquals(array($category2->id, $category4->id), array_keys($children)); $children = $category1->get_children(array('offset' => 1, 'limit' => 2)); $this->assertEquals(array($category4->id, $category6->id), array_keys($children)); $children = $category1->get_children(array('sort' => array('name' => 1))); // must be 7,2,4,6 $this->assertEquals(array($category7->id, $category2->id, $category4->id, $category6->id), array_keys($children)); $children = $category1->get_children(array('sort' => array('idnumber' => 1, 'name' => -1))); // must be 2,7,6,4 $this->assertEquals(array($category2->id, $category7->id, $category6->id, $category4->id), array_keys($children)); // check that everything is all right after purging the caches cache_helper::purge_by_event('changesincoursecat'); $children = $category1->get_children(); $this->assertEquals(array($category2->id, $category4->id, $category6->id, $category7->id), array_keys($children)); $this->assertEquals(4, $category1->get_children_count()); } public function test_get_search_courses() { $cat1 = coursecat::create(array('name' => 'Cat1')); $cat2 = coursecat::create(array('name' => 'Cat2', 'parent' => $cat1->id)); $c1 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 3', 'summary' => ' ', 'idnumber' => 'ID3')); $c2 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 1', 'summary' => ' ', 'visible' => 0)); $c3 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Математика', 'summary' => ' Test ')); $c4 = $this->getDataGenerator()->create_course(array('category' => $cat1->id, 'fullname' => 'Test 4', 'summary' => ' ', 'idnumber' => 'ID4')); $c5 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 5', 'summary' => ' ')); $c6 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Дискретная Математика', 'summary' => ' ')); $c7 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 7', 'summary' => ' ', 'visible' => 0)); $c8 = $this->getDataGenerator()->create_course(array('category' => $cat2->id, 'fullname' => 'Test 8', 'summary' => ' ')); // get courses in category 1 (returned visible only because user is not enrolled) global $DB; $res = $cat1->get_courses(array('sortorder' => 1)); $this->assertEquals(array($c4->id, $c3->id, $c1->id), array_keys($res)); // courses are added in reverse order $this->assertEquals(3, $cat1->get_courses_count()); // get courses in category 1 recursively (returned visible only because user is not enrolled) $res = $cat1->get_courses(array('recursive' => 1)); $this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c6->id, $c5->id), array_keys($res)); $this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1))); // get courses sorted by fullname $res = $cat1->get_courses(array('sort' => array('fullname' => 1))); $this->assertEquals(array($c1->id, $c4->id, $c3->id), array_keys($res)); $this->assertEquals(3, $cat1->get_courses_count(array('sort' => array('fullname' => 1)))); // get courses sorted by fullname recursively $res = $cat1->get_courses(array('recursive' => 1, 'sort' => array('fullname' => 1))); $this->assertEquals(array($c1->id, $c4->id, $c5->id, $c8->id, $c6->id, $c3->id), array_keys($res)); $this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1, 'sort' => array('fullname' => 1)))); // get courses sorted by fullname recursively, use offset and limit $res = $cat1->get_courses(array('recursive' => 1, 'offset' => 1, 'limit' => 2, 'sort' => array('fullname' => -1))); $this->assertEquals(array($c6->id, $c8->id), array_keys($res)); // offset and limit do not affect get_courses_count() $this->assertEquals(6, $cat1->get_courses_count(array('recursive' => 1, 'offset' => 1, 'limit' => 2, 'sort' => array('fullname' => 1)))); // calling get_courses_count without prior call to get_courses() $this->assertEquals(3, $cat2->get_courses_count(array('recursive' => 1, 'sort' => array('idnumber' => 1)))); // search courses // search by text $res = coursecat::search_courses(array('search' => 'Test')); $this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c5->id), array_keys($res)); $this->assertEquals(5, coursecat::search_courses_count(array('search' => 'Test'))); // search by text with specified offset and limit $options = array('sort' => array('fullname' => 1), 'offset' => 1, 'limit' => 2); $res = coursecat::search_courses(array('search' => 'Test'), $options); $this->assertEquals(array($c4->id, $c5->id), array_keys($res)); $this->assertEquals(5, coursecat::search_courses_count(array('search' => 'Test'), $options)); // IMPORTANT: the tests below may fail on some databases // case-insensitive search $res = coursecat::search_courses(array('search' => 'test')); $this->assertEquals(array($c4->id, $c3->id, $c1->id, $c8->id, $c5->id), array_keys($res)); $this->assertEquals(5, coursecat::search_courses_count(array('search' => 'test'))); // non-latin language search $res = coursecat::search_courses(array('search' => 'Математика')); $this->assertEquals(array($c3->id, $c6->id), array_keys($res)); $this->assertEquals(2, coursecat::search_courses_count(array('search' => 'Математика'), array())); } public function test_course_contacts() { global $DB, $CFG; $teacherrole = $DB->get_record('role', array('shortname'=>'editingteacher')); $managerrole = $DB->get_record('role', array('shortname'=>'manager')); $studentrole = $DB->get_record('role', array('shortname'=>'student')); $oldcoursecontact = $CFG->coursecontact; $CFG->coursecontact = $managerrole->id. ','. $teacherrole->id; /** * User is listed in course contacts for the course if he has one of the * "course contact" roles ($CFG->coursecontact) AND is enrolled in the course. * If the user has several roles only the highest is displayed. */ // Test case: // // == Cat1 (user2 has teacher role) // == Cat2 // -- course21 (user2 is enrolled as manager) | [Expected] Manager: F2 L2 // -- course22 (user2 is enrolled as student) | [Expected] Teacher: F2 L2 // == Cat4 (user2 has manager role) // -- course41 (user4 is enrolled as teacher, user5 is enrolled as manager) | [Expected] Manager: F5 L5, Teacher: F4 L4 // -- course42 (user2 is enrolled as teacher) | [Expected] Manager: F2 L2 // == Cat3 (user3 has manager role) // -- course31 (user3 is enrolled as student) | [Expected] Manager: F3 L3 // -- course32 | [Expected] // -- course11 (user1 is enrolled as teacher) | [Expected] Teacher: F1 L1 // -- course12 (user1 has teacher role) | [Expected] // also user4 is enrolled as teacher but enrolment is not active $category = $course = $enrol = $user = array(); $category[1] = coursecat::create(array('name' => 'Cat1'))->id; $category[2] = coursecat::create(array('name' => 'Cat2', 'parent' => $category[1]))->id; $category[3] = coursecat::create(array('name' => 'Cat3', 'parent' => $category[1]))->id; $category[4] = coursecat::create(array('name' => 'Cat4', 'parent' => $category[2]))->id; foreach (array(1,2,3,4) as $catid) { foreach (array(1,2) as $courseid) { $course[$catid][$courseid] = $this->getDataGenerator()->create_course(array('idnumber' => 'id'.$catid.$courseid, 'category' => $category[$catid]))->id; $enrol[$catid][$courseid] = $DB->get_record('enrol', array('courseid'=>$course[$catid][$courseid], 'enrol'=>'manual'), '*', MUST_EXIST); } } foreach (array(1,2,3,4,5) as $userid) { $user[$userid] = $this->getDataGenerator()->create_user(array('firstname' => 'F'.$userid, 'lastname' => 'L'.$userid))->id; } $manual = enrol_get_plugin('manual'); // Cat1 (user2 has teacher role) role_assign($teacherrole->id, $user[2], context_coursecat::instance($category[1])); // course21 (user2 is enrolled as manager) $manual->enrol_user($enrol[2][1], $user[2], $managerrole->id); // course22 (user2 is enrolled as student) $manual->enrol_user($enrol[2][2], $user[2], $studentrole->id); // Cat4 (user2 has manager role) role_assign($managerrole->id, $user[2], context_coursecat::instance($category[4])); // course41 (user4 is enrolled as teacher, user5 is enrolled as manager) $manual->enrol_user($enrol[4][1], $user[4], $teacherrole->id); $manual->enrol_user($enrol[4][1], $user[5], $managerrole->id); // course42 (user2 is enrolled as teacher) $manual->enrol_user($enrol[4][2], $user[2], $teacherrole->id); // Cat3 (user3 has manager role) role_assign($managerrole->id, $user[3], context_coursecat::instance($category[3])); // course31 (user3 is enrolled as student) $manual->enrol_user($enrol[3][1], $user[3], $studentrole->id); // course11 (user1 is enrolled as teacher) $manual->enrol_user($enrol[1][1], $user[1], $teacherrole->id); // -- course12 (user1 has teacher role) // also user4 is enrolled as teacher but enrolment is not active role_assign($teacherrole->id, $user[1], context_course::instance($course[1][2])); $manual->enrol_user($enrol[1][2], $user[4], $teacherrole->id, 0, 0, ENROL_USER_SUSPENDED); $allcourses = coursecat::get(0)->get_courses(array('recursive' => true, 'coursecontacts' => true, 'sort' => array('idnumber' => 1))); // Simplify the list of contacts for each course (similar as renderer would do) $contacts = array(); foreach (array(1,2,3,4) as $catid) { foreach (array(1,2) as $courseid) { $tmp = array(); foreach ($allcourses[$course[$catid][$courseid]]->get_course_contacts() as $contact) { $tmp[] = $contact['rolename']. ': '. $contact['username']; } $contacts[$catid][$courseid] = join(', ', $tmp); } } // Assert: // -- course21 (user2 is enrolled as manager) | Manager: F2 L2 $this->assertEquals('Manager: F2 L2', $contacts[2][1]); // -- course22 (user2 is enrolled as student) | Teacher: F2 L2 $this->assertEquals('Teacher: F2 L2', $contacts[2][2]); // -- course41 (user4 is enrolled as teacher, user5 is enrolled as manager) | Manager: F5 L5, Teacher: F4 L4 $this->assertEquals('Manager: F5 L5, Teacher: F4 L4', $contacts[4][1]); // -- course42 (user2 is enrolled as teacher) | [Expected] Manager: F2 L2 $this->assertEquals('Manager: F2 L2', $contacts[4][2]); // -- course31 (user3 is enrolled as student) | Manager: F3 L3 $this->assertEquals('Manager: F3 L3', $contacts[3][1]); // -- course32 | $this->assertEquals('', $contacts[3][2]); // -- course11 (user1 is enrolled as teacher) | Teacher: F1 L1 $this->assertEquals('Teacher: F1 L1', $contacts[1][1]); // -- course12 (user1 has teacher role) | $this->assertEquals('', $contacts[1][2]); $CFG->coursecontact = $oldcoursecontact; } }