See Release Notes
Long Term Support Release
<?php // This file is part of Moodle - http://moodle.org/ // // Moodle is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // // Moodle is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // // You should have received a copy of the GNU General Public License // along with Moodle. If not, see <http://www.gnu.org/licenses/>. namespace core; defined('MOODLE_INTERNAL') || die(); require_once(__DIR__.'/fixtures/lib.php'); /** * Test grade items * * @package core * @category test * @copyright nicolas@moodle.com * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class grade_item_test extends \grade_base_testcase { public function test_grade_item() { $this->sub_test_grade_item_construct(); $this->sub_test_grade_item_insert(); $this->sub_test_grade_item_delete(); $this->sub_test_grade_item_update(); $this->sub_test_grade_item_load_scale(); $this->sub_test_grade_item_load_outcome(); $this->sub_test_grade_item_qualifies_for_regrading(); $this->sub_test_grade_item_force_regrading(); $this->sub_test_grade_item_fetch(); $this->sub_test_grade_item_fetch_all(); $this->sub_test_grade_item_get_all_finals(); $this->sub_test_grade_item_get_final(); $this->sub_test_grade_item_get_sortorder(); $this->sub_test_grade_item_set_sortorder(); $this->sub_test_grade_item_move_after_sortorder(); $this->sub_test_grade_item_get_name_escaped(); $this->sub_test_grade_item_get_name_unescaped(); $this->sub_test_grade_item_set_parent(); $this->sub_test_grade_item_get_parent_category(); $this->sub_test_grade_item_load_parent_category(); $this->sub_test_grade_item_get_item_category(); $this->sub_test_grade_item_load_item_category(); $this->sub_test_grade_item_regrade_final_grades(); $this->sub_test_grade_item_adjust_raw_grade(); $this->sub_test_grade_item_rescale_grades_keep_percentage(); $this->sub_test_grade_item_set_locked(); $this->sub_test_grade_item_is_locked(); $this->sub_test_grade_item_set_hidden(); $this->sub_test_grade_item_is_hidden(); $this->sub_test_grade_item_is_category_item(); $this->sub_test_grade_item_is_course_item(); $this->sub_test_grade_item_fetch_course_item(); $this->sub_test_grade_item_depends_on(); $this->sub_test_refresh_grades(); $this->sub_test_grade_item_is_calculated(); $this->sub_test_grade_item_set_calculation(); $this->sub_test_grade_item_get_calculation(); $this->sub_test_grade_item_compute(); $this->sub_test_update_final_grade(); $this->sub_test_grade_item_can_control_visibility(); $this->sub_test_grade_item_fix_sortorder(); $this->sub_test_grade_item_created_event(); $this->sub_test_grade_item_updated_event(); } protected function sub_test_grade_item_construct() { $params = new \stdClass(); $params->courseid = $this->courseid; $params->categoryid = $this->grade_categories[1]->id; $params->itemname = 'unittestgradeitem4'; $params->itemtype = 'mod'; $params->itemmodule = 'database'; $params->iteminfo = 'Grade item used for unit testing'; $grade_item = new \grade_item($params, false); $this->assertEquals($params->courseid, $grade_item->courseid); $this->assertEquals($params->categoryid, $grade_item->categoryid); $this->assertEquals($params->itemmodule, $grade_item->itemmodule); } protected function sub_test_grade_item_insert() { $grade_item = new \grade_item(); $this->assertTrue(method_exists($grade_item, 'insert')); $grade_item->courseid = $this->courseid; $grade_item->categoryid = $this->grade_categories[1]->id; $grade_item->itemname = 'unittestgradeitem4'; $grade_item->itemtype = 'mod'; $grade_item->itemmodule = 'quiz'; $grade_item->iteminfo = 'Grade item used for unit testing'; $grade_item->insert(); $last_grade_item = end($this->grade_items); $this->assertEquals($grade_item->id, $last_grade_item->id + 1); $this->assertEquals(18, $grade_item->sortorder); // Keep our reference collection the same as what is in the database. $this->grade_items[] = $grade_item; } protected function sub_test_grade_item_delete() { global $DB; $grade_item = new \grade_item($this->grade_items[7], false); // Use a grade item not touched by previous (or future) tests. $this->assertTrue(method_exists($grade_item, 'delete')); // Add two files. $dummy = array( 'contextid' => $grade_item->get_context()->id, 'component' => GRADE_FILE_COMPONENT, 'filearea' => GRADE_HISTORY_FEEDBACK_FILEAREA, 'itemid' => 1, 'filepath' => '/', 'filename' => 'feedback1.txt' ); $fs = get_file_storage(); $fs->create_file_from_string($dummy, ''); $dummy['itemid'] = 2; $fs->create_file_from_string($dummy, ''); $files = $fs->get_area_files($grade_item->get_context()->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); // Includes directories. $this->assertCount(4, $files); $this->assertTrue($grade_item->delete()); $this->assertFalse($DB->get_record('grade_items', array('id' => $grade_item->id))); $files = $fs->get_area_files($grade_item->get_context()->id, GRADE_FILE_COMPONENT, GRADE_HISTORY_FEEDBACK_FILEAREA); $this->assertEmpty($files); // Keep our reference collection the same as the database. unset($this->grade_items[7]); } protected function sub_test_grade_item_update() { global $DB; $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'update')); $grade_item->iteminfo = 'Updated info for this unittest grade_item'; $this->assertTrue($grade_item->update()); $grade_item->grademin = 14; $this->assertTrue($grade_item->qualifies_for_regrading()); $this->assertTrue($grade_item->update()); $iteminfo = $DB->get_field('grade_items', 'iteminfo', array('id' => $this->grade_items[0]->id)); $this->assertEquals($grade_item->iteminfo, $iteminfo); } protected function sub_test_grade_item_load_scale() { $grade_item = new \grade_item($this->grade_items[2], false); $this->assertTrue(method_exists($grade_item, 'load_scale')); $scale = $grade_item->load_scale(); $this->assertFalse(empty($grade_item->scale)); $this->assertEquals($scale->id, $this->grade_items[2]->scaleid); } protected function sub_test_grade_item_load_outcome() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'load_outcome')); // TODO: add tests. } protected function sub_test_grade_item_qualifies_for_regrading() { $grade_item = new \grade_item($this->grade_items[3], false); // Use a grade item not touched by previous tests. $this->assertTrue(method_exists($grade_item, 'qualifies_for_regrading')); $this->assertFalse($grade_item->qualifies_for_regrading()); $grade_item->iteminfo = 'Updated info for this unittest grade_item'; $this->assertFalse($grade_item->qualifies_for_regrading()); $grade_item->grademin = 14; $this->assertTrue($grade_item->qualifies_for_regrading()); } protected function sub_test_grade_item_force_regrading() { $grade_item = new \grade_item($this->grade_items[3], false); // Use a grade item not touched by previous tests. $this->assertTrue(method_exists($grade_item, 'force_regrading')); $this->assertEquals(0, $grade_item->needsupdate); $grade_item->force_regrading(); $this->assertEquals(1, $grade_item->needsupdate); $grade_item->update_from_db(); $this->assertEquals(1, $grade_item->needsupdate); } protected function sub_test_grade_item_fetch() { $grade_item = new \grade_item(); $this->assertTrue(method_exists($grade_item, 'fetch')); // Not using $this->grade_items[0] as it's iteminfo was modified by sub_test_grade_item_qualifies_for_regrading(). $grade_item = \grade_item::fetch(array('id'=>$this->grade_items[1]->id)); $this->assertEquals($this->grade_items[1]->id, $grade_item->id); $this->assertEquals($this->grade_items[1]->iteminfo, $grade_item->iteminfo); $grade_item = \grade_item::fetch(array('itemtype'=>$this->grade_items[1]->itemtype, 'itemmodule'=>$this->grade_items[1]->itemmodule)); $this->assertEquals($this->grade_items[1]->id, $grade_item->id); $this->assertEquals($this->grade_items[1]->iteminfo, $grade_item->iteminfo); } protected function sub_test_grade_item_fetch_all() { $grade_item = new \grade_item(); $this->assertTrue(method_exists($grade_item, 'fetch_all')); $grade_items = \grade_item::fetch_all(array('courseid'=>$this->courseid)); $this->assertEquals(count($this->grade_items), count($grade_items)-1); // -1 to account for the course grade item. } // Retrieve all final scores for a given grade_item. protected function sub_test_grade_item_get_all_finals() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'get_final')); $final_grades = $grade_item->get_final(); $this->assertEquals(3, count($final_grades)); } // Retrieve all final scores for a specific userid. protected function sub_test_grade_item_get_final() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'get_final')); $final_grade = $grade_item->get_final($this->user[1]->id); $this->assertEquals($this->grade_grades[0]->finalgrade, $final_grade->finalgrade); } protected function sub_test_grade_item_get_sortorder() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'get_sortorder')); $sortorder = $grade_item->get_sortorder(); $this->assertEquals($this->grade_items[0]->sortorder, $sortorder); } protected function sub_test_grade_item_set_sortorder() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'set_sortorder')); $grade_item->set_sortorder(999); $this->assertEquals($grade_item->sortorder, 999); } protected function sub_test_grade_item_move_after_sortorder() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'move_after_sortorder')); $grade_item->move_after_sortorder(5); $this->assertEquals($grade_item->sortorder, 6); $grade_item = \grade_item::fetch(array('id'=>$this->grade_items[0]->id)); $this->assertEquals($grade_item->sortorder, 6); $after = \grade_item::fetch(array('id'=>$this->grade_items[6]->id)); $this->assertEquals($after->sortorder, 8); } /** * Tests the getter of the item name with escaped HTML. */ protected function sub_test_grade_item_get_name_escaped() { $gradeitem = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($gradeitem, 'get_name')); $this->assertEquals(format_string($this->grade_items[0]->itemname, true, ['escape' => true]), $gradeitem->get_name(false, true)); } /** * Tests the getter of the item name with unescaped HTML. */ protected function sub_test_grade_item_get_name_unescaped() { $gradeitem = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($gradeitem, 'get_name')); $this->assertEquals(format_string($this->grade_items[0]->itemname, true, ['escape' => false]), $gradeitem->get_name(false, false)); } protected function sub_test_grade_item_set_parent() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'set_parent')); $old = $grade_item->get_parent_category(); $new = new \grade_category($this->grade_categories[3], false); $new_item = $new->get_grade_item(); $this->assertTrue($grade_item->set_parent($new->id)); $new_item->update_from_db(); $grade_item->update_from_db(); $this->assertEquals($grade_item->categoryid, $new->id); } protected function sub_test_grade_item_get_parent_category() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'get_parent_category')); $category = $grade_item->get_parent_category(); $this->assertEquals($this->grade_categories[1]->fullname, $category->fullname); } protected function sub_test_grade_item_load_parent_category() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'load_parent_category')); $category = $grade_item->load_parent_category(); $this->assertEquals($this->grade_categories[1]->fullname, $category->fullname); $this->assertEquals($this->grade_categories[1]->fullname, $grade_item->parent_category->fullname); } protected function sub_test_grade_item_get_item_category() { $grade_item = new \grade_item($this->grade_items[3], false); $this->assertTrue(method_exists($grade_item, 'get_item_category')); $category = $grade_item->get_item_category(); $this->assertEquals($this->grade_categories[0]->fullname, $category->fullname); } protected function sub_test_grade_item_load_item_category() { $grade_item = new \grade_item($this->grade_items[3], false); $this->assertTrue(method_exists($grade_item, 'load_item_category')); $category = $grade_item->load_item_category(); $this->assertEquals($this->grade_categories[0]->fullname, $category->fullname); $this->assertEquals($this->grade_categories[0]->fullname, $grade_item->item_category->fullname); } protected function sub_test_grade_item_regrade_final_grades() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'regrade_final_grades')); $this->assertEquals(true, $grade_item->regrade_final_grades()); // TODO: add more tests. } protected function sub_test_grade_item_adjust_raw_grade() { $grade_item = new \grade_item($this->grade_items[2], false); // Anything but assignment module! $this->assertTrue(method_exists($grade_item, 'adjust_raw_grade')); $grade_raw = new \stdClass(); $grade_raw->rawgrade = 40; $grade_raw->grademax = 100; $grade_raw->grademin = 0; $grade_item->gradetype = GRADE_TYPE_VALUE; $grade_item->multfactor = 1; $grade_item->plusfactor = 0; $grade_item->grademax = 50; $grade_item->grademin = 0; $original_grade_raw = clone($grade_raw); $original_grade_item = clone($grade_item); $this->assertEquals(20, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Try a larger maximum grade. $grade_item->grademax = 150; $grade_item->grademin = 0; $this->assertEquals(60, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Try larger minimum grade. $grade_item->grademin = 50; $this->assertEquals(90, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Rescaling from a small scale (0-50) to a larger scale (0-100). $grade_raw->grademax = 50; $grade_raw->grademin = 0; $grade_item->grademax = 100; $grade_item->grademin = 0; $this->assertEquals(80, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Rescaling from a small scale (0-50) to a larger scale with offset (40-100). $grade_item->grademax = 100; $grade_item->grademin = 40; $this->assertEquals(88, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Try multfactor and plusfactor. $grade_raw = clone($original_grade_raw); $grade_item = clone($original_grade_item); $grade_item->multfactor = 1.23; $grade_item->plusfactor = 3; $this->assertEquals(27.6, $grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax)); // Try multfactor below 0 and a negative plusfactor. $grade_raw = clone($original_grade_raw); $grade_item = clone($original_grade_item); $grade_item->multfactor = 0.23; $grade_item->plusfactor = -3; $this->assertEquals(round(1.6), round($grade_item->adjust_raw_grade($grade_raw->rawgrade, $grade_raw->grademin, $grade_raw->grademax))); } protected function sub_test_grade_item_rescale_grades_keep_percentage() { global $DB; $gradeitem = new \grade_item($this->grade_items[10], false); // 10 is the manual grade item. // Create some grades to go with the grade item. $gradeids = array(); $grade = new \stdClass(); $grade->itemid = $gradeitem->id; $grade->userid = $this->user[2]->id; $grade->finalgrade = 10; $grade->rawgrademax = $gradeitem->grademax; $grade->rawgrademin = $gradeitem->grademin; $grade->timecreated = time(); $grade->timemodified = time(); $gradeids[] = $DB->insert_record('grade_grades', $grade); $grade->userid = $this->user[3]->id; $grade->finalgrade = 50; $grade->rawgrademax = $gradeitem->grademax; $grade->rawgrademin = $gradeitem->grademin; $gradeids[] = $DB->insert_record('grade_grades', $grade); // Run the function. $gradeitem->grademax = 33; $gradeitem->grademin = 3; $gradeitem->update(); $gradeitem->rescale_grades_keep_percentage(0, 100, 3, 33, 'test'); // Check that the grades were updated to match the grade item. $grade = $DB->get_record('grade_grades', array('id' => $gradeids[0])); $this->assertEqualsWithDelta($gradeitem->grademax, $grade->rawgrademax, 0.0001, 'Max grade mismatch'); $this->assertEqualsWithDelta($gradeitem->grademin, $grade->rawgrademin, 0.0001, 'Min grade mismatch'); $this->assertEqualsWithDelta(6, $grade->finalgrade, 0.0001, 'Min grade mismatch'); $grade = $DB->get_record('grade_grades', array('id' => $gradeids[1])); $this->assertEqualsWithDelta($gradeitem->grademax, $grade->rawgrademax, 0.0001, 'Max grade mismatch'); $this->assertEqualsWithDelta($gradeitem->grademin, $grade->rawgrademin, 0.0001, 'Min grade mismatch'); $this->assertEqualsWithDelta(18, $grade->finalgrade, 0.0001, 'Min grade mismatch'); } protected function sub_test_grade_item_set_locked() { // Getting a grade_item from the DB as set_locked() will fail if the grade items needs to be updated // also needs to have at least one grade_grade or $grade_item->get_final(1) returns null. // $grade_item = new \grade_item($this->grade_items[8]); $grade_item = \grade_item::fetch(array('id'=>$this->grade_items[8]->id)); $this->assertTrue(method_exists($grade_item, 'set_locked')); $grade_grade = new \grade_grade($grade_item->get_final($this->user[1]->id), false); $this->assertTrue(empty($grade_item->locked));// Not locked. $this->assertTrue(empty($grade_grade->locked));// Not locked. $this->assertTrue($grade_item->set_locked(true, true, false)); $grade_grade = new \grade_grade($grade_item->get_final($this->user[1]->id), false); $this->assertFalse(empty($grade_item->locked));// Locked. $this->assertFalse(empty($grade_grade->locked)); // Individual grades should be locked too. $this->assertTrue($grade_item->set_locked(false, true, false)); $grade = new \grade_grade($grade_item->get_final($this->user[1]->id), false); $this->assertTrue(empty($grade_item->locked)); $this->assertTrue(empty($grade->locked)); // Individual grades should be unlocked too. } protected function sub_test_grade_item_is_locked() { $grade_item = new \grade_item($this->grade_items[10], false); $this->assertTrue(method_exists($grade_item, 'is_locked')); $this->assertFalse($grade_item->is_locked()); $this->assertFalse($grade_item->is_locked($this->user[1]->id)); $this->assertTrue($grade_item->set_locked(true, true, false)); $this->assertTrue($grade_item->is_locked()); $this->assertTrue($grade_item->is_locked($this->user[1]->id)); } protected function sub_test_grade_item_set_hidden() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'set_hidden')); $grade = new \grade_grade($grade_item->get_final($this->user[1]->id), false); $this->assertEquals(0, $grade_item->hidden); $this->assertEquals(0, $grade->hidden); $grade_item->set_hidden(666, true); $grade = new \grade_grade($grade_item->get_final($this->user[1]->id), false); $this->assertEquals(666, $grade_item->hidden); $this->assertEquals(666, $grade->hidden); } protected function sub_test_grade_item_is_hidden() { $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'is_hidden')); $this->assertFalse($grade_item->is_hidden()); $this->assertFalse($grade_item->is_hidden(1)); $grade_item->set_hidden(1); $this->assertTrue($grade_item->is_hidden()); $this->assertTrue($grade_item->is_hidden(1)); $grade_item->set_hidden(666); $this->assertFalse($grade_item->is_hidden()); $this->assertFalse($grade_item->is_hidden(1)); $grade_item->set_hidden(time()+666); $this->assertTrue($grade_item->is_hidden()); $this->assertTrue($grade_item->is_hidden(1)); } protected function sub_test_grade_item_is_category_item() { $grade_item = new \grade_item($this->grade_items[3], false); $this->assertTrue(method_exists($grade_item, 'is_category_item')); $this->assertTrue($grade_item->is_category_item()); } protected function sub_test_grade_item_is_course_item() { $grade_item = \grade_item::fetch_course_item($this->courseid); $this->assertTrue(method_exists($grade_item, 'is_course_item')); $this->assertTrue($grade_item->is_course_item()); } protected function sub_test_grade_item_fetch_course_item() { $grade_item = \grade_item::fetch_course_item($this->courseid); $this->assertTrue(method_exists($grade_item, 'fetch_course_item')); $this->assertEquals($grade_item->itemtype, 'course'); } protected function sub_test_grade_item_depends_on() { global $CFG; $origenableoutcomes = $CFG->enableoutcomes; $CFG->enableoutcomes = 0; $grade_item = new \grade_item($this->grade_items[1], false); // Calculated grade dependency. $deps = $grade_item->depends_on(); sort($deps, SORT_NUMERIC); // For comparison. $this->assertEquals(array($this->grade_items[0]->id), $deps); // Simulate depends on returns none when locked. $grade_item->locked = time(); $grade_item->update(); $deps = $grade_item->depends_on(); sort($deps, SORT_NUMERIC); // For comparison. $this->assertEquals(array(), $deps); // Category dependency. $grade_item = new \grade_item($this->grade_items[3], false); $deps = $grade_item->depends_on(); sort($deps, SORT_NUMERIC); // For comparison. $res = array($this->grade_items[4]->id, $this->grade_items[5]->id); $this->assertEquals($res, $deps); } protected function scales_outcomes_test_grade_item_depends_on() { $CFG->enableoutcomes = 1; $origgradeincludescalesinaggregation = $CFG->grade_includescalesinaggregation; $CFG->grade_includescalesinaggregation = 1; // Scale item in category with $CFG->grade_includescalesinaggregation = 1. $grade_item = new \grade_item($this->grade_items[14], false); $deps = $grade_item->depends_on(); sort($deps, SORT_NUMERIC); $res = array($this->grade_items[16]->id); $this->assertEquals($res, $deps); // Scale item in category with $CFG->grade_includescalesinaggregation = 0. $CFG->grade_includescalesinaggregation = 0; $grade_item = new \grade_item($this->grade_items[14], false); $deps = $grade_item->depends_on(); $res = array(); $this->assertEquals($res, $deps); $CFG->grade_includescalesinaggregation = 1; // Outcome item in category with outcomes disabled. $CFG->enableoutcomes = 0; $grade_item = new \grade_item($this->grade_items[14], false); $deps = $grade_item->depends_on(); sort($deps, SORT_NUMERIC); $res = array($this->grade_items[16]->id, $this->grade_items[17]->id); $this->assertEquals($res, $deps); $CFG->enableoutcomes = $origenableoutcomes; $CFG->grade_includescalesinaggregation = $origgradeincludescalesinaggregation; } protected function sub_test_refresh_grades() {< // Testing with the grade item for a mod_assignment instance.> // Testing with the grade item for a mod_assign instance.$grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue(method_exists($grade_item, 'refresh_grades')); $this->assertTrue($grade_item->refresh_grades()); // Break the grade item and check error handling. $grade_item->iteminstance = 123456789; $this->assertFalse($grade_item->refresh_grades()); $this->assertDebuggingCalled(); } protected function sub_test_grade_item_is_calculated() { $grade_item = new \grade_item($this->grade_items[1], false); $this->assertTrue(method_exists($grade_item, 'is_calculated')); $this->assertTrue($grade_item->is_calculated()); $grade_item = new \grade_item($this->grade_items[0], false); $this->assertFalse($grade_item->is_calculated()); } protected function sub_test_grade_item_set_calculation() { $grade_item = new \grade_item($this->grade_items[1], false); $this->assertTrue(method_exists($grade_item, 'set_calculation')); $grade_itemsource = new \grade_item($this->grade_items[0], false); $grade_item->set_calculation('=[['.$grade_itemsource->idnumber.']]'); $this->assertTrue(!empty($grade_item->needsupdate)); $this->assertEquals('=##gi'.$grade_itemsource->id.'##', $grade_item->calculation); } protected function sub_test_grade_item_get_calculation() { $grade_item = new \grade_item($this->grade_items[1], false); $this->assertTrue(method_exists($grade_item, 'get_calculation')); $grade_itemsource = new \grade_item($this->grade_items[0], false); $denormalizedformula = str_replace('##gi'.$grade_itemsource->id.'##', '[['.$grade_itemsource->idnumber.']]', $this->grade_items[1]->calculation); $formula = $grade_item->get_calculation(); $this->assertTrue(!empty($grade_item->needsupdate)); $this->assertEquals($denormalizedformula, $formula); } public function sub_test_grade_item_compute() { $grade_item = \grade_item::fetch(array('id'=>$this->grade_items[1]->id)); $this->assertTrue(method_exists($grade_item, 'compute')); // Check the grade_grades in the array match those in the DB then delete $this->grade_items[1]'s grade_grades. $this->grade_grades[3] = \grade_grade::fetch(array('id'=>$this->grade_grades[3]->id)); $grade_grade = \grade_grade::fetch(array('id'=>$this->grade_grades[3]->id)); $grade_grade->delete(); $this->grade_grades[4] = \grade_grade::fetch(array('id'=>$this->grade_grades[4]->id)); $grade_grade = \grade_grade::fetch(array('id'=>$this->grade_grades[4]->id)); $grade_grade->delete(); $this->grade_grades[5] = \grade_grade::fetch(array('id'=>$this->grade_grades[5]->id)); $grade_grade = \grade_grade::fetch(array('id'=>$this->grade_grades[5]->id)); $grade_grade->delete(); // Recalculate the grades (its a calculation so pulls values from other grade_items) and reinsert them. $grade_item->compute(); $grade_grade = \grade_grade::fetch(array('userid'=>$this->grade_grades[3]->userid, 'itemid'=>$this->grade_grades[3]->itemid)); $this->assertEquals($this->grade_grades[3]->finalgrade, $grade_grade->finalgrade); $grade_grade = \grade_grade::fetch(array('userid'=>$this->grade_grades[4]->userid, 'itemid'=>$this->grade_grades[4]->itemid)); $this->assertEquals($this->grade_grades[4]->finalgrade, $grade_grade->finalgrade); $grade_grade = \grade_grade::fetch(array('userid'=>$this->grade_grades[5]->userid, 'itemid'=>$this->grade_grades[5]->itemid)); $this->assertEquals($this->grade_grades[5]->finalgrade, $grade_grade->finalgrade); } protected function sub_test_update_final_grade() { // MDL-31713 Check that min and max are set on the grade_grade instance // if the grade is overridden before the activity has supplied a grade. $min = 2; $max = 8; // Create a brand new grade item. $grade_item = new \grade_item(); $this->assertTrue(method_exists($grade_item, 'insert')); $grade_item->courseid = $this->courseid; $grade_item->categoryid = $this->grade_categories[1]->id; $grade_item->itemname = 'brand new unit test grade item'; $grade_item->itemtype = 'mod'; $grade_item->itemmodule = 'quiz'; $grade_item->iteminfo = 'Grade item used for unit testing'; $grade_item->iteminstance = $this->activities[7]->id; $grade_item->grademin = $min; $grade_item->grademax = $max; $grade_item->insert(); // Override the student grade. $grade_item->update_final_grade($this->user[1]->id, 7, 'gradebook', '', FORMAT_MOODLE); // Check the student's grade has the correct min and max grade. $grade_grade = \grade_grade::fetch(array('userid'=>$this->user[1]->id, 'itemid'=>$grade_item->id)); $this->assertEquals($min, $grade_grade->rawgrademin); $this->assertEquals($max, $grade_grade->rawgrademax); } protected function sub_test_grade_item_can_control_visibility() { // Grade item 0 == Course module 0 == Assignment. $grade_item = new \grade_item($this->grade_items[0], false); $this->assertTrue($grade_item->can_control_visibility()); // Grade item == Course module 7 == Quiz. $grade_item = new \grade_item($this->grade_items[11], false); $this->assertFalse($grade_item->can_control_visibility()); } /** * Test the {@link \grade_item::fix_duplicate_sortorder() function with * faked duplicate sortorder data. */ public function sub_test_grade_item_fix_sortorder() { global $DB; $this->resetAfterTest(true); // Each set is used for filling the db with fake data and will be representing the result of query: // "SELECT sortorder from {grade_items} WHERE courseid=? ORDER BY id". $testsets = array( // Items that need no action. array(1,2,3), array(5,6,7), array(7,6,1,3,2,5), // Items with sortorder duplicates array(1,2,2,3,3,4,5), // Only one sortorder duplicate. array(1,1), array(3,3), // Non-sequential sortorders with one or multiple duplicates. array(3,3,7,5,6,6,9,10,8,3), array(7,7,3), array(3,4,5,3,5,4,7,1) ); $origsequence = array(); // Generate the data and remember the initial sequence or items. foreach ($testsets as $testset) { $course = $this->getDataGenerator()->create_course(); foreach ($testset as $sortorder) { $this->insert_fake_grade_item_sortorder($course->id, $sortorder); } $DB->get_records('grade_items'); $origsequence[$course->id] = $DB->get_fieldset_sql("SELECT id FROM {grade_items} ". "WHERE courseid = ? ORDER BY sortorder, id", array($course->id)); } $duplicatedetectionsql = "SELECT courseid, sortorder FROM {grade_items} WHERE courseid = :courseid GROUP BY courseid, sortorder HAVING COUNT(id) > 1"; // Do the work. foreach ($origsequence as $courseid => $ignore) { \grade_item::fix_duplicate_sortorder($courseid); // Verify that no duplicates are left in the database. $dupes = $DB->record_exists_sql($duplicatedetectionsql, array('courseid' => $courseid)); $this->assertFalse($dupes); } // Verify that sequences are exactly the same as they were before upgrade script. $idx = 0; foreach ($origsequence as $courseid => $sequence) { if (count(($testsets[$idx])) == count(array_unique($testsets[$idx]))) { // If there were no duplicates for this course verify that sortorders are not modified. $newsortorders = $DB->get_fieldset_sql("SELECT sortorder from {grade_items} WHERE courseid=? ORDER BY id", array($courseid)); $this->assertEquals($testsets[$idx], $newsortorders); } $newsequence = $DB->get_fieldset_sql("SELECT id FROM {grade_items} ". "WHERE courseid = ? ORDER BY sortorder, id", array($courseid)); $this->assertEquals($sequence, $newsequence, "Sequences do not match for test set $idx : ".join(',', $testsets[$idx])); $idx++; } } /** * Populate some fake grade items into the database with specified * sortorder and course id. * * NOTE: This function doesn't make much attempt to respect the * gradebook internals, its simply used to fake some data for * testing the upgradelib function. Please don't use it for other * purposes. * * @param int $courseid id of course * @param int $sortorder numeric sorting order of item< * @return stdClass grade item object from the database.> * @return \stdClass grade item object from the database.*/ private function insert_fake_grade_item_sortorder($courseid, $sortorder) { global $DB, $CFG; require_once($CFG->libdir.'/gradelib.php'); $item = new \stdClass(); $item->courseid = $courseid; $item->sortorder = $sortorder; $item->gradetype = GRADE_TYPE_VALUE; $item->grademin = 30; $item->grademax = 110; $item->itemnumber = 1; $item->iteminfo = ''; $item->timecreated = time(); $item->timemodified = time(); $item->id = $DB->insert_record('grade_items', $item); return $DB->get_record('grade_items', array('id' => $item->id)); } public function test_set_aggregation_fields_for_aggregation() { $course = $this->getDataGenerator()->create_course(); $gi = new \grade_item(array('courseid' => $course->id, 'itemtype' => 'manual'), false); $methods = array(GRADE_AGGREGATE_MEAN, GRADE_AGGREGATE_MEDIAN, GRADE_AGGREGATE_MIN, GRADE_AGGREGATE_MAX, GRADE_AGGREGATE_MODE, GRADE_AGGREGATE_WEIGHTED_MEAN, GRADE_AGGREGATE_WEIGHTED_MEAN2, GRADE_AGGREGATE_EXTRACREDIT_MEAN, GRADE_AGGREGATE_SUM); // Switching from and to the same aggregation using the defaults. foreach ($methods as $method) { $defaults = \grade_category::get_default_aggregation_coefficient_values($method); $gi->aggregationcoef = $defaults['aggregationcoef']; $gi->aggregationcoef2 = $defaults['aggregationcoef2']; $gi->weightoverride = $defaults['weightoverride']; $this->assertFalse($gi->set_aggregation_fields_for_aggregation($method, $method)); $this->assertEquals($defaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals($defaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($defaults['weightoverride'], $gi->weightoverride); } // Extra credit is kept across aggregation methods that support it. foreach ($methods as $from) { $fromsupportsec = \grade_category::aggregation_uses_extracredit($from); $fromdefaults = \grade_category::get_default_aggregation_coefficient_values($from); foreach ($methods as $to) { $tosupportsec = \grade_category::aggregation_uses_extracredit($to); $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); // Set the item to be extra credit, if supported. if ($fromsupportsec) { $gi->aggregationcoef = 1; } else { $gi->aggregationcoef = $fromdefaults['aggregationcoef']; } // We ignore those fields, we know it is never used for extra credit. $gi->aggregationcoef2 = $todefaults['aggregationcoef2']; $gi->weightoverride = $todefaults['weightoverride']; if ($fromsupportsec && $tosupportsec) { $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals(1, $gi->aggregationcoef); } else if ($fromsupportsec && !$tosupportsec) { if ($to == GRADE_AGGREGATE_WEIGHTED_MEAN) { // Special case, aggregationcoef is used but for weights. $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); } else { $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); } } else { // The source does not support extra credit, everything will be reset. if (($from == GRADE_AGGREGATE_WEIGHTED_MEAN || $to == GRADE_AGGREGATE_WEIGHTED_MEAN) && $from != $to) { // Special case, aggregationcoef is used but for weights. $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); } else { $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); } } } } // Extra credit can be higher than one for GRADE_AGGREGATE_EXTRACREDIT_MEAN, but will be normalised for others. $from = GRADE_AGGREGATE_EXTRACREDIT_MEAN; $fromdefaults = \grade_category::get_default_aggregation_coefficient_values($from); foreach ($methods as $to) { if (!\grade_category::aggregation_uses_extracredit($to)) { continue; } $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $gi->aggregationcoef = 8; // Ignore those fields, they are not used for extra credit. $gi->aggregationcoef2 = $todefaults['aggregationcoef2']; $gi->weightoverride = $todefaults['weightoverride']; if ($to == $from) { $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals(8, $gi->aggregationcoef); } else { $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals(1, $gi->aggregationcoef); } } // Weights are reset. $from = GRADE_AGGREGATE_SUM; $fromdefaults = \grade_category::get_default_aggregation_coefficient_values($from); $gi->aggregationcoef = $fromdefaults['aggregationcoef']; $gi->aggregationcoef2 = 0.321; $gi->weightoverride = $fromdefaults['weightoverride']; $to = GRADE_AGGREGATE_WEIGHTED_MEAN; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals($todefaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($todefaults['weightoverride'], $gi->weightoverride); $gi->aggregationcoef = $fromdefaults['aggregationcoef']; $gi->aggregationcoef2 = 0.321; $gi->weightoverride = $fromdefaults['weightoverride']; $to = GRADE_AGGREGATE_SUM; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals($todefaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($todefaults['weightoverride'], $gi->weightoverride); // Weight is kept when using SUM with weight override. $from = GRADE_AGGREGATE_SUM; $fromdefaults = \grade_category::get_default_aggregation_coefficient_values($from); $gi->aggregationcoef = $fromdefaults['aggregationcoef']; $gi->aggregationcoef2 = 0.321; $gi->weightoverride = 1; $to = GRADE_AGGREGATE_SUM; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals(0.321, $gi->aggregationcoef2); $this->assertEquals(1, $gi->weightoverride); $gi->aggregationcoef2 = 0.321; $gi->aggregationcoef = $fromdefaults['aggregationcoef']; $gi->weightoverride = 1; $to = GRADE_AGGREGATE_WEIGHTED_MEAN; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals($todefaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($todefaults['weightoverride'], $gi->weightoverride); // Weight is kept when staying in weighted mean. $from = GRADE_AGGREGATE_WEIGHTED_MEAN; $fromdefaults = \grade_category::get_default_aggregation_coefficient_values($from); $gi->aggregationcoef = 18; $gi->aggregationcoef2 = $fromdefaults['aggregationcoef2']; $gi->weightoverride = $fromdefaults['weightoverride']; $to = GRADE_AGGREGATE_WEIGHTED_MEAN; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertFalse($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals(18, $gi->aggregationcoef); $this->assertEquals($todefaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($todefaults['weightoverride'], $gi->weightoverride); $gi->aggregationcoef = 18; $gi->aggregationcoef2 = $fromdefaults['aggregationcoef2']; $gi->weightoverride = $fromdefaults['weightoverride']; $to = GRADE_AGGREGATE_SUM; $todefaults = \grade_category::get_default_aggregation_coefficient_values($to); $this->assertTrue($gi->set_aggregation_fields_for_aggregation($from, $to), "From: $from, to: $to"); $this->assertEquals($todefaults['aggregationcoef'], $gi->aggregationcoef); $this->assertEquals($todefaults['aggregationcoef2'], $gi->aggregationcoef2); $this->assertEquals($todefaults['weightoverride'], $gi->weightoverride); } /** * Test that grade item event triggered when a grade item is created. */ protected function sub_test_grade_item_created_event() { $sink = $this->redirectEvents(); $gradeitem = new \grade_item(); $gradeitem->courseid = $this->courseid; $gradeitem->categoryid = $this->grade_categories[1]->id; $gradeitem->itemname = 'unittestgradeitem4'; $gradeitem->itemtype = 'mod'; $gradeitem->itemmodule = 'quiz'; $gradeitem->iteminfo = 'Grade item used for unit testing'; $gradeitem->insert(); $result = $sink->get_events(); $sink->close(); $this->assertCount(1, $result); $event = reset($result); $this->assertEventContextNotUsed($event); $this->assertInstanceOf('core\event\grade_item_created', $event); $eventgradeitem = $event->get_grade_item(); $this->assertInstanceOf('grade_item', $eventgradeitem); $this->assertEquals($gradeitem->id, $eventgradeitem->id); $this->assertEquals($gradeitem->itemname, $event->other['itemname']); $this->assertEquals($gradeitem->itemtype, $event->other['itemtype']); $this->assertEquals($gradeitem->itemmodule, $event->other['itemmodule']); } /** * Test that grade item event triggered when a grade item is updated. */ protected function sub_test_grade_item_updated_event() { $gradeitem = new \grade_item(); $gradeitem->courseid = $this->courseid; $gradeitem->categoryid = $this->grade_categories[1]->id; $gradeitem->itemname = 'unittestgradeitem4'; $gradeitem->itemtype = 'mod'; $gradeitem->itemmodule = 'quiz'; $gradeitem->iteminfo = 'Grade item used for unit testing'; $gradeitem->insert(); $sink = $this->redirectEvents(); $gradeitem->itemname = 'updatedname'; $gradeitem->update(); $result = $sink->get_events(); $sink->close(); $this->assertCount(1, $result); $event = reset($result); $this->assertInstanceOf('core\event\grade_item_updated', $event); $this->assertEventContextNotUsed($event); $eventgradeitem = $event->get_grade_item(); $this->assertInstanceOf('grade_item', $eventgradeitem); $this->assertEquals($gradeitem->id, $eventgradeitem->id); $this->assertEquals($gradeitem->itemtype, $event->other['itemtype']); $this->assertEquals($gradeitem->itemmodule, $event->other['itemmodule']); $this->assertEquals('updatedname', $event->other['itemname']); } /** * Test grade item duplication expecting success. */ public function test_grade_duplicate_grade_item_success() { $cat = new \grade_category(); $cat->courseid = $this->courseid; $cat->fullname = 'Grade category'; $cat->insert(); // Method exists. $gi = new \grade_item(); $this->assertTrue(method_exists($gi, 'duplicate')); // Grade item is inserted and valid for duplication. $gi->courseid = $this->courseid; $gi->categoryid = $cat->id; $gi->itemtype = 'manual'; $gi->itemname = 'Grade Item 1'; $gi->idnumber = '1000'; $gi->insert(); $gi2 = $gi->duplicate(); $this->assertEquals($gi->courseid, $gi2->courseid); $this->assertEquals($gi->categoryid, $gi2->categoryid); $this->assertEquals($gi->itemtype, $gi2->itemtype); $this->assertEquals($gi->gradetype, $gi2->gradetype); $this->assertEquals($gi->grademax, $gi2->grademax); $this->assertEquals($gi->grademin, $gi2->grademin); $this->assertEquals($gi->gradepass, $gi2->gradepass); $this->assertEquals($gi->display, $gi2->display); $this->assertEquals($gi->decimals, $gi2->decimals); $this->assertEquals($gi->hidden, $gi2->hidden); $this->assertEquals($gi->weightoverride, $gi2->weightoverride); $this->assertNotEquals($gi->id, $gi2->id); $this->assertNotEquals($gi->idnumber, $gi2->idnumber); $this->assertNotEquals($gi->sortorder, $gi2->sortorder); $this->assertNotEquals($gi->itemname, $gi2->itemname); } /** * Test grade item duplication exception expected with incomplete grade item. */ public function test_grade_duplicate_grade_item_incomplete() { // Grade item is not valid because it is empty. $gi = new \grade_item(); $gi->courseid = $this->courseid; $this->expectException("moodle_exception"); $gi2 = $gi->duplicate(); } /** * Test grade item duplication exception expected because item must be in db. */ public function test_grade_duplicate_grade_item_not_in_db() { $cat = new \grade_category(); $cat->courseid = $this->courseid; $cat->fullname = 'Grade category'; $cat->insert(); // Grade item is valid for insertion but is not inserted into db. // Duplicate method throws an exception. $gi = new \grade_item(); $gi->courseid = $this->courseid; $gi->categoryid = $cat->id; $gi->itemtype = 'manual'; $gi->itemname = 'Grade Item 1'; $gi->idnumber = '1000'; $this->expectException("moodle_exception"); $gi2 = $gi->duplicate(); } }