MDL-61308 assign_feedback: Privacy code for user rights.
[moodle.git] / mod / assign / feedback / comments / tests / privacy_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  * Unit tests for assignfeedback_comments.
19  *
20  * @package    assignfeedback_comments
21  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 global $CFG;
28 require_once($CFG->dirroot . '/mod/assign/locallib.php');
29 require_once($CFG->dirroot . '/mod/assign/tests/privacy_test.php');
31 /**
32  * Unit tests for mod/assign/feedback/comments/classes/privacy/
33  *
34  * @copyright  2018 Adrian Greeve <adrian@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class assignfeedback_comments_privacy_testcase extends \mod_assign\tests\mod_assign_privacy_testcase {
39     /**
40      * Convenience function for creating feedback data.
41      *
42      * @param  object   $assign         assign object
43      * @param  stdClass $student        user object
44      * @param  stdClass $teacher        user object
45      * @param  string   $submissiontext Submission text
46      * @param  string   $feedbacktext   Feedback text
47      * @return array   Feedback plugin object and the grade object.
48      */
49     protected function create_feedback($assign, $student, $teacher, $submissiontext, $feedbacktext) {
50         $submission = new \stdClass();
51         $submission->assignment = $assign->get_instance()->id;
52         $submission->userid = $student->id;
53         $submission->timecreated = time();
54         $submission->onlinetext_editor = ['text' => $submissiontext,
55                                          'format' => FORMAT_MOODLE];
57         $this->setUser($student);
58         $notices = [];
59         $assign->save_submission($submission, $notices);
61         $grade = $assign->get_user_grade($student->id, true);
63         $this->setUser($teacher);
65         $plugin = $assign->get_feedback_plugin_by_type('comments');
66         $feedbackdata = new \stdClass();
67         $feedbackdata->assignfeedbackcomments_editor = [
68             'text' => $feedbacktext,
69             'format' => 1
70         ];
72         $plugin->save($grade, $feedbackdata);
73         return [$plugin, $grade];
74     }
76     /**
77      * Quick test to make sure that get_metadata returns something.
78      */
79     public function test_get_metadata() {
80         $collection = new \core_privacy\local\metadata\collection('assignfeedback_comments');
81         $collection = \assignfeedback_comments\privacy\provider::get_metadata($collection);
82         $this->assertNotEmpty($collection);
83     }
85     /**
86      * Test that feedback comments are exported for a user.
87      */
88     public function test_export_feedback_user_data() {
89         $this->resetAfterTest();
91         // Create course, assignment, submission, and then a feedback comment.
92         $course = $this->getDataGenerator()->create_course();
93         // Student.
94         $user1 = $this->getDataGenerator()->create_user();
95         // Teacher.
96         $user2 = $this->getDataGenerator()->create_user();
97         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
98         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'editingteacher');
99         $assign = $this->create_instance(['course' => $course]);
101         $context = $assign->get_context();
103         $feedbacktext = '<p>first comment for this test</p>';
104         list($plugin, $grade) = $this->create_feedback($assign, $user1, $user2, 'Submission text', $feedbacktext);
106         $writer = \core_privacy\local\request\writer::with_context($context);
107         $this->assertFalse($writer->has_any_data());
109         // The student should be able to see the teachers feedback.
110         $exportdata = new \mod_assign\privacy\assign_plugin_request_data($context, $assign, $grade, [], $user1);
111         \assignfeedback_comments\privacy\provider::export_feedback_user_data($exportdata);
112         $this->assertEquals($feedbacktext, $writer->get_data(['Feedback comments'])->commenttext);
114         // The teacher should also be able to see the feedback that they provided.
115         $exportdata = new \mod_assign\privacy\assign_plugin_request_data($context, $assign, $grade, [], $user2);
116         \assignfeedback_comments\privacy\provider::export_feedback_user_data($exportdata);
117         $this->assertEquals($feedbacktext, $writer->get_data(['Feedback comments'])->commenttext);
118     }
120     /**
121      * Test that all feedback is deleted for a context.
122      */
123     public function test_delete_feedback_for_context() {
124         $this->resetAfterTest();
125         // Create course, assignment, submission, and then a feedback comment.
126         $course = $this->getDataGenerator()->create_course();
127         // Student.
128         $user1 = $this->getDataGenerator()->create_user();
129         $user2 = $this->getDataGenerator()->create_user();
130         // Teacher.
131         $user3 = $this->getDataGenerator()->create_user();
132         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
133         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
134         $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'editingteacher');
135         $assign = $this->create_instance(['course' => $course]);
137         $context = $assign->get_context();
139         $feedbacktext = '<p>first comment for this test</p>';
140         list($plugin1, $grade1) = $this->create_feedback($assign, $user1, $user3, 'Submission text', $feedbacktext);
141         $feedbacktext = '<p>Comment for second student.</p>';
142         list($plugin2, $grade2) = $this->create_feedback($assign, $user2, $user3, 'Submission text', $feedbacktext);
144         // Check that we have data.
145         $feedbackcomments = $plugin1->get_feedback_comments($grade1->id);
146         $this->assertNotEmpty($feedbackcomments);
147         $feedbackcomments = $plugin1->get_feedback_comments($grade2->id);
148         $this->assertNotEmpty($feedbackcomments);
150         // Delete all comments for this context.
151         $requestdata = new \mod_assign\privacy\assign_plugin_request_data($context, $assign);
152         assignfeedback_comments\privacy\provider::delete_feedback_for_context($requestdata);
154         // Check that the data is now gone.
155         $feedbackcomments = $plugin1->get_feedback_comments($grade1->id);
156         $this->assertEmpty($feedbackcomments);
157         $feedbackcomments = $plugin1->get_feedback_comments($grade2->id);
158         $this->assertEmpty($feedbackcomments);
159     }
161     /**
162      * Test that a grade item is deleted for a user.
163      */
164     public function test_delete_feedback_for_grade() {
165         $this->resetAfterTest();
166         // Create course, assignment, submission, and then a feedback comment.
167         $course = $this->getDataGenerator()->create_course();
168         // Student.
169         $user1 = $this->getDataGenerator()->create_user();
170         $user2 = $this->getDataGenerator()->create_user();
171         // Teacher.
172         $user3 = $this->getDataGenerator()->create_user();
173         $this->getDataGenerator()->enrol_user($user1->id, $course->id, 'student');
174         $this->getDataGenerator()->enrol_user($user2->id, $course->id, 'student');
175         $this->getDataGenerator()->enrol_user($user3->id, $course->id, 'editingteacher');
176         $assign = $this->create_instance(['course' => $course]);
178         $context = $assign->get_context();
180         $feedbacktext = '<p>first comment for this test</p>';
181         list($plugin1, $grade1) = $this->create_feedback($assign, $user1, $user3, 'Submission text', $feedbacktext);
182         $feedbacktext = '<p>Comment for second student.</p>';
183         list($plugin2, $grade2) = $this->create_feedback($assign, $user2, $user3, 'Submission text', $feedbacktext);
185         // Check that we have data.
186         $feedbackcomments = $plugin1->get_feedback_comments($grade1->id);
187         $this->assertNotEmpty($feedbackcomments);
188         $feedbackcomments = $plugin1->get_feedback_comments($grade2->id);
189         $this->assertNotEmpty($feedbackcomments);
191         // Delete all comments for this grade object.
192         $requestdata = new \mod_assign\privacy\assign_plugin_request_data($context, $assign, $grade1, [], $user1);
193         assignfeedback_comments\privacy\provider::delete_feedback_for_grade($requestdata);
195         // These comments should be empty.
196         $feedbackcomments = $plugin1->get_feedback_comments($grade1->id);
197         $this->assertEmpty($feedbackcomments);
199         // These comments should not.
200         $feedbackcomments = $plugin1->get_feedback_comments($grade2->id);
201         $this->assertNotEmpty($feedbackcomments);
202     }