MDL-61944 tool_mobile: Implement Privacy API
[moodle.git] / admin / tool / mobile / tests / privacy_provider_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/>.
16 /**
17  * Base class for unit tests for tool_mobile.
18  *
19  * @package    tool_mobile
20  * @category   test
21  * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 defined('MOODLE_INTERNAL') || die();
26 use \core_privacy\local\request\writer;
27 use \core_privacy\local\request\transform;
28 use \core_privacy\local\request\approved_contextlist;
29 use \tool_mobile\privacy\provider;
31 /**
32  * Unit tests for the tool_mobile implementation of the privacy API.
33  *
34  * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class tool_mobile_privacy_testcase extends \core_privacy\tests\provider_testcase {
39     /**
40      * Basic setup for these tests.
41      */
42     public function setUp() {
43         $this->resetAfterTest(true);
44     }
46     /**
47      * Test to check export_user_preferences.
48      * returns user preferences data.
49      */
50     public function test_export_user_preferences() {
51         $user = $this->getDataGenerator()->create_user();
52         $expectedtime = time();
53         set_user_preference('tool_mobile_autologin_request_last', time(), $user);
54         provider::export_user_preferences($user->id);
55         $writer = writer::with_context(\context_system::instance());
56         $prefs = $writer->get_user_preferences('tool_mobile');
57         $time = transform::datetime($expectedtime);
58         $this->assertEquals($time, $prefs->tool_mobile_autologin_request_last->value);
59         $this->assertEquals(get_string('privacy:metadata:preference:tool_mobile_autologin_request_last', 'tool_mobile'),
60             $prefs->tool_mobile_autologin_request_last->description);
61     }
62     /**
63      * Test getting the context for the user ID related to this plugin.
64      */
65     public function test_get_contexts_for_userid() {
66         // Create user and Mobile user keys.
67         $user = $this->getDataGenerator()->create_user();
68         $context = \context_user::instance($user->id);
69         $key = get_user_key('tool_mobile', $user->id);
70         $contextlist = provider::get_contexts_for_userid($user->id);
71         $this->assertEquals($context->id, $contextlist->current()->id);
72     }
73     /**
74      * Test that data is exported correctly for this plugin.
75      */
76     public function test_export_user_data() {
77         global $DB;
78         // Create user and Mobile user keys.
79         $user = $this->getDataGenerator()->create_user();
80         $context = \context_user::instance($user->id);
81         $keyvalue = get_user_key('tool_mobile', $user->id);
82         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
83         // Validate exported data.
84         $this->setUser($user);
85         $writer = writer::with_context($context);
86         $this->assertFalse($writer->has_any_data());
87         $this->export_context_data_for_user($user->id, $context, 'tool_mobile');
88         $userkeydata = $writer->get_related_data([], 'userkeys');
89         $this->assertCount(1, $userkeydata->keys);
90         $this->assertEquals($key->script, reset($userkeydata->keys)->script);
91     }
92     /**
93      * Test for provider::delete_data_for_all_users_in_context().
94      */
95     public function test_delete_data_for_all_users_in_context() {
96         global $DB;
97         // Create user and Mobile user keys.
98         $user = $this->getDataGenerator()->create_user();
99         $context = \context_user::instance($user->id);
100         $keyvalue = get_user_key('tool_mobile', $user->id);
101         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
102         // Before deletion, we should have 1 user_private_key.
103         $count = $DB->count_records('user_private_key', ['script' => 'tool_mobile']);
104         $this->assertEquals(1, $count);
105         // Delete data.
106         provider::delete_data_for_all_users_in_context($context);
107         // After deletion, the user_private_key entries should have been deleted.
108         $count = $DB->count_records('user_private_key', ['script' => 'tool_mobile']);
109         $this->assertEquals(0, $count);
110     }
111     /**
112      * Test for provider::delete_data_for_user().
113      */
114     public function test_delete_data_for_user() {
115         global $DB;
116         // Create user and Mobile user keys.
117         $user = $this->getDataGenerator()->create_user();
118         $context = \context_user::instance($user->id);
119         $keyvalue = get_user_key('tool_mobile', $user->id);
120         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
121         // Before deletion, we should have 1 user_private_key.
122         $count = $DB->count_records('user_private_key', ['script' => 'tool_mobile']);
123         $this->assertEquals(1, $count);
124         // Delete data.
125         $contextlist = provider::get_contexts_for_userid($user->id);
126         $approvedcontextlist = new approved_contextlist($user, 'tool_mobile', $contextlist->get_contextids());
127         provider::delete_data_for_user($approvedcontextlist);
128         // After deletion, the user_private_key entries should have been deleted.
129         $count = $DB->count_records('user_private_key', ['script' => 'tool_mobile']);
130         $this->assertEquals(0, $count);
131     }