[moodle.git] / notes / tests / externallib_test.php

<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * External notes functions unit tests
 *
 * @package    core_notes
 * @category   external
 * @copyright  2012 Jerome Mouneyrac
 * @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 . '/notes/externallib.php');

class core_notes_externallib_testcase extends externallib_advanced_testcase {

    /**
     * Test create_notes
     */
    public function test_create_notes() {

        global $DB, $USER;

        $this->resetAfterTest(true);

        $course = self::getDataGenerator()->create_course();

        // Set the required capabilities by the external function.
        $contextid = context_course::instance($course->id)->id;
        $roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
        $this->assignUserCapability('moodle/course:view', $contextid, $roleid);

        // Create test note data.
        $note1 = array();
        $note1['userid'] = $USER->id;
        $note1['publishstate'] = 'personal';
        $note1['courseid'] = $course->id;
        $note1['text'] = 'the text';
        $note1['clientnoteid'] = 4;
        $notes = array($note1);

        $creatednotes = core_notes_external::create_notes($notes);
        // We need to execute the return values cleaning process to simulate the web service server.
        $creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);

        $thenote = $DB->get_record('post', array('id' => $creatednotes[0]['noteid']));

        // Confirm that base note data was inserted correctly.
        $this->assertEquals($thenote->userid, $note1['userid']);
        $this->assertEquals($thenote->courseid, $note1['courseid']);
        $this->assertEquals($thenote->publishstate, NOTES_STATE_DRAFT);
        $this->assertEquals($thenote->content, $note1['text']);
        $this->assertEquals($creatednotes[0]['clientnoteid'], $note1['clientnoteid']);

