my/tests/privacy_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/>.
  16
  17 /**
  18  * Unit tests for the core_my implementation of the privacy API.
  19  *
  20  * @package    core_my
  21  * @category   test
  22  * @copyright  2018 Zig Tan <zig@moodle.com>
  23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24  */
  25
  26 defined('MOODLE_INTERNAL') || die();
  27
  28 use \core_privacy\local\request\writer;
  29 use \core_my\privacy\provider;
  30
  31 /**
  32  * Unit tests for the core_my implementation of the privacy API.
  33  *
  34  * @copyright  2018 Zig Tan <zig@moodle.com>
  35  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36  */
  37 class core_my_privacy_testcase extends \core_privacy\tests\provider_testcase {
  38
  39     /**
  40      * Test for provider::test_export_user_preferences().
  41      */
  42     public function test_export_user_preferences() {
  43         global $DB;
  44
  45         // Test setup.
  46         $this->resetAfterTest(true);
  47         $user = $this->getDataGenerator()->create_user();
  48         $this->setUser($user);
  49
  50         // Add a user home page preference for the User.
  51         set_user_preference('user_home_page_preference', HOMEPAGE_MY);
  52
  53         // Test the user preference exists.
  54         $params = [
  55             'userid' => $user->id,
  56             'name' => 'user_home_page_preference'
  57         ];
  58
  59         $preferences = $DB->get_record('user_preferences', $params);
  60         $this->assertEquals('user_home_page_preference', $preferences->name);
  61
  62         // Test the user preferences export contains 1 user preference record for the User.
  63         provider::export_user_preferences($user->id);
  64         $contextuser = context_user::instance($user->id);
  65         $writer = writer::with_context($contextuser);
  66         $this->assertTrue($writer->has_any_data());
  67
  68         $prefs = $writer->get_user_preferences('core_my');
  69         $this->assertCount(1, (array) $prefs);
  70         $this->assertEquals(HOMEPAGE_MY, $prefs->user_home_page_preference->value);
  71     }
  72
  73 }