1fc46d4fded42b74fbd2b5abcfe4708ad77aeaed
[moodle.git] / rss / 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/>.
16 /**
17  * Base class for unit tests for core_rss.
18  *
19  * @package    core_rss
20  * @copyright  2018 Sara Arjona <sara@moodle.com>
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
24 defined('MOODLE_INTERNAL') || die();
26 use \core_privacy\tests\provider_testcase;
27 use \core_rss\privacy\provider;
28 use \core_privacy\local\request\writer;
29 use \core_privacy\local\request\approved_contextlist;
31 /**
32  * Unit tests for rss\classes\privacy\provider.php
33  *
34  * @copyright  2018 Sara Arjona <sara@moodle.com>
35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_rss_testcase extends provider_testcase {
39     /**
40      * Basic setup for these tests.
41      */
42     public function setUp() {
43         $this->resetAfterTest(true);
44     }
46     /**
47      * Test getting the context for the user ID related to this plugin.
48      */
49     public function test_get_contexts_for_userid() {
50         // Create user and RSS user keys.
51         $user = $this->getDataGenerator()->create_user();
52         $context = \context_user::instance($user->id);
53         $key = get_user_key('rss', $user->id);
55         $contextlist = provider::get_contexts_for_userid($user->id);
56         $this->assertEquals($context->id, $contextlist->current()->id);
57     }
59     /**
60      * Test that data is exported correctly for this plugin.
61      */
62     public function test_export_user_data() {
63         global $DB;
65         // Create user and RSS user keys.
66         $user = $this->getDataGenerator()->create_user();
67         $context = \context_user::instance($user->id);
68         $keyvalue = get_user_key('rss', $user->id);
69         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
71         // Validate exported data.
72         $this->setUser($user);
73         $writer = writer::with_context($context);
74         $this->assertFalse($writer->has_any_data());
75         $this->export_context_data_for_user($user->id, $context, 'core_rss');
76         $userkeydata = $writer->get_related_data([], 'userkeys');
77         $this->assertCount(1, $userkeydata->keys);
78         $this->assertEquals($key->script, reset($userkeydata->keys)->script);
79     }
81     /**
82      * Test for provider::delete_data_for_all_users_in_context().
83      */
84     public function test_delete_data_for_all_users_in_context() {
85         global $DB;
87         // Create user and RSS user keys.
88         $user = $this->getDataGenerator()->create_user();
89         $context = \context_user::instance($user->id);
90         $keyvalue = get_user_key('rss', $user->id);
91         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
93         // Before deletion, we should have 1 user_private_key.
94         $count = $DB->count_records('user_private_key', ['script' => 'rss']);
95         $this->assertEquals(1, $count);
97         // Delete data.
98         provider::delete_data_for_all_users_in_context($context);
100         // After deletion, the user_private_key entries should have been deleted.
101         $count = $DB->count_records('user_private_key', ['script' => 'rss']);
102         $this->assertEquals(0, $count);
103     }
105     /**
106      * Test for provider::delete_data_for_user().
107      */
108     public function test_delete_data_for_user() {
109         global $DB;
111         // Create user and RSS user keys.
112         $user = $this->getDataGenerator()->create_user();
113         $context = \context_user::instance($user->id);
114         $keyvalue = get_user_key('rss', $user->id);
115         $key = $DB->get_record('user_private_key', ['value' => $keyvalue]);
117         // Before deletion, we should have 1 user_private_key.
118         $count = $DB->count_records('user_private_key', ['script' => 'rss']);
119         $this->assertEquals(1, $count);
121         // Delete data.
122         $contextlist = provider::get_contexts_for_userid($user->id);
123         $approvedcontextlist = new approved_contextlist($user, 'rss', $contextlist->get_contextids());
124         provider::delete_data_for_user($approvedcontextlist);
126         // After deletion, the user_private_key entries should have been deleted.
127         $count = $DB->count_records('user_private_key', ['script' => 'rss']);
128         $this->assertEquals(0, $count);
129     }