        // Call without required capability.
        $this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
        $this->setExpectedException('required_capability_exception');
        $creatednotes = core_notes_external::create_notes($notes);
    }

    public function test_delete_notes() {

        global $DB, $USER;

        $this->resetAfterTest(true);

        $course = self::getDataGenerator()->create_course();

        // Set the required capabilities by the external function.
        $contextid = context_course::instance($course->id)->id;
        $roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
        $this->assignUserCapability('moodle/course:view', $contextid, $roleid);

        // Create test note data.
        $cnote = array();
        $cnote['userid'] = $USER->id;
        $cnote['publishstate'] = 'personal';
        $cnote['courseid'] = $course->id;
        $cnote['text'] = 'the text';
        $cnote['clientnoteid'] = 4;
        $cnotes = array($cnote);
        $creatednotes = core_notes_external::create_notes($cnotes);
        $creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);

        $dnotes1 = array($creatednotes[0]['noteid']);
        $deletednotes1 = core_notes_external::delete_notes($dnotes1);
        $deletednotes1 = external_api::clean_returnvalue(core_notes_external::delete_notes_returns(), $deletednotes1);

        // Confirm that base note data was deleted correctly.
        $notdeletedcount = $DB->count_records_select('post', 'id = ' . $creatednotes[0]['noteid']);
        $this->assertEquals(0, $notdeletedcount);

        $dnotes2 = array(33); // This note does not exist.
        $deletednotes2 = core_notes_external::delete_notes($dnotes2);
        $deletednotes2 = external_api::clean_returnvalue(core_notes_external::delete_notes_returns(), $deletednotes2);

        $this->assertEquals("note", $deletednotes2[0]["item"]);
        $this->assertEquals(33, $deletednotes2[0]["itemid"]);
        $this->assertEquals("badid", $deletednotes2[0]["warningcode"]);
        $this->assertEquals("Note does not exist", $deletednotes2[0]["message"]);

        // Call without required capability.
        $creatednotes = core_notes_external::create_notes($cnotes);
        $dnotes3 = array($creatednotes[0]['noteid']);

        $this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
        $this->setExpectedException('required_capability_exception');
        $deletednotes = core_notes_external::delete_notes($dnotes3);
    }

    public function test_get_notes() {

        global $DB, $USER;

        $this->resetAfterTest(true);

        $course = self::getDataGenerator()->create_course();

        // Set the required capabilities by the external function.
        $contextid = context_course::instance($course->id)->id;
        $roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
        $this->assignUserCapability('moodle/notes:view', $contextid, $roleid);
        $this->assignUserCapability('moodle/course:view', $contextid, $roleid);

        // Create test note data.
        $cnote = array();
        $cnote['userid'] = $USER->id;
        $cnote['publishstate'] = 'personal';
        $cnote['courseid'] = $course->id;
        $cnote['text'] = 'the text';
        $cnotes = array($cnote);

        $creatednotes1 = core_notes_external::create_notes($cnotes);
        $creatednotes2 = core_notes_external::create_notes($cnotes);
        $creatednotes3 = core_notes_external::create_notes($cnotes);

        $creatednotes1 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes1);
        $creatednotes2 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes2);
        $creatednotes3 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes3);

        // Note 33 does not exist.
        $gnotes = array($creatednotes1[0]['noteid'], $creatednotes2[0]['noteid'], $creatednotes3[0]['noteid'], 33);
        $getnotes = core_notes_external::get_notes($gnotes);
        $getnotes = external_api::clean_returnvalue(core_notes_external::get_notes_returns(), $getnotes);

        $this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
        // Confirm that base note data was retrieved correctly.
        $this->assertEquals($cnote['userid'], $getnotes["notes"][0]["userid"]);
        $this->assertEquals($cnote['text'], $getnotes["notes"][0]["text"]);
        $this->assertEquals($cnote['userid'], $getnotes["notes"][1]["userid"]);
        $this->assertEquals($cnote['text'], $getnotes["notes"][1]["text"]);
        $this->assertEquals($cnote['userid'], $getnotes["notes"][2]["userid"]);
        $this->assertEquals($cnote['text'], $getnotes["notes"][2]["text"]);
        $this->assertEquals("note", $getnotes["warnings"][0]["item"]);
        $this->assertEquals(33, $getnotes["warnings"][0]["itemid"]);
        $this->assertEquals("badid", $getnotes["warnings"][0]["warningcode"]);
        $this->assertEquals("Note does not exist", $getnotes["warnings"][0]["message"]);

        // Call without required capability.
        $this->unassignUserCapability('moodle/notes:view', $contextid, $roleid);
        $this->setExpectedException('required_capability_exception');
        $creatednotes = core_notes_external::get_notes($gnotes);
    }

    public function test_update_notes() {

        global $DB, $USER;

        $this->resetAfterTest(true);

        $course = self::getDataGenerator()->create_course();

        // Set the required capabilities by the external function.
        $contextid = context_course::instance($course->id)->id;
        $roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
        $this->assignUserCapability('moodle/course:view', $contextid, $roleid);

        // Create test note data.
        $note1 = array();
        $note1['userid'] = $USER->id;
        $note1['publishstate'] = 'personal';
        $note1['courseid'] = $course->id;
        $note1['text'] = 'the text';
        $note2['userid'] = $USER->id;
        $note2['publishstate'] = 'course';
        $note2['courseid'] = $course->id;
        $note2['text'] = 'the text';
        $note3['userid'] = $USER->id;
        $note3['publishstate'] = 'site';
        $note3['courseid'] = $course->id;
        $note3['text'] = 'the text';
        $notes1 = array($note1, $note2, $note3);

        $creatednotes = core_notes_external::create_notes($notes1);
        $creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);

        $note2 = array();
        $note2["id"] = $creatednotes[0]['noteid'];
        $note2['publishstate'] = 'personal';
        $note2['text'] = 'the new text';
        $note2['format'] = FORMAT_HTML;
        $notes2 = array($note2);

        $updatednotes = core_notes_external::update_notes($notes2);

        $updatednotes = external_api::clean_returnvalue(core_notes_external::update_notes_returns(), $updatednotes);
        $thenote = $DB->get_record('post', array('id' => $creatednotes[0]['noteid']));

        // Confirm that base note data was updated correctly.
        $this->assertEquals($thenote->publishstate, NOTES_STATE_DRAFT);
        $this->assertEquals($note2['text'], $thenote->content);

        // Call without required capability.
        $creatednotes = core_notes_external::create_notes($notes1);
        $this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
        $this->setExpectedException('required_capability_exception');
        $note2 = array();
        $note2["id"] = $creatednotes[0]['noteid'];
        $note2['publishstate'] = 'personal';
        $note2['text'] = 'the new text';
        $note2['format'] = FORMAT_HTML;
        $notes2 = array($note2);
        $updatednotes = core_notes_external::update_notes($notes2);
    }

    /**
     * Test get_course_notes
     */
    public function test_get_course_notes() {
        global $DB, $CFG;

        $this->resetAfterTest(true);
        $CFG->enablenotes = true;

        // Take role definitions.
        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
        $teacherrole = $DB->get_record('role', array('shortname' => 'teacher'));

        // Create students and teachers.
        $student1 = $this->getDataGenerator()->create_user();
        $student2 = $this->getDataGenerator()->create_user();
        $teacher1 = $this->getDataGenerator()->create_user();
        $teacher2 = $this->getDataGenerator()->create_user();
        $course1 = $this->getDataGenerator()->create_course();
        $course2 = $this->getDataGenerator()->create_course();

        // Enroll students and teachers to COURSE-1.
        $this->getDataGenerator()->enrol_user($student1->id, $course1->id, $studentrole->id);
        $this->getDataGenerator()->enrol_user($student2->id, $course1->id, $studentrole->id);
        $this->getDataGenerator()->enrol_user($teacher1->id, $course1->id, $teacherrole->id);
        $this->getDataGenerator()->enrol_user($teacher2->id, $course1->id, $teacherrole->id);
        // Enroll students and teachers to COURSE-2 (teacher1 is not enrolled in Course 2).
        $this->getDataGenerator()->enrol_user($student1->id, $course2->id, $studentrole->id);
        $this->getDataGenerator()->enrol_user($student2->id, $course2->id, $studentrole->id);

        $this->getDataGenerator()->enrol_user($teacher2->id, $course2->id, $teacherrole->id);

        // Generate notes.
        $gen = $this->getDataGenerator()->get_plugin_generator('core_notes');

        $this->setUser($teacher1);

        // NoteA1: on student1 (Course1) by Teacher1.
        $params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
            'usermodified' => $teacher1->id);
        $notea1 = $gen->create_instance($params);
        // NoteA2: on student1 (Course1) by Teacher1.
        $params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
            'usermodified' => $teacher1->id);
        $notea2 = $gen->create_instance($params);
        // NoteS1: on student1 SITE-LEVEL by teacher1.
        $params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_SITE,
            'usermodified' => $teacher1->id);
        $notes1 = $gen->create_instance($params);
        // NoteP1: on student1 PERSONAL by teacher1.
        $params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_DRAFT,
            'usermodified' => $teacher1->id);
        $notep1 = $gen->create_instance($params);
        // NoteB1: on student1 (Course2) by teacher1.
        $params = array('courseid' => $course2->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
            'usermodified' => $teacher1->id);
        $noteb1 = $gen->create_instance($params);

        // Retrieve notes, normal case.
        $result = core_notes_external::get_course_notes($course1->id, $student1->id);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
        $this->assertCount(2, $result['coursenotes']);

        foreach ($result['coursenotes'] as $coursenote) {
            if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
                $this->fail('the returned notes ids does not match with the created ones');
            }
        }

        $this->assertEquals($notep1->id, $result['personalnotes'][0]['id']);

        // Try to get notes from a course the user is not enrolled.
        try {
            $result = core_notes_external::get_course_notes($course2->id, $student1->id);
            $this->fail('the user is not enrolled in the course');
        } catch (require_login_exception $e) {
            $this->assertEquals('requireloginerror', $e->errorcode);
        }

        $result = core_notes_external::get_course_notes(0, $student1->id);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEmpty($result['sitenotes']);

        foreach ($result['coursenotes'] as $coursenote) {
            if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
                $this->fail('the returned notes ids does not match with the created ones');
            }
        }

        $this->assertCount(2, $result['coursenotes']);

        $this->setAdminUser();
        $result = core_notes_external::get_course_notes(0, $student1->id);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
        $this->assertCount(1, $result['sitenotes']);

        $this->setUser($teacher1);
        $result = core_notes_external::get_course_notes(0, 0);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEmpty($result['sitenotes']);
        $this->assertEmpty($result['coursenotes']);
        $this->assertEmpty($result['personalnotes']);

        $this->setUser($teacher2);
        $result = core_notes_external::get_course_notes($course1->id, $student1->id);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);

        foreach ($result['coursenotes'] as $coursenote) {
            if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
                $this->fail('the returned notes ids does not match with the created ones');
            }
        }

        $this->assertCount(1, $result['sitenotes']);
        $this->assertCount(2, $result['coursenotes']);

        $result = core_notes_external::get_course_notes($course1->id, 0);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);

        foreach ($result['coursenotes'] as $coursenote) {
            if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
                $this->fail('the returned notes ids does not match with the created ones');
            }
        }

        $this->assertCount(1, $result['sitenotes']);
        $this->assertCount(2, $result['coursenotes']);

        $this->setUser($teacher1);
        $result = core_notes_external::get_course_notes($course1->id, 0);
        $result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
        $this->assertEquals($notep1->id, $result['personalnotes'][0]['id']);
        $this->assertCount(1, $result['personalnotes']);

    }

    /**
     * Test view_notes
     */
    public function test_view_notes() {
        global $DB, $CFG;

        $this->resetAfterTest(true);
        $CFG->enablenotes = true;

        // Take role definitions.
        $studentrole = $DB->get_record('role', array('shortname' => 'student'));
        $teacherrole = $DB->get_record('role', array('shortname' => 'teacher'));

        // Create students and teachers.
        $student = $this->getDataGenerator()->create_user();
        $teacher = $this->getDataGenerator()->create_user();
        $course = $this->getDataGenerator()->create_course();
        $coursecontext = context_course::instance($course->id);

        // Enroll students and teachers to course.
        $this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id);
        $this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);

        // Generate notes.
        $gen = $this->getDataGenerator()->get_plugin_generator('core_notes');
        $this->setUser($teacher);

        // NoteA1: on student (Course) by Teacher.
        $params = array('courseid' => $course->id, 'userid' => $student->id, 'publishstate' => NOTES_STATE_PUBLIC,
            'usermodified' => $teacher->id);
        $notea1 = $gen->create_instance($params);

        $sink = $this->redirectEvents();

        $result = core_notes_external::view_notes($course->id, $student->id);
        $result = external_api::clean_returnvalue(core_notes_external::view_notes_returns(), $result);

        $result = core_notes_external::view_notes($course->id);
        $result = external_api::clean_returnvalue(core_notes_external::view_notes_returns(), $result);

        $events = $sink->get_events();

        $this->assertCount(2, $events);

        $this->assertInstanceOf('\core\event\notes_viewed', $events[0]);
        $this->assertEquals($coursecontext, $events[0]->get_context());
        $this->assertEquals($student->id, $events[0]->relateduserid);

        $this->assertInstanceOf('\core\event\notes_viewed', $events[1]);
        $this->assertEquals($coursecontext, $events[1]->get_context());
        $this->assertEquals(0, $events[1]->relateduserid);

        try {
            core_notes_external::view_notes(0);
            $this->fail('Exception expected due to invalid permissions at system level.');
        } catch (moodle_exception $e) {
            $this->assertEquals('nopermissions', $e->errorcode);
        }

        try {
            core_notes_external::view_notes($course->id, $student->id + 100);
            $this->fail('Exception expected due to invalid user id.');
        } catch (moodle_exception $e) {
            $this->assertEquals('invaliduser', $e->errorcode);
        }
    }
}
Commit	Line	Data
4647b4d7 JM	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/>.
	16
	17	/**
	18	* External notes functions unit tests
	19	*
	20	* @package core_notes
	21	* @category external
	22	* @copyright 2012 Jerome Mouneyrac
	23	* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
	24	*/
	25
	26	defined('MOODLE_INTERNAL') \|\| die();
	27
	28	global $CFG;
	29
	30	require_once($CFG->dirroot . '/webservice/tests/helpers.php');
	31	require_once($CFG->dirroot . '/notes/externallib.php');
	32
