Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 310 and 311] [Versions 310 and 400] [Versions 310 and 401] [Versions 310 and 402] [Versions 310 and 403] [Versions 39 and 310]

   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  /**
  18   * Tests for the manager observer.
  19   *
  20   * @package    tool_dataprivacy
  21   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  defined('MOODLE_INTERNAL') || die();
  26  require_once ('data_privacy_testcase.php');
  27  
  28  /**
  29   * API tests.
  30   *
  31   * @package    tool_dataprivacy
  32   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  33   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  34   */
  35  class tool_dataprivacy_manager_observer_testcase extends data_privacy_testcase {
  36      /**
  37       * Ensure that when users are configured as DPO, they are sent an message upon failure.
  38       */
  39      public function test_handle_component_failure() {
  40          $this->resetAfterTest();
  41  
  42          // Create another user who is not a DPO.
  43          $this->getDataGenerator()->create_user();
  44  
  45          // Create two DPOs.
  46          $dpo1 = $this->getDataGenerator()->create_user();
  47          $dpo2 = $this->getDataGenerator()->create_user();
  48          $this->assign_site_dpo(array($dpo1, $dpo2));
  49          $dpos = \tool_dataprivacy\api::get_site_dpos();
  50  
  51          $observer = new \tool_dataprivacy\manager_observer();
  52  
  53          // Handle the failure, catching messages.
  54          $mailsink = $this->redirectMessages();
  55          $mailsink->clear();
  56          $observer->handle_component_failure(new \Exception('error'), 'foo', 'bar', 'baz', ['foobarbaz', 'bum']);
  57  
  58          // Messages should be sent to both DPOs only.
  59          $this->assertEquals(2, $mailsink->count());
  60  
  61          $messages = $mailsink->get_messages();
  62          $messageusers = array_map(function($message) {
  63              return $message->useridto;
  64          }, $messages);
  65  
  66          $this->assertEqualsCanonicalizing(array_keys($dpos), $messageusers);
  67      }
  68  
  69      /**
  70       * Ensure that when no user is configured as DPO, the message is sent to admin instead.
  71       */
  72      public function test_handle_component_failure_no_dpo() {
  73          $this->resetAfterTest();
  74  
  75          // Create another user who is not a DPO or admin.
  76          $this->getDataGenerator()->create_user();
  77  
  78          $observer = new \tool_dataprivacy\manager_observer();
  79  
  80          $mailsink = $this->redirectMessages();
  81          $mailsink->clear();
  82          $observer->handle_component_failure(new \Exception('error'), 'foo', 'bar', 'baz', ['foobarbaz', 'bum']);
  83  
  84          // Messages should have been sent only to the admin.
  85          $this->assertEquals(1, $mailsink->count());
  86  
  87          $messages = $mailsink->get_messages();
  88          $message = reset($messages);
  89  
  90          $admin = \core_user::get_user_by_username('admin');
  91          $this->assertEquals($admin->id, $message->useridto);
  92      }
  93  }