[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   * Unit Tests for the approved userlist Class
  19   *
  20   * @package     core_privacy
  21   * @category    test
  22   * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  23   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  24   */
  25  
  26  defined('MOODLE_INTERNAL') || die();
  27  
  28  global $CFG;
  29  
  30  use \core_privacy\local\request\userlist;
  31  
  32  /**
  33   * Tests for the \core_privacy API's approved userlist functionality.
  34   *
  35   * @copyright   2018 Andrew Nicols <andrew@nicols.co.uk>
  36   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  37   * @coversDefaultClass \core_privacy\local\request\userlist
  38   */
  39  class userlist_test extends advanced_testcase {
  40  
  41      /**
  42       * Ensure that valid SQL results in the relevant users being added.
  43       *
  44       * @covers ::add_from_sql
  45       */
  46      public function test_add_from_sql() {
  47          global $DB;
  48  
  49          $sql = "SELECT c.id FROM {user} c";
  50          $params = [];
  51          $allusers = $DB->get_records_sql($sql, $params);
  52  
  53          $uut = new userlist(\context_system::instance(), 'core_privacy');
  54          $uut->add_from_sql('id', $sql, $params);
  55  
  56          $this->assertCount(count($allusers), $uut);
  57      }
  58  
  59      /**
  60       * Ensure that adding a single user adds that user.
  61       *
  62       * @covers ::add_user
  63       */
  64      public function test_add_user() {
  65          $this->resetAfterTest();
  66  
  67          $u1 = $this->getDataGenerator()->create_user();
  68          $u2 = $this->getDataGenerator()->create_user();
  69  
  70          $uut = new userlist(\context_system::instance(), 'core_privacy');
  71          $uut->add_user($u1->id);
  72  
  73          $this->assertCount(1, $uut);
  74          $this->assertEquals($uut->current(), $u1);
  75      }
  76  
  77  
  78      /**
  79       * Ensure that adding multiple users by ID adds those users.
  80       *
  81       * @covers ::add_users
  82       */
  83      public function test_add_users() {
  84          $this->resetAfterTest();
  85  
  86          $u1 = $this->getDataGenerator()->create_user();
  87          $u2 = $this->getDataGenerator()->create_user();
  88          $u3 = $this->getDataGenerator()->create_user();
  89          $expected = [$u1->id, $u3->id];
  90  
  91          $uut = new userlist(\context_system::instance(), 'core_privacy');
  92          $uut->add_users([$u1->id, $u3->id]);
  93  
  94          $this->assertCount(2, $uut);
  95  
  96          foreach ($uut as $user) {
  97              $this->assertNotFalse(array_search($user->id, $expected));
  98          }
  99      }
 100  }