8252b7c2	33	class core_notes_externallib_testcase extends externallib_advanced_testcase {
4647b4d7 JM	34
	35	/**
	36	* Test create_notes
	37	*/
	38	public function test_create_notes() {
	39
34348b2b	40	global $DB, $USER;
4647b4d7 JM	41
	42	$this->resetAfterTest(true);
	43
34348b2b	44	$course = self::getDataGenerator()->create_course();
4647b4d7	45
34348b2b	46	// Set the required capabilities by the external function.
4647b4d7 JM	47	$contextid = context_course::instance($course->id)->id;
	48	$roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
	49	$this->assignUserCapability('moodle/course:view', $contextid, $roleid);
	50
	51	// Create test note data.
	52	$note1 = array();
	53	$note1['userid'] = $USER->id;
	54	$note1['publishstate'] = 'personal';
	55	$note1['courseid'] = $course->id;
	56	$note1['text'] = 'the text';
	57	$note1['clientnoteid'] = 4;
	58	$notes = array($note1);
	59
	60	$creatednotes = core_notes_external::create_notes($notes);
fb695f6e JM	61	// We need to execute the return values cleaning process to simulate the web service server.
	62	$creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);
	63
4647b4d7 JM	64	$thenote = $DB->get_record('post', array('id' => $creatednotes[0]['noteid']));
	65
	66	// Confirm that base note data was inserted correctly.
	67	$this->assertEquals($thenote->userid, $note1['userid']);
	68	$this->assertEquals($thenote->courseid, $note1['courseid']);
	69	$this->assertEquals($thenote->publishstate, NOTES_STATE_DRAFT);
	70	$this->assertEquals($thenote->content, $note1['text']);
	71	$this->assertEquals($creatednotes[0]['clientnoteid'], $note1['clientnoteid']);
	72
34348b2b	73	// Call without required capability.
4647b4d7 JM	74	$this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
	75	$this->setExpectedException('required_capability_exception');
	76	$creatednotes = core_notes_external::create_notes($notes);
34348b2b JF	77	}
	78
	79	public function test_delete_notes() {
	80
	81	global $DB, $USER;
	82
	83	$this->resetAfterTest(true);
	84
	85	$course = self::getDataGenerator()->create_course();
	86
	87	// Set the required capabilities by the external function.
	88	$contextid = context_course::instance($course->id)->id;
	89	$roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
	90	$this->assignUserCapability('moodle/course:view', $contextid, $roleid);
	91
	92	// Create test note data.
	93	$cnote = array();
	94	$cnote['userid'] = $USER->id;
	95	$cnote['publishstate'] = 'personal';
	96	$cnote['courseid'] = $course->id;
	97	$cnote['text'] = 'the text';
	98	$cnote['clientnoteid'] = 4;
	99	$cnotes = array($cnote);
	100	$creatednotes = core_notes_external::create_notes($cnotes);
	101	$creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);
	102
