d2e118cbecad2da8643edc1ce2463ed6d1ac2a56
[moodle.git] / grade / grading / form / guide / 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  * Privacy tests for gradingform_guide.
19  *
20  * @package    gradingform_guide
21  * @category   test
22  * @copyright  2018 Sara Arjona <sara@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 global $CFG;
29 require_once($CFG->dirroot . '/grade/grading/tests/fixtures/marking_guide.php');
31 use \core_privacy\tests\provider_testcase;
32 use \core_privacy\local\request\writer;
33 use \gradingform_guide\privacy\provider;
35 /**
36  * Privacy tests for gradingform_guide.
37  *
38  * @copyright  2018 Sara Arjona <sara@moodle.com>
39  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
40  */
41 class gradingform_guide_privacy_testcase extends provider_testcase {
43     /**
44      * Ensure that export_user_preferences returns no data if the user has no data.
45      */
46     public function test_export_user_preferences_not_defined() {
47         $user = \core_user::get_user_by_username('admin');
48         provider::export_user_preferences($user->id);
50         $writer = writer::with_context(\context_system::instance());
51         $this->assertFalse($writer->has_any_data());
52     }
54     /**
55      * Ensure that export_user_preferences returns single preferences.
56      */
57     public function test_export_user_preferences() {
58         $this->resetAfterTest();
60         // Define a user preference.
61         $user = $this->getDataGenerator()->create_user();
62         $this->setUser($user);
63         set_user_preference('gradingform_guide-showmarkerdesc', 0, $user);
64         set_user_preference('gradingform_guide-showstudentdesc', 1, $user);
66         // Validate exported data.
67         provider::export_user_preferences($user->id);
68         $context = context_user::instance($user->id);
69         $writer = writer::with_context($context);
70         $this->assertTrue($writer->has_any_data());
71         $prefs = $writer->get_user_preferences('gradingform_guide');
72         $this->assertCount(2, (array) $prefs);
73         $this->assertEquals(
74             get_string('privacy:metadata:preference:showstudentdesc', 'gradingform_guide'),
75             $prefs->{'gradingform_guide-showstudentdesc'}->description
76         );
77         $this->assertEquals(get_string('no'), $prefs->{'gradingform_guide-showmarkerdesc'}->value);
78         $this->assertEquals(get_string('yes'), $prefs->{'gradingform_guide-showstudentdesc'}->value);
79     }
81     /**
82      * Test the export of rubric data.
83      */
84     public function test_get_gradingform_export_data() {
85         global $DB;
86         $this->resetAfterTest();
87         $course = $this->getDataGenerator()->create_course();
88         $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]);
89         $user = $this->getDataGenerator()->create_user();
91         $this->setUser($user);
93         $modulecontext = context_module::instance($module->cmid);
94         $guide = new test_guide($modulecontext, 'testrubrib', 'Description text');
95         $guide->add_criteria(
96             'Spelling mistakes',
97             'Full marks will be given for no spelling mistakes.',
98             'Deduct 5 points per spelling mistake made.',
99             25
100         );
101         $guide->add_criteria(
102             'Pictures',
103             'Full marks will be given for including 3 pictures.',
104             'Give 5 points for each picture present',
105             15
106         );
107         $guide->create_guide();
109         $controller = $guide->manager->get_controller('guide');
110         // In the situation of mod_assign this would be the id from assign_grades.
111         $itemid = 1;
112         $instance = $controller->create_instance($user->id, $itemid);
113         // I need the ids for the criteria and there doesn't seem to be a nice method to get it.
114         $criteria = $DB->get_records('gradingform_guide_criteria');
115         $data = ['criteria' => []];
116         foreach ($criteria as $key => $value) {
117             if ($value->shortname == 'Spelling mistakes') {
118                 $data['criteria'][$key]['remark'] = 'This user made several mistakes.';
119                 $data['criteria'][$key]['remarkformat'] = 0;
120                 $data['criteria'][$key]['score'] = 5;
121             } else {
122                 $data['criteria'][$key]['remark'] = 'This user has two pictures.';
123                 $data['criteria'][$key]['remarkformat'] = 0;
124                 $data['criteria'][$key]['score'] = 10;
125             }
126         }
127         $data['itemid'] = $itemid;
129         // Update this instance with data.
130         $instance->update($data);
131         $instanceid = $instance->get_data('id');
133         // Let's try the method we are testing.
134         provider::export_gradingform_instance_data($modulecontext, $instance->get_id(), ['Test']);
135         $data = (array) writer::with_context($modulecontext)->get_data(['Test', 'Marking guide', $instanceid]);
136         $this->assertCount(2, $data);
137         $this->assertEquals('Spelling mistakes', $data['Spelling mistakes']->shortname);
138         $this->assertEquals('This user made several mistakes.', $data['Spelling mistakes']->remark);
139         $this->assertEquals('Pictures', $data['Pictures']->shortname);
140         $this->assertEquals('This user has two pictures.', $data['Pictures']->remark);
141     }
143     /**
144      * Test the deletion of rubric user information via the instance ID.
145      */
146     public function test_delete_gradingform_for_instances() {
147         global $DB;
148         $this->resetAfterTest();
149         $course = $this->getDataGenerator()->create_course();
150         $module = $this->getDataGenerator()->create_module('assign', ['course' => $course]);
151         $user = $this->getDataGenerator()->create_user();
153         $this->setUser($user);
155         $modulecontext = context_module::instance($module->cmid);
156         $guide = new test_guide($modulecontext, 'testrubrib', 'Description text');
157         $guide->add_criteria(
158             'Spelling mistakes',
159             'Full marks will be given for no spelling mistakes.',
160             'Deduct 5 points per spelling mistake made.',
161             25
162         );
163         $guide->add_criteria(
164             'Pictures',
165             'Full marks will be given for including 3 pictures.',
166             'Give 5 points for each picture present',
167             15
168         );
169         $guide->create_guide();
171         $controller = $guide->manager->get_controller('guide');
172         // In the situation of mod_assign this would be the id from assign_grades.
173         $itemid = 1;
174         $instance = $controller->create_instance($user->id, $itemid);
175         // I need the ids for the criteria and there doesn't seem to be a nice method to get it.
176         $criteria = $DB->get_records('gradingform_guide_criteria');
177         $data = ['criteria' => []];
178         foreach ($criteria as $key => $value) {
179             if ($value->shortname == 'Spelling mistakes') {
180                 $data['criteria'][$key]['remark'] = 'This user made several mistakes.';
181                 $data['criteria'][$key]['remarkformat'] = 0;
182                 $data['criteria'][$key]['score'] = 5;
183             } else {
184                 $data['criteria'][$key]['remark'] = 'This user has two pictures.';
185                 $data['criteria'][$key]['remarkformat'] = 0;
186                 $data['criteria'][$key]['score'] = 10;
187             }
188         }
189         $data['itemid'] = $itemid;
191         // Update this instance with data.
192         $instance->update($data);
194         $itemid = 2;
195         $instance = $controller->create_instance($user->id, $itemid);
196         // I need the ids for the criteria and there doesn't seem to be a nice method to get it.
197         $criteria = $DB->get_records('gradingform_guide_criteria');
198         $data = ['criteria' => []];
199         foreach ($criteria as $key => $value) {
200             if ($value->shortname == 'Spelling mistakes') {
201                 $data['criteria'][$key]['remark'] = 'This user made no mistakes.';
202                 $data['criteria'][$key]['remarkformat'] = 0;
203                 $data['criteria'][$key]['score'] = 25;
204             } else {
205                 $data['criteria'][$key]['remark'] = 'This user has one pictures.';
206                 $data['criteria'][$key]['remarkformat'] = 0;
207                 $data['criteria'][$key]['score'] = 5;
208             }
209         }
210         $data['itemid'] = $itemid;
212         // Update this instance with data.
213         $instance->update($data);
215         // Check how many records we have in the fillings table.
216         $records = $DB->get_records('gradingform_guide_fillings');
217         $this->assertCount(4, $records);
218         // Let's delete one of the instances (the last one would be the easiest).
219         provider::delete_gradingform_for_instances([$instance->get_id()]);
220         $records = $DB->get_records('gradingform_guide_fillings');
221         $this->assertCount(2, $records);
222         foreach ($records as $record) {
223             $this->assertNotEquals($instance->get_id(), $record->instanceid);
224         }
225     }