[Summary view]

   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   * Privacy provider tests.
  19   *
  20   * @package    quiz_overview
  21   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  23   */
  24  
  25  use core_privacy\local\metadata\collection;
  26  use quiz_overview\privacy\provider;
  27  use core_privacy\local\request\writer;
  28  use core_privacy\local\request\transform;
  29  
  30  defined('MOODLE_INTERNAL') || die();
  31  
  32  /**
  33   * Privacy provider tests class.
  34   *
  35   * @package    quiz_overview
  36   * @copyright  2018 Andrew Nicols <andrew@nicols.co.uk>
  37   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  38   */
  39  class quiz_overview_privacy_provider_testcase extends \core_privacy\tests\provider_testcase {
  40      /**
  41       * When no preference exists, there should be no export.
  42       */
  43      public function test_preference_unset() {
  44          global $USER;
  45  
  46          $this->resetAfterTest();
  47          $this->setAdminUser();
  48  
  49          provider::export_user_preferences($USER->id);
  50  
  51          $this->assertFalse(writer::with_context(\context_system::instance())->has_any_data());
  52      }
  53  
  54      /**
  55       * Preference does exist.
  56       */
  57      public function test_preference_yes() {
  58          $this->resetAfterTest();
  59  
  60          // Create test user, add some preferences.
  61          $user = $this->getDataGenerator()->create_user();
  62          $this->setUser($user);
  63  
  64          set_user_preference('quiz_overview_slotmarks', 1, $user);
  65  
  66          // Switch to admin user (so we can validate preferences of the correct user are being exported).
  67          $this->setAdminUser();
  68  
  69          // Export test users preferences.
  70          provider::export_user_preferences($user->id);
  71  
  72          $writer = writer::with_context(\context_system::instance());
  73          $this->assertTrue($writer->has_any_data());
  74  
  75          $preferences = $writer->get_user_preferences('quiz_overview');
  76          $this->assertNotEmpty($preferences->slotmarks);
  77          $this->assertEquals(transform::yesno(1), $preferences->slotmarks->value);
  78          $description = get_string('privacy:preference:slotmarks:yes', 'quiz_overview');
  79          $this->assertEquals($description, $preferences->slotmarks->description);
  80      }
  81  
  82      /**
  83       * Preference does exist and is no.
  84       */
  85      public function test_preference_no() {
  86          $this->resetAfterTest();
  87  
  88          // Create test user, add some preferences.
  89          $user = $this->getDataGenerator()->create_user();
  90          $this->setUser($user);
  91  
  92          set_user_preference('quiz_overview_slotmarks', 0);
  93  
  94          // Switch to admin user (so we can validate preferences of the correct user are being exported).
  95          $this->setAdminUser();
  96  
  97          // Export test users preferences.
  98          provider::export_user_preferences($user->id);
  99  
 100          $writer = writer::with_context(\context_system::instance());
 101          $this->assertTrue($writer->has_any_data());
 102  
 103          $preferences = $writer->get_user_preferences('quiz_overview');
 104          $this->assertNotEmpty($preferences->slotmarks);
 105          $this->assertEquals(transform::yesno(0), $preferences->slotmarks->value);
 106          $description = get_string('privacy:preference:slotmarks:no', 'quiz_overview');
 107          $this->assertEquals($description, $preferences->slotmarks->description);
 108      }
 109  }