. /** * External rating functions unit tests * * @package core_rating * @category external * @copyright 2015 Costantino Cito * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/webservice/tests/helpers.php'); require_once($CFG->dirroot . '/rating/lib.php'); /** * External rating functions unit tests * * @package core_rating * @category external * @copyright 2015 Costantino Cito * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ class core_rating_externallib_testcase extends externallib_advanced_testcase { /** * Test get_item_ratings */ public function test_get_item_ratings() { global $DB, $USER; $this->resetAfterTest(true); $course = self::getDataGenerator()->create_course(); $student = $this->getDataGenerator()->create_user(); $teacher1 = $this->getDataGenerator()->create_user(); $teacher2 = $this->getDataGenerator()->create_user(); $teacher3 = $this->getDataGenerator()->create_user(); $studentrole = $DB->get_record('role', array('shortname' => 'student')); $teacherrole = $DB->get_record('role', array('shortname' => 'teacher')); unassign_capability('moodle/site:accessallgroups', $teacherrole->id); $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id); $this->getDataGenerator()->enrol_user($teacher1->id, $course->id, $teacherrole->id); $this->getDataGenerator()->enrol_user($teacher2->id, $course->id, $teacherrole->id); $this->getDataGenerator()->enrol_user($teacher3->id, $course->id, $teacherrole->id); // Create the forum. $record = new stdClass(); $record->introformat = FORMAT_HTML; $record->course = $course->id; // Set Aggregate type = Average of ratings. $record->assessed = RATING_AGGREGATE_AVERAGE; $forum = self::getDataGenerator()->create_module('forum', $record); $contextid = context_module::instance($forum->cmid)->id; // Add discussion to the forums. $record = new stdClass(); $record->course = $course->id; $record->userid = $student->id; $record->forum = $forum->id; $discussion = self::getDataGenerator()->get_plugin_generator('mod_forum')->create_discussion($record); // Retrieve the first post. $post = $DB->get_record('forum_posts', array('discussion' => $discussion->id)); // Rete the discussion as teacher1. $rating1 = new stdClass(); $rating1->contextid = $contextid; $rating1->component = 'mod_forum'; $rating1->ratingarea = 'post'; $rating1->itemid = $post->id; $rating1->rating = 90; $rating1->scaleid = 100; $rating1->userid = $teacher1->id; $rating1->timecreated = time(); $rating1->timemodified = time(); $rating1->id = $DB->insert_record('rating', $rating1); // Rete the discussion as teacher2. $rating2 = new stdClass(); $rating2->contextid = $contextid; $rating2->component = 'mod_forum'; $rating2->ratingarea = 'post'; $rating2->itemid = $post->id; $rating2->rating = 95; $rating2->scaleid = 100; $rating2->userid = $teacher2->id; $rating2->timecreated = time() + 1; $rating2->timemodified = time() + 1; $rating2->id = $DB->insert_record('rating', $rating2); // Delete teacher2, we must still receive the ratings. delete_user($teacher2); // Teachers can see all the ratings. $this->setUser($teacher1); $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'post', $post->id, 100, ''); // We need to execute the return values cleaning process to simulate the web service server. $ratings = external_api::clean_returnvalue(core_rating_external::get_item_ratings_returns(), $ratings); $this->assertCount(2, $ratings['ratings']); $indexedratings = array(); foreach ($ratings['ratings'] as $rating) { $indexedratings[$rating['id']] = $rating; } $this->assertEquals($rating1->rating.' / '.$rating1->scaleid, $indexedratings[$rating1->id]['rating']); $this->assertEquals($rating2->rating.' / '.$rating2->scaleid, $indexedratings[$rating2->id]['rating']); $this->assertEquals($rating1->userid, $indexedratings[$rating1->id]['userid']); $this->assertEquals($rating2->userid, $indexedratings[$rating2->id]['userid']); // Student can see ratings. $this->setUser($student); $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'post', $post->id, 100, ''); // We need to execute the return values cleaning process to simulate the web service server. $ratings = external_api::clean_returnvalue(core_rating_external::get_item_ratings_returns(), $ratings); $this->assertCount(2, $ratings['ratings']); // Invalid item. try { $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'post', 0, 100, ''); $this->fail('Exception expected due invalid itemid.'); } catch (moodle_exception $e) { $this->assertEquals('invalidrecord', $e->errorcode); } // Invalid area. try { $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'xyz', $post->id, 100, ''); $this->fail('Exception expected due invalid rating area.'); } catch (moodle_exception $e) { $this->assertEquals('invalidratingarea', $e->errorcode); } // Invalid context. invalid_parameter_exception. try { $ratings = core_rating_external::get_item_ratings('module', 0, 'mod_forum', 'post', $post->id, 100, ''); $this->fail('Exception expected due invalid context.'); } catch (invalid_parameter_exception $e) { $this->assertEquals('invalidparameter', $e->errorcode); } // Test for groupmode. set_coursemodule_groupmode($forum->cmid, SEPARATEGROUPS); $group = $this->getDataGenerator()->create_group(array('courseid' => $course->id)); groups_add_member($group, $teacher1); $discussion->groupid = $group->id; $DB->update_record('forum_discussions', $discussion); // Error for teacher3 and 2 ratings for teacher1 should be returned. $this->setUser($teacher1); $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'post', $post->id, 100, ''); // We need to execute the return values cleaning process to simulate the web service server. $ratings = external_api::clean_returnvalue(core_rating_external::get_item_ratings_returns(), $ratings); $this->assertCount(2, $ratings['ratings']); $this->setUser($teacher3); try { $ratings = core_rating_external::get_item_ratings('module', $forum->cmid, 'mod_forum', 'post', $post->id, 100, ''); $this->fail('Exception expected due invalid group permissions.'); } catch (moodle_exception $e) { $this->assertEquals('noviewrate', $e->errorcode); } } }