MDL-62564 privacy: Add unit tests
[moodle.git] / admin / tool / dataprivacy / tests / user_deleted_observer_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  * Tests for the event observer.
19  *
20  * @package    tool_dataprivacy
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 \tool_dataprivacy\event\user_deleted_observer;
28 use \tool_dataprivacy\api;
30 /**
31  * Event observer test.
32  *
33  * @package    tool_dataprivacy
34  * @copyright  2018 Mihail Geshoski <mihail@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class tool_dataprivacy_user_deleted_observer_testcase extends advanced_testcase {
39     /**
40      * Ensure that a delete data request is created upon user deletion.
41      */
42     public function test_create_delete_data_request() {
43         $this->resetAfterTest();
45         // Enable automatic creation of delete data requests.
46         set_config('automaticdeletionrequests', 1, 'tool_dataprivacy');
48         // Create another user who is not a DPO.
49         $user = $this->getDataGenerator()->create_user();
51         $event = $this->trigger_delete_user_event($user);
53         user_deleted_observer::create_delete_data_request($event);
54         // Validate that delete data request has been created.
55         $this->assertTrue(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
56     }
58     /**
59      * Ensure that a delete data request is not created upon user deletion if automatic creation of
60      * delete data requests is disabled.
61      */
62     public function test_create_delete_data_request_automatic_creation_disabled() {
63         $this->resetAfterTest();
65         // Disable automatic creation of delete data requests.
66         set_config('automaticdeletionrequests', 0, 'tool_dataprivacy');
68         // Create another user who is not a DPO.
69         $user = $this->getDataGenerator()->create_user();
71         $event = $this->trigger_delete_user_event($user);
73         user_deleted_observer::create_delete_data_request($event);
74         // Validate that delete data request has been created.
75         $this->assertFalse(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
76     }
78     /**
79      * Ensure that a delete data request is being created upon user deletion
80      * if an ongoing export data request (or any other except delete data request) for that user already exists.
81      */
82     public function test_create_delete_data_request_export_data_request_preexists() {
83         $this->resetAfterTest();
85         // Enable automatic creation of delete data requests.
86         set_config('automaticdeletionrequests', 1, 'tool_dataprivacy');
88         // Create another user who is not a DPO.
89         $user = $this->getDataGenerator()->create_user();
90         // Create a delete data request for $user.
91         api::create_data_request($user->id, api::DATAREQUEST_TYPE_EXPORT);
92         // Validate that delete data request has been created.
93         $this->assertTrue(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_EXPORT));
94         $this->assertEquals(0, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
96         $event = $this->trigger_delete_user_event($user);
98         user_deleted_observer::create_delete_data_request($event);
99         // Validate that delete data request has been created.
100         $this->assertEquals(1, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
101     }
103     /**
104      * Ensure that a delete data request is not being created upon user deletion
105      * if an ongoing delete data request for that user already exists.
106      */
107     public function test_create_delete_data_request_ongoing_delete_data_request_preexists() {
108         $this->resetAfterTest();
110         // Enable automatic creation of delete data requests.
111         set_config('automaticdeletionrequests', 1, 'tool_dataprivacy');
113         // Create another user who is not a DPO.
114         $user = $this->getDataGenerator()->create_user();
115         // Create a delete data request for $user.
116         api::create_data_request($user->id, api::DATAREQUEST_TYPE_DELETE);
117         // Validate that delete data request has been created.
118         $this->assertTrue(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
120         $event = $this->trigger_delete_user_event($user);
122         user_deleted_observer::create_delete_data_request($event);
123         // Validate that additional delete data request has not been created.
124         $this->assertEquals(1, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
125     }
127     /**
128      * Ensure that a delete data request is being created upon user deletion
129      * if a finished delete data request (excluding complete) for that user already exists.
130      */
131     public function test_create_delete_data_request_canceled_delete_data_request_preexists() {
132         $this->resetAfterTest();
134         // Enable automatic creation of delete data requests.
135         set_config('automaticdeletionrequests', 1, 'tool_dataprivacy');
137         // Create another user who is not a DPO.
138         $user = $this->getDataGenerator()->create_user();
139         // Create a delete data request for $user.
140         $datarequest = api::create_data_request($user->id, api::DATAREQUEST_TYPE_DELETE);
141         $requestid = $datarequest->get('id');
142         api::update_request_status($requestid, api::DATAREQUEST_STATUS_CANCELLED);
144         // Validate that delete data request has been created and the status has been updated to 'Canceled'.
145         $this->assertEquals(1, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
146         $this->assertFalse(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
148         $event = $this->trigger_delete_user_event($user);
150         user_deleted_observer::create_delete_data_request($event);
151         // Validate that additional delete data request has been created.
152         $this->assertEquals(2, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
153         $this->assertTrue(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
154     }
156     /**
157      * Ensure that a delete data request is being created upon user deletion
158      * if a completed delete data request for that user already exists.
159      */
160     public function test_create_delete_data_request_completed_delete_data_request_preexists() {
161         $this->resetAfterTest();
163         // Enable automatic creation of delete data requests.
164         set_config('automaticdeletionrequests', 1, 'tool_dataprivacy');
166         // Create another user who is not a DPO.
167         $user = $this->getDataGenerator()->create_user();
168         // Create a delete data request for $user.
169         $datarequest = api::create_data_request($user->id, api::DATAREQUEST_TYPE_DELETE);
170         $requestid = $datarequest->get('id');
171         api::update_request_status($requestid, api::DATAREQUEST_STATUS_COMPLETE);
173         // Validate that delete data request has been created and the status has been updated to 'Completed'.
174         $this->assertEquals(1, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
175         $this->assertFalse(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
177         $event = $this->trigger_delete_user_event($user);
179         user_deleted_observer::create_delete_data_request($event);
180         // Validate that additional delete data request has not been created.
181         $this->assertEquals(1, api::get_data_requests_count($user->id, [], [api::DATAREQUEST_TYPE_DELETE]));
182         $this->assertFalse(api::has_ongoing_request($user->id, api::DATAREQUEST_TYPE_DELETE));
183     }
185     /**
186      * Helper to trigger and capture the delete user event.
187      *
188      * @param object $user The user object.
189      * @return \core\event\user_deleted $event The returned event.
190      */
191     private function trigger_delete_user_event($user) {
193         $sink = $this->redirectEvents();
194         delete_user($user);
195         $events = $sink->get_events();
196         $sink->close();
197         $event = reset($events);
198         // Validate event data.
199         $this->assertInstanceOf('\core\event\user_deleted', $event);
201         return $event;
202     }