60d80781	103	$dnotes1 = array($creatednotes[0]['noteid']);
34348b2b JF	104	$deletednotes1 = core_notes_external::delete_notes($dnotes1);
	105	$deletednotes1 = external_api::clean_returnvalue(core_notes_external::delete_notes_returns(), $deletednotes1);
	106
	107	// Confirm that base note data was deleted correctly.
	108	$notdeletedcount = $DB->count_records_select('post', 'id = ' . $creatednotes[0]['noteid']);
	109	$this->assertEquals(0, $notdeletedcount);
	110
60d80781	111	$dnotes2 = array(33); // This note does not exist.
34348b2b JF	112	$deletednotes2 = core_notes_external::delete_notes($dnotes2);
	113	$deletednotes2 = external_api::clean_returnvalue(core_notes_external::delete_notes_returns(), $deletednotes2);
	114
	115	$this->assertEquals("note", $deletednotes2[0]["item"]);
	116	$this->assertEquals(33, $deletednotes2[0]["itemid"]);
	117	$this->assertEquals("badid", $deletednotes2[0]["warningcode"]);
	118	$this->assertEquals("Note does not exist", $deletednotes2[0]["message"]);
	119
	120	// Call without required capability.
	121	$creatednotes = core_notes_external::create_notes($cnotes);
