/**
* Test adding discussions in a course with gorups
*/
public function test_add_discussion_in_course_with_groups() {
global $CFG;
$this->resetAfterTest(true);
// Create course to add the module.
$course = self::getDataGenerator()->create_course(array('groupmode' => VISIBLEGROUPS, 'groupmodeforce' => 0));
$user = self::getDataGenerator()->create_user();
$this->getDataGenerator()->enrol_user($user->id, $course->id);
// Forum forcing separate gropus.
$record = new stdClass();
$record->course = $course->id;
$forum = self::getDataGenerator()->create_module('forum', $record, array('groupmode' => SEPARATEGROUPS));
// Try to post (user not enrolled).
self::setUser($user);
// The user is not enroled in any group, try to post in a forum with separate groups.
try {
mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...');
$this->fail('Exception expected due to invalid group permissions.');
} catch (moodle_exception $e) {
$this->assertEquals('cannotcreatediscussion', $e->errorcode);
}
try {
mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...', 0);
$this->fail('Exception expected due to invalid group permissions.');
} catch (moodle_exception $e) {
$this->assertEquals('cannotcreatediscussion', $e->errorcode);
}
// Create a group.
$group = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
// Try to post in a group the user is not enrolled.
try {
mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...', $group->id);
$this->fail('Exception expected due to invalid group permissions.');
} catch (moodle_exception $e) {
$this->assertEquals('cannotcreatediscussion', $e->errorcode);
}
// Add the user to a group.
groups_add_member($group->id, $user->id);
// Try to post in a group the user is not enrolled.
try {
mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...', $group->id + 1);
$this->fail('Exception expected due to invalid group.');
} catch (moodle_exception $e) {
$this->assertEquals('cannotcreatediscussion', $e->errorcode);
}
// Nost add the discussion using a valid group.
$discussion = mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...', $group->id);
$discussion = external_api::clean_returnvalue(mod_forum_external::add_discussion_returns(), $discussion);
$discussions = mod_forum_external::get_forum_discussions_paginated($forum->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertCount(1, $discussions['discussions']);
$this->assertCount(0, $discussions['warnings']);
$this->assertEquals($discussion['discussionid'], $discussions['discussions'][0]['discussion']);
$this->assertEquals($group->id, $discussions['discussions'][0]['groupid']);
// Now add a discussions without indicating a group. The function should guess the correct group.
$discussion = mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...');
$discussion = external_api::clean_returnvalue(mod_forum_external::add_discussion_returns(), $discussion);
$discussions = mod_forum_external::get_forum_discussions_paginated($forum->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertCount(2, $discussions['discussions']);
$this->assertCount(0, $discussions['warnings']);
$this->assertEquals($group->id, $discussions['discussions'][0]['groupid']);
$this->assertEquals($group->id, $discussions['discussions'][1]['groupid']);
// Enrol the same user in other group.
$group2 = $this->getDataGenerator()->create_group(array('courseid' => $course->id));
groups_add_member($group2->id, $user->id);
// Now add a discussions without indicating a group. The function should guess the correct group (the first one).
$discussion = mod_forum_external::add_discussion($forum->id, 'the subject', 'some text here...');
$discussion = external_api::clean_returnvalue(mod_forum_external::add_discussion_returns(), $discussion);
$discussions = mod_forum_external::get_forum_discussions_paginated($forum->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertCount(3, $discussions['discussions']);
$this->assertCount(0, $discussions['warnings']);
$this->assertEquals($group->id, $discussions['discussions'][0]['groupid']);
$this->assertEquals($group->id, $discussions['discussions'][1]['groupid']);
$this->assertEquals($group->id, $discussions['discussions'][2]['groupid']);
}
/**
* Test get forum discussions paginated
*/
public function test_mod_forum_get_forum_discussions_paginated()
{
global $USER, $CFG, $DB;
$this->resetAfterTest(true);
// Set the CFG variable to allow track forums.
$CFG->forum_trackreadposts = true;
// Create a user who can track forums.
$record = new stdClass();
$record->trackforums = true;
$user1 = self::getDataGenerator()->create_user($record);
// Create a bunch of other users to post.
$user2 = self::getDataGenerator()->create_user();
$user3 = self::getDataGenerator()->create_user();
$user4 = self::getDataGenerator()->create_user();
// Set the first created user to the test user.
self::setUser($user1);
// Create courses to add the modules.
$course1 = self::getDataGenerator()->create_course();
// First forum with tracking off.
$record = new stdClass();
$record->course = $course1->id;
$record->trackingtype = FORUM_TRACKING_OFF;
$forum1 = self::getDataGenerator()->create_module('forum', $record);
// Add discussions to the forums.
$record = new stdClass();
$record->course = $course1->id;
$record->userid = $user1->id;
$record->forum = $forum1->id;
$discussion1 = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record);
// Add three replies to the discussion 1 from different users.
$record = new stdClass();
$record->discussion = $discussion1->id;
$record->parent = $discussion1->firstpost;
$record->userid = $user2->id;
$discussion1reply1 = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_post($record);
$record->parent = $discussion1reply1->id;
$record->userid = $user3->id;
$discussion1reply2 = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_post($record);
$record->userid = $user4->id;
$discussion1reply3 = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_post($record);
// Enrol the user in the first course.
$enrol = enrol_get_plugin('manual');
// We don't use the dataGenerator as we need to get the $instance2 to unenrol later.
$enrolinstances = enrol_get_instances($course1->id, true);
foreach ($enrolinstances as $courseenrolinstance) {
if ($courseenrolinstance->enrol == "manual") {
$instance1 = $courseenrolinstance;
break;
}
}
$enrol->enrol_user($instance1, $user1->id);
// Delete one user.
delete_user($user4);
// Assign capabilities to view discussions for forum 1.
$cm = get_coursemodule_from_id('forum', $forum1->cmid, 0, false, MUST_EXIST);
$context = context_module::instance($cm->id);
$newrole = create_role('Role 2', 'role2', 'Role 2 description');
$this->assignUserCapability('mod/forum:viewdiscussion', $context->id, $newrole);
// Create what we expect to be returned when querying the forums.
$post1 = $DB->get_record('forum_posts', array('id' => $discussion1->firstpost), '*', MUST_EXIST);
$userpictureurl = moodle_url::make_webservice_pluginfile_url(context_user::instance($user1->id)->id, 'user', 'icon', null, '/', 'f1');
// We expect an empty URL since we deleted the user4.
$usermodifiedpictureurl = '';
$expecteddiscussions = array('id' => $discussion1->firstpost, 'name' => $discussion1->name, 'groupid' => $discussion1->groupid, 'timemodified' => $discussion1reply3->created, 'usermodified' => $discussion1reply3->userid, 'timestart' => $discussion1->timestart, 'timeend' => $discussion1->timeend, 'discussion' => $discussion1->id, 'parent' => 0, 'userid' => $discussion1->userid, 'created' => $post1->created, 'modified' => $post1->modified, 'mailed' => $post1->mailed, 'subject' => $post1->subject, 'message' => $post1->message, 'messageformat' => $post1->messageformat, 'messagetrust' => $post1->messagetrust, 'attachment' => $post1->attachment, 'totalscore' => $post1->totalscore, 'mailnow' => $post1->mailnow, 'userfullname' => fullname($user1), 'usermodifiedfullname' => fullname($user4), 'userpictureurl' => $userpictureurl, 'usermodifiedpictureurl' => $usermodifiedpictureurl, 'numreplies' => 3, 'numunread' => 0);
// Call the external function passing forum id.
$discussions = mod_forum_external::get_forum_discussions_paginated($forum1->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$expectedreturn = array('discussions' => array($expecteddiscussions), 'warnings' => array());
$this->assertEquals($expectedreturn, $discussions);
// Call without required view discussion capability.
$this->unassignUserCapability('mod/forum:viewdiscussion', $context->id, $newrole);
try {
mod_forum_external::get_forum_discussions_paginated($forum1->id);
$this->fail('Exception expected due to missing capability.');
} catch (moodle_exception $e) {
$this->assertEquals('noviewdiscussionspermission', $e->errorcode);
}
// Unenrol user from second course.
$enrol->unenrol_user($instance1, $user1->id);
// Call for the second course we unenrolled the user from, make sure exception thrown.
try {
mod_forum_external::get_forum_discussions_paginated($forum1->id);
$this->fail('Exception expected due to being unenrolled from the course.');
} catch (moodle_exception $e) {
$this->assertEquals('requireloginerror', $e->errorcode);
}
}
/**
* Test get forum discussions paginated (qanda forums)
*/
public function test_mod_forum_get_forum_discussions_paginated_qanda()
{
$this->resetAfterTest(true);
// Create courses to add the modules.
$course = self::getDataGenerator()->create_course();
$user1 = self::getDataGenerator()->create_user();
$user2 = self::getDataGenerator()->create_user();
// First forum with tracking off.
$record = new stdClass();
$record->course = $course->id;
$record->type = 'qanda';
$forum = self::getDataGenerator()->create_module('forum', $record);
// Add discussions to the forums.
$discussionrecord = new stdClass();
$discussionrecord->course = $course->id;
$discussionrecord->userid = $user2->id;
$discussionrecord->forum = $forum->id;
$discussion = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($discussionrecord);
self::setAdminUser();
$discussions = mod_forum_external::get_forum_discussions_paginated($forum->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertCount(1, $discussions['discussions']);
$this->assertCount(0, $discussions['warnings']);
self::setUser($user1);
$this->getDataGenerator()->enrol_user($user1->id, $course->id);
$discussions = mod_forum_external::get_forum_discussions_paginated($forum->id);
$discussions = external_api::clean_returnvalue(mod_forum_external::get_forum_discussions_paginated_returns(), $discussions);
$this->assertCount(1, $discussions['discussions']);
$this->assertCount(0, $discussions['warnings']);
}
