[Summary view]

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

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