60d80781	122	$dnotes3 = array($creatednotes[0]['noteid']);
34348b2b JF	123
	124	$this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
	125	$this->setExpectedException('required_capability_exception');
	126	$deletednotes = core_notes_external::delete_notes($dnotes3);
	127	}
	128
	129	public function test_get_notes() {
	130
	131	global $DB, $USER;
	132
	133	$this->resetAfterTest(true);
	134
	135	$course = self::getDataGenerator()->create_course();
	136
	137	// Set the required capabilities by the external function.
	138	$contextid = context_course::instance($course->id)->id;
	139	$roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
	140	$this->assignUserCapability('moodle/notes:view', $contextid, $roleid);
	141	$this->assignUserCapability('moodle/course:view', $contextid, $roleid);
4647b4d7	142
34348b2b JF	143	// Create test note data.
	144	$cnote = array();
	145	$cnote['userid'] = $USER->id;
	146	$cnote['publishstate'] = 'personal';
	147	$cnote['courseid'] = $course->id;
	148	$cnote['text'] = 'the text';
	149	$cnotes = array($cnote);
	150
	151	$creatednotes1 = core_notes_external::create_notes($cnotes);
	152	$creatednotes2 = core_notes_external::create_notes($cnotes);
	153	$creatednotes3 = core_notes_external::create_notes($cnotes);
	154
	155	$creatednotes1 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes1);
	156	$creatednotes2 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes2);
	157	$creatednotes3 = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes3);
	158
	159	// Note 33 does not exist.
