[Summary view]

Differences Between: [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_grader implementation of the privacy API.
  19   *
  20   * @package    gradereport_grader
  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_grader\privacy;
  26  
  27  defined('MOODLE_INTERNAL') || die();
  28  
  29  use core_privacy\local\metadata\collection;
  30  use core_privacy\local\request\writer;
  31  use core_privacy\local\request\approved_contextlist;
  32  use core_privacy\local\request\deletion_criteria;
  33  use gradereport_grader\privacy\provider;
  34  
  35  /**
  36   * Unit tests for the gradereport_grader implementation of the privacy API.
  37   *
  38   * @copyright  2018 Sara Arjona <sara@moodle.com>
  39   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class provider_test extends \core_privacy\tests\provider_testcase {
  42  
  43      /**
  44       * Basic setup for these tests.
  45       */
  46      public function setUp(): void {
  47          $this->resetAfterTest(true);
  48      }
  49  
  50  
  51      /**
  52       * Ensure that export_user_preferences returns no data if the user has no data.
  53       */
  54      public function test_export_user_preferences_not_defined() {
  55          $user = \core_user::get_user_by_username('admin');
  56          provider::export_user_preferences($user->id);
  57  
  58          $writer = writer::with_context(\context_system::instance());
  59          $this->assertFalse($writer->has_any_data());
  60      }
  61  
  62      /**
  63       * Ensure that export_user_preferences returns single preferences.
  64       * These preferences can be set on each course, but the value is shared in the whole site.
  65       */
  66      public function test_export_user_preferences_single() {
  67          // Create test user, add some preferences.
  68          $user = $this->getDataGenerator()->create_user();
  69          $this->setUser($user);
  70  
  71          set_user_preference('grade_report_showcalculations', 1, $user);
  72          set_user_preference('grade_report_meanselection', GRADE_REPORT_MEAN_GRADED, $user);
  73          set_user_preference('grade_report_studentsperpage', 50, $user);
  74  
  75          // Switch to admin user (so we can validate preferences of our test user are still exported).
  76          $this->setAdminUser();
  77  
  78          // Validate exported data for our test user.
  79          provider::export_user_preferences($user->id);
  80          $context = \context_user::instance($user->id);
  81          $writer = writer::with_context($context);
  82          $this->assertTrue($writer->has_any_data());
  83          $prefs = $writer->get_user_preferences('gradereport_grader');
  84          $this->assertCount(3, (array) $prefs);
  85          $this->assertEquals(
  86              get_string('privacy:metadata:preference:grade_report_showcalculations', 'gradereport_grader'),
  87              $prefs->grade_report_showcalculations->description
  88          );
  89          $this->assertEquals(get_string('meangraded', 'grades'), $prefs->grade_report_meanselection->value);
  90          $this->assertEquals(50, $prefs->grade_report_studentsperpage->value);
  91      }
  92  
  93      /**
  94       * Ensure that export_user_preferences returns preferences.
  95       */
  96      public function test_export_user_preferences_multiple() {
  97          // Create a course and add a user preference.
  98          $user = $this->getDataGenerator()->create_user();
  99          $this->setUser($user);
 100          $course = $this->getDataGenerator()->create_course();
 101          $collapsed = serialize(['aggregatesonly' => array(), 'gradesonly' => array()]);
 102          set_user_preference('grade_report_grader_collapsed_categories'.$course->id, $collapsed, $user);
 103  
 104          // Validate exported data.
 105          provider::export_user_preferences($user->id);
 106          $context = \context_user::instance($user->id);
 107          $writer = writer::with_context($context);
 108          $this->assertTrue($writer->has_any_data());
 109          $prefs = $writer->get_user_preferences('gradereport_grader');
 110          $this->assertCount(1, (array) $prefs);
 111          $this->assertEquals(
 112              get_string('privacy:request:preference:grade_report_grader_collapsed_categories', 'gradereport_grader', ['name' => $course->fullname]),
 113              $prefs->grade_report_grader_collapsed_categories->description
 114          );
 115      }
 116  }