MDL-61882 auth_oauth2: Implement Privacy API
[moodle.git] / auth / oauth2 / 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  * Privacy test for the authentication oauth2
18  *
19  * @package    auth_oauth2
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  */
25 defined('MOODLE_INTERNAL') || die();
27 use \auth_oauth2\privacy\provider;
28 use \core_privacy\local\request\approved_contextlist;
29 use \core_privacy\local\request\writer;
30 use \core_privacy\tests\provider_testcase;
32 /**
33  * Privacy test for the authentication oauth2
34  *
35  * @package    auth_oauth2
36  * @category   test
37  * @copyright  2018 Carlos Escobedo <carlos@moodle.com>
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class auth_oauth2_privacy_testcase extends provider_testcase {
41     /**
42      * Set up method.
43      */
44     public function setUp() {
45         $this->resetAfterTest();
46         $this->setAdminUser();
47     }
49     /**
50      * Check that a user context is returned if there is any user data for this user.
51      */
52     public function test_get_contexts_for_userid() {
53         $user = $this->getDataGenerator()->create_user();
54         $this->assertEmpty(provider::get_contexts_for_userid($user->id));
56         $issuer = \core\oauth2\api::create_standard_issuer('google');
57         $info = [];
58         $info['username'] = 'gina';
59         $info['email'] = 'gina@example.com';
60         \auth_oauth2\api::link_login($info, $issuer, $user->id, false);
62         $contextlist = provider::get_contexts_for_userid($user->id);
63         // Check that we only get back one context.
64         $this->assertCount(1, $contextlist);
66         // Check that a context is returned is the expected.
67         $usercontext = \context_user::instance($user->id);
68         $this->assertEquals($usercontext->id, $contextlist->get_contextids()[0]);
69     }
71     /**
72      * Test that user data is exported correctly.
73      */
74     public function test_export_user_data() {
75         $user = $this->getDataGenerator()->create_user();
76         $issuer = \core\oauth2\api::create_standard_issuer('google');
77         $info = [];
78         $info['username'] = 'gina';
79         $info['email'] = 'gina@example.com';
80         \auth_oauth2\api::link_login($info, $issuer, $user->id, false);
81         $usercontext = \context_user::instance($user->id);
83         $writer = writer::with_context($usercontext);
84         $this->assertFalse($writer->has_any_data());
85         $approvedlist = new approved_contextlist($user, 'auth_oauth2', [$usercontext->id]);
86         provider::export_user_data($approvedlist);
87         $data = $writer->get_data([get_string('privacy:metadata:auth_oauth2', 'auth_oauth2'), $issuer->get('name')]);
88         $this->assertEquals($info['username'], $data->username);
89         $this->assertEquals($info['email'], $data->email);
90     }
92     /**
93      * Test deleting all user data for a specific context.
94      */
95     public function test_delete_data_for_all_users_in_context() {
96         global $DB;
98         $user1 = $this->getDataGenerator()->create_user();
99         $issuer1 = \core\oauth2\api::create_standard_issuer('google');
100         $info = [];
101         $info['username'] = 'gina';
102         $info['email'] = 'gina@example.com';
103         \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false);
104         $user1context = \context_user::instance($user1->id);
106         $user2 = $this->getDataGenerator()->create_user();
107         $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft');
108         $info = [];
109         $info['username'] = 'jerry';
110         $info['email'] = 'jerry@example.com';
111         \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false);
112         $user2context = \context_user::instance($user2->id);
114         // Get all oauth2 accounts.
115         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array());
116         // There should be two.
117         $this->assertCount(2, $oauth2accounts);
119         // Delete everything for the first user context.
120         provider::delete_data_for_all_users_in_context($user1context);
122         // Get all oauth2 accounts match with user1.
123         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', ['userid' => $user1->id]);
124         $this->assertCount(0, $oauth2accounts);
126         // Get all oauth2 accounts.
127         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array());
128         // There should be one.
129         $this->assertCount(1, $oauth2accounts);
130     }
132     /**
133      * This should work identical to the above test.
134      */
135     public function test_delete_data_for_user() {
136         global $DB;
138         $user1 = $this->getDataGenerator()->create_user();
139         $issuer1 = \core\oauth2\api::create_standard_issuer('google');
140         $info = [];
141         $info['username'] = 'gina';
142         $info['email'] = 'gina@example.com';
143         \auth_oauth2\api::link_login($info, $issuer1, $user1->id, false);
144         $user1context = \context_user::instance($user1->id);
146         $user2 = $this->getDataGenerator()->create_user();
147         $issuer2 = \core\oauth2\api::create_standard_issuer('microsoft');
148         $info = [];
149         $info['username'] = 'jerry';
150         $info['email'] = 'jerry@example.com';
151         \auth_oauth2\api::link_login($info, $issuer2, $user2->id, false);
152         $user2context = \context_user::instance($user2->id);
154         // Get all oauth2 accounts.
155         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array());
156         // There should be two.
157         $this->assertCount(2, $oauth2accounts);
159         // Delete everything for the first user.
160         $approvedlist = new approved_contextlist($user1, 'auth_oauth2', [$user1context->id]);
161         provider::delete_data_for_user($approvedlist);
163         // Get all oauth2 accounts match with user1.
164         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', ['userid' => $user1->id]);
165         $this->assertCount(0, $oauth2accounts);
167         // Get all oauth2 accounts.
168         $oauth2accounts = $DB->get_records('auth_oauth2_linked_login', array());
169         // There should be one user.
170         $this->assertCount(1, $oauth2accounts);
171     }