60d80781	160	$gnotes = array($creatednotes1[0]['noteid'], $creatednotes2[0]['noteid'], $creatednotes3[0]['noteid'], 33);
34348b2b JF	161	$getnotes = core_notes_external::get_notes($gnotes);
	162	$getnotes = external_api::clean_returnvalue(core_notes_external::get_notes_returns(), $getnotes);
	163
	164	$this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
	165	// Confirm that base note data was retrieved correctly.
	166	$this->assertEquals($cnote['userid'], $getnotes["notes"][0]["userid"]);
	167	$this->assertEquals($cnote['text'], $getnotes["notes"][0]["text"]);
	168	$this->assertEquals($cnote['userid'], $getnotes["notes"][1]["userid"]);
	169	$this->assertEquals($cnote['text'], $getnotes["notes"][1]["text"]);
	170	$this->assertEquals($cnote['userid'], $getnotes["notes"][2]["userid"]);
	171	$this->assertEquals($cnote['text'], $getnotes["notes"][2]["text"]);
	172	$this->assertEquals("note", $getnotes["warnings"][0]["item"]);
	173	$this->assertEquals(33, $getnotes["warnings"][0]["itemid"]);
	174	$this->assertEquals("badid", $getnotes["warnings"][0]["warningcode"]);
	175	$this->assertEquals("Note does not exist", $getnotes["warnings"][0]["message"]);
	176
	177	// Call without required capability.
	178	$this->unassignUserCapability('moodle/notes:view', $contextid, $roleid);
	179	$this->setExpectedException('required_capability_exception');
	180	$creatednotes = core_notes_external::get_notes($gnotes);
	181	}
	182
	183	public function test_update_notes() {
	184
	185	global $DB, $USER;
	186
	187	$this->resetAfterTest(true);
	188
	189	$course = self::getDataGenerator()->create_course();
	190
	191	// Set the required capabilities by the external function.
	192	$contextid = context_course::instance($course->id)->id;
	193	$roleid = $this->assignUserCapability('moodle/notes:manage', $contextid);
	194	$this->assignUserCapability('moodle/course:view', $contextid, $roleid);
	195
	196	// Create test note data.
	197	$note1 = array();
	198	$note1['userid'] = $USER->id;
	199	$note1['publishstate'] = 'personal';
	200	$note1['courseid'] = $course->id;
	201	$note1['text'] = 'the text';
	202	$note2['userid'] = $USER->id;
	203	$note2['publishstate'] = 'course';
	204	$note2['courseid'] = $course->id;
	205	$note2['text'] = 'the text';
	206	$note3['userid'] = $USER->id;
	207	$note3['publishstate'] = 'site';
	208	$note3['courseid'] = $course->id;
	209	$note3['text'] = 'the text';
	210	$notes1 = array($note1, $note2, $note3);
	211
	212	$creatednotes = core_notes_external::create_notes($notes1);
	213	$creatednotes = external_api::clean_returnvalue(core_notes_external::create_notes_returns(), $creatednotes);
	214
	215	$note2 = array();
	216	$note2["id"] = $creatednotes[0]['noteid'];
	217	$note2['publishstate'] = 'personal';
	218	$note2['text'] = 'the new text';
	219	$note2['format'] = FORMAT_HTML;
	220	$notes2 = array($note2);
	221
	222	$updatednotes = core_notes_external::update_notes($notes2);
	223
	224	$updatednotes = external_api::clean_returnvalue(core_notes_external::update_notes_returns(), $updatednotes);
225	$thenote = $DB->get_record('post', array('id' => $creatednotes[0]['noteid']));
226
227	// Confirm that base note data was updated correctly.
228	$this->assertEquals($thenote->publishstate, NOTES_STATE_DRAFT);
229	$this->assertEquals($note2['text'], $thenote->content);
230
231	// Call without required capability.
232	$creatednotes = core_notes_external::create_notes($notes1);
233	$this->unassignUserCapability('moodle/notes:manage', $contextid, $roleid);
234	$this->setExpectedException('required_capability_exception');
235	$note2 = array();
236	$note2["id"] = $creatednotes[0]['noteid'];
237	$note2['publishstate'] = 'personal';
238	$note2['text'] = 'the new text';
239	$note2['format'] = FORMAT_HTML;
240	$notes2 = array($note2);
241	$updatednotes = core_notes_external::update_notes($notes2);
4647b4d7	242	}
12068d65 CC	243
	244	/**
	245	* Test get_course_notes
	246	*/
	247	public function test_get_course_notes() {
	248	global $DB, $CFG;
	249
	250	$this->resetAfterTest(true);
	251	$CFG->enablenotes = true;
	252
	253	// Take role definitions.
	254	$studentrole = $DB->get_record('role', array('shortname' => 'student'));
	255	$teacherrole = $DB->get_record('role', array('shortname' => 'teacher'));
	256
	257	// Create students and teachers.
	258	$student1 = $this->getDataGenerator()->create_user();
	259	$student2 = $this->getDataGenerator()->create_user();
	260	$teacher1 = $this->getDataGenerator()->create_user();
	261	$teacher2 = $this->getDataGenerator()->create_user();
	262	$course1 = $this->getDataGenerator()->create_course();
	263	$course2 = $this->getDataGenerator()->create_course();
	264
	265	// Enroll students and teachers to COURSE-1.
	266	$this->getDataGenerator()->enrol_user($student1->id, $course1->id, $studentrole->id);
	267	$this->getDataGenerator()->enrol_user($student2->id, $course1->id, $studentrole->id);
	268	$this->getDataGenerator()->enrol_user($teacher1->id, $course1->id, $teacherrole->id);
	269	$this->getDataGenerator()->enrol_user($teacher2->id, $course1->id, $teacherrole->id);
	270	// Enroll students and teachers to COURSE-2 (teacher1 is not enrolled in Course 2).
	271	$this->getDataGenerator()->enrol_user($student1->id, $course2->id, $studentrole->id);
	272	$this->getDataGenerator()->enrol_user($student2->id, $course2->id, $studentrole->id);
	273
	274	$this->getDataGenerator()->enrol_user($teacher2->id, $course2->id, $teacherrole->id);
	275
	276	// Generate notes.
	277	$gen = $this->getDataGenerator()->get_plugin_generator('core_notes');
	278
	279	$this->setUser($teacher1);
	280
	281	// NoteA1: on student1 (Course1) by Teacher1.
	282	$params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
	283	'usermodified' => $teacher1->id);
	284	$notea1 = $gen->create_instance($params);
	285	// NoteA2: on student1 (Course1) by Teacher1.
	286	$params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
	287	'usermodified' => $teacher1->id);
	288	$notea2 = $gen->create_instance($params);
	289	// NoteS1: on student1 SITE-LEVEL by teacher1.
	290	$params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_SITE,
	291	'usermodified' => $teacher1->id);
	292	$notes1 = $gen->create_instance($params);
	293	// NoteP1: on student1 PERSONAL by teacher1.
	294	$params = array('courseid' => $course1->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_DRAFT,
	295	'usermodified' => $teacher1->id);
	296	$notep1 = $gen->create_instance($params);
	297	// NoteB1: on student1 (Course2) by teacher1.
	298	$params = array('courseid' => $course2->id, 'userid' => $student1->id, 'publishstate' => NOTES_STATE_PUBLIC,
	299	'usermodified' => $teacher1->id);
	300	$noteb1 = $gen->create_instance($params);
	301
	302	// Retrieve notes, normal case.
	303	$result = core_notes_external::get_course_notes($course1->id, $student1->id);
	304	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	305	$this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
