d6d9c1dcafe5f45768f41ed0b006cee7f5cf1590
[moodle.git] / course / tests / courselib_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  * Course related unit 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();
28 global $CFG;
29 require_once($CFG->dirroot.'/course/lib.php');
31 class courselib_testcase extends advanced_testcase {
33     /**
34      * Set forum specific test values for calling create_module().
35      *
36      * @param object $moduleinfo - the moduleinfo to add some specific values - passed in reference.
37      */
38     private function forum_create_set_values(&$moduleinfo) {
39         // Completion specific to forum - optional.
40         $moduleinfo->completionposts = 3;
41         $moduleinfo->completiondiscussions = 1;
42         $moduleinfo->completionreplies = 2;
44         // Specific values to the Forum module.
45         $moduleinfo->forcesubscribe = FORUM_INITIALSUBSCRIBE;
46         $moduleinfo->type = 'single';
47         $moduleinfo->trackingtype = FORUM_TRACKING_ON;
48         $moduleinfo->maxbytes = 10240;
49         $moduleinfo->maxattachments = 2;
51         // Post threshold for blocking - specific to forum.
52         $moduleinfo->blockperiod = 60*60*24;
53         $moduleinfo->blockafter = 10;
54         $moduleinfo->warnafter = 5;
55     }
57     /**
58      * Execute test asserts on the saved DB data by create_module($forum).
59      *
60      * @param object $moduleinfo - the specific forum values that were used to create a forum.
61      * @param object $dbmodinstance - the DB values of the created forum.
62      */
63     private function forum_create_run_asserts($moduleinfo, $dbmodinstance) {
64         // Compare values specific to forums.
65         $this->assertEquals($moduleinfo->forcesubscribe, $dbmodinstance->forcesubscribe);
66         $this->assertEquals($moduleinfo->type, $dbmodinstance->type);
67         $this->assertEquals($moduleinfo->assessed, $dbmodinstance->assessed);
68         $this->assertEquals($moduleinfo->completionposts, $dbmodinstance->completionposts);
69         $this->assertEquals($moduleinfo->completiondiscussions, $dbmodinstance->completiondiscussions);
70         $this->assertEquals($moduleinfo->completionreplies, $dbmodinstance->completionreplies);
71         $this->assertEquals($moduleinfo->scale, $dbmodinstance->scale);
72         $this->assertEquals($moduleinfo->assesstimestart, $dbmodinstance->assesstimestart);
73         $this->assertEquals($moduleinfo->assesstimefinish, $dbmodinstance->assesstimefinish);
74         $this->assertEquals($moduleinfo->rsstype, $dbmodinstance->rsstype);
75         $this->assertEquals($moduleinfo->rssarticles, $dbmodinstance->rssarticles);
76         $this->assertEquals($moduleinfo->trackingtype, $dbmodinstance->trackingtype);
77         $this->assertEquals($moduleinfo->maxbytes, $dbmodinstance->maxbytes);
78         $this->assertEquals($moduleinfo->maxattachments, $dbmodinstance->maxattachments);
79         $this->assertEquals($moduleinfo->blockperiod, $dbmodinstance->blockperiod);
80         $this->assertEquals($moduleinfo->blockafter, $dbmodinstance->blockafter);
81         $this->assertEquals($moduleinfo->warnafter, $dbmodinstance->warnafter);
82     }
84     /**
85      * Set assign module specific test values for calling create_module().
86      *
87      * @param object $moduleinfo - the moduleinfo to add some specific values - passed in reference.
88      */
89     private function assign_create_set_values(&$moduleinfo) {
90         // Specific values to the Assign module.
91         $moduleinfo->alwaysshowdescription = true;
92         $moduleinfo->submissiondrafts = true;
93         $moduleinfo->requiresubmissionstatement = true;
94         $moduleinfo->sendnotifications = true;
95         $moduleinfo->sendlatenotifications = true;
96         $moduleinfo->duedate = time() + (7 * 24 * 3600);
97         $moduleinfo->cutoffdate = time() + (7 * 24 * 3600);
98         $moduleinfo->allowsubmissionsfromdate = time();
99         $moduleinfo->teamsubmission = true;
100         $moduleinfo->requireallteammemberssubmit = true;
101         $moduleinfo->teamsubmissiongroupingid = true;
102         $moduleinfo->blindmarking = true;
103         $moduleinfo->markingworkflow = true;
104         $moduleinfo->markingallocation = true;
105         $moduleinfo->assignsubmission_onlinetext_enabled = true;
106         $moduleinfo->assignsubmission_file_enabled = true;
107         $moduleinfo->assignsubmission_file_maxfiles = 1;
108         $moduleinfo->assignsubmission_file_maxsizebytes = 1000000;
109         $moduleinfo->assignsubmission_comments_enabled = true;
110         $moduleinfo->assignfeedback_comments_enabled = true;
111         $moduleinfo->assignfeedback_offline_enabled = true;
112         $moduleinfo->assignfeedback_file_enabled = true;
114         // Advanced grading.
115         $gradingmethods = grading_manager::available_methods();
116         $moduleinfo->advancedgradingmethod_submissions = current(array_keys($gradingmethods));
117     }
119     /**
120      * Execute test asserts on the saved DB data by create_module($assign).
121      *
122      * @param object $moduleinfo - the specific assign module values that were used to create an assign module.
123      * @param object $dbmodinstance - the DB values of the created assign module.
124      */
125     private function assign_create_run_asserts($moduleinfo, $dbmodinstance) {
126         global $DB;
128         $this->assertEquals($moduleinfo->alwaysshowdescription, $dbmodinstance->alwaysshowdescription);
129         $this->assertEquals($moduleinfo->submissiondrafts, $dbmodinstance->submissiondrafts);
130         $this->assertEquals($moduleinfo->requiresubmissionstatement, $dbmodinstance->requiresubmissionstatement);
131         $this->assertEquals($moduleinfo->sendnotifications, $dbmodinstance->sendnotifications);
132         $this->assertEquals($moduleinfo->duedate, $dbmodinstance->duedate);
133         $this->assertEquals($moduleinfo->cutoffdate, $dbmodinstance->cutoffdate);
134         $this->assertEquals($moduleinfo->allowsubmissionsfromdate, $dbmodinstance->allowsubmissionsfromdate);
135         $this->assertEquals($moduleinfo->teamsubmission, $dbmodinstance->teamsubmission);
136         $this->assertEquals($moduleinfo->requireallteammemberssubmit, $dbmodinstance->requireallteammemberssubmit);
137         $this->assertEquals($moduleinfo->teamsubmissiongroupingid, $dbmodinstance->teamsubmissiongroupingid);
138         $this->assertEquals($moduleinfo->blindmarking, $dbmodinstance->blindmarking);
139         $this->assertEquals($moduleinfo->markingworkflow, $dbmodinstance->markingworkflow);
140         $this->assertEquals($moduleinfo->markingallocation, $dbmodinstance->markingallocation);
141         // The goal not being to fully test assign_add_instance() we'll stop here for the assign tests - to avoid too many DB queries.
143         // Advanced grading.
144         $contextmodule = context_module::instance($dbmodinstance->id);
145         $advancedgradingmethod = $DB->get_record('grading_areas',
146             array('contextid' => $contextmodule->id,
147                 'activemethod' => $moduleinfo->advancedgradingmethod_submissions));
148         $this->assertEquals($moduleinfo->advancedgradingmethod_submissions, $advancedgradingmethod);
149     }
151     /**
152      * Run some asserts test for a specific module for the function create_module().
153      *
154      * The function has been created (and is called) for $this->test_create_module().
155      * Note that the call to MODULE_create_set_values and MODULE_create_run_asserts are done after the common set values/run asserts.
156      * So if you want, you can overwrite the default values/asserts in the respective functions.
157      * @param string $modulename Name of the module ('forum', 'assign', 'book'...).
158      */
159     private function create_specific_module_test($modulename) {
160         global $DB, $CFG;
162         $this->resetAfterTest(true);
164         $this->setAdminUser();
166         // Warnings: you'll need to change this line if ever you come to test a module not following Moodle standard.
167         require_once($CFG->dirroot.'/mod/'. $modulename .'/lib.php');
169         // Enable avaibility.
170         // If not enabled all conditional fields will be ignored.
171         set_config('enableavailability', 1);
173         // Enable course completion.
174         // If not enabled all completion settings will be ignored.
175         set_config('enablecompletion', COMPLETION_ENABLED);
177         // Enable forum RSS feeds.
178         set_config('enablerssfeeds', 1);
179         set_config('forum_enablerssfeeds', 1);
181         $course = $this->getDataGenerator()->create_course(array('numsections'=>1, 'enablecompletion' => COMPLETION_ENABLED),
182            array('createsections'=>true));
184         $grouping = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
186         // Create assign module instance for test.
187         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
188         $params['course'] = $course->id;
189         $instance = $generator->create_instance($params);
190         $assigncm = get_coursemodule_from_instance('assign', $instance->id);
192         // Module test values.
193         $moduleinfo = new stdClass();
195         // Always mandatory generic values to any module.
196         $moduleinfo->modulename = $modulename;
197         $moduleinfo->section = 1; // This is the section number in the course. Not the section id in the database.
198         $moduleinfo->course = $course->id;
199         $moduleinfo->groupingid = $grouping->id;
200         $moduleinfo->groupmembersonly = 0;
201         $moduleinfo->visible = true;
203         // Sometimes optional generic values for some modules.
204         $moduleinfo->name = 'My test module';
205         $moduleinfo->showdescription = 1; // standard boolean
206         require_once($CFG->libdir . '/gradelib.php');
207         $gradecats = grade_get_categories_menu($moduleinfo->course, false);
208         $gradecatid = current(array_keys($gradecats)); // Retrieve the first key of $gradecats
209         $moduleinfo->gradecat = $gradecatid;
210         $moduleinfo->groupmode = VISIBLEGROUPS;
211         $moduleinfo->cmidnumber = 'idnumber_XXX';
213         // Completion common to all module.
214         $moduleinfo->completion = COMPLETION_TRACKING_AUTOMATIC;
215         $moduleinfo->completionview = COMPLETION_VIEW_REQUIRED;
216         $moduleinfo->completiongradeitemnumber = 1;
217         $moduleinfo->completionexpected = time() + (7 * 24 * 3600);
219         // Conditional activity.
220         $moduleinfo->availablefrom = time();
221         $moduleinfo->availableuntil = time() + (7 * 24 * 3600);
222         $moduleinfo->showavailability = CONDITION_STUDENTVIEW_SHOW;
223         $coursegradeitem = grade_item::fetch_course_item($moduleinfo->course); //the activity will become available only when the user reach some grade into the course itself.
224         $moduleinfo->conditiongradegroup = array(array('conditiongradeitemid' => $coursegradeitem->id, 'conditiongrademin' => 10, 'conditiongrademax' => 80));
225         $moduleinfo->conditionfieldgroup = array(array('conditionfield' => 'email', 'conditionfieldoperator' => OP_CONTAINS, 'conditionfieldvalue' => '@'));
226         $moduleinfo->conditioncompletiongroup = array(array('conditionsourcecmid' => $assigncm->id, 'conditionrequiredcompletion' => COMPLETION_COMPLETE)); // "conditionsourcecmid == 0" => none
228         // Grading and Advanced grading.
229         require_once($CFG->dirroot . '/rating/lib.php');
230         $moduleinfo->assessed = RATING_AGGREGATE_AVERAGE;
231         $moduleinfo->scale = 10; // Note: it could be minus (for specific course scale). It is a signed number.
232         $moduleinfo->assesstimestart = time();
233         $moduleinfo->assesstimefinish = time() + (7 * 24 * 3600);
235         // RSS.
236         $moduleinfo->rsstype = 2;
237         $moduleinfo->rssarticles = 10;
239         // Optional intro editor (depends of module).
240         $draftid_editor = 0;
241         file_prepare_draft_area($draftid_editor, null, null, null, null);
242         $moduleinfo->introeditor = array('text' => 'This is a module', 'format' => FORMAT_HTML, 'itemid' => $draftid_editor);
244         // Following is the advanced grading method area called 'submissions' for the 'assign' module.
245         if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
246             $moduleinfo->grade = 100;
247         }
249         // Plagiarism form values.
250         // No plagiarism plugin installed by default. Use this space to make your own test.
252         // Values specific to the module.
253         $modulesetvalues = $modulename.'_create_set_values';
254         $this->$modulesetvalues($moduleinfo);
256         // Create the module.
257         $result = create_module($moduleinfo);
259         // Retrieve the module info.
260         $dbmodinstance = $DB->get_record($moduleinfo->modulename, array('id' => $result->instance));
261         $dbcm = get_coursemodule_from_instance($moduleinfo->modulename, $result->instance);
262         // We passed the course section number to create_courses but $dbcm contain the section id.
263         // We need to retrieve the db course section number.
264         $section = $DB->get_record('course_sections', array('course' => $dbcm->course, 'id' => $dbcm->section));
265         // Retrieve the grade item.
266         $gradeitem = $DB->get_record('grade_items', array('courseid' => $moduleinfo->course,
267             'iteminstance' => $dbmodinstance->id, 'itemmodule' => $moduleinfo->modulename));
269         // Compare the values common to all module instances.
270         $this->assertEquals($moduleinfo->modulename, $dbcm->modname);
271         $this->assertEquals($moduleinfo->section, $section->section);
272         $this->assertEquals($moduleinfo->course, $dbcm->course);
273         $this->assertEquals($moduleinfo->groupingid, $dbcm->groupingid);
274         $this->assertEquals($moduleinfo->groupmembersonly, $dbcm->groupmembersonly);
275         $this->assertEquals($moduleinfo->visible, $dbcm->visible);
276         $this->assertEquals($moduleinfo->completion, $dbcm->completion);
277         $this->assertEquals($moduleinfo->completionview, $dbcm->completionview);
278         $this->assertEquals($moduleinfo->completiongradeitemnumber, $dbcm->completiongradeitemnumber);
279         $this->assertEquals($moduleinfo->completionexpected, $dbcm->completionexpected);
280         $this->assertEquals($moduleinfo->availablefrom, $dbcm->availablefrom);
281         $this->assertEquals($moduleinfo->availableuntil, $dbcm->availableuntil);
282         $this->assertEquals($moduleinfo->showavailability, $dbcm->showavailability);
283         $this->assertEquals($moduleinfo->showdescription, $dbcm->showdescription);
284         $this->assertEquals($moduleinfo->groupmode, $dbcm->groupmode);
285         $this->assertEquals($moduleinfo->cmidnumber, $dbcm->idnumber);
286         $this->assertEquals($moduleinfo->gradecat, $gradeitem->categoryid);
288         // Optional grade testing.
289         if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
290             $this->assertEquals($moduleinfo->grade, $dbmodinstance->grade);
291         }
293         // Some optional (but quite common) to some module.
294         $this->assertEquals($moduleinfo->name, $dbmodinstance->name);
295         $this->assertEquals($moduleinfo->intro, $dbmodinstance->intro);
296         $this->assertEquals($moduleinfo->introformat, $dbmodinstance->introformat);
298         // Common values when conditional activity is enabled.
299         foreach ($moduleinfo->conditionfieldgroup as $fieldgroup) {
300             $isfieldgroupsaved = $DB->count_records('course_modules_avail_fields', array('coursemoduleid' => $dbcm->id,
301                 'userfield' => $fieldgroup['conditionfield'], 'operator' => $fieldgroup['conditionfieldoperator'],
302                 'value' => $fieldgroup['conditionfieldvalue']));
303             $this->assertEquals(1, $isfieldgroupsaved);
304         }
305         foreach ($moduleinfo->conditiongradegroup as $gradegroup) {
306             $isgradegroupsaved = $DB->count_records('course_modules_availability', array('coursemoduleid' => $dbcm->id,
307                 'grademin' => $gradegroup['conditiongrademin'], 'grademax' => $gradegroup['conditiongrademax'],
308                 'gradeitemid' => $gradegroup['conditiongradeitemid']));
309             $this->assertEquals(1, $isgradegroupsaved);
310         }
311         foreach ($moduleinfo->conditioncompletiongroup as $completiongroup) {
312             $iscompletiongroupsaved = $DB->count_records('course_modules_availability', array('coursemoduleid' => $dbcm->id,
313                 'sourcecmid' => $completiongroup['conditionsourcecmid'], 'requiredcompletion' => $completiongroup['conditionrequiredcompletion']));
314             $this->assertEquals(1, $iscompletiongroupsaved);
315         }
317         // Test specific to the module.
318         $modulerunasserts = $modulename.'_create_run_asserts';
319         $this->$modulerunasserts($moduleinfo, $dbmodinstance);
320     }
322     /**
323      * Test create_module() for multiple modules defined in the $modules array (first declaration of the function).
324      */
325     public function test_create_module() {
326         // Add the module name you want to test here.
327         // Create the match MODULENAME_create_set_values() and MODULENAME_create_run_asserts().
328         $modules = array('forum', 'assign');
329         // Run all tests.
330         foreach ($modules as $modulename) {
331             $this->create_specific_module_test($modulename);
332         }
333     }
335     /**
336      * Test update_module() for multiple modules defined in the $modules array (first declaration of the function).
337      */
338     public function test_update_module() {
339         // Add the module name you want to test here.
340         // Create the match MODULENAME_update_set_values() and MODULENAME_update_run_asserts().
341         $modules = array('forum');
342         // Run all tests.
343         foreach ($modules as $modulename) {
344             $this->update_specific_module_test($modulename);
345         }
346     }
348     /**
349      * Set forum specific test values for calling update_module().
350      *
351      * @param object $moduleinfo - the moduleinfo to add some specific values - passed in reference.
352      */
353     private function forum_update_set_values(&$moduleinfo) {
354         // Completion specific to forum - optional.
355         $moduleinfo->completionposts = 3;
356         $moduleinfo->completiondiscussions = 1;
357         $moduleinfo->completionreplies = 2;
359         // Specific values to the Forum module.
360         $moduleinfo->forcesubscribe = FORUM_INITIALSUBSCRIBE;
361         $moduleinfo->type = 'single';
362         $moduleinfo->trackingtype = FORUM_TRACKING_ON;
363         $moduleinfo->maxbytes = 10240;
364         $moduleinfo->maxattachments = 2;
366         // Post threshold for blocking - specific to forum.
367         $moduleinfo->blockperiod = 60*60*24;
368         $moduleinfo->blockafter = 10;
369         $moduleinfo->warnafter = 5;
370     }
372     /**
373      * Execute test asserts on the saved DB data by update_module($forum).
374      *
375      * @param object $moduleinfo - the specific forum values that were used to update a forum.
376      * @param object $dbmodinstance - the DB values of the updated forum.
377      */
378     private function forum_update_run_asserts($moduleinfo, $dbmodinstance) {
379         // Compare values specific to forums.
380         $this->assertEquals($moduleinfo->forcesubscribe, $dbmodinstance->forcesubscribe);
381         $this->assertEquals($moduleinfo->type, $dbmodinstance->type);
382         $this->assertEquals($moduleinfo->assessed, $dbmodinstance->assessed);
383         $this->assertEquals($moduleinfo->completionposts, $dbmodinstance->completionposts);
384         $this->assertEquals($moduleinfo->completiondiscussions, $dbmodinstance->completiondiscussions);
385         $this->assertEquals($moduleinfo->completionreplies, $dbmodinstance->completionreplies);
386         $this->assertEquals($moduleinfo->scale, $dbmodinstance->scale);
387         $this->assertEquals($moduleinfo->assesstimestart, $dbmodinstance->assesstimestart);
388         $this->assertEquals($moduleinfo->assesstimefinish, $dbmodinstance->assesstimefinish);
389         $this->assertEquals($moduleinfo->rsstype, $dbmodinstance->rsstype);
390         $this->assertEquals($moduleinfo->rssarticles, $dbmodinstance->rssarticles);
391         $this->assertEquals($moduleinfo->trackingtype, $dbmodinstance->trackingtype);
392         $this->assertEquals($moduleinfo->maxbytes, $dbmodinstance->maxbytes);
393         $this->assertEquals($moduleinfo->maxattachments, $dbmodinstance->maxattachments);
394         $this->assertEquals($moduleinfo->blockperiod, $dbmodinstance->blockperiod);
395         $this->assertEquals($moduleinfo->blockafter, $dbmodinstance->blockafter);
396         $this->assertEquals($moduleinfo->warnafter, $dbmodinstance->warnafter);
397     }
401     /**
402      * Test a specific type of module.
403      *
404      * @param string $modulename - the module name to test
405      */
406     private function update_specific_module_test($modulename) {
407         global $DB, $CFG;
409         $this->resetAfterTest(true);
411         $this->setAdminUser();
413         // Warnings: you'll need to change this line if ever you come to test a module not following Moodle standard.
414         require_once($CFG->dirroot.'/mod/'. $modulename .'/lib.php');
416         // Enable avaibility.
417         // If not enabled all conditional fields will be ignored.
418         set_config('enableavailability', 1);
420         // Enable course completion.
421         // If not enabled all completion settings will be ignored.
422         set_config('enablecompletion', COMPLETION_ENABLED);
424         // Enable forum RSS feeds.
425         set_config('enablerssfeeds', 1);
426         set_config('forum_enablerssfeeds', 1);
428         $course = $this->getDataGenerator()->create_course(array('numsections'=>1, 'enablecompletion' => COMPLETION_ENABLED),
429            array('createsections'=>true));
431         $grouping = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
433         // Create assign module instance for testing gradeitem.
434         $generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
435         $params['course'] = $course->id;
436         $instance = $generator->create_instance($params);
437         $assigncm = get_coursemodule_from_instance('assign', $instance->id);
439         // Create the test forum to update.
440         $initvalues = new stdClass();
441         $initvalues->introformat = FORMAT_HTML;
442         $initvalues->course = $course->id;
443         $forum = self::getDataGenerator()->create_module('forum', $initvalues);
445         // Retrieve course module.
446         $cm = get_coursemodule_from_instance('forum', $forum->id);
448         // Module test values.
449         $moduleinfo = new stdClass();
451         // Always mandatory generic values to any module.
452         $moduleinfo->coursemodule = $cm->id;
453         $moduleinfo->modulename = $modulename;
454         $moduleinfo->course = $course->id;
455         $moduleinfo->groupingid = $grouping->id;
456         $moduleinfo->groupmembersonly = 0;
457         $moduleinfo->visible = true;
459         // Sometimes optional generic values for some modules.
460         $moduleinfo->name = 'My test module';
461         $moduleinfo->showdescription = 1; // standard boolean
462         require_once($CFG->libdir . '/gradelib.php');
463         $gradecats = grade_get_categories_menu($moduleinfo->course, false);
464         $gradecatid = current(array_keys($gradecats)); // Retrieve the first key of $gradecats
465         $moduleinfo->gradecat = $gradecatid;
466         $moduleinfo->groupmode = VISIBLEGROUPS;
467         $moduleinfo->cmidnumber = 'idnumber_XXX';
469         // Completion common to all module.
470         $moduleinfo->completion = COMPLETION_TRACKING_AUTOMATIC;
471         $moduleinfo->completionview = COMPLETION_VIEW_REQUIRED;
472         $moduleinfo->completiongradeitemnumber = 1;
473         $moduleinfo->completionexpected = time() + (7 * 24 * 3600);
474         $moduleinfo->completionunlocked = 1;
476         // Conditional activity.
477         $moduleinfo->availablefrom = time();
478         $moduleinfo->availableuntil = time() + (7 * 24 * 3600);
479         $moduleinfo->showavailability = CONDITION_STUDENTVIEW_SHOW;
480         $coursegradeitem = grade_item::fetch_course_item($moduleinfo->course); //the activity will become available only when the user reach some grade into the course itself.
481         $moduleinfo->conditiongradegroup = array(array('conditiongradeitemid' => $coursegradeitem->id, 'conditiongrademin' => 10, 'conditiongrademax' => 80));
482         $moduleinfo->conditionfieldgroup = array(array('conditionfield' => 'email', 'conditionfieldoperator' => OP_CONTAINS, 'conditionfieldvalue' => '@'));
483         $moduleinfo->conditioncompletiongroup = array(array('conditionsourcecmid' => $assigncm->id, 'conditionrequiredcompletion' => COMPLETION_COMPLETE)); // "conditionsourcecmid == 0" => none
485         // Grading and Advanced grading.
486         require_once($CFG->dirroot . '/rating/lib.php');
487         $moduleinfo->assessed = RATING_AGGREGATE_AVERAGE;
488         $moduleinfo->scale = 10; // Note: it could be minus (for specific course scale). It is a signed number.
489         $moduleinfo->assesstimestart = time();
490         $moduleinfo->assesstimefinish = time() + (7 * 24 * 3600);
492         // RSS.
493         $moduleinfo->rsstype = 2;
494         $moduleinfo->rssarticles = 10;
496         // Optional intro editor (depends of module).
497         $draftid_editor = 0;
498         file_prepare_draft_area($draftid_editor, null, null, null, null);
499         $moduleinfo->introeditor = array('text' => 'This is a module', 'format' => FORMAT_HTML, 'itemid' => $draftid_editor);
501         // Following is the advanced grading method area called 'submissions' for the 'assign' module.
502         if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
503             $moduleinfo->grade = 100;
504         }
505         // Plagiarism form values.
506         // No plagiarism plugin installed by default. Use this space to make your own test.
508         // Values specific to the module.
509         $modulesetvalues = $modulename.'_update_set_values';
510         $this->$modulesetvalues($moduleinfo);
512         // Create the module.
513         $result = update_module($moduleinfo);
515         // Retrieve the module info.
516         $dbmodinstance = $DB->get_record($moduleinfo->modulename, array('id' => $result->instance));
517         $dbcm = get_coursemodule_from_instance($moduleinfo->modulename, $result->instance);
518         // Retrieve the grade item.
519         $gradeitem = $DB->get_record('grade_items', array('courseid' => $moduleinfo->course,
520             'iteminstance' => $dbmodinstance->id, 'itemmodule' => $moduleinfo->modulename));
522         // Compare the values common to all module instances.
523         $this->assertEquals($moduleinfo->modulename, $dbcm->modname);
524         $this->assertEquals($moduleinfo->course, $dbcm->course);
525         $this->assertEquals($moduleinfo->groupingid, $dbcm->groupingid);
526         $this->assertEquals($moduleinfo->groupmembersonly, $dbcm->groupmembersonly);
527         $this->assertEquals($moduleinfo->visible, $dbcm->visible);
528         $this->assertEquals($moduleinfo->completion, $dbcm->completion);
529         $this->assertEquals($moduleinfo->completionview, $dbcm->completionview);
530         $this->assertEquals($moduleinfo->completiongradeitemnumber, $dbcm->completiongradeitemnumber);
531         $this->assertEquals($moduleinfo->completionexpected, $dbcm->completionexpected);
532         $this->assertEquals($moduleinfo->availablefrom, $dbcm->availablefrom);
533         $this->assertEquals($moduleinfo->availableuntil, $dbcm->availableuntil);
534         $this->assertEquals($moduleinfo->showavailability, $dbcm->showavailability);
535         $this->assertEquals($moduleinfo->showdescription, $dbcm->showdescription);
536         $this->assertEquals($moduleinfo->groupmode, $dbcm->groupmode);
537         $this->assertEquals($moduleinfo->cmidnumber, $dbcm->idnumber);
538         $this->assertEquals($moduleinfo->gradecat, $gradeitem->categoryid);
540         // Optional grade testing.
541         if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
542             $this->assertEquals($moduleinfo->grade, $dbmodinstance->grade);
543         }
545         // Some optional (but quite common) to some module.
546         $this->assertEquals($moduleinfo->name, $dbmodinstance->name);
547         $this->assertEquals($moduleinfo->intro, $dbmodinstance->intro);
548         $this->assertEquals($moduleinfo->introformat, $dbmodinstance->introformat);
550         // Common values when conditional activity is enabled.
551         foreach ($moduleinfo->conditionfieldgroup as $fieldgroup) {
552             $isfieldgroupsaved = $DB->count_records('course_modules_avail_fields', array('coursemoduleid' => $dbcm->id,
553                 'userfield' => $fieldgroup['conditionfield'], 'operator' => $fieldgroup['conditionfieldoperator'],
554                 'value' => $fieldgroup['conditionfieldvalue']));
555             $this->assertEquals(1, $isfieldgroupsaved);
556         }
557         foreach ($moduleinfo->conditiongradegroup as $gradegroup) {
558             $isgradegroupsaved = $DB->count_records('course_modules_availability', array('coursemoduleid' => $dbcm->id,
559                 'grademin' => $gradegroup['conditiongrademin'], 'grademax' => $gradegroup['conditiongrademax'],
560                 'gradeitemid' => $gradegroup['conditiongradeitemid']));
561             $this->assertEquals(1, $isgradegroupsaved);
562         }
563         foreach ($moduleinfo->conditioncompletiongroup as $completiongroup) {
564             $iscompletiongroupsaved = $DB->count_records('course_modules_availability', array('coursemoduleid' => $dbcm->id,
565                 'sourcecmid' => $completiongroup['conditionsourcecmid'], 'requiredcompletion' => $completiongroup['conditionrequiredcompletion']));
566             $this->assertEquals(1, $iscompletiongroupsaved);
567         }
569         // Test specific to the module.
570         $modulerunasserts = $modulename.'_update_run_asserts';
571         $this->$modulerunasserts($moduleinfo, $dbmodinstance);
572    }
575     public function test_create_course() {
576         global $DB;
577         $this->resetAfterTest(true);
578         $defaultcategory = $DB->get_field_select('course_categories', "MIN(id)", "parent=0");
580         $course = new stdClass();
581         $course->fullname = 'Apu loves Unit Təsts';
582         $course->shortname = 'Spread the lŭve';
583         $course->idnumber = '123';
584         $course->summary = 'Awesome!';
585         $course->summaryformat = FORMAT_PLAIN;
586         $course->format = 'topics';
587         $course->newsitems = 0;
588         $course->numsections = 5;
589         $course->category = $defaultcategory;
590         $original = (array) $course;
592         $created = create_course($course);
593         $context = context_course::instance($created->id);
595         // Compare original and created.
596         $this->assertEquals($original, array_intersect_key((array) $created, $original));
598         // Ensure default section is created.
599         $sectioncreated = $DB->record_exists('course_sections', array('course' => $created->id, 'section' => 0));
600         $this->assertTrue($sectioncreated);
602         // Ensure blocks have been associated to the course.
603         $blockcount = $DB->count_records('block_instances', array('parentcontextid' => $context->id));
604         $this->assertGreaterThan(0, $blockcount);
605     }
607     public function test_create_course_with_generator() {
608         global $DB;
609         $this->resetAfterTest(true);
610         $course = $this->getDataGenerator()->create_course();
612         // Ensure default section is created.
613         $sectioncreated = $DB->record_exists('course_sections', array('course' => $course->id, 'section' => 0));
614         $this->assertTrue($sectioncreated);
615     }
617     public function test_create_course_sections() {
618         global $DB;
619         $this->resetAfterTest(true);
621         $course = $this->getDataGenerator()->create_course(
622                 array('shortname' => 'GrowingCourse',
623                     'fullname' => 'Growing Course',
624                     'numsections' => 5),
625                 array('createsections' => true));
627         // Ensure all 6 (0-5) sections were created and modinfo/sectioninfo cache works properly
628         $sectionscreated = array_keys(get_fast_modinfo($course)->get_section_info_all());
629         $this->assertEquals(range(0, $course->numsections), $sectionscreated);
631         // this will do nothing, section already exists
632         $this->assertFalse(course_create_sections_if_missing($course, $course->numsections));
634         // this will create new section
635         $this->assertTrue(course_create_sections_if_missing($course, $course->numsections + 1));
637         // Ensure all 7 (0-6) sections were created and modinfo/sectioninfo cache works properly
638         $sectionscreated = array_keys(get_fast_modinfo($course)->get_section_info_all());
639         $this->assertEquals(range(0, $course->numsections + 1), $sectionscreated);
640     }
642     public function test_reorder_sections() {
643         global $DB;
644         $this->resetAfterTest(true);
646         $this->getDataGenerator()->create_course(array('numsections'=>5), array('createsections'=>true));
647         $course = $this->getDataGenerator()->create_course(array('numsections'=>10), array('createsections'=>true));
648         $oldsections = array();
649         $sections = array();
650         foreach ($DB->get_records('course_sections', array('course'=>$course->id), 'id') as $section) {
651             $oldsections[$section->section] = $section->id;
652             $sections[$section->id] = $section->section;
653         }
654         ksort($oldsections);
656         $neworder = reorder_sections($sections, 2, 4);
657         $neworder = array_keys($neworder);
658         $this->assertEquals($oldsections[0], $neworder[0]);
659         $this->assertEquals($oldsections[1], $neworder[1]);
660         $this->assertEquals($oldsections[2], $neworder[4]);
661         $this->assertEquals($oldsections[3], $neworder[2]);
662         $this->assertEquals($oldsections[4], $neworder[3]);
663         $this->assertEquals($oldsections[5], $neworder[5]);
664         $this->assertEquals($oldsections[6], $neworder[6]);
666         $neworder = reorder_sections($sections, 4, 2);
667         $neworder = array_keys($neworder);
668         $this->assertEquals($oldsections[0], $neworder[0]);
669         $this->assertEquals($oldsections[1], $neworder[1]);
670         $this->assertEquals($oldsections[2], $neworder[3]);
671         $this->assertEquals($oldsections[3], $neworder[4]);
672         $this->assertEquals($oldsections[4], $neworder[2]);
673         $this->assertEquals($oldsections[5], $neworder[5]);
674         $this->assertEquals($oldsections[6], $neworder[6]);
676         $neworder = reorder_sections(1, 2, 4);
677         $this->assertFalse($neworder);
678     }
680     public function test_move_section_down() {
681         global $DB;
682         $this->resetAfterTest(true);
684         $this->getDataGenerator()->create_course(array('numsections'=>5), array('createsections'=>true));
685         $course = $this->getDataGenerator()->create_course(array('numsections'=>10), array('createsections'=>true));
686         $oldsections = array();
687         foreach ($DB->get_records('course_sections', array('course'=>$course->id)) as $section) {
688             $oldsections[$section->section] = $section->id;
689         }
690         ksort($oldsections);
692         // Test move section down..
693         move_section_to($course, 2, 4);
694         $sections = array();
695         foreach ($DB->get_records('course_sections', array('course'=>$course->id)) as $section) {
696             $sections[$section->section] = $section->id;
697         }
698         ksort($sections);
700         $this->assertEquals($oldsections[0], $sections[0]);
701         $this->assertEquals($oldsections[1], $sections[1]);
702         $this->assertEquals($oldsections[2], $sections[4]);
703         $this->assertEquals($oldsections[3], $sections[2]);
704         $this->assertEquals($oldsections[4], $sections[3]);
705         $this->assertEquals($oldsections[5], $sections[5]);
706         $this->assertEquals($oldsections[6], $sections[6]);
707     }
709     public function test_move_section_up() {
710         global $DB;
711         $this->resetAfterTest(true);
713         $this->getDataGenerator()->create_course(array('numsections'=>5), array('createsections'=>true));
714         $course = $this->getDataGenerator()->create_course(array('numsections'=>10), array('createsections'=>true));
715         $oldsections = array();
716         foreach ($DB->get_records('course_sections', array('course'=>$course->id)) as $section) {
717             $oldsections[$section->section] = $section->id;
718         }
719         ksort($oldsections);
721         // Test move section up..
722         move_section_to($course, 6, 4);
723         $sections = array();
724         foreach ($DB->get_records('course_sections', array('course'=>$course->id)) as $section) {
725             $sections[$section->section] = $section->id;
726         }
727         ksort($sections);
729         $this->assertEquals($oldsections[0], $sections[0]);
730         $this->assertEquals($oldsections[1], $sections[1]);
731         $this->assertEquals($oldsections[2], $sections[2]);
732         $this->assertEquals($oldsections[3], $sections[3]);
733         $this->assertEquals($oldsections[4], $sections[5]);
734         $this->assertEquals($oldsections[5], $sections[6]);
735         $this->assertEquals($oldsections[6], $sections[4]);
736     }
738     public function test_move_section_marker() {
739         global $DB;
740         $this->resetAfterTest(true);
742         $this->getDataGenerator()->create_course(array('numsections'=>5), array('createsections'=>true));
743         $course = $this->getDataGenerator()->create_course(array('numsections'=>10), array('createsections'=>true));
745         // Set course marker to the section we are going to move..
746         course_set_marker($course->id, 2);
747         // Verify that the course marker is set correctly.
748         $course = $DB->get_record('course', array('id' => $course->id));
749         $this->assertEquals(2, $course->marker);
751         // Test move the marked section down..
752         move_section_to($course, 2, 4);
754         // Verify that the coruse marker has been moved along with the section..
755         $course = $DB->get_record('course', array('id' => $course->id));
756         $this->assertEquals(4, $course->marker);
758         // Test move the marked section up..
759         move_section_to($course, 4, 3);
761         // Verify that the course marker has been moved along with the section..
762         $course = $DB->get_record('course', array('id' => $course->id));
763         $this->assertEquals(3, $course->marker);
765         // Test moving a non-marked section above the marked section..
766         move_section_to($course, 4, 2);
768         // Verify that the course marker has been moved down to accomodate..
769         $course = $DB->get_record('course', array('id' => $course->id));
770         $this->assertEquals(4, $course->marker);
772         // Test moving a non-marked section below the marked section..
773         move_section_to($course, 3, 6);
775         // Verify that the course marker has been up to accomodate..
776         $course = $DB->get_record('course', array('id' => $course->id));
777         $this->assertEquals(3, $course->marker);
778     }
780     public function test_get_course_display_name_for_list() {
781         global $CFG;
782         $this->resetAfterTest(true);
784         $course = $this->getDataGenerator()->create_course(array('shortname' => 'FROG101', 'fullname' => 'Introduction to pond life'));
786         $CFG->courselistshortnames = 0;
787         $this->assertEquals('Introduction to pond life', get_course_display_name_for_list($course));
789         $CFG->courselistshortnames = 1;
790         $this->assertEquals('FROG101 Introduction to pond life', get_course_display_name_for_list($course));
791     }
793     public function test_move_module_in_course() {
794         global $DB;
796         $this->resetAfterTest(true);
797         // Setup fixture
798         $course = $this->getDataGenerator()->create_course(array('numsections'=>5), array('createsections' => true));
799         $forum = $this->getDataGenerator()->create_module('forum', array('course'=>$course->id));
801         $cms = get_fast_modinfo($course)->get_cms();
802         $cm = reset($cms);
804         $newsection = get_fast_modinfo($course)->get_section_info(3);
805         $oldsectionid = $cm->section;
807         // Perform the move
808         moveto_module($cm, $newsection);
810         // reset of get_fast_modinfo is usually called the code calling moveto_module so call it here
811         get_fast_modinfo(0, 0, true);
812         $cms = get_fast_modinfo($course)->get_cms();
813         $cm = reset($cms);
815         // Check that the cached modinfo contains the correct section info
816         $modinfo = get_fast_modinfo($course);
817         $this->assertTrue(empty($modinfo->sections[0]));
818         $this->assertFalse(empty($modinfo->sections[3]));
820         // Check that the old section's sequence no longer contains this ID
821         $oldsection = $DB->get_record('course_sections', array('id' => $oldsectionid));
822         $oldsequences = explode(',', $newsection->sequence);
823         $this->assertFalse(in_array($cm->id, $oldsequences));
825         // Check that the new section's sequence now contains this ID
826         $newsection = $DB->get_record('course_sections', array('id' => $newsection->id));
827         $newsequences = explode(',', $newsection->sequence);
828         $this->assertTrue(in_array($cm->id, $newsequences));
830         // Check that the section number has been changed in the cm
831         $this->assertEquals($newsection->id, $cm->section);
834         // Perform a second move as some issues were only seen on the second move
835         $newsection = get_fast_modinfo($course)->get_section_info(2);
836         $oldsectionid = $cm->section;
837         $result = moveto_module($cm, $newsection);
838         $this->assertTrue($result);
840         // reset of get_fast_modinfo is usually called the code calling moveto_module so call it here
841         get_fast_modinfo(0, 0, true);
842         $cms = get_fast_modinfo($course)->get_cms();
843         $cm = reset($cms);
845         // Check that the cached modinfo contains the correct section info
846         $modinfo = get_fast_modinfo($course);
847         $this->assertTrue(empty($modinfo->sections[0]));
848         $this->assertFalse(empty($modinfo->sections[2]));
850         // Check that the old section's sequence no longer contains this ID
851         $oldsection = $DB->get_record('course_sections', array('id' => $oldsectionid));
852         $oldsequences = explode(',', $newsection->sequence);
853         $this->assertFalse(in_array($cm->id, $oldsequences));
855         // Check that the new section's sequence now contains this ID
856         $newsection = $DB->get_record('course_sections', array('id' => $newsection->id));
857         $newsequences = explode(',', $newsection->sequence);
858         $this->assertTrue(in_array($cm->id, $newsequences));
859     }
861     public function test_module_visibility() {
862         $this->setAdminUser();
863         $this->resetAfterTest(true);
865         // Create course and modules.
866         $course = $this->getDataGenerator()->create_course(array('numsections' => 5));
867         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id));
868         $assign = $this->getDataGenerator()->create_module('assign', array('duedate' => time(), 'course' => $course->id));
869         $modules = compact('forum', 'assign');
871         // Hiding the modules.
872         foreach ($modules as $mod) {
873             set_coursemodule_visible($mod->cmid, 0);
874             $this->check_module_visibility($mod, 0, 0);
875         }
877         // Showing the modules.
878         foreach ($modules as $mod) {
879             set_coursemodule_visible($mod->cmid, 1);
880             $this->check_module_visibility($mod, 1, 1);
881         }
882     }
884     public function test_section_visibility() {
885         $this->setAdminUser();
886         $this->resetAfterTest(true);
888         // Create course.
889         $course = $this->getDataGenerator()->create_course(array('numsections' => 3), array('createsections' => true));
891         // Testing an empty section.
892         $sectionnumber = 1;
893         set_section_visible($course->id, $sectionnumber, 0);
894         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
895         $this->assertEquals($section_info->visible, 0);
896         set_section_visible($course->id, $sectionnumber, 1);
897         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
898         $this->assertEquals($section_info->visible, 1);
900         // Testing a section with visible modules.
901         $sectionnumber = 2;
902         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
903                 array('section' => $sectionnumber));
904         $assign = $this->getDataGenerator()->create_module('assign', array('duedate' => time(),
905                 'course' => $course->id), array('section' => $sectionnumber));
906         $modules = compact('forum', 'assign');
907         set_section_visible($course->id, $sectionnumber, 0);
908         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
909         $this->assertEquals($section_info->visible, 0);
910         foreach ($modules as $mod) {
911             $this->check_module_visibility($mod, 0, 1);
912         }
913         set_section_visible($course->id, $sectionnumber, 1);
914         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
915         $this->assertEquals($section_info->visible, 1);
916         foreach ($modules as $mod) {
917             $this->check_module_visibility($mod, 1, 1);
918         }
920         // Testing a section with hidden modules, which should stay hidden.
921         $sectionnumber = 3;
922         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id),
923                 array('section' => $sectionnumber));
924         $assign = $this->getDataGenerator()->create_module('assign', array('duedate' => time(),
925                 'course' => $course->id), array('section' => $sectionnumber));
926         $modules = compact('forum', 'assign');
927         foreach ($modules as $mod) {
928             set_coursemodule_visible($mod->cmid, 0);
929             $this->check_module_visibility($mod, 0, 0);
930         }
931         set_section_visible($course->id, $sectionnumber, 0);
932         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
933         $this->assertEquals($section_info->visible, 0);
934         foreach ($modules as $mod) {
935             $this->check_module_visibility($mod, 0, 0);
936         }
937         set_section_visible($course->id, $sectionnumber, 1);
938         $section_info = get_fast_modinfo($course->id)->get_section_info($sectionnumber);
939         $this->assertEquals($section_info->visible, 1);
940         foreach ($modules as $mod) {
941             $this->check_module_visibility($mod, 0, 0);
942         }
943     }
945     /**
946      * Helper function to assert that a module has correctly been made visible, or hidden.
947      *
948      * @param stdClass $mod module information
949      * @param int $visibility the current state of the module
950      * @param int $visibleold the current state of the visibleold property
951      * @return void
952      */
953     public function check_module_visibility($mod, $visibility, $visibleold) {
954         global $DB;
955         $cm = get_fast_modinfo($mod->course)->get_cm($mod->cmid);
956         $this->assertEquals($visibility, $cm->visible);
957         $this->assertEquals($visibleold, $cm->visibleold);
959         // Check the module grade items.
960         $grade_items = grade_item::fetch_all(array('itemtype' => 'mod', 'itemmodule' => $cm->modname,
961                 'iteminstance' => $cm->instance, 'courseid' => $cm->course));
962         if ($grade_items) {
963             foreach ($grade_items as $grade_item) {
964                 if ($visibility) {
965                     $this->assertFalse($grade_item->is_hidden(), "$cm->modname grade_item not visible");
966                 } else {
967                     $this->assertTrue($grade_item->is_hidden(), "$cm->modname grade_item not hidden");
968                 }
969             }
970         }
972         // Check the events visibility.
973         if ($events = $DB->get_records('event', array('instance' => $cm->instance, 'modulename' => $cm->modname))) {
974             foreach ($events as $event) {
975                 $calevent = new calendar_event($event);
976                 $this->assertEquals($visibility, $calevent->visible, "$cm->modname calendar_event visibility");
977             }
978         }
979     }
981     public function test_course_page_type_list() {
982         global $DB;
983         $this->resetAfterTest(true);
985         // Create a category.
986         $category = new stdClass();
987         $category->name = 'Test Category';
989         $testcategory = $this->getDataGenerator()->create_category($category);
991         // Create a course.
992         $course = new stdClass();
993         $course->fullname = 'Apu loves Unit Təsts';
994         $course->shortname = 'Spread the lŭve';
995         $course->idnumber = '123';
996         $course->summary = 'Awesome!';
997         $course->summaryformat = FORMAT_PLAIN;
998         $course->format = 'topics';
999         $course->newsitems = 0;
1000         $course->numsections = 5;
1001         $course->category = $testcategory->id;
1003         $testcourse = $this->getDataGenerator()->create_course($course);
1005         // Create contexts.
1006         $coursecontext = context_course::instance($testcourse->id);
1007         $parentcontext = $coursecontext->get_parent_context(); // Not actually used.
1008         $pagetype = 'page-course-x'; // Not used either.
1009         $pagetypelist = course_page_type_list($pagetype, $parentcontext, $coursecontext);
1011         // Page type lists for normal courses.
1012         $testpagetypelist1 = array();
1013         $testpagetypelist1['*'] = 'Any page';
1014         $testpagetypelist1['course-*'] = 'Any course page';
1015         $testpagetypelist1['course-view-*'] = 'Any type of course main page';
1017         $this->assertEquals($testpagetypelist1, $pagetypelist);
1019         // Get the context for the front page course.
1020         $sitecoursecontext = context_course::instance(SITEID);
1021         $pagetypelist = course_page_type_list($pagetype, $parentcontext, $sitecoursecontext);
1023         // Page type list for the front page course.
1024         $testpagetypelist2 = array('*' => 'Any page');
1025         $this->assertEquals($testpagetypelist2, $pagetypelist);
1027         // Make sure that providing no current context to the function doesn't result in an error.
1028         // Calls made from generate_page_type_patterns() may provide null values.
1029         $pagetypelist = course_page_type_list($pagetype, null, null);
1030         $this->assertEquals($pagetypelist, $testpagetypelist1);
1031     }
1033     public function test_compare_activities_by_time_desc() {
1035         // Let's create some test data.
1036         $activitiesivities = array();
1037         $x = new stdClass();
1038         $x->timestamp = null;
1039         $activities[] = $x;
1041         $x = new stdClass();
1042         $x->timestamp = 1;
1043         $activities[] = $x;
1045         $x = new stdClass();
1046         $x->timestamp = 3;
1047         $activities[] = $x;
1049         $x = new stdClass();
1050         $x->timestamp = 0;
1051         $activities[] = $x;
1053         $x = new stdClass();
1054         $x->timestamp = 5;
1055         $activities[] = $x;
1057         $x = new stdClass();
1058         $activities[] = $x;
1060         $x = new stdClass();
1061         $x->timestamp = 5;
1062         $activities[] = $x;
1064         // Do the sorting.
1065         usort($activities, 'compare_activities_by_time_desc');
1067         // Let's check the result.
1068         $last = 10;
1069         foreach($activities as $activity) {
1070             if (empty($activity->timestamp)) {
1071                 $activity->timestamp = 0;
1072             }
1073             $this->assertLessThanOrEqual($last, $activity->timestamp);
1074         }
1075     }
1077     public function test_compare_activities_by_time_asc() {
1079         // Let's create some test data.
1080         $activities = array();
1081         $x = new stdClass();
1082         $x->timestamp = null;
1083         $activities[] = $x;
1085         $x = new stdClass();
1086         $x->timestamp = 1;
1087         $activities[] = $x;
1089         $x = new stdClass();
1090         $x->timestamp = 3;
1091         $activities[] = $x;
1093         $x = new stdClass();
1094         $x->timestamp = 0;
1095         $activities[] = $x;
1097         $x = new stdClass();
1098         $x->timestamp = 5;
1099         $activities[] = $x;
1101         $x = new stdClass();
1102         $activities[] = $x;
1104         $x = new stdClass();
1105         $x->timestamp = 5;
1106         $activities[] = $x;
1108         // Do the sorting.
1109         usort($activities, 'compare_activities_by_time_asc');
1111         // Let's check the result.
1112         $last = 0;
1113         foreach($activities as $activity) {
1114             if (empty($activity->timestamp)) {
1115                 $activity->timestamp = 0;
1116             }
1117             $this->assertGreaterThanOrEqual($last, $activity->timestamp);
1118         }
1119     }
1121     /**
1122      * Tests moving a module between hidden/visible sections and
1123      * verifies that the course/module visiblity seettings are
1124      * retained.
1125      */
1126     public function test_moveto_module_between_hidden_sections() {
1127         global $DB;
1129         $this->resetAfterTest(true);
1131         $course = $this->getDataGenerator()->create_course(array('numsections' => 4), array('createsections' => true));
1132         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id));
1133         $page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
1134         $quiz= $this->getDataGenerator()->create_module('quiz', array('course' => $course->id));
1136         // Set the page as hidden
1137         set_coursemodule_visible($page->cmid, 0);
1139         // Set sections 3 as hidden.
1140         set_section_visible($course->id, 3, 0);
1142         $modinfo = get_fast_modinfo($course);
1144         $hiddensection = $modinfo->get_section_info(3);
1145         // New section is definitely not visible:
1146         $this->assertEquals($hiddensection->visible, 0);
1148         $forumcm = $modinfo->cms[$forum->cmid];
1149         $pagecm = $modinfo->cms[$page->cmid];
1151         // Move the forum and the page to a hidden section.
1152         moveto_module($forumcm, $hiddensection);
1153         moveto_module($pagecm, $hiddensection);
1155         // Reset modinfo cache.
1156         get_fast_modinfo(0, 0, true);
1158         $modinfo = get_fast_modinfo($course);
1160         // Verify that forum and page have been moved to the hidden section and quiz has not.
1161         $this->assertContains($forum->cmid, $modinfo->sections[3]);
1162         $this->assertContains($page->cmid, $modinfo->sections[3]);
1163         $this->assertNotContains($quiz->cmid, $modinfo->sections[3]);
1165         // Verify that forum has been made invisible.
1166         $forumcm = $modinfo->cms[$forum->cmid];
1167         $this->assertEquals($forumcm->visible, 0);
1168         // Verify that old state has been retained.
1169         $this->assertEquals($forumcm->visibleold, 1);
1171         // Verify that page has stayed invisible.
1172         $pagecm = $modinfo->cms[$page->cmid];
1173         $this->assertEquals($pagecm->visible, 0);
1174         // Verify that old state has been retained.
1175         $this->assertEquals($pagecm->visibleold, 0);
1177         // Verify that quiz has been unaffected.
1178         $quizcm = $modinfo->cms[$quiz->cmid];
1179         $this->assertEquals($quizcm->visible, 1);
1181         // Move forum and page back to visible section.
1182         $visiblesection = $modinfo->get_section_info(2);
1183         moveto_module($forumcm, $visiblesection);
1184         moveto_module($pagecm, $visiblesection);
1186         // Reset modinfo cache.
1187         get_fast_modinfo(0, 0, true);
1188         $modinfo = get_fast_modinfo($course);
1190         // Verify that forum has been made visible.
1191         $forumcm = $modinfo->cms[$forum->cmid];
1192         $this->assertEquals($forumcm->visible, 1);
1194         // Verify that page has stayed invisible.
1195         $pagecm = $modinfo->cms[$page->cmid];
1196         $this->assertEquals($pagecm->visible, 0);
1198         // Move the page in the same section (this is what mod duplicate does_
1199         moveto_module($pagecm, $visiblesection, $forumcm);
1201         // Reset modinfo cache.
1202         get_fast_modinfo(0, 0, true);
1204         // Verify that the the page is still hidden
1205         $modinfo = get_fast_modinfo($course);
1206         $pagecm = $modinfo->cms[$page->cmid];
1207         $this->assertEquals($pagecm->visible, 0);
1208     }
1210     /**
1211      * Tests moving a module around in the same section. moveto_module()
1212      * is called this way in modduplicate.
1213      */
1214     public function test_moveto_module_in_same_section() {
1215         global $DB;
1217         $this->resetAfterTest(true);
1219         $course = $this->getDataGenerator()->create_course(array('numsections' => 3), array('createsections' => true));
1220         $page = $this->getDataGenerator()->create_module('page', array('course' => $course->id));
1221         $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id));
1223         // Simulate inconsistent visible/visibleold values (MDL-38713).
1224         $cm = $DB->get_record('course_modules', array('id' => $page->cmid), '*', MUST_EXIST);
1225         $cm->visible = 0;
1226         $cm->visibleold = 1;
1227         $DB->update_record('course_modules', $cm);
1229         $modinfo = get_fast_modinfo($course);
1230         $forumcm = $modinfo->cms[$forum->cmid];
1231         $pagecm = $modinfo->cms[$page->cmid];
1233         // Verify that page is hidden.
1234         $this->assertEquals($pagecm->visible, 0);
1236         // Verify section 0 is where all mods added.
1237         $section = $modinfo->get_section_info(0);
1238         $this->assertEquals($section->id, $forumcm->section);
1239         $this->assertEquals($section->id, $pagecm->section);
1242         // Move the forum and the page to a hidden section.
1243         moveto_module($pagecm, $section, $forumcm);
1245         // Reset modinfo cache.
1246         get_fast_modinfo(0, 0, true);
1248         // Verify that the the page is still hidden
1249         $modinfo = get_fast_modinfo($course);
1250         $pagecm = $modinfo->cms[$page->cmid];
1251         $this->assertEquals($pagecm->visible, 0);
1252     }