[Summary view]

Differences Between: [Versions 311 and 402] [Versions 400 and 402] [Versions 401 and 402]

   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 gradereport_user implementation of the privacy API.
  19   *
  20   * @package    gradereport_user
  21   * @category   test
  22   * @copyright  2018 Sara Arjona <sara@moodle.com>
  23   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  namespace gradereport_user\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core_privacy\local\request\writer;
  30  
  31  /**
  32   * Unit tests for the gradereport_user implementation of the privacy API.
  33   *
  34   * @copyright  2018 Sara Arjona <sara@moodle.com>
  35   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  36   */
  37  class provider_test extends \core_privacy\tests\provider_testcase {
  38  
  39      /**
  40       * Basic setup for these tests.
  41       */
  42      public function setUp(): void {
  43          $this->resetAfterTest(true);
  44      }
  45  
  46      /**
  47       * Ensure that export_user_preferences returns no data if the user has no data.
  48       */
  49      public function test_export_user_preferences_not_defined() {
  50          $user = \core_user::get_user_by_username('admin');
  51          provider::export_user_preferences($user->id);
  52  
  53          $writer = writer::with_context(\context_system::instance());
  54          $this->assertFalse($writer->has_any_data());
  55      }
  56  
  57      /**
  58       * Ensure that export_user_preferences returns single preferences.
  59       * These preferences can be set on each course, but the value is shared in the whole site.
  60       */
  61      public function test_export_user_preferences_single() {
  62          // Define a user preference.
  63          $user = $this->getDataGenerator()->create_user();
  64          $this->setUser($user);
  65          set_user_preference('gradereport_user_view_user', 1, $user);
  66  
  67          // Validate exported data.
  68          provider::export_user_preferences($user->id);
  69          $context = \context_user::instance($user->id);
  70          /** @var \core_privacy\tests\request\content_writer $writer */
  71          $writer = writer::with_context($context);
  72          $this->assertTrue($writer->has_any_data());
  73          $prefs = $writer->get_user_preferences('gradereport_user');
  74          $this->assertCount(1, (array) $prefs);
  75          $this->assertEquals(
  76              get_string('privacy:metadata:preference:gradereport_user_view_user', 'gradereport_user'),
  77              $prefs->gradereport_user_view_user->description
  78          );
  79          $this->assertEquals(get_string('yes'), $prefs->gradereport_user_view_user->value);
  80      }
  81  }