d4fdd3a1 JL	306	$this->assertCount(2, $result['coursenotes']);
	307
	308	foreach ($result['coursenotes'] as $coursenote) {
	309	if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
	310	$this->fail('the returned notes ids does not match with the created ones');
	311	}
	312	}
	313
12068d65 CC	314	$this->assertEquals($notep1->id, $result['personalnotes'][0]['id']);
	315
	316	// Try to get notes from a course the user is not enrolled.
	317	try {
	318	$result = core_notes_external::get_course_notes($course2->id, $student1->id);
	319	$this->fail('the user is not enrolled in the course');
	320	} catch (require_login_exception $e) {
	321	$this->assertEquals('requireloginerror', $e->errorcode);
	322	}
	323
	324	$result = core_notes_external::get_course_notes(0, $student1->id);
	325	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	326	$this->assertEmpty($result['sitenotes']);
d4fdd3a1 JL	327
	328	foreach ($result['coursenotes'] as $coursenote) {
	329	if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
	330	$this->fail('the returned notes ids does not match with the created ones');
	331	}
	332	}
	333
12068d65 CC	334	$this->assertCount(2, $result['coursenotes']);
	335
	336	$this->setAdminUser();
	337	$result = core_notes_external::get_course_notes(0, $student1->id);
	338	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	339	$this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
	340	$this->assertCount(1, $result['sitenotes']);
	341
	342	$this->setUser($teacher1);
	343	$result = core_notes_external::get_course_notes(0, 0);
	344	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	345	$this->assertEmpty($result['sitenotes']);
	346	$this->assertEmpty($result['coursenotes']);
	347	$this->assertEmpty($result['personalnotes']);
	348
	349	$this->setUser($teacher2);
	350	$result = core_notes_external::get_course_notes($course1->id, $student1->id);
	351	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	352	$this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
