forked from moodle/moodle
-
Notifications
You must be signed in to change notification settings - Fork 0
/
indicators_test.php
354 lines (300 loc) · 16.4 KB
/
indicators_test.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
<?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/>.
/**
* Unit tests for core indicators.
*
* @package core
* @category analytics
* @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die();
require_once(__DIR__ . '/../../analytics/tests/fixtures/test_target_shortname.php');
require_once(__DIR__ . '/../../admin/tool/log/store/standard/tests/fixtures/event.php');
require_once(__DIR__ . '/../../lib/enrollib.php');
/**
* Unit tests for core indicators.
*
* @package core
* @category analytics
* @copyright 2017 David Monllaó {@link http://www.davidmonllao.com}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class core_analytics_indicators_testcase extends advanced_testcase {
/**
* Test all core indicators.
*
* Single method as it is significantly faster (from 13s to 5s) than having separate
* methods because of preventResetByRollback.
*
* @return void
*/
public function test_core_indicators() {
global $DB;
$this->preventResetByRollback();
$this->resetAfterTest(true);
$this->setAdminuser();
set_config('enabled_stores', 'logstore_standard', 'tool_log');
set_config('buffersize', 0, 'logstore_standard');
$user1 = $this->getDataGenerator()->create_user();
$user2 = $this->getDataGenerator()->create_user();
// Test any access after end.
$params = array(
'startdate' => mktime(0, 0, 0, 10, 24, 2015),
'enddate' => mktime(0, 0, 0, 10, 24, 2016)
);
$course = $this->getDataGenerator()->create_course($params);
$coursecontext = \context_course::instance($course->id);
$this->getDataGenerator()->enrol_user($user1->id, $course->id);
$indicator = new \core\analytics\indicator\any_access_after_end();
$sampleids = array($user1->id => $user1->id, $user2->id => $user2->id);
$data = array($user1->id => array(
'context' => $coursecontext,
'course' => $course,
'user' => $user1
));
$data[$user2->id] = $data[$user1->id];
$data[$user2->id]['user'] = $user2;
$indicator->add_sample_data($data);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
\logstore_standard\event\unittest_executed::create(
array('context' => $coursecontext, 'userid' => $user1->id))->trigger();
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// Test any access before start.
$params = array(
'startdate' => 9999999998,
'enddate' => 9999999999
);
// Resetting $course var.
$course = $this->getDataGenerator()->create_course($params);
$coursecontext = \context_course::instance($course->id);
$this->getDataGenerator()->enrol_user($user1->id, $course->id);
$indicator = new \core\analytics\indicator\any_access_before_start();
$sampleids = array($user1->id => $user1->id, $user2->id => $user2->id);
$data = array($user1->id => array(
'context' => $coursecontext,
'course' => $course,
'user' => $user1
));
$data[$user2->id] = $data[$user1->id];
$data[$user2->id]['user'] = $user2;
$indicator->add_sample_data($data);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
\logstore_standard\event\unittest_executed::create(
array('context' => $coursecontext, 'userid' => $user1->id))->trigger();
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// Test any course access.
$course = $this->getDataGenerator()->create_course($params);
$coursecontext = \context_course::instance($course->id);
$this->getDataGenerator()->enrol_user($user1->id, $course->id);
$indicator = new \core\analytics\indicator\any_course_access();
$sampleids = array($user1->id => $user1->id);
$data = array($user1->id => array(
'course' => $course,
'user' => $user1
));
$indicator->add_sample_data($data);
$analysable = new \core_analytics\course($course);
// Min value if no user_lastaccess records.
$indicator->fill_per_analysable_caches($analysable);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', time() - 10, time() + 10);
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
// Any access is enough if no time restrictions.
$DB->insert_record('user_lastaccess', array('userid' => $user1->id,
'courseid' => $course->id, 'timeaccess' => time() - 1));
$indicator->fill_per_analysable_caches($analysable);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere');
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
// Min value if the existing records are old.
$indicator->fill_per_analysable_caches($analysable);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', time(), time() + 10);
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', time());
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
// Max value if the existing records are prior to end.
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', time() - 10, time());
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', false, time());
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', false, time());
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
// Max value if no end time and existing user_lastaccess record.
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', time() - 10);
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
// Rely on logs if the last time access is after the end time.
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', false, time() - 10);
// Min value if no logs are found.
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
\logstore_standard\event\unittest_executed::create(
array('context' => \context_course::instance($course->id), 'userid' => $user1->id))->trigger();
// Max value if logs are found before the end time.
list($values, $unused) = $indicator->calculate($sampleids, 'notrelevanthere', false, time() + 10);
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
// Test any write action.
$course1 = $this->getDataGenerator()->create_course();
$coursecontext1 = \context_course::instance($course1->id);
$course2 = $this->getDataGenerator()->create_course();
$coursecontext2 = \context_course::instance($course2->id);
$this->getDataGenerator()->enrol_user($user1->id, $course2->id);
$indicator = new \core\analytics\indicator\any_write_action();
$sampleids = array($user1->id => $user1->id, $user2->id => $user2->id);
$data = array($user1->id => array(
'context' => $coursecontext1,
'course' => $course1,
'user' => $user1
));
$data[$user2->id] = $data[$user1->id];
$data[$user2->id]['user'] = $user2;
$indicator->add_sample_data($data);
list($values, $unused) = $indicator->calculate($sampleids, 'user');
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
$beforecourseeventcreate = time();
sleep(1);
\logstore_standard\event\unittest_executed::create(
array('context' => $coursecontext1, 'userid' => $user1->id))->trigger();
list($values, $unused) = $indicator->calculate($sampleids, 'user');
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// Now try with course-level samples where user is not available.
$sampleids = array($course1->id => $course1->id, $course2->id => $course2->id);
$data = array(
$course1->id => array(
'context' => $coursecontext1,
'course' => $course1,
),
$course2->id => array(
'context' => $coursecontext2,
'course' => $course2,
)
);
$indicator->clear_sample_data();
$indicator->add_sample_data($data);
// Limited by time to avoid previous logs interfering as other logs
// have been generated by the system.
list($values, $unused) = $indicator->calculate($sampleids, 'course', $beforecourseeventcreate);
$this->assertEquals($indicator::get_max_value(), $values[$course1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$course2->id][0]);
// Test any write action in the course.
$course1 = $this->getDataGenerator()->create_course();
$coursecontext1 = \context_course::instance($course1->id);
$activity1 = $this->getDataGenerator()->create_module('forum', array('course' => $course1->id));
$activity1context = \context_module::instance($activity1->cmid);
$course2 = $this->getDataGenerator()->create_course();
$coursecontext2 = \context_course::instance($course2->id);
$this->getDataGenerator()->enrol_user($user1->id, $course2->id);
$indicator = new \core\analytics\indicator\any_write_action_in_course();
$sampleids = array($user1->id => $user1->id, $user2->id => $user2->id);
$data = array($user1->id => array(
'context' => $coursecontext1,
'course' => $course1,
'user' => $user1
));
$data[$user2->id] = $data[$user1->id];
$data[$user2->id]['user'] = $user2;
$indicator->add_sample_data($data);
list($values, $unused) = $indicator->calculate($sampleids, 'user');
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
$beforecourseeventcreate = time();
sleep(1);
\logstore_standard\event\unittest_executed::create(
array('context' => $activity1context, 'userid' => $user1->id))->trigger();
list($values, $unused) = $indicator->calculate($sampleids, 'user');
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// Now try with course-level samples where user is not available.
$sampleids = array($course1->id => $course1->id, $course2->id => $course2->id);
$data = array(
$course1->id => array(
'context' => $coursecontext1,
'course' => $course1,
),
$course2->id => array(
'context' => $coursecontext2,
'course' => $course2,
)
);
$indicator->clear_sample_data();
$indicator->add_sample_data($data);
// Limited by time to avoid previous logs interfering as other logs
// have been generated by the system.
list($values, $unused) = $indicator->calculate($sampleids, 'course', $beforecourseeventcreate);
$this->assertEquals($indicator::get_max_value(), $values[$course1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$course2->id][0]);
// Test read actions.
$course = $this->getDataGenerator()->create_course();
$coursecontext = \context_course::instance($course->id);
$this->getDataGenerator()->enrol_user($user1->id, $course->id);
$indicator = new \core\analytics\indicator\read_actions();
$sampleids = array($user1->id => $user1->id, $user2->id => $user2->id);
$data = array($user1->id => array(
'context' => $coursecontext,
'course' => $course,
'user' => $user1
));
$data[$user2->id] = $data[$user1->id];
$data[$user2->id]['user'] = $user2;
$indicator->add_sample_data($data);
// More or less 4 weeks duration.
$startdate = time() - (WEEKSECS * 2);
$enddate = time() + (WEEKSECS * 2);
$this->setAdminUser();
list($values, $unused) = $indicator->calculate($sampleids, 'user');
$this->assertNull($values[$user1->id][0]);
$this->assertNull($values[$user1->id][1]);
$this->assertNull($values[$user1->id][0]);
$this->assertNull($values[$user2->id][1]);
// Zero score for 0 accesses.
list($values, $unused) = $indicator->calculate($sampleids, 'user', $startdate, $enddate);
$this->assertEquals($indicator::get_min_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// 1/3 score for more than 0 accesses.
\core\event\course_viewed::create(
array('context' => $coursecontext, 'userid' => $user1->id))->trigger();
list($values, $unused) = $indicator->calculate($sampleids, 'user', $startdate, $enddate);
$this->assertEquals(-0.33, $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// 2/3 score for more than 1 access per week.
for ($i = 0; $i < 12; $i++) {
\core\event\course_viewed::create(
array('context' => $coursecontext, 'userid' => $user1->id))->trigger();
}
list($values, $unused) = $indicator->calculate($sampleids, 'user', $startdate, $enddate);
$this->assertEquals(0.33, $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
// 100% score for tons of accesses during this period (3 logs per access * 4 weeks * 10 accesses).
for ($i = 0; $i < (3 * 10 * 4); $i++) {
\core\event\course_viewed::create(
array('context' => $coursecontext, 'userid' => $user1->id))->trigger();
}
list($values, $unused) = $indicator->calculate($sampleids, 'user', $startdate, $enddate);
$this->assertEquals($indicator::get_max_value(), $values[$user1->id][0]);
$this->assertEquals($indicator::get_min_value(), $values[$user2->id][0]);
set_config('enabled_stores', '', 'tool_log');
get_log_manager(true);
}
}