MDL-62030 profilefield_menu: Add privacy files and unit tests
[moodle.git] / user / profile / field / menu / 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  * Base class for unit tests for profilefield_menu.
19  *
20  * @package    profilefield_menu
21  * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 defined('MOODLE_INTERNAL') || die();
27 use \core_privacy\tests\provider_testcase;
29 /**
30  * Unit tests for user\profile\field\menu\classes\privacy\provider.php
31  *
32  * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class profilefield_menu_testcase extends provider_testcase {
37     /**
38      * Basic setup for these tests.
39      */
40     public function setUp() {
41         $this->resetAfterTest(true);
42     }
44     /**
45      * Test getting the context for the user ID related to this plugin.
46      */
47     public function test_get_contexts_for_userid() {
48         global $DB;
49         // Create profile category.
50         $categoryid = $this->add_profile_category();
51         // Create profile field.
52         $profilefieldid = $this->add_profile_field($categoryid, 'menu');
53         // Create a user.
54         $user = $this->getDataGenerator()->create_user();
55         $this->add_user_info_data($user->id, $profilefieldid, 'test data');
56         // Get the field that was created.
57         $userfielddata = $DB->get_records('user_info_data', array('userid' => $user->id));
58         // Confirm we got the right number of user field data.
59         $this->assertCount(1, $userfielddata);
60         $context = context_user::instance($user->id);
61         $contextlist = \profilefield_menu\privacy\provider::get_contexts_for_userid($user->id);
62         $this->assertEquals($context, $contextlist->current());
63     }
65     /**
66      * Test that data is exported correctly for this plugin.
67      */
68     public function test_export_user_data() {
69         // Create profile category.
70         $categoryid = $this->add_profile_category();
71         // Create menu profile field.
72         $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
73         // Create checkbox profile field.
74         $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
75         // Create a user.
76         $user = $this->getDataGenerator()->create_user();
77         $context = context_user::instance($user->id);
78         // Add menu user info data.
79         $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
80         // Add checkbox user info data.
81         $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
82         $writer = \core_privacy\local\request\writer::with_context($context);
83         $this->assertFalse($writer->has_any_data());
84         $this->export_context_data_for_user($user->id, $context, 'profilefield_menu');
85         $data = $writer->get_data([get_string('pluginname', 'profilefield_menu')]);
86         $this->assertCount(3, (array) $data);
87         $this->assertEquals('Test field', $data->name);
88         $this->assertEquals('This is a test.', $data->description);
89         $this->assertEquals('test menu', $data->data);
90     }
92     /**
93      * Test that user data is deleted using the context.
94      */
95     public function test_delete_data_for_all_users_in_context() {
96         global $DB;
97         // Create profile category.
98         $categoryid = $this->add_profile_category();
99         // Create menu profile field.
100         $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
101         // Create checkbox profile field.
102         $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
103         // Create a user.
104         $user = $this->getDataGenerator()->create_user();
105         $context = context_user::instance($user->id);
106         // Add menu user info data.
107         $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
108         // Add checkbox user info data.
109         $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
110         // Check that we have two entries.
111         $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
112         $this->assertCount(2, $userinfodata);
113         \profilefield_menu\privacy\provider::delete_data_for_all_users_in_context($context);
114         // Check that the correct profile field has been deleted.
115         $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
116         $this->assertCount(1, $userinfodata);
117         $this->assertNotEquals('test menu', reset($userinfodata)->data);
118     }
120     /**
121      * Test that user data is deleted for this user.
122      */
123     public function test_delete_data_for_user() {
124         global $DB;
125         // Create profile category.
126         $categoryid = $this->add_profile_category();
127         // Create menu profile field.
128         $menuprofilefieldid = $this->add_profile_field($categoryid, 'menu');
129         // Create checkbox profile field.
130         $checkboxprofilefieldid = $this->add_profile_field($categoryid, 'checkbox');
131         // Create a user.
132         $user = $this->getDataGenerator()->create_user();
133         $context = context_user::instance($user->id);
134         // Add menu user info data.
135         $this->add_user_info_data($user->id, $menuprofilefieldid, 'test menu');
136         // Add checkbox user info data.
137         $this->add_user_info_data($user->id, $checkboxprofilefieldid, 'test data');
138         // Check that we have two entries.
139         $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
140         $this->assertCount(2, $userinfodata);
141         $approvedlist = new \core_privacy\local\request\approved_contextlist($user, 'profilefield_menu',
142             [$context->id]);
143         \profilefield_menu\privacy\provider::delete_data_for_user($approvedlist);
144         // Check that the correct profile field has been deleted.
145         $userinfodata = $DB->get_records('user_info_data', ['userid' => $user->id]);
146         $this->assertCount(1, $userinfodata);
147         $this->assertNotEquals('test menu', reset($userinfodata)->data);
148     }
150     /**
151      * Add dummy user info data.
152      *
153      * @param int $userid The ID of the user
154      * @param int $fieldid The ID of the field
155      * @param string $data The data
156      */
157     private function add_user_info_data($userid, $fieldid, $data) {
158         global $DB;
160         $userinfodata = array(
161             'userid' => $userid,
162             'fieldid' => $fieldid,
163             'data' => $data,
164             'dataformat' => 0
165         );
167         $DB->insert_record('user_info_data', $userinfodata);
168     }
170     /**
171      * Add dummy profile category.
172      *
173      * @return int The ID of the profile category
174      */
175     private function add_profile_category() {
176         global $DB;
177         // Create a new profile category.
178         $cat = new stdClass();
179         $cat->name = 'Test category';
180         $cat->sortorder = 1;
182         return $DB->insert_record('user_info_category', $cat);
183     }
185     /**
186      * Add dummy profile field.
187      *
188      * @param int $categoryid The ID of the profile category
189      * @param string $datatype The datatype of the profile field
190      * @return int The ID of the profile field
191      */
192     private function add_profile_field($categoryid, $datatype) {
193         global $DB;
194         // Create a new profile field.
195         $data = new stdClass();
196         $data->datatype = $datatype;
197         $data->shortname = 'tstField';
198         $data->name = 'Test field';
199         $data->description = 'This is a test.';
200         $data->required = false;
201         $data->locked = false;
202         $data->forceunique = false;
203         $data->signup = false;
204         $data->visible = '0';
205         $data->categoryid = $categoryid;
207         return $DB->insert_record('user_info_field', $data);
208     }