MDL-61407 mod_quiz: Add initial privacy implementation
[moodle.git] / mod / quiz / tests / privacy_legacy_quizaccess_polyfill_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  * Unit tests for the privacy legacy polyfill for quiz access rules.
19  *
20  * @package     mod_quiz
21  * @category    test
22  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
23  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
26 defined('MOODLE_INTERNAL') || die();
28 global $CFG;
29 require_once($CFG->dirroot . '/mod/quiz/attemptlib.php');
31 /**
32  * Unit tests for the privacy legacy polyfill for quiz access rules.
33  *
34  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
35  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
36  */
37 class core_privacy_legacy_quizaccess_polyfill_test extends advanced_testcase {
38     /**
39      * Test that the core_quizaccess\privacy\legacy_polyfill works and that the static _export_quizaccess_user_data can
40      * be called.
41      */
42     public function test_export_quizaccess_user_data() {
43         $quiz = $this->createMock(quiz::class);
44         $user = (object) [];
45         $returnvalue = (object) [];
47         $mock = $this->createMock(test_privacy_legacy_quizaccess_polyfill_mock_wrapper::class);
48         $mock->expects($this->once())
49             ->method('get_return_value')
50             ->with('_export_quizaccess_user_data', [$quiz, $user])
51             ->willReturn($returnvalue);
53         test_privacy_legacy_quizaccess_polyfill_provider::$mock = $mock;
54         $result = test_privacy_legacy_quizaccess_polyfill_provider::export_quizaccess_user_data($quiz, $user);
55         $this->assertSame($returnvalue, $result);
56     }
58     /**
59      * Test the _delete_quizaccess_for_context shim.
60      */
61     public function test_delete_quizaccess_for_context() {
62         $context = context_system::instance();
64         $quiz = $this->createMock(quiz::class);
66         $mock = $this->createMock(test_privacy_legacy_quizaccess_polyfill_mock_wrapper::class);
67         $mock->expects($this->once())
68             ->method('get_return_value')
69             ->with('_delete_quizaccess_data_for_all_users_in_context', [$quiz]);
71         test_privacy_legacy_quizaccess_polyfill_provider::$mock = $mock;
72         test_privacy_legacy_quizaccess_polyfill_provider::delete_quizaccess_data_for_all_users_in_context($quiz);
73     }
75     /**
76      * Test the _delete_quizaccess_for_context shim.
77      */
78     public function test_delete_quizaccess_for_user() {
79         $context = context_system::instance();
81         $quiz = $this->createMock(quiz::class);
82         $user = (object) [];
84         $mock = $this->createMock(test_privacy_legacy_quizaccess_polyfill_mock_wrapper::class);
85         $mock->expects($this->once())
86             ->method('get_return_value')
87             ->with('_delete_quizaccess_data_for_user', [$quiz, $user]);
89         test_privacy_legacy_quizaccess_polyfill_provider::$mock = $mock;
90         test_privacy_legacy_quizaccess_polyfill_provider::delete_quizaccess_data_for_user($quiz, $user);
91     }
92 }
94 /**
95  * Legacy polyfill test class for the quizaccess_provider.
96  *
97  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
98  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
99  */
100 class test_privacy_legacy_quizaccess_polyfill_provider implements
101         \core_privacy\local\metadata\provider,
102         \mod_quiz\privacy\quizaccess_provider {
104     use \mod_quiz\privacy\legacy_quizaccess_polyfill;
105     use \core_privacy\local\legacy_polyfill;
107     /**
108      * @var test_privacy_legacy_quizaccess_polyfill_provider $mock.
109      */
110     public static $mock = null;
112     /**
113      * Export all user data for the quizaccess plugin.
114      *
115      * @param \quiz $quiz
116      * @param \stdClass $user
117      */
118     protected static function _export_quizaccess_user_data($quiz, $user) {
119         return static::$mock->get_return_value(__FUNCTION__, func_get_args());
120     }
122     /**
123      * Deletes all user data for the given context.
124      *
125      * @param \quiz $quiz
126      */
127     protected static function _delete_quizaccess_data_for_all_users_in_context($quiz) {
128         static::$mock->get_return_value(__FUNCTION__, func_get_args());
129     }
131     /**
132      * Delete personal data for the given user and context.
133      *
134      * @param   \quiz           $quiz The quiz being deleted
135      * @param   \stdClass       $user The user to export data for
136      */
137     protected static function _delete_quizaccess_data_for_user($quiz, $user) {
138         static::$mock->get_return_value(__FUNCTION__, func_get_args());
139     }
141     /**
142      * Returns metadata about this plugin.
143      *
144      * @param   \core_privacy\local\metadata\collection $collection The initialised collection to add items to.
145      * @return  \core_privacy\local\metadata\collection     A listing of user data stored through this system.
146      */
147     protected static function _get_metadata(\core_privacy\local\metadata\collection $collection) {
148         return $collection;
149     }
152 /**
153  * Called inside the polyfill methods in the test polyfill provider, allowing us to ensure these are called with correct params.
154  *
155  * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
156  * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
157  */
158 class test_privacy_legacy_quizaccess_polyfill_mock_wrapper {
159     /**
160      * Get the return value for the specified item.
161      */
162     public function get_return_value() {
163     }