[Summary view]

Differences Between: [Versions 401 and 402] [Versions 401 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  declare(strict_types=1);
  18  
  19  namespace core_reportbuilder\external\reports;
  20  
  21  use context_system;
  22  use core_reportbuilder_generator;
  23  use external_api;
  24  use externallib_advanced_testcase;
  25  use core_reportbuilder\report_access_exception;
  26  use core_reportbuilder\local\models\report;
  27  use core_user\reportbuilder\datasource\users;
  28  
  29  defined('MOODLE_INTERNAL') || die();
  30  
  31  global $CFG;
  32  require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
  33  
  34  /**
  35   * Unit tests of external class for listing reports
  36   *
  37   * @package     core_reportbuilder
  38   * @covers      \core_reportbuilder\external\reports\listing
  39   * @copyright   2022 Paul Holden <paulh@moodle.com>
  40   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class listing_test extends externallib_advanced_testcase {
  43  
  44      /**
  45       * Text execute method
  46       */
  47      public function test_execute(): void {
  48          $this->resetAfterTest();
  49          $this->setAdminUser();
  50  
  51          /** @var core_reportbuilder_generator $generator */
  52          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  53  
  54          // Create three reports.
  55          $reportone = $generator->create_report(['name' => 'Report one', 'source' => users::class]);
  56          $reporttwo = $generator->create_report(['name' => 'Report two', 'source' => users::class]);
  57          $reportthree = $generator->create_report(['name' => 'Report three', 'source' => users::class]);
  58  
  59          // Create second user, with audience of both report one and two.
  60          $user = $this->getDataGenerator()->create_user();
  61          $this->setUser($user);
  62  
  63          $generator->create_audience(['reportid' => $reportone->get('id'), 'configdata' => []]);
  64          $generator->create_audience(['reportid' => $reporttwo->get('id'), 'configdata' => []]);
  65  
  66          // Switch to second user, get their report listing.
  67          $result = listing::execute();
  68          $result = external_api::clean_returnvalue(listing::execute_returns(), $result);
  69  
  70          $this->assertEquals(['Report one', 'Report two'], array_column($result['reports'], 'name'));
  71          $this->assertEmpty($result['warnings']);
  72      }
  73  
  74      /**
  75       * Test execute method for a user without permission to view reports
  76       */
  77      public function test_execute_access_exception(): void {
  78          global $DB;
  79  
  80          $this->resetAfterTest();
  81  
  82          $userrole = $DB->get_field('role', 'id', ['shortname' => 'user'], MUST_EXIST);
  83          assign_capability('moodle/reportbuilder:view', CAP_PROHIBIT, $userrole, context_system::instance(), true);
  84  
  85          $user = $this->getDataGenerator()->create_user();
  86          $this->setUser($user);
  87  
  88          $this->expectException(report_access_exception::class);
  89          $this->expectExceptionMessage('You cannot view this report');
  90          listing::execute();
  91      }
  92  }