MDL-64609 gradebook: Prevent infinite loop in regrading
[moodle.git] / lib / tests / gradelib_test.php
CommitLineData
69bcca5e
AD
1<?php
2// This file is part of Moodle - http://moodle.org/
3//
4// Moodle is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8//
9// Moodle is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13//
14// You should have received a copy of the GNU General Public License
15// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16
17/**
18 * Unit tests for /lib/gradelib.php.
19 *
970dc511 20 * @package core_grades
69bcca5e
AD
21 * @category phpunit
22 * @copyright 2012 Andrew Davis
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24 */
25
26defined('MOODLE_INTERNAL') || die();
27
28global $CFG;
29require_once($CFG->libdir . '/gradelib.php');
30
b8f26f4a 31class core_gradelib_testcase extends advanced_testcase {
69bcca5e
AD
32
33 public function test_grade_update_mod_grades() {
34
35 $this->resetAfterTest(true);
36
37 // Create a broken module instance.
38 $modinstance = new stdClass();
39 $modinstance->modname = 'doesntexist';
40
41 $this->assertFalse(grade_update_mod_grades($modinstance));
42 // A debug message should have been generated.
43 $this->assertDebuggingCalled();
44
45 // Create a course and instance of mod_assign.
46 $course = $this->getDataGenerator()->create_course();
47
48 $assigndata['course'] = $course->id;
49 $assigndata['name'] = 'lightwork assignment';
50 $modinstance = self::getDataGenerator()->create_module('assign', $assigndata);
51
b8f26f4a 52 // Function grade_update_mod_grades() requires 2 additional properties, cmidnumber and modname.
69bcca5e
AD
53 $cm = get_coursemodule_from_instance('assign', $modinstance->id, 0, false, MUST_EXIST);
54 $modinstance->cmidnumber = $cm->id;
55 $modinstance->modname = 'assign';
56
57 $this->assertTrue(grade_update_mod_grades($modinstance));
58 }
8bfe9082
MN
59
60 /**
61 * Tests the function remove_grade_letters().
62 */
63 public function test_remove_grade_letters() {
64 global $DB;
65
66 $this->resetAfterTest();
67
68 $course = $this->getDataGenerator()->create_course();
69
70 $context = context_course::instance($course->id);
71
72 // Add a grade letter to the course.
73 $letter = new stdClass();
74 $letter->letter = 'M';
75 $letter->lowerboundary = '100';
76 $letter->contextid = $context->id;
77 $DB->insert_record('grade_letters', $letter);
78
79 remove_grade_letters($context, false);
80
81 // Confirm grade letter was deleted.
82 $this->assertEquals(0, $DB->count_records('grade_letters'));
83 }
84
85 /**
86 * Tests the function grade_course_category_delete().
87 */
88 public function test_grade_course_category_delete() {
89 global $DB;
90
91 $this->resetAfterTest();
92
442f12f8 93 $category = core_course_category::create(array('name' => 'Cat1'));
8bfe9082
MN
94
95 // Add a grade letter to the category.
96 $letter = new stdClass();
97 $letter->letter = 'M';
98 $letter->lowerboundary = '100';
99 $letter->contextid = context_coursecat::instance($category->id)->id;
100 $DB->insert_record('grade_letters', $letter);
101
102 grade_course_category_delete($category->id, '', false);
103
104 // Confirm grade letter was deleted.
105 $this->assertEquals(0, $DB->count_records('grade_letters'));
106 }
d64e545a
EM
107
108 /**
109 * Tests the function grade_regrade_final_grades().
110 */
111 public function test_grade_regrade_final_grades() {
112 global $DB;
113
114 $this->resetAfterTest();
115
116 // Setup some basics.
117 $course = $this->getDataGenerator()->create_course();
118 $user = $this->getDataGenerator()->create_user();
119 $this->getDataGenerator()->enrol_user($user->id, $course->id, 'student');
120
121 // We need two grade items.
122 $params = ['idnumber' => 'g1', 'courseid' => $course->id];
123 $g1 = new grade_item($this->getDataGenerator()->create_grade_item($params));
124 unset($params['idnumber']);
125 $g2 = new grade_item($this->getDataGenerator()->create_grade_item($params));
126
127 $category = new grade_category($this->getDataGenerator()->create_grade_category($params));
128 $catitem = $category->get_grade_item();
129
130 // Now set a calculation.
131 $catitem->set_calculation('=[[g1]]');
132
133 $catitem->update();
134
135 // Everything needs updating.
136 $this->assertEquals(4, $DB->count_records('grade_items', ['courseid' => $course->id, 'needsupdate' => 1]));
137
138 grade_regrade_final_grades($course->id);
139
140 // See that everything has been updated.
141 $this->assertEquals(0, $DB->count_records('grade_items', ['courseid' => $course->id, 'needsupdate' => 1]));
142
143 $g1->delete();
144
145 // Now there is one that needs updating.
146 $this->assertEquals(1, $DB->count_records('grade_items', ['courseid' => $course->id, 'needsupdate' => 1]));
147
148 // This can cause an infinite loop if things go... poorly.
149 grade_regrade_final_grades($course->id);
150
151 // Now because of the failure, two things need updating.
152 $this->assertEquals(2, $DB->count_records('grade_items', ['courseid' => $course->id, 'needsupdate' => 1]));
153 }
69bcca5e 154}