From 95a844ebdc729e0db9f76637c5be2cdfa2068337 Mon Sep 17 00:00:00 2001 From: Michael Hawkins Date: Fri, 10 Aug 2018 15:13:42 +0800 Subject: [PATCH] MDL-62660 tool_dataprivacy: Add and update PHPUnit tests Updated tests with latest statuses. Added testing for request download expiry functionality and method. Added assign_site_dpo within a parent class for unit tests. --- admin/tool/dataprivacy/tests/api_test.php | 11 +- .../tests/data_privacy_testcase.php | 64 +++++++ .../tests/expired_data_requests_test.php | 173 ++++++++++++++++++ .../tests/manager_observer_test.php | 38 +--- 4 files changed, 251 insertions(+), 35 deletions(-) create mode 100644 admin/tool/dataprivacy/tests/data_privacy_testcase.php create mode 100644 admin/tool/dataprivacy/tests/expired_data_requests_test.php diff --git a/admin/tool/dataprivacy/tests/api_test.php b/admin/tool/dataprivacy/tests/api_test.php index c341a6309e7..9feebcf055b 100644 --- a/admin/tool/dataprivacy/tests/api_test.php +++ b/admin/tool/dataprivacy/tests/api_test.php @@ -66,12 +66,12 @@ class tool_dataprivacy_api_testcase extends advanced_testcase { $requestid = $datarequest->get('id'); // Update with a valid status. - $result = api::update_request_status($requestid, api::DATAREQUEST_STATUS_COMPLETE); + $result = api::update_request_status($requestid, api::DATAREQUEST_STATUS_DOWNLOAD_READY); $this->assertTrue($result); // Fetch the request record again. $datarequest = new data_request($requestid); - $this->assertEquals(api::DATAREQUEST_STATUS_COMPLETE, $datarequest->get('status')); + $this->assertEquals(api::DATAREQUEST_STATUS_DOWNLOAD_READY, $datarequest->get('status')); // Update with an invalid status. $this->expectException(invalid_persistent_exception::class); @@ -468,8 +468,8 @@ class tool_dataprivacy_api_testcase extends advanced_testcase { * @return array */ public function get_data_requests_provider() { - $completeonly = [api::DATAREQUEST_STATUS_COMPLETE]; - $completeandcancelled = [api::DATAREQUEST_STATUS_COMPLETE, api::DATAREQUEST_STATUS_CANCELLED]; + $completeonly = [api::DATAREQUEST_STATUS_COMPLETE, api::DATAREQUEST_STATUS_DOWNLOAD_READY, api::DATAREQUEST_STATUS_DELETED]; + $completeandcancelled = array_merge($completeonly, [api::DATAREQUEST_STATUS_CANCELLED]); return [ // Own data requests. @@ -612,6 +612,9 @@ class tool_dataprivacy_api_testcase extends advanced_testcase { [api::DATAREQUEST_STATUS_COMPLETE, false], [api::DATAREQUEST_STATUS_CANCELLED, false], [api::DATAREQUEST_STATUS_REJECTED, false], + [api::DATAREQUEST_STATUS_DOWNLOAD_READY, false], + [api::DATAREQUEST_STATUS_EXPIRED, false], + [api::DATAREQUEST_STATUS_DELETED, false], ]; } diff --git a/admin/tool/dataprivacy/tests/data_privacy_testcase.php b/admin/tool/dataprivacy/tests/data_privacy_testcase.php new file mode 100644 index 00000000000..16b48de4c83 --- /dev/null +++ b/admin/tool/dataprivacy/tests/data_privacy_testcase.php @@ -0,0 +1,64 @@ +. + +/** + * Parent class for tests which need data privacy functionality. + * + * @package tool_dataprivacy + * @copyright 2018 Michael Hawkins + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die(); + +/** + * Parent class for tests which need data privacy functionality. + * + * @package tool_dataprivacy + * @copyright 2018 Michael Hawkins + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +abstract class data_privacy_testcase extends advanced_testcase { + + /** + * Assign one or more user IDs as site DPO + * + * @param stdClass|array $users User ID or array of user IDs to be assigned as site DPO + * @return void + */ + protected function assign_site_dpo($users) { + global $DB; + $this->resetAfterTest(); + + if (!is_array($users)) { + $users = array($users); + } + + $context = context_system::instance(); + + // Give the manager role with the capability to manage data requests. + $managerroleid = $DB->get_field('role', 'id', array('shortname' => 'manager')); + assign_capability('tool/dataprivacy:managedatarequests', CAP_ALLOW, $managerroleid, $context->id, true); + + // Assign user(s) as manager. + foreach ($users as $user) { + role_assign($managerroleid, $user->id, $context->id); + } + + // Only map the manager role to the DPO role. + set_config('dporoles', $managerroleid, 'tool_dataprivacy'); + } +} diff --git a/admin/tool/dataprivacy/tests/expired_data_requests_test.php b/admin/tool/dataprivacy/tests/expired_data_requests_test.php new file mode 100644 index 00000000000..00c6259cc92 --- /dev/null +++ b/admin/tool/dataprivacy/tests/expired_data_requests_test.php @@ -0,0 +1,173 @@ +. + +/** + * Expired data requests tests. + * + * @package tool_dataprivacy + * @copyright 2018 Michael Hawkins + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +use tool_dataprivacy\api; +use tool_dataprivacy\data_request; + +defined('MOODLE_INTERNAL') || die(); +global $CFG; + +require_once('data_privacy_testcase.php'); + +/** + * Expired data requests tests. + * + * @package tool_dataprivacy + * @copyright 2018 Michael Hawkins + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ +class tool_dataprivacy_expired_data_requests_testcase extends data_privacy_testcase { + + /** + * Test tearDown. + */ + public function tearDown() { + \core_privacy\local\request\writer::reset(); + } + + /** + * Test finding and deleting expired data requests + */ + public function test_data_request_expiry() { + global $DB; + $this->resetAfterTest(); + \core_privacy\local\request\writer::setup_real_writer_instance(); + + // Set up test users. + $this->setAdminUser(); + $studentuser = $this->getDataGenerator()->create_user(); + $studentusercontext = context_user::instance($studentuser->id); + + $dpouser = $this->getDataGenerator()->create_user(); + $this->assign_site_dpo($dpouser); + + // Set request expiry to 5 minutes. + set_config('privacyrequestexpiry', 300, 'tool_dataprivacy'); + + // Create and approve data request. + $this->setUser($studentuser->id); + $datarequest = api::create_data_request($studentuser->id, api::DATAREQUEST_TYPE_EXPORT); + $this->setAdminUser(); + ob_start(); + $this->runAdhocTasks('\tool_dataprivacy\task\initiate_data_request_task'); + $requestid = $datarequest->get('id'); + $this->setUser($dpouser->id); + api::approve_data_request($requestid); + $this->setAdminUser(); + $this->runAdhocTasks('\tool_dataprivacy\task\process_data_request_task'); + ob_end_clean(); + + // Confirm approved and exported. + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_DOWNLOAD_READY, $request->get('status')); + $fileconditions = array( + 'userid' => $studentuser->id, + 'component' => 'tool_dataprivacy', + 'filearea' => 'export', + 'itemid' => $requestid, + 'contextid' => $studentusercontext->id, + ); + $this->assertEquals(2, $DB->count_records('files', $fileconditions)); + + // Run expiry deletion - should not affect test export. + $expiredrequests = data_request::get_expired_requests(); + $this->assertEquals(0, count($expiredrequests)); + data_request::expire($expiredrequests); + + // Confirm test export was not deleted. + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_DOWNLOAD_READY, $request->get('status')); + $this->assertEquals(2, $DB->count_records('files', $fileconditions)); + + // Change request expiry to 1 second and allow it to elapse. + set_config('privacyrequestexpiry', 1, 'tool_dataprivacy'); + $this->waitForSecond(); + + // Re-run expiry deletion, confirm the request expires and export is deleted. + $expiredrequests = data_request::get_expired_requests(); + $this->assertEquals(1, count($expiredrequests)); + data_request::expire($expiredrequests); + + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_EXPIRED, $request->get('status')); + $this->assertEquals(0, $DB->count_records('files', $fileconditions)); + } + + + /** + * Test for \tool_dataprivacy\data_request::is_expired() + * Tests for the expected request status to protect from false positive/negative, + * then tests is_expired() is returning the expected response. + */ + public function test_is_expired() { + $this->resetAfterTest(); + \core_privacy\local\request\writer::setup_real_writer_instance(); + + // Set request expiry beyond this test. + set_config('privacyrequestexpiry', 20, 'tool_dataprivacy'); + + $admin = get_admin(); + $this->setAdminUser(); + + // Create export request. + $datarequest = api::create_data_request($admin->id, api::DATAREQUEST_TYPE_EXPORT); + $requestid = $datarequest->get('id'); + + // Approve the request. + ob_start(); + $this->runAdhocTasks('\tool_dataprivacy\task\initiate_data_request_task'); + $this->setAdminUser(); + api::approve_data_request($requestid); + $this->runAdhocTasks('\tool_dataprivacy\task\process_data_request_task'); + ob_end_clean(); + + // Test Download ready (not expired) response. + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_DOWNLOAD_READY, $request->get('status')); + $result = data_request::is_expired($request); + $this->assertFalse($result); + + // Let request expiry time lapse. + set_config('privacyrequestexpiry', 1, 'tool_dataprivacy'); + $this->waitForSecond(); + + // Test Download ready (time expired) response. + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_DOWNLOAD_READY, $request->get('status')); + $result = data_request::is_expired($request); + $this->assertTrue($result); + + // Run the expiry task to properly expire the request. + ob_start(); + $task = \core\task\manager::get_scheduled_task('\tool_dataprivacy\task\delete_expired_requests'); + $task->execute(); + ob_end_clean(); + + // Test Expired response status response. + $request = new data_request($requestid); + $this->assertEquals(api::DATAREQUEST_STATUS_EXPIRED, $request->get('status')); + $result = data_request::is_expired($request); + $this->assertTrue($result); + } +} diff --git a/admin/tool/dataprivacy/tests/manager_observer_test.php b/admin/tool/dataprivacy/tests/manager_observer_test.php index 6c710277501..1c471536fd3 100644 --- a/admin/tool/dataprivacy/tests/manager_observer_test.php +++ b/admin/tool/dataprivacy/tests/manager_observer_test.php @@ -23,6 +23,7 @@ */ defined('MOODLE_INTERNAL') || die(); +require_once('data_privacy_testcase.php'); /** * API tests. @@ -31,35 +32,7 @@ defined('MOODLE_INTERNAL') || die(); * @copyright 2018 Andrew Nicols * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */ -class tool_dataprivacy_manager_observer_testcase extends advanced_testcase { - - /** - * Helper to set andn return two users who are DPOs. - */ - protected function setup_site_dpos() { - global $DB; - $this->resetAfterTest(); - - $generator = new testing_data_generator(); - $u1 = $this->getDataGenerator()->create_user(); - $u2 = $this->getDataGenerator()->create_user(); - - $context = context_system::instance(); - - // Give the manager role with the capability to manage data requests. - $managerroleid = $DB->get_field('role', 'id', array('shortname' => 'manager')); - assign_capability('tool/dataprivacy:managedatarequests', CAP_ALLOW, $managerroleid, $context->id, true); - - // Assign both users as manager. - role_assign($managerroleid, $u1->id, $context->id); - role_assign($managerroleid, $u2->id, $context->id); - - // Only map the manager role to the DPO role. - set_config('dporoles', $managerroleid, 'tool_dataprivacy'); - - return \tool_dataprivacy\api::get_site_dpos(); - } - +class tool_dataprivacy_manager_observer_testcase extends data_privacy_testcase { /** * Ensure that when users are configured as DPO, they are sent an message upon failure. */ @@ -69,8 +42,11 @@ class tool_dataprivacy_manager_observer_testcase extends advanced_testcase { // Create another user who is not a DPO. $this->getDataGenerator()->create_user(); - // Create the DPOs. - $dpos = $this->setup_site_dpos(); + // Create two DPOs. + $dpo1 = $this->getDataGenerator()->create_user(); + $dpo2 = $this->getDataGenerator()->create_user(); + $this->assign_site_dpo(array($dpo1, $dpo2)); + $dpos = \tool_dataprivacy\api::get_site_dpos(); $observer = new \tool_dataprivacy\manager_observer();