Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

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 scormreport_basic implementation of the privacy API.
  19   *
  20   * @package    scormreport_basic
  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 scormreport_basic\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core_privacy\local\request\writer;
  30  use scormreport_basic\privacy\provider;
  31  
  32  /**
  33   * Unit tests for the scormreport_basic implementation of the privacy API.
  34   *
  35   * @copyright  2018 Sara Arjona <sara@moodle.com>
  36   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   */
  38  class provider_test extends \core_privacy\tests\provider_testcase {
  39  
  40      /**
  41       * Basic setup for these tests.
  42       */
  43      public function setUp(): void {
  44          $this->resetAfterTest(true);
  45      }
  46  
  47      /**
  48       * Ensure that export_user_preferences returns no data if the user has no data.
  49       */
  50      public function test_export_user_preferences_not_defined() {
  51          $user = \core_user::get_user_by_username('admin');
  52          provider::export_user_preferences($user->id);
  53  
  54          $writer = writer::with_context(\context_system::instance());
  55          $this->assertFalse($writer->has_any_data());
  56      }
  57  
  58      /**
  59       * Ensure that export_user_preferences returns single preferences.
  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('scorm_report_detailed', 1);
  66          set_user_preference('scorm_report_pagesize', 50);
  67  
  68          // Validate exported data.
  69          provider::export_user_preferences($user->id);
  70          $context = \context_user::instance($user->id);
  71          /** @var \core_privacy\tests\request\content_writer $writer */
  72          $writer = writer::with_context($context);
  73          $this->assertTrue($writer->has_any_data());
  74          $prefs = $writer->get_user_preferences('scormreport_basic');
  75          $this->assertCount(2, (array) $prefs);
  76          $this->assertEquals(
  77              get_string('privacy:metadata:preference:scorm_report_detailed', 'scormreport_basic'),
  78              $prefs->scorm_report_detailed->description
  79          );
  80          $this->assertEquals(get_string('yes'), $prefs->scorm_report_detailed->value);
  81          $this->assertEquals(
  82              get_string('privacy:metadata:preference:scorm_report_pagesize', 'scormreport_basic'),
  83              $prefs->scorm_report_pagesize->description
  84          );
  85          $this->assertEquals(50, $prefs->scorm_report_pagesize->value);
  86      }
  87  }