| Línea 12... |
Línea 12... |
| 12 |
// GNU General Public License for more details.
|
12 |
// GNU General Public License for more details.
|
| 13 |
//
|
13 |
//
|
| 14 |
// You should have received a copy of the GNU General Public License
|
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/>.
|
15 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
| Línea -... |
Línea 16... |
| - |
|
16 |
|
| - |
|
17 |
namespace core;
|
| 16 |
|
18 |
|
| 17 |
/**
|
19 |
/**
|
| 18 |
* Tests for report_helper.
|
20 |
* Tests the report_helper class.
|
| - |
|
21 |
*
|
| 19 |
*
|
22 |
* @covers \core\report_helper
|
| 20 |
* @package core
|
23 |
* @package core
|
| 21 |
* @category test
|
24 |
* @category test
|
| 22 |
* @copyright 2021 Sujith Haridasan
|
25 |
* @copyright 2024 The Open University
|
| 23 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
26 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
| - |
|
27 |
*/
|
| - |
|
28 |
final class report_helper_test extends \advanced_testcase {
|
| - |
|
29 |
/** @var int[] Array of created user ids */
|
| Línea -... |
Línea 30... |
| - |
|
30 |
protected array $userids;
|
| - |
|
31 |
|
| - |
|
32 |
/**
|
| - |
|
33 |
* Tests {@see report_helper::get_group_filter()}.
|
| 24 |
*/
|
34 |
*/
|
| Línea -... |
Línea 35... |
| - |
|
35 |
public function test_get_group_filter(): void {
|
| - |
|
36 |
$this->resetAfterTest();
|
| - |
|
37 |
|
| - |
|
38 |
// Create some test course, groups, and users.
|
| - |
|
39 |
$generator = self::getDataGenerator();
|
| - |
|
40 |
|
| - |
|
41 |
$vgcourse = $generator->create_course(['groupmode' => VISIBLEGROUPS]);
|
| - |
|
42 |
$sgcourse = $generator->create_course(['groupmode' => SEPARATEGROUPS]);
|
| - |
|
43 |
|
| - |
|
44 |
$vg1 = $generator->create_group(['courseid' => $vgcourse->id]);
|
| - |
|
45 |
$vg2 = $generator->create_group(['courseid' => $vgcourse->id]);
|
| - |
|
46 |
$sg1 = $generator->create_group(['courseid' => $sgcourse->id]);
|
| - |
|
47 |
$sg2 = $generator->create_group(['courseid' => $sgcourse->id]);
|
| - |
|
48 |
|
| - |
|
49 |
$this->userids = [];
|
| - |
|
50 |
for ($i = 0; $i < 10; $i++) {
|
| - |
|
51 |
$this->userids[$i] = $generator->create_user()->id;
|
| - |
|
52 |
$generator->enrol_user($this->userids[$i], ($i < 5) ? $vgcourse->id : $sgcourse->id, 'student');
|
| - |
|
53 |
}
|
| - |
|
54 |
|
| - |
|
55 |
groups_add_member($vg1, $this->userids[0]);
|
| - |
|
56 |
groups_add_member($vg1, $this->userids[1]);
|
| - |
|
57 |
groups_add_member($vg2, $this->userids[0]);
|
| - |
|
58 |
groups_add_member($vg2, $this->userids[2]);
|
| - |
|
59 |
groups_add_member($vg2, $this->userids[3]);
|
| - |
|
60 |
|
| - |
|
61 |
groups_add_member($sg1, $this->userids[5]);
|
| - |
|
62 |
groups_add_member($sg1, $this->userids[6]);
|
| - |
|
63 |
groups_add_member($sg2, $this->userids[5]);
|
| - |
|
64 |
groups_add_member($sg2, $this->userids[7]);
|
| - |
|
65 |
groups_add_member($sg2, $this->userids[8]);
|
| - |
|
66 |
|
| - |
|
67 |
// Teacher user has access all groups.
|
| - |
|
68 |
$teacher = $generator->create_user();
|
| - |
|
69 |
$generator->enrol_user($teacher->id, $vgcourse->id, 'editingteacher');
|
| - |
|
70 |
$generator->enrol_user($teacher->id, $sgcourse->id, 'editingteacher');
|
| - |
|
71 |
|
| - |
|
72 |
// With specified groups on either course (does not matter who user is).
|
| - |
|
73 |
$this->assert_group_filter([0, 1], ['courseid' => $vgcourse->id, 'groupid' => $vg1->id]);
|
| - |
|
74 |
$this->assert_group_filter([0, 2, 3], ['courseid' => $vgcourse->id, 'groupid' => $vg2->id]);
|
| - |
|
75 |
$this->assert_group_filter([5, 6], ['courseid' => $sgcourse->id, 'groupid' => $sg1->id]);
|
| - |
|
76 |
$this->assert_group_filter([5, 7, 8], ['courseid' => $sgcourse->id, 'groupid' => $sg2->id]);
|
| - |
|
77 |
|
| - |
|
78 |
// With specified group and user.
|
| - |
|
79 |
$this->assert_group_filter([2], [
|
| - |
|
80 |
'courseid' => $vgcourse->id,
|
| - |
|
81 |
'groupid' => $vg2->id,
|
| - |
|
82 |
'userid' => $this->userids[2],
|
| - |
|
83 |
]);
|
| - |
|
84 |
$this->assert_group_filter([6], [
|
| 25 |
|
85 |
'courseid' => $sgcourse->id,
|
| - |
|
86 |
'groupid' => $sg2->id,
|
| - |
|
87 |
'userid' => $this->userids[6],
|
| - |
|
88 |
]);
|
| - |
|
89 |
|
| - |
|
90 |
// No restrictions, user belongs to a group or to both groups on VG course.
|
| - |
|
91 |
$this->setUser($this->userids[1]);
|
| - |
|
92 |
$all = array_keys($this->userids);
|
| - |
|
93 |
$this->assert_group_filter($all, ['courseid' => $vgcourse->id]);
|
| - |
|
94 |
$this->setUser($this->userids[0]);
|
| - |
|
95 |
$this->assert_group_filter($all, ['courseid' => $vgcourse->id]);
|
| - |
|
96 |
|
| - |
|
97 |
// No restrictions, user belongs to a group or to both groups on SG course.
|
| - |
|
98 |
$this->setUser($this->userids[6]);
|
| - |
|
99 |
$this->assert_group_filter([5, 6], ['courseid' => $sgcourse->id]);
|
| - |
|
100 |
$this->setUser($this->userids[5]);
|
| - |
|
101 |
$this->assert_group_filter([5, 6, 7, 8], ['courseid' => $sgcourse->id]);
|
| - |
|
102 |
|
| - |
|
103 |
// No restrictions, user has access all groups on either course.
|
| - |
|
104 |
$this->setUser($teacher);
|
| - |
|
105 |
$this->assert_group_filter($all, ['courseid' => $vgcourse->id]);
|
| - |
|
106 |
$this->assert_group_filter($all, ['courseid' => $sgcourse->id]);
|
| - |
|
107 |
|
| - |
|
108 |
// There was a performance issue for users with access all groups where it listed all users
|
| 26 |
namespace core;
|
109 |
// in the system in the 'filter' list, now it doesn't.
|
| - |
|
110 |
$this->assertNull(report_helper::get_group_filter(
|
| - |
|
111 |
(object)['courseid' => $sgcourse->id],
|
| - |
|
112 |
)['useridfilter']);
|
| - |
|
113 |
|
| - |
|
114 |
// Specified group even if you have AAG.
|
| - |
|
115 |
$this->assert_group_filter([0, 1], ['courseid' => $vgcourse->id, 'groupid' => $vg1->id]);
|
| - |
|
116 |
$this->assert_group_filter([5, 6], ['courseid' => $sgcourse->id, 'groupid' => $sg1->id]);
|
| - |
|
117 |
|
| - |
|
118 |
// No restrictions, user does not belong to a group on course. Makes no difference in VG.
|
| - |
|
119 |
$this->setUser($this->userids[5]);
|
| - |
|
120 |
$this->assert_group_filter($all, ['courseid' => $vgcourse->id]);
|
| - |
|
121 |
|
| - |
|
122 |
// In SG user can now view all users across system who are not in a group on course.
|
| - |
|
123 |
// Strange but true.
|
| Línea 27... |
Línea -... |
| 27 |
|
- |
|
| 28 |
use moodle_url;
|
- |
|
| 29 |
use core\report_helper;
|
- |
|
| 30 |
|
- |
|
| 31 |
/**
|
124 |
$this->setUser($this->userids[0]);
|
| 32 |
* Tests the functions for report_helper class.
|
125 |
$this->assert_group_filter([0, 1, 2, 3, 4, 9], ['courseid' => $sgcourse->id]);
|
| - |
|
126 |
}
|
| 33 |
*/
|
127 |
|
| 34 |
class report_helper_test extends \advanced_testcase {
|
128 |
/**
|
| - |
|
129 |
* Calls {@see report_helper::get_group_filter()} and checks which of the users created by this
|
| 35 |
/**
|
130 |
* unit test are returned.
|
| 36 |
* Data provider for testing selected report for same and different courses
|
131 |
*
|
| 37 |
*
|
132 |
* @param int[] $expecteduserindexes Expected user indexes
|
| - |
|
133 |
* @param array $filterparams Array of filter parameters to pass to get_group_filter
|
| - |
|
134 |
*/
|
| - |
|
135 |
protected function assert_group_filter(array $expecteduserindexes, array $filterparams): void {
|
| - |
|
136 |
global $DB;
|
| 38 |
* @return array
|
137 |
|
| 39 |
*/
|
138 |
$result = report_helper::get_group_filter((object)$filterparams);
|
| 40 |
public function data_selected_report(): array {
|
139 |
|
| 41 |
return [
|
140 |
// Combine the joins (if any). 'TRUE' is not allowed in SQL Server, you must use '1 = 1'.
|
| - |
|
141 |
$where = '1 = 1';
|
| - |
|
142 |
foreach ($result['joins'] as $join) {
|
| - |
|
143 |
$where .= ' AND ' . $join;
|
| 42 |
['course_url_id' => [
|
144 |
}
|
| - |
|
145 |
|
| 43 |
['url' => '/test', 'id' => 1],
|
146 |
// The joins use field 'userid' so we make a subselect table with that field name.
|
| - |
|
147 |
$userids = $DB->get_fieldset_sql("
|
| 44 |
['url' => '/foo', 'id' => 1]]
|
148 |
SELECT userid
|
| - |
|
149 |
FROM (SELECT id AS userid FROM {user}) userdata
|
| 45 |
],
|
150 |
WHERE $where", $result['params']);
|
| - |
|
151 |
|
| - |
|
152 |
if ($result['useridfilter'] !== null) {
|
| - |
|
153 |
$userids = array_filter($userids, fn($userid) => array_key_exists($userid, $result['useridfilter']));
|
| - |
|
154 |
}
|
| 46 |
['course_url_id' => [
|
155 |
|
| - |
|
156 |
// Convert user ids to expected indexes, exclude any results not in our test user list, and sort.
|
| 47 |
['url' => '/test', 'id' => 1],
|
157 |
$indexes = array_map(fn($userid) => array_search($userid, $this->userids), $userids);
|
| Línea 48... |
Línea 158... |
| 48 |
['url' => '/foo/bar', 'id' => 2]]
|
158 |
$indexes = array_filter($indexes, fn($index) => $index !== false);
|
| 49 |
]
|
159 |
sort($indexes);
|
| - |
|
160 |
$this->assertEquals($expecteduserindexes, $indexes);
|
| - |
|
161 |
}
|
| - |
|
162 |
|
| - |
|
163 |
/**
|
| - |
|
164 |
* Tests {@see report_helper::has_valid_group()}.
|
| - |
|
165 |
*
|
| - |
|
166 |
* @param int $groupmode Group mode for the course
|
| 50 |
];
|
167 |
* @param string $username Username of the user to check
|
| 51 |
}
|
168 |
* @param array $expected Expected result of the check, with 3 boolean values depending on the context:
|
| 52 |
|
169 |
* - Course context
|
| 53 |
/**
|
170 |
* - Module context
|
| 54 |
* Testing selected report saved in $USER session.
|
171 |
* - System context
|
| 55 |
*
|
172 |
*
|
| Línea 56... |
Línea 173... |
| 56 |
* @dataProvider data_selected_report
|
173 |
* @covers \core\report_helper::has_valid_group
|
| 57 |
* @param array $courseurlid The array has both course url and course id
|
174 |
* @dataProvider has_valid_group_provider
|
| 58 |
*/
|
175 |
*/
|
| 59 |
public function test_save_selected_report(array $courseurlid): void {
|
176 |
public function test_has_valid_group(int $groupmode, string $username, array $expected): void {
|
| 60 |
global $USER;
|
177 |
$this->resetAfterTest();
|
| 61 |
|
178 |
|
| - |
|
179 |
// Create some test course, groups, and users.
|
| - |
|
180 |
$generator = self::getDataGenerator();
|
| - |
|
181 |
$course = $generator->create_course(['groupmode' => $groupmode, 'groupmodeforce' => 1]);
|
| - |
|
182 |
$assign = $generator->create_module('assign', ['course' => $course->id]);
|
| - |
|
183 |
$g1 = $generator->create_group(['courseid' => $course->id]);
|
| - |
|
184 |
|
| - |
|
185 |
$this->userids = [];
|
| - |
|
186 |
$data = [
|
| - |
|
187 |
's1' => ['role' => 'student', 'group' => $g1->id],
|
| - |
|
188 |
's2' => ['role' => 'student', 'group' => null],
|
| - |
|
189 |
't1' => ['role' => 'teacher', 'group' => $g1->id],
|
| 62 |
$url1 = new moodle_url($courseurlid[0]['url']);
|
190 |
't2' => ['role' => 'teacher', 'group' => null],
|
| - |
|
191 |
'et1' => ['role' => 'editingteacher', 'group' => null],
|
| - |
|
192 |
];
|
| - |
|
193 |
foreach ($data as $key => $value) {
|
| 63 |
$courseid1 = $courseurlid[0]['id'];
|
194 |
['group' => $groupid, 'role' => $role] = $value;
|
| 64 |
report_helper::save_selected_report($courseid1, $url1);
|
195 |
$this->userids[$key] = $generator->create_user(['username' => $key]);
|
| - |
|
196 |
$generator->enrol_user($this->userids[$key]->id, $course->id, $role);
|
| - |
|
197 |
if ($groupid) {
|
| - |
|
198 |
groups_add_member($groupid, $this->userids[$key]->id);
|
| - |
|
199 |
}
|
| - |
|
200 |
}
|
| - |
|
201 |
$coursecontext = \context_course::instance($course->id);
|
| - |
|
202 |
[$course, $cm] = get_course_and_cm_from_instance($assign->id, 'assign');
|
| - |
|
203 |
$modulecontext = \context_module::instance($cm->id);
|
| - |
|
204 |
[$hasvalidgroupcourse, $hasvalidgroupmodule, $hasvalidgroupsystem] = $expected;
|
| 65 |
$this->assertDebuggingCalled('save_selected_report() has been deprecated because it is no ' .
|
205 |
$this->assertEquals(
|
| 66 |
'longer used and will be removed in future versions of Moodle');
|
206 |
$hasvalidgroupcourse,
|
| - |
|
207 |
report_helper::has_valid_group($coursecontext, $this->userids[$username]->id),
|
| - |
|
208 |
"Failed for user $username in course context"
|
| - |
|
209 |
);
|
| - |
|
210 |
$this->assertEquals(
|
| 67 |
|
211 |
$hasvalidgroupmodule,
|
| 68 |
$this->assertEquals($USER->course_last_report[$courseid1], $url1);
|
212 |
report_helper::has_valid_group($modulecontext, $this->userids[$username]->id),
|
| - |
|
213 |
'Failed for user ' . $username . ' in module context'
|
| - |
|
214 |
);
|
| Línea -... |
Línea 215... |
| - |
|
215 |
$this->assertEquals(
|
| - |
|
216 |
$hasvalidgroupsystem,
|
| - |
|
217 |
report_helper::has_valid_group(\context_system::instance(), $this->userids[$username]->id),
|
| - |
|
218 |
'Failed for user ' . $username . ' in system context'
|
| - |
|
219 |
);
|
| - |
|
220 |
}
|
| - |
|
221 |
|
| - |
|
222 |
/**
|
| - |
|
223 |
* Data provider for test_has_valid_group.
|
| - |
|
224 |
*
|
| - |
|
225 |
* @return array
|
| - |
|
226 |
*/
|
| - |
|
227 |
public static function has_valid_group_provider(): array {
|
| - |
|
228 |
return [
|
| - |
|
229 |
'student 1 - g1 - separate group' => [
|
| - |
|
230 |
'groupmode' => SEPARATEGROUPS,
|
| - |
|
231 |
'username' => 's1',
|
| - |
|
232 |
'expected' => [true, true, true],
|
| - |
|
233 |
],
|
| - |
|
234 |
'student 2 - no group - separate group' => [
|
| - |
|
235 |
'groupmode' => SEPARATEGROUPS,
|
| - |
|
236 |
'username' => 's2',
|
| 69 |
|
237 |
'expected' => [false, false, true],
|
| - |
|
238 |
],
|
| - |
|
239 |
'teacher 1 - g1 - separate group' => [
|
| - |
|
240 |
'groupmode' => SEPARATEGROUPS,
|
| - |
|
241 |
'username' => 't1',
|
| - |
|
242 |
'expected' => [true, true, true],
|
| - |
|
243 |
],
|
| - |
|
244 |
'teacher 2 - no group - separate group' => [
|
| - |
|
245 |
'groupmode' => SEPARATEGROUPS,
|
| - |
|
246 |
'username' => 't2',
|
| - |
|
247 |
'expected' => [false, false, true],
|
| - |
|
248 |
],
|
| - |
|
249 |
'editing teacher - no group - separate group' => [
|
| - |
|
250 |
'groupmode' => SEPARATEGROUPS,
|
| - |
|
251 |
'username' => 'et1',
|
| - |
|
252 |
'expected' => [true, true, true],
|
| - |
|
253 |
],
|
| - |
|
254 |
'student 1 - g1 - no group' => [
|
| - |
|
255 |
'groupmode' => NOGROUPS,
|
| - |
|
256 |
'username' => 's1',
|
| - |
|
257 |
'expected' => [true, true, true],
|
| - |
|
258 |
],
|
| - |
|
259 |
'student 2 - no group - no group' => [
|
| - |
|
260 |
'groupmode' => NOGROUPS,
|
| - |
|
261 |
'username' => 's2',
|
| - |
|
262 |
'expected' => [true, true, true],
|
| - |
|
263 |
],
|
| - |
|
264 |
'teacher 1 - g1 - no group' => [
|
| - |
|
265 |
'groupmode' => NOGROUPS,
|
| - |
|
266 |
'username' => 't1',
|
| - |
|
267 |
'expected' => [true, true, true],
|
| - |
|
268 |
],
|
| - |
|
269 |
'teacher 2 - no group - no group' => [
|
| - |
|
270 |
'groupmode' => NOGROUPS,
|
| - |
|
271 |
'username' => 't2',
|
| - |
|
272 |
'expected' => [true, true, true],
|
| - |
|
273 |
],
|
| - |
|
274 |
'editing teacher - no group - no group' => [
|
| - |
|
275 |
'groupmode' => NOGROUPS,
|
| - |
|
276 |
'username' => 'et1',
|
| - |
|
277 |
'expected' => [true, true, true],
|
| - |
|
278 |
],
|
| - |
|
279 |
'student 1 - g1 - visible group' => [
|
| - |
|
280 |
'groupmode' => VISIBLEGROUPS,
|
| - |
|
281 |
'username' => 's1',
|
| - |
|
282 |
'expected' => [true, true, true],
|
| - |
|
283 |
],
|
| - |
|
284 |
'student 2 - no group - visible group' => [
|
| - |
|
285 |
'groupmode' => VISIBLEGROUPS,
|
| - |
|
286 |
'username' => 's2',
|
| - |
|
287 |
'expected' => [true, true, true],
|
| - |
|
288 |
],
|
| - |
|
289 |
'teacher 1 - g1 - visible group' => [
|
| - |
|
290 |
'groupmode' => VISIBLEGROUPS,
|
| - |
|
291 |
'username' => 't1',
|
| - |
|
292 |
'expected' => [true, true, true],
|
| - |
|
293 |
],
|
| - |
|
294 |
'teacher 2 - no group - visible group' => [
|
| - |
|
295 |
'groupmode' => VISIBLEGROUPS,
|
| - |
|
296 |
'username' => 't2',
|
| - |
|
297 |
'expected' => [true, true, true],
|
| 70 |
$url2 = new moodle_url($courseurlid[1]['url']);
|
298 |
],
|
| 71 |
$courseid2 = $courseurlid[1]['id'];
|
299 |
'editing teacher - visible group - no group' => [
|