d4fdd3a1 JL	353
	354	foreach ($result['coursenotes'] as $coursenote) {
	355	if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
	356	$this->fail('the returned notes ids does not match with the created ones');
	357	}
	358	}
	359
12068d65 CC	360	$this->assertCount(1, $result['sitenotes']);
	361	$this->assertCount(2, $result['coursenotes']);
	362
	363	$result = core_notes_external::get_course_notes($course1->id, 0);
	364	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	365	$this->assertEquals($notes1->id, $result['sitenotes'][0]['id']);
d4fdd3a1 JL	366
	367	foreach ($result['coursenotes'] as $coursenote) {
	368	if ($coursenote['id'] != $notea1->id and $coursenote['id'] != $notea2->id) {
	369	$this->fail('the returned notes ids does not match with the created ones');
	370	}
	371	}
	372
12068d65 CC	373	$this->assertCount(1, $result['sitenotes']);
	374	$this->assertCount(2, $result['coursenotes']);
	375
	376	$this->setUser($teacher1);
	377	$result = core_notes_external::get_course_notes($course1->id, 0);
	378	$result = external_api::clean_returnvalue(core_notes_external::get_course_notes_returns(), $result);
	379	$this->assertEquals($notep1->id, $result['personalnotes'][0]['id']);
	380	$this->assertCount(1, $result['personalnotes']);
	381
	382	}
29ab6351 JL	383
	384	/**
	385	* Test view_notes
	386	*/
	387	public function test_view_notes() {
	388	global $DB, $CFG;
	389
	390	$this->resetAfterTest(true);
	391	$CFG->enablenotes = true;
	392
	393	// Take role definitions.
	394	$studentrole = $DB->get_record('role', array('shortname' => 'student'));
	395	$teacherrole = $DB->get_record('role', array('shortname' => 'teacher'));
	396
	397	// Create students and teachers.
	398	$student = $this->getDataGenerator()->create_user();
	399	$teacher = $this->getDataGenerator()->create_user();
	400	$course = $this->getDataGenerator()->create_course();
	401	$coursecontext = context_course::instance($course->id);
	402
	403	// Enroll students and teachers to course.
	404	$this->getDataGenerator()->enrol_user($student->id, $course->id, $studentrole->id);
	405	$this->getDataGenerator()->enrol_user($teacher->id, $course->id, $teacherrole->id);
	406
	407	// Generate notes.
	408	$gen = $this->getDataGenerator()->get_plugin_generator('core_notes');
	409	$this->setUser($teacher);
	410
	411	// NoteA1: on student (Course) by Teacher.
	412	$params = array('courseid' => $course->id, 'userid' => $student->id, 'publishstate' => NOTES_STATE_PUBLIC,
	413	'usermodified' => $teacher->id);
	414	$notea1 = $gen->create_instance($params);
	415
	416	$sink = $this->redirectEvents();
	417
	418	$result = core_notes_external::view_notes($course->id, $student->id);
	419	$result = external_api::clean_returnvalue(core_notes_external::view_notes_returns(), $result);
	420
	421	$result = core_notes_external::view_notes($course->id);
	422	$result = external_api::clean_returnvalue(core_notes_external::view_notes_returns(), $result);
	423
	424	$events = $sink->get_events();
	425
	426	$this->assertCount(2, $events);
	427
	428	$this->assertInstanceOf('\core\event\notes_viewed', $events[0]);
	429	$this->assertEquals($coursecontext, $events[0]->get_context());
	430	$this->assertEquals($student->id, $events[0]->relateduserid);
	431
	432	$this->assertInstanceOf('\core\event\notes_viewed', $events[1]);
	433	$this->assertEquals($coursecontext, $events[1]->get_context());
	434	$this->assertEquals(0, $events[1]->relateduserid);
	435
	436	try {
	437	core_notes_external::view_notes(0);
	438	$this->fail('Exception expected due to invalid permissions at system level.');
	439	} catch (moodle_exception $e) {
	440	$this->assertEquals('nopermissions', $e->errorcode);
	441	}
	442
	443	try {
	444	core_notes_external::view_notes($course->id, $student->id + 100);
	445	$this->fail('Exception expected due to invalid user id.');
	446	} catch (moodle_exception $e) {
447	$this->assertEquals('invaliduser', $e->errorcode);
448	}
449	}
4647b4d7	450	}