/**
* Test a specific type of module.
*
* @param string $modulename - the module name to test
*/
private function update_specific_module_test($modulename)
{
global $DB, $CFG;
$this->resetAfterTest(true);
$this->setAdminUser();
// Warnings: you'll need to change this line if ever you come to test a module not following Moodle standard.
require_once $CFG->dirroot . '/mod/' . $modulename . '/lib.php';
// Enable avaibility.
// If not enabled all conditional fields will be ignored.
set_config('enableavailability', 1);
// Enable course completion.
// If not enabled all completion settings will be ignored.
set_config('enablecompletion', COMPLETION_ENABLED);
// Enable forum RSS feeds.
set_config('enablerssfeeds', 1);
set_config('forum_enablerssfeeds', 1);
$course = $this->getDataGenerator()->create_course(array('numsections' => 1, 'enablecompletion' => COMPLETION_ENABLED), array('createsections' => true));
$grouping = $this->getDataGenerator()->create_grouping(array('courseid' => $course->id));
// Create assign module instance for testing gradeitem.
$generator = $this->getDataGenerator()->get_plugin_generator('mod_assign');
$params['course'] = $course->id;
$instance = $generator->create_instance($params);
$assigncm = get_coursemodule_from_instance('assign', $instance->id);
// Create the test forum to update.
$initvalues = new stdClass();
$initvalues->introformat = FORMAT_HTML;
$initvalues->course = $course->id;
$forum = self::getDataGenerator()->create_module('forum', $initvalues);
// Retrieve course module.
$cm = get_coursemodule_from_instance('forum', $forum->id);
// Module test values.
$moduleinfo = new stdClass();
// Always mandatory generic values to any module.
$moduleinfo->coursemodule = $cm->id;
$moduleinfo->modulename = $modulename;
$moduleinfo->course = $course->id;
$moduleinfo->groupingid = $grouping->id;
$moduleinfo->visible = true;
// Sometimes optional generic values for some modules.
$moduleinfo->name = 'My test module';
$moduleinfo->showdescription = 1;
// standard boolean
require_once $CFG->libdir . '/gradelib.php';
$gradecats = grade_get_categories_menu($moduleinfo->course, false);
$gradecatid = current(array_keys($gradecats));
// Retrieve the first key of $gradecats
$moduleinfo->gradecat = $gradecatid;
$moduleinfo->groupmode = VISIBLEGROUPS;
$moduleinfo->cmidnumber = 'idnumber_XXX';
// Completion common to all module.
$moduleinfo->completion = COMPLETION_TRACKING_AUTOMATIC;
$moduleinfo->completionview = COMPLETION_VIEW_REQUIRED;
$moduleinfo->completiongradeitemnumber = 1;
$moduleinfo->completionexpected = time() + 7 * 24 * 3600;
$moduleinfo->completionunlocked = 1;
// Conditional activity.
$coursegradeitem = grade_item::fetch_course_item($moduleinfo->course);
//the activity will become available only when the user reach some grade into the course itself.
$moduleinfo->availability = json_encode(\core_availability\tree::get_root_json(array(\availability_date\condition::get_json('>=', time()), \availability_date\condition::get_json('<', time() + 7 * 24 * 3600), \availability_grade\condition::get_json($coursegradeitem->id, 10, 80), \availability_profile\condition::get_json(false, 'email', 'contains', '@'), \availability_completion\condition::get_json($assigncm->id, COMPLETION_COMPLETE)), '&'));
// Grading and Advanced grading.
require_once $CFG->dirroot . '/rating/lib.php';
$moduleinfo->assessed = RATING_AGGREGATE_AVERAGE;
$moduleinfo->scale = 10;
// Note: it could be minus (for specific course scale). It is a signed number.
$moduleinfo->assesstimestart = time();
$moduleinfo->assesstimefinish = time() + 7 * 24 * 3600;
// RSS.
$moduleinfo->rsstype = 2;
$moduleinfo->rssarticles = 10;
// Optional intro editor (depends of module).
$draftid_editor = 0;
file_prepare_draft_area($draftid_editor, null, null, null, null);
$moduleinfo->introeditor = array('text' => 'This is a module', 'format' => FORMAT_HTML, 'itemid' => $draftid_editor);
// Following is the advanced grading method area called 'submissions' for the 'assign' module.
if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
$moduleinfo->grade = 100;
}
// Plagiarism form values.
// No plagiarism plugin installed by default. Use this space to make your own test.
// Values specific to the module.
$modulesetvalues = $modulename . '_update_set_values';
$this->{$modulesetvalues}($moduleinfo);
// Create the module.
$result = update_module($moduleinfo);
// Retrieve the module info.
$dbmodinstance = $DB->get_record($moduleinfo->modulename, array('id' => $result->instance));
$dbcm = get_coursemodule_from_instance($moduleinfo->modulename, $result->instance);
// Retrieve the grade item.
$gradeitem = $DB->get_record('grade_items', array('courseid' => $moduleinfo->course, 'iteminstance' => $dbmodinstance->id, 'itemmodule' => $moduleinfo->modulename));
// Compare the values common to all module instances.
$this->assertEquals($moduleinfo->modulename, $dbcm->modname);
$this->assertEquals($moduleinfo->course, $dbcm->course);
$this->assertEquals($moduleinfo->groupingid, $dbcm->groupingid);
$this->assertEquals($moduleinfo->visible, $dbcm->visible);
$this->assertEquals($moduleinfo->completion, $dbcm->completion);
$this->assertEquals($moduleinfo->completionview, $dbcm->completionview);
$this->assertEquals($moduleinfo->completiongradeitemnumber, $dbcm->completiongradeitemnumber);
$this->assertEquals($moduleinfo->completionexpected, $dbcm->completionexpected);
$this->assertEquals($moduleinfo->availability, $dbcm->availability);
$this->assertEquals($moduleinfo->showdescription, $dbcm->showdescription);
$this->assertEquals($moduleinfo->groupmode, $dbcm->groupmode);
$this->assertEquals($moduleinfo->cmidnumber, $dbcm->idnumber);
$this->assertEquals($moduleinfo->gradecat, $gradeitem->categoryid);
// Optional grade testing.
if (plugin_supports('mod', $modulename, FEATURE_GRADE_HAS_GRADE, false) && !plugin_supports('mod', $modulename, FEATURE_RATE, false)) {
$this->assertEquals($moduleinfo->grade, $dbmodinstance->grade);
}
// Some optional (but quite common) to some module.
$this->assertEquals($moduleinfo->name, $dbmodinstance->name);
$this->assertEquals($moduleinfo->intro, $dbmodinstance->intro);
$this->assertEquals($moduleinfo->introformat, $dbmodinstance->introformat);
// Test specific to the module.
$modulerunasserts = $modulename . '_update_run_asserts';
$this->{$modulerunasserts}($moduleinfo, $dbmodinstance);
return $moduleinfo;
}
/**
* Tests the update_all_dates function.
*/
public function test_update_all_dates()
{
global $DB;
$this->resetAfterTest();
// Create a course with 3 pages.
$generator = $this->getDataGenerator();
$course = $generator->create_course();
$rec = array('course' => $course);
$page1 = $generator->get_plugin_generator('mod_page')->create_instance($rec);
$page2 = $generator->get_plugin_generator('mod_page')->create_instance($rec);
$page3 = $generator->get_plugin_generator('mod_page')->create_instance($rec);
// Set the availability page 2 to a simple date condition. You can access
// it from 1337 onwards.
$simplecondition = tree::get_root_json(array(condition::get_json(condition::DIRECTION_FROM, 1337)));
$DB->set_field('course_modules', 'availability', json_encode($simplecondition), array('id' => $page2->cmid));
// Set page 3 to a complex set of conditions including a nested date condition.
// You can access it until 1459, *or* after 2810 if you belong to a group.
$complexcondition = tree::get_root_json(array(condition::get_json(condition::DIRECTION_UNTIL, 1459), tree::get_nested_json(array(condition::get_json(condition::DIRECTION_FROM, 2810), \availability_group\condition::get_json()))), tree::OP_OR);
$DB->set_field('course_modules', 'availability', json_encode($complexcondition), array('id' => $page3->cmid));
// Now use the update_all_dates function to move date forward 100000.
condition::update_all_dates($course->id, 100000);
// Get the expected conditions after adjusting time, and compare to database.
$simplecondition->c[0]->t = 101337;
$complexcondition->c[0]->t = 101459;
$complexcondition->c[1]->c[0]->t = 102810;
$this->assertEquals($simplecondition, json_decode($DB->get_field('course_modules', 'availability', array('id' => $page2->cmid))));
$this->assertEquals($complexcondition, json_decode($DB->get_field('course_modules', 'availability', array('id' => $page3->cmid))));
// The one without availability conditions should still be null.
$this->assertNull($DB->get_field('course_modules', 'availability', array('id' => $page1->cmid)));
}
/**
* Tests get_user_list_sql.
*/
public function test_get_user_list_sql()
{
global $DB;
$this->resetAfterTest();
$generator = $this->getDataGenerator();
// Create a test course with 2 groups and users in each combination of them.
$course = $generator->create_course();
$group1 = $generator->create_group(array('courseid' => $course->id));
$group2 = $generator->create_group(array('courseid' => $course->id));
$userin1 = $generator->create_user();
$userin2 = $generator->create_user();
$userinboth = $generator->create_user();
$userinneither = $generator->create_user();
$studentroleid = $DB->get_field('role', 'id', array('shortname' => 'student'));
foreach (array($userin1, $userin2, $userinboth, $userinneither) as $user) {
$generator->enrol_user($user->id, $course->id, $studentroleid);
}
groups_add_member($group1, $userin1);
groups_add_member($group2, $userin2);
groups_add_member($group1, $userinboth);
groups_add_member($group2, $userinboth);
$info = new \core_availability\mock_info($course);
// Tree with single group condition.
$tree = new tree(tree::get_root_json(array(\availability_group\condition::get_json($group1->id))));
list($sql, $params) = $tree->get_user_list_sql(false, $info, false);
$result = $DB->get_fieldset_sql($sql, $params);
sort($result);
$this->assertEquals(array($userin1->id, $userinboth->id), $result);
// Tree with 'AND' of both group conditions.
$tree = new tree(tree::get_root_json(array(\availability_group\condition::get_json($group1->id), \availability_group\condition::get_json($group2->id))));
list($sql, $params) = $tree->get_user_list_sql(false, $info, false);
$result = $DB->get_fieldset_sql($sql, $params);
sort($result);
$this->assertEquals(array($userinboth->id), $result);
// Tree with 'AND' of both group conditions.
$tree = new tree(tree::get_root_json(array(\availability_group\condition::get_json($group1->id), \availability_group\condition::get_json($group2->id)), tree::OP_OR));
list($sql, $params) = $tree->get_user_list_sql(false, $info, false);
$result = $DB->get_fieldset_sql($sql, $params);
sort($result);
$this->assertEquals(array($userin1->id, $userin2->id, $userinboth->id), $result);
// Check with flipped logic (NOT above level of tree).
list($sql, $params) = $tree->get_user_list_sql(true, $info, false);
$result = $DB->get_fieldset_sql($sql, $params);
sort($result);
$this->assertEquals(array($userinneither->id), $result);
// Tree with 'OR' of group conditions and a non-filtering condition.
// The non-filtering condition should mean that ALL users are included.
$tree = new tree(tree::get_root_json(array(\availability_group\condition::get_json($group1->id), \availability_date\condition::get_json(\availability_date\condition::DIRECTION_UNTIL, 3)), tree::OP_OR));
list($sql, $params) = $tree->get_user_list_sql(false, $info, false);
$this->assertEquals('', $sql);
$this->assertEquals(array(), $params);
}
/**
* Get date condition for module availability.
* @param $time
* @param string $comparator
* @return string
* @throws \coding_exception
*/
protected function get_date_condition_json($time, $comparator = '>=')
{
return json_encode(\core_availability\tree::get_root_json([\availability_date\condition::get_json($comparator, $time)]));
}
