Merge branch 'MDL-47408-master' of https://github.com/DmitryNefedov/moodle
[moodle.git] / lib / testing / tests / generator_test.php
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/>.
17 /**
18  * Data generators tests
19  *
20  * @package    core
21  * @category   phpunit
22  * @copyright  2012 Petr Skoda {@link http://skodak.org}
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
29 /**
30  * Test data generator
31  *
32  * @package    core
33  * @category   phpunit
34  * @copyright  2012 Petr Skoda {@link http://skodak.org}
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_test_generator_testcase extends advanced_testcase {
38     public function test_get_plugin_generator_good_case() {
39         $generator = $this->getDataGenerator()->get_plugin_generator('core_question');
40         $this->assertInstanceOf('core_question_generator', $generator);
41     }
43     public function test_get_plugin_generator_sloppy_name() {
44         $generator = $this->getDataGenerator()->get_plugin_generator('quiz');
45         $this->assertDebuggingCalled('Please specify the component you want a generator for as ' .
46                     'mod_quiz, not quiz.', DEBUG_DEVELOPER);
47         $this->assertInstanceOf('mod_quiz_generator', $generator);
48     }
50     public function test_get_plugin_generator_no_component_dir() {
51         $this->setExpectedException('coding_exception', 'Component core_completion does not support ' .
52                     'generators yet. Missing tests/generator/lib.php.');
53         $generator = $this->getDataGenerator()->get_plugin_generator('core_completion');
54     }
56     public function test_create() {
57         global $DB;
59         $this->resetAfterTest(true);
60         $generator = $this->getDataGenerator();
62         $count = $DB->count_records('user');
63         $user = $generator->create_user();
64         $this->assertEquals($count+1, $DB->count_records('user'));
65         $this->assertSame($user->username, clean_param($user->username, PARAM_USERNAME));
66         $this->assertSame($user->email, clean_param($user->email, PARAM_EMAIL));
67         $user = $generator->create_user(array('firstname'=>'Žluťoučký', 'lastname'=>'Koníček'));
68         $this->assertSame($user->username, clean_param($user->username, PARAM_USERNAME));
69         $this->assertSame($user->email, clean_param($user->email, PARAM_EMAIL));
71         $count = $DB->count_records('course_categories');
72         $category = $generator->create_category();
73         $this->assertEquals($count+1, $DB->count_records('course_categories'));
74         $this->assertRegExp('/^Course category \d/', $category->name);
75         $this->assertSame('', $category->idnumber);
76         $this->assertRegExp('/^Test course category \d/', $category->description);
77         $this->assertSame(FORMAT_MOODLE, $category->descriptionformat);
79         $count = $DB->count_records('cohort');
80         $cohort = $generator->create_cohort();
81         $this->assertEquals($count+1, $DB->count_records('cohort'));
82         $this->assertEquals(context_system::instance()->id, $cohort->contextid);
83         $this->assertRegExp('/^Cohort \d/', $cohort->name);
84         $this->assertSame('', $cohort->idnumber);
85         $this->assertRegExp('/^Test cohort \d/', $cohort->description);
86         $this->assertSame(FORMAT_MOODLE, $cohort->descriptionformat);
87         $this->assertSame('', $cohort->component);
88         $this->assertLessThanOrEqual(time(), $cohort->timecreated);
89         $this->assertSame($cohort->timecreated, $cohort->timemodified);
91         $count = $DB->count_records('course');
92         $course = $generator->create_course();
93         $this->assertEquals($count+1, $DB->count_records('course'));
94         $this->assertRegExp('/^Test course \d/', $course->fullname);
95         $this->assertRegExp('/^tc_\d/', $course->shortname);
96         $this->assertSame('', $course->idnumber);
97         $this->assertSame('topics', $course->format);
98         $this->assertEquals(0, $course->newsitems);
99         $this->assertEquals(5, $course->numsections);
100         $this->assertRegExp('/^Test course \d/', $course->summary);
101         $this->assertSame(FORMAT_MOODLE, $course->summaryformat);
103         $section = $generator->create_course_section(array('course'=>$course->id, 'section'=>3));
104         $this->assertEquals($course->id, $section->course);
106         $scale = $generator->create_scale();
107         $this->assertNotEmpty($scale);
109         // Note we only count grade cats with depth > 1 because the course grade category
110         // is lazily created.
111         $count = $DB->count_records_select('grade_categories', 'depth <> 1');
112         $gradecategory = $generator->create_grade_category(array('courseid'=>$course->id));
113         $this->assertEquals($count+1, $DB->count_records_select('grade_categories', 'depth <> 1'));
114         $this->assertEquals(2, $gradecategory->depth);
115         $this->assertEquals($course->id, $gradecategory->courseid);
116         $this->assertEquals('Grade category 1', $gradecategory->fullname);
117     }
119     public function test_create_module() {
120         global $CFG, $SITE, $DB;
121         if (!file_exists("$CFG->dirroot/mod/page/")) {
122             $this->markTestSkipped('Can not find standard Page module');
123         }
125         $this->resetAfterTest(true);
126         $generator = $this->getDataGenerator();
128         $page = $generator->create_module('page', array('course'=>$SITE->id));
129         $this->assertNotEmpty($page);
130         $cm = get_coursemodule_from_instance('page', $page->id, $SITE->id, true);
131         $this->assertEquals(0, $cm->sectionnum);
133         $page = $generator->create_module('page', array('course'=>$SITE->id), array('section'=>3));
134         $this->assertNotEmpty($page);
135         $cm = get_coursemodule_from_instance('page', $page->id, $SITE->id, true);
136         $this->assertEquals(3, $cm->sectionnum);
138         // Prepare environment to generate modules with all possible options.
140         // Enable advanced functionality.
141         $CFG->enablecompletion = 1;
142         $CFG->enableavailability = 1;
143         $CFG->enableoutcomes = 1;
144         require_once($CFG->libdir.'/gradelib.php');
145         require_once($CFG->libdir.'/completionlib.php');
146         require_once($CFG->dirroot.'/rating/lib.php');
148         // Create a course with enabled completion.
149         $course = $generator->create_course(array('enablecompletion' => true));
151         // Create new grading category in this course.
152         $grade_category = new grade_category();
153         $grade_category->courseid = $course->id;
154         $grade_category->fullname = 'Grade category';
155         $grade_category->insert();
157         // Create group and grouping.
158         $group = $generator->create_group(array('courseid' => $course->id));
159         $grouping = $generator->create_grouping(array('courseid' => $course->id));
160         $generator->create_grouping_group(array('groupid' => $group->id, 'groupingid' => $grouping->id));
162         // Prepare arrays with properties that we can both use for creating modules and asserting the data in created modules.
164         // General properties.
165         $optionsgeneral = array(
166             'visible' => 0, // Note: 'visibleold' will always be set to the same value as 'visible'.
167             'section' => 3, // Note: section will be created if does not exist.
168             // Module supports FEATURE_IDNUMBER.
169             'cmidnumber' => 'IDNUM', // Note: alternatively can have key 'idnumber'.
170             // Module supports FEATURE_GROUPS;
171             'groupmode' => SEPARATEGROUPS, // Note: will be reset to 0 if course groupmodeforce is set.
172             // Module supports FEATURE_GROUPINGS.
173             'groupingid' => $grouping->id,
174         );
176         // In case completion is enabled on site and for course every module can have manual completion.
177         $featurecompletionmanual = array(
178             'completion' => COMPLETION_TRACKING_MANUAL, // "Students can manually mark activity as completed."
179             'completionexpected' => time() + 7 * DAYSECS,
180         );
182         // Automatic completion is possible if module supports FEATURE_COMPLETION_TRACKS_VIEWS or FEATURE_GRADE_HAS_GRADE.
183         // Note: completionusegrade is stored in DB and can be found in cm_info as 'completiongradeitemnumber' - either NULL or 0.
184         // Note: module can have more autocompletion rules as defined in moodleform_mod::add_completion_rules().
185         $featurecompletionautomatic = array(
186             'completion' => COMPLETION_TRACKING_AUTOMATIC, // "Show activity as complete when conditions are met."
187             'completionview' => 1, // "Student must view this activity to complete it"
188             'completionusegrade' => 1, // "Student must receive a grade to complete this activity"
189         );
191         // Module supports FEATURE_RATE:
192         $featurerate = array(
193             'assessed' => RATING_AGGREGATE_AVERAGE, // "Aggregate type"
194             'scale' => 100, // Either max grade or negative number for scale id.
195             'ratingtime' => 1, // "Restrict ratings to items with dates in this range".
196             'assesstimestart' => time() - DAYSECS, // Note: Will be ignored if neither 'assessed' nor 'ratingtime' is set.
197             'assesstimefinish' => time() + DAYSECS, // Note: Will be ignored if neither 'assessed' nor 'ratingtime' is set.
198         );
200         // Module supports FEATURE_GRADE_HAS_GRADE:
201         $featuregrade = array(
202             'grade' => 10,
203             'gradecat' => $grade_category->id, // Note: if $CFG->enableoutcomes is set, this can be set to -1 to automatically create new grade category.
204         );
206         // Now let's create several modules with different options.
207         $m1 = $generator->create_module('assign',
208             array('course' => $course->id) +
209             $optionsgeneral);
210         $m2 = $generator->create_module('data',
211             array('course' => $course->id) +
212             $featurecompletionmanual +
213             $featurerate);
214         $m3 = $generator->create_module('assign',
215             array('course' => $course->id) +
216             $featurecompletionautomatic +
217             $featuregrade);
219         // We need id of the grading item for the second module to create availability dependency in the 3rd module.
220         $gradingitem = grade_item::fetch(array('courseid'=>$course->id, 'itemtype'=>'mod', 'itemmodule' => 'assign', 'iteminstance' => $m3->id));
222         // Now prepare option to create the 4th module with an availability condition.
223         $optionsavailability = array(
224             'availability' => '{"op":"&","showc":[true],"c":[' .
225                 '{"type":"date","d":">=","t":' . (time() - WEEKSECS) . '}]}',
226         );
228         // Create module with conditional availability.
229         $m4 = $generator->create_module('assign',
230                 array('course' => $course->id) +
231                 $optionsavailability
232         );
234         // Verifying that everything is generated correctly.
235         $modinfo = get_fast_modinfo($course->id);
236         $cm1 = $modinfo->cms[$m1->cmid];
237         $this->assertEquals($optionsgeneral['visible'], $cm1->visible);
238         $this->assertEquals($optionsgeneral['section'], $cm1->sectionnum); // Note difference in key.
239         $this->assertEquals($optionsgeneral['cmidnumber'], $cm1->idnumber); // Note difference in key.
240         $this->assertEquals($optionsgeneral['groupmode'], $cm1->groupmode);
241         $this->assertEquals($optionsgeneral['groupingid'], $cm1->groupingid);
243         $cm2 = $modinfo->cms[$m2->cmid];
244         $this->assertEquals($featurecompletionmanual['completion'], $cm2->completion);
245         $this->assertEquals($featurecompletionmanual['completionexpected'], $cm2->completionexpected);
246         $this->assertEquals(null, $cm2->completiongradeitemnumber);
247         // Rating info is stored in the module's table (in our test {data}).
248         $data = $DB->get_record('data', array('id' => $m2->id));
249         $this->assertEquals($featurerate['assessed'], $data->assessed);
250         $this->assertEquals($featurerate['scale'], $data->scale);
251         $this->assertEquals($featurerate['assesstimestart'], $data->assesstimestart);
252         $this->assertEquals($featurerate['assesstimefinish'], $data->assesstimefinish);
253         // No validation for 'ratingtime'. It is only used in to enable/disable assesstime* when adding module.
255         $cm3 = $modinfo->cms[$m3->cmid];
256         $this->assertEquals($featurecompletionautomatic['completion'], $cm3->completion);
257         $this->assertEquals($featurecompletionautomatic['completionview'], $cm3->completionview);
258         $this->assertEquals(0, $cm3->completiongradeitemnumber); // Zero instead of default null since 'completionusegrade' was set.
259         $gradingitem = grade_item::fetch(array('courseid'=>$course->id, 'itemtype'=>'mod', 'itemmodule' => 'assign', 'iteminstance' => $m3->id));
260         $this->assertEquals(0, $gradingitem->grademin);
261         $this->assertEquals($featuregrade['grade'], $gradingitem->grademax);
262         $this->assertEquals($featuregrade['gradecat'], $gradingitem->categoryid);
264         $cm4 = $modinfo->cms[$m4->cmid];
265         $this->assertEquals($optionsavailability['availability'], $cm4->availability);
266     }
268     public function test_create_block() {
269         global $CFG;
270         if (!file_exists("$CFG->dirroot/blocks/online_users/")) {
271             $this->markTestSkipped('Can not find standard Online users block');
272         }
274         $this->resetAfterTest(true);
275         $generator = $this->getDataGenerator();
277         $page = $generator->create_block('online_users');
278         $this->assertNotEmpty($page);
279     }
281     public function test_enrol_user() {
282         global $DB;
284         $this->resetAfterTest();
286         $selfplugin = enrol_get_plugin('self');
287         $this->assertNotEmpty($selfplugin);
289         $manualplugin = enrol_get_plugin('manual');
290         $this->assertNotEmpty($manualplugin);
292         // Prepare some data.
294         $studentrole = $DB->get_record('role', array('shortname'=>'student'));
295         $this->assertNotEmpty($studentrole);
296         $teacherrole = $DB->get_record('role', array('shortname'=>'teacher'));
297         $this->assertNotEmpty($teacherrole);
299         $course1 = $this->getDataGenerator()->create_course();
300         $course2 = $this->getDataGenerator()->create_course();
301         $course3 = $this->getDataGenerator()->create_course();
303         $context1 = context_course::instance($course1->id);
304         $context2 = context_course::instance($course2->id);
305         $context3 = context_course::instance($course3->id);
307         $user1 = $this->getDataGenerator()->create_user();
308         $user2 = $this->getDataGenerator()->create_user();
309         $user3 = $this->getDataGenerator()->create_user();
311         $this->assertEquals(3, $DB->count_records('enrol', array('enrol'=>'self')));
312         $instance1 = $DB->get_record('enrol', array('courseid'=>$course1->id, 'enrol'=>'self'), '*', MUST_EXIST);
313         $instance2 = $DB->get_record('enrol', array('courseid'=>$course2->id, 'enrol'=>'self'), '*', MUST_EXIST);
314         $instance3 = $DB->get_record('enrol', array('courseid'=>$course3->id, 'enrol'=>'self'), '*', MUST_EXIST);
316         $this->assertEquals($studentrole->id, $instance1->roleid);
317         $this->assertEquals($studentrole->id, $instance2->roleid);
318         $this->assertEquals($studentrole->id, $instance3->roleid);
320         $this->assertEquals(3, $DB->count_records('enrol', array('enrol'=>'manual')));
321         $maninstance1 = $DB->get_record('enrol', array('courseid'=>$course1->id, 'enrol'=>'manual'), '*', MUST_EXIST);
322         $maninstance2 = $DB->get_record('enrol', array('courseid'=>$course2->id, 'enrol'=>'manual'), '*', MUST_EXIST);
323         $maninstance3 = $DB->get_record('enrol', array('courseid'=>$course3->id, 'enrol'=>'manual'), '*', MUST_EXIST);
324         $maninstance3->roleid = $teacherrole->id;
325         $DB->update_record('enrol', $maninstance3, array('id'=>$maninstance3->id));
327         $this->assertEquals($studentrole->id, $maninstance1->roleid);
328         $this->assertEquals($studentrole->id, $maninstance2->roleid);
329         $this->assertEquals($teacherrole->id, $maninstance3->roleid);
331         $result = $this->getDataGenerator()->enrol_user($user1->id, $course1->id);
332         $this->assertTrue($result);
333         $this->assertTrue($DB->record_exists('user_enrolments', array('enrolid'=>$maninstance1->id, 'userid'=>$user1->id)));
334         $this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user1->id, 'roleid'=>$studentrole->id)));
336         $result = $this->getDataGenerator()->enrol_user($user1->id, $course2->id, $teacherrole->id, 'manual');
337         $this->assertTrue($result);
338         $this->assertTrue($DB->record_exists('user_enrolments', array('enrolid'=>$maninstance2->id, 'userid'=>$user1->id)));
339         $this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context2->id, 'userid'=>$user1->id, 'roleid'=>$teacherrole->id)));
341         $result = $this->getDataGenerator()->enrol_user($user1->id, $course3->id, 0, 'manual');
342         $this->assertTrue($result);
343         $this->assertTrue($DB->record_exists('user_enrolments', array('enrolid'=>$maninstance3->id, 'userid'=>$user1->id)));
344         $this->assertFalse($DB->record_exists('role_assignments', array('contextid'=>$context3->id, 'userid'=>$user1->id)));
346         $result = $this->getDataGenerator()->enrol_user($user2->id, $course1->id, null, 'self');
347         $this->assertTrue($result);
348         $this->assertTrue($DB->record_exists('user_enrolments', array('enrolid'=>$instance1->id, 'userid'=>$user2->id)));
349         $this->assertTrue($DB->record_exists('role_assignments', array('contextid'=>$context1->id, 'userid'=>$user2->id, 'roleid'=>$studentrole->id)));
351         $selfplugin->add_instance($course2, array('status'=>ENROL_INSTANCE_ENABLED, 'roleid'=>$teacherrole->id));
352         $result = $this->getDataGenerator()->enrol_user($user2->id, $course2->id, null, 'self');
353         $this->assertFalse($result);
355         $DB->delete_records('enrol', array('enrol'=>'self', 'courseid'=>$course3->id));
356         $result = $this->getDataGenerator()->enrol_user($user2->id, $course3->id, null, 'self');
357         $this->assertFalse($result);
358     }