MDL-61751 core_plagiarism: add polyfill for plagiarism provider

plagiarism/classes/privacy/legacy_polyfill.php

@@ -0,0 +1,68 @@
+<?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/>.
+
+/**
+ * This file contains the polyfill to allow a plugin to operate with Moodle 3.3 up.
+ *
+ * @package core_plagiarism
+ * @copyright 2018 Jake Dallimore <[email protected]>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+namespace core_plagiarism\privacy;
+
+defined('MOODLE_INTERNAL') || die();
+
+use \core_privacy\local\metadata\collection;
+
+/**
+ * The trait used to provide a backwards compatibility for third-party plugins.
+ *
+ * @copyright 2018 Jake Dallimore <[email protected]>
+ * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+trait legacy_polyfill {
+
+    /**
+     * Export all plagiarism data from each plagiarism plugin for the specified userid and context.
+     *
+     * @param   int         $userid The user to export.
+     * @param   \context    $context The context to export.
+     * @param   array       $subcontext The subcontext within the context to export this information to.
+     * @param   array       $linkarray The weird and wonderful link array used to display information for a specific item
+     */
+    public static function export_plagiarism_user_data(int $userid, \context $context, array $subcontext, array $linkarray) {
+        static::_export_plagiarism_user_data($userid, $context, $subcontext, $linkarray);
+    }
+
+    /**
+     * Delete all user information for the provided context.
+     *
+     * @param  \context $context The context to delete user data for.
+     */
+    public static function delete_plagiarism_for_context(\context $context) {
+        static::_delete_plagiarism_for_context($context);
+    }
+
+    /**
+     * Delete all user information for the provided user and context.
+     *
+     * @param  int      $userid    The user to delete
+     * @param  \context $context   The context to refine the deletion.
+     */
+    public static function delete_plagiarism_for_user(int $userid, \context $context) {
+        static::_delete_plagiarism_for_user($userid, $context);
+    }
+}

plagiarism/tests/privacy_legacy_polyfill_test.php

@@ -0,0 +1,160 @@
+<?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 plagiarism.
+ *
+ * @package     core_privacy
+ * @category    test
+ * @copyright   2018 Andrew Nicols <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Unit tests for the Plagiarism API's privacy legacy_polyfill.
+ *
+ * @copyright   2018 Jake Dallimore <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class core_plagiarism_privacy_legacy_polyfill_test extends advanced_testcase {
+    /**
+     * Test that the core_plagiarism\privacy\legacy_polyfill works and that the static _export_plagiarism_user_data can be called.
+     */
+    public function test_export_plagiarism_user_data() {
+        $userid = 476;
+        $context = context_system::instance();
+
+        $mock = $this->createMock(test_plagiarism_legacy_polyfill_mock_wrapper::class);
+        $mock->expects($this->once())
+            ->method('get_return_value')
+            ->with('_export_plagiarism_user_data', [$userid, $context, [], []]);
+
+        test_legacy_polyfill_plagiarism_provider::$mock = $mock;
+        test_legacy_polyfill_plagiarism_provider::export_plagiarism_user_data($userid, $context, [], []);
+    }
+
+    /**
+     * Test for _get_metadata shim.
+     */
+    public function test_get_metadata() {
+        $collection = new \core_privacy\local\metadata\collection('core_plagiarism');
+        $this->assertSame($collection, test_legacy_polyfill_plagiarism_provider::get_metadata($collection));
+    }
+
+    /**
+     * Test the _delete_plagiarism_for_context shim.
+     */
+    public function test_delete_plagiarism_for_context() {
+        $context = context_system::instance();
+
+        $mock = $this->createMock(test_plagiarism_legacy_polyfill_mock_wrapper::class);
+        $mock->expects($this->once())
+            ->method('get_return_value')
+            ->with('_delete_plagiarism_for_context', [$context]);
+
+        test_legacy_polyfill_plagiarism_provider::$mock = $mock;
+        test_legacy_polyfill_plagiarism_provider::delete_plagiarism_for_context($context);
+    }
+
+    /**
+     * Test the _delete_plagiarism_for_context shim.
+     */
+    public function test_delete_plagiarism_for_user() {
+        $userid = 696;
+        $context = \context_system::instance();
+
+        $mock = $this->createMock(test_plagiarism_legacy_polyfill_mock_wrapper::class);
+        $mock->expects($this->once())
+            ->method('get_return_value')
+            ->with('_delete_plagiarism_for_user', [$userid, $context]);
+
+        test_legacy_polyfill_plagiarism_provider::$mock = $mock;
+        test_legacy_polyfill_plagiarism_provider::delete_plagiarism_for_user($userid, $context);
+    }
+}
+
+/**
+ * Legacy polyfill test class for the plagiarism_provider.
+ *
+ * @copyright   2018 Jake Dallimore <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class test_legacy_polyfill_plagiarism_provider implements \core_plagiarism\privacy\plagiarism_provider {
+
+    use \core_plagiarism\privacy\legacy_polyfill;
+
+    /**
+     * @var test_legacy_polyfill_plagiarism_provider $mock.
+     */
+    public static $mock = null;
+
+    /**
+     * Export all user data for the plagiarism plugin.
+     *
+     * @param int $userid
+     * @param context $context
+     * @param array $subcontext
+     * @param array $linkarray
+     */
+    protected static function _export_plagiarism_user_data($userid, \context $context, array $subcontext, array $linkarray) {
+        static::$mock->get_return_value(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * Deletes all user data for the given context.
+     *
+     * @param context $context
+     */
+    protected static function _delete_plagiarism_for_context(\context $context) {
+        static::$mock->get_return_value(__FUNCTION__, func_get_args());
+    }
+
+    /**
+     * Delete personal data for the given user and context.
+     *
+     * @param int $userid
+     * @param context $context
+     */
+    protected static function _delete_plagiarism_for_user($userid, \context $context) {
+        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;
+    }
+}
+
+/**
+ * Called inside the polyfill methods in the test polyfill provider, allowing us to ensure these are called with correct params.
+ *
+ * @copyright   2018 Jake Dallimore <[email protected]>
+ * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class test_plagiarism_legacy_polyfill_mock_wrapper {
+    /**
+     * Get the return value for the specified item.
+     */
+    public function get_return_value() {
+    }
+}