You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
227 lines
8.7 KiB
227 lines
8.7 KiB
<?php
|
|
// This file is part of Moodle - http://moodle.org/
|
|
//
|
|
// Moodle is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// Moodle is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU General Public License
|
|
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
/**
|
|
* Unit tests for the privacy legacy polyfill for gradingform.
|
|
*
|
|
* @package core_grading
|
|
* @category test
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
/**
|
|
* Unit tests for the Grading API's privacy legacy_polyfill.
|
|
*
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class gradeform_privacy_legacy_polyfill_test extends advanced_testcase {
|
|
/**
|
|
* Test that the core_grading\privacy\legacy_polyfill works and that the static _export_gradingform_instance_data can be called.
|
|
*/
|
|
public function test_export_gradingform_instance_data() {
|
|
$context = context_system::instance();
|
|
|
|
$mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class);
|
|
$mock->expects($this->once())
|
|
->method('get_return_value')
|
|
->with('_export_gradingform_instance_data', [$context, 3, ['subcontext']]);
|
|
|
|
test_legacy_polyfill_gradingform_provider::$mock = $mock;
|
|
test_legacy_polyfill_gradingform_provider::export_gradingform_instance_data($context, 3, ['subcontext']);
|
|
}
|
|
|
|
/**
|
|
* Test for _get_metadata shim.
|
|
*/
|
|
public function test_get_metadata() {
|
|
$collection = new \core_privacy\local\metadata\collection('core_gradingform');
|
|
$this->assertSame($collection, test_legacy_polyfill_gradingform_provider::get_metadata($collection));
|
|
}
|
|
|
|
/**
|
|
* Test the _delete_gradingform_for_instances shim.
|
|
*/
|
|
public function test_delete_gradingform_for_instances() {
|
|
$context = context_system::instance();
|
|
|
|
$mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class);
|
|
$mock->expects($this->once())
|
|
->method('get_return_value')
|
|
->with('_delete_gradingform_for_instances', [[3, 17]]);
|
|
|
|
test_legacy_polyfill_gradingform_provider::$mock = $mock;
|
|
test_legacy_polyfill_gradingform_provider::delete_gradingform_for_instances([3, 17]);
|
|
}
|
|
|
|
/**
|
|
* Test the __get_gradingform_export_data shim.
|
|
*/
|
|
public function test_get_gradingform_export_data() {
|
|
$userid = 476;
|
|
$context = context_system::instance();
|
|
|
|
$mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class);
|
|
$mock->expects($this->once())
|
|
->method('get_return_value')
|
|
->with('_get_gradingform_export_data', [$context, (object)[], $userid]);
|
|
|
|
test_legacy_polyfill_gradingform_provider::$mock = $mock;
|
|
test_legacy_polyfill_gradingform_provider::get_gradingform_export_data($context, (object)[], $userid);
|
|
$this->assertDebuggingCalled();
|
|
}
|
|
|
|
/**
|
|
* Test the _delete_gradingform_for_context shim.
|
|
*/
|
|
public function test_delete_gradingform_for_context() {
|
|
$context = context_system::instance();
|
|
|
|
$mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class);
|
|
$mock->expects($this->once())
|
|
->method('get_return_value')
|
|
->with('_delete_gradingform_for_context', [$context]);
|
|
|
|
test_legacy_polyfill_gradingform_provider::$mock = $mock;
|
|
test_legacy_polyfill_gradingform_provider::delete_gradingform_for_context($context);
|
|
$this->assertDebuggingCalled();
|
|
}
|
|
|
|
/**
|
|
* Test the _delete_gradingform_for_userid shim.
|
|
*/
|
|
public function test_delete_gradingform_for_user() {
|
|
$userid = 696;
|
|
$context = \context_system::instance();
|
|
|
|
$mock = $this->createMock(test_gradingform_legacy_polyfill_mock_wrapper::class);
|
|
$mock->expects($this->once())
|
|
->method('get_return_value')
|
|
->with('_delete_gradingform_for_userid', [$userid, $context]);
|
|
|
|
test_legacy_polyfill_gradingform_provider::$mock = $mock;
|
|
test_legacy_polyfill_gradingform_provider::delete_gradingform_for_userid($userid, $context);
|
|
$this->assertDebuggingCalled();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Legacy polyfill test class for the gradingform_provider.
|
|
*
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class test_legacy_polyfill_gradingform_provider implements
|
|
\core_privacy\local\metadata\provider,
|
|
\core_grading\privacy\gradingform_provider,
|
|
\core_grading\privacy\gradingform_provider_v2 {
|
|
|
|
use \core_grading\privacy\gradingform_legacy_polyfill;
|
|
use \core_privacy\local\legacy_polyfill;
|
|
|
|
/**
|
|
* @var test_legacy_polyfill_gradingform_provider $mock.
|
|
*/
|
|
public static $mock = null;
|
|
|
|
/**
|
|
* Export user data relating to an instance ID.
|
|
*
|
|
* @param \context $context Context to use with the export writer.
|
|
* @param int $instanceid The instance ID to export data for.
|
|
* @param array $subcontext The directory to export this data to.
|
|
*/
|
|
protected static function _export_gradingform_instance_data(\context $context, $instanceid, $subcontext) {
|
|
static::$mock->get_return_value(__FUNCTION__, func_get_args());
|
|
}
|
|
|
|
/**
|
|
* Deletes all user data related to the provided instance IDs.
|
|
*
|
|
* @param array $instanceids The instance IDs to delete information from.
|
|
*/
|
|
protected static function _delete_gradingform_for_instances($instanceids) {
|
|
static::$mock->get_return_value(__FUNCTION__, func_get_args());
|
|
}
|
|
|
|
/**
|
|
* Returns metadata about this plugin.
|
|
*
|
|
* @param \core_privacy\local\metadata\collection $collection The initialised collection to add items to.
|
|
* @return \core_privacy\local\metadata\collection A listing of user data stored through this system.
|
|
*/
|
|
protected static function _get_metadata(\core_privacy\local\metadata\collection $collection) {
|
|
return $collection;
|
|
}
|
|
|
|
/**
|
|
* This method is used to export any user data this sub-plugin has using the object to get the context and userid.
|
|
*
|
|
* @deprecated Since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface.
|
|
* @todo MDL-63167 remove this method.
|
|
*
|
|
* @param context $context Context owner of the data.
|
|
* @param stdClass $definition Grading definition entry to export.
|
|
* @param int $userid The user whose information is to be exported.
|
|
*
|
|
* @return stdClass The data to export.
|
|
*/
|
|
protected static function _get_gradingform_export_data(\context $context, $definition, int $userid) {
|
|
static::$mock->get_return_value(__FUNCTION__, func_get_args());
|
|
}
|
|
|
|
/**
|
|
* Any call to this method should delete all user data for the context defined.
|
|
*
|
|
* @deprecated Since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface.
|
|
* @todo MDL-63167 remove this method.
|
|
*
|
|
* @param context $context Context owner of the data.
|
|
*/
|
|
protected static function _delete_gradingform_for_context(\context $context) {
|
|
static::$mock->get_return_value(__FUNCTION__, func_get_args());
|
|
}
|
|
|
|
/**
|
|
* A call to this method should delete user data (where practicle) from the userid and context.
|
|
*
|
|
* @deprecated Since Moodle 3.6 MDL-62535 Please use the methods in the gradingform_provider_v2 interface.
|
|
* @todo MDL-63167 remove this method.
|
|
*
|
|
* @param int $userid The user whose information is to be deleted.
|
|
* @param context $context Context owner of the data.
|
|
*/
|
|
protected static function _delete_gradingform_for_userid(int $userid, \context $context) {
|
|
static::$mock->get_return_value(__FUNCTION__, func_get_args());
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Called inside the polyfill methods in the test polyfill provider, allowing us to ensure these are called with correct params.
|
|
*
|
|
* @copyright 2018 Jake Dallimore <jrhdallimore@gmail.com>
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class test_gradingform_legacy_polyfill_mock_wrapper {
|
|
/**
|
|
* Get the return value for the specified item.
|
|
*/
|
|
public function get_return_value() {
|
|
}
|
|
}
|
|
|