[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 core_reportbuilder_generator;
  22  use external_api;
  23  use externallib_advanced_testcase;
  24  use core_reportbuilder\event\report_viewed;
  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 viewing reports
  36   *
  37   * @package     core_reportbuilder
  38   * @covers      \core_reportbuilder\external\reports\view
  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 view_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          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
  54  
  55          // Catch the events.
  56          $sink = $this->redirectEvents();
  57  
  58          $result = view::execute($report->get('id'));
  59          $result = external_api::clean_returnvalue(view::execute_returns(), $result);
  60  
  61          $events = $sink->get_events();
  62          $this->assertCount(1, $events);
  63          $sink->close();
  64  
  65          $this->assertValidKeys($result, ['status', 'warnings']);
  66          $this->assertTrue($result['status']);
  67          $this->assertEmpty($result['warnings']);
  68  
  69          // Validate the event.
  70          $this->assertCount(1, $events);
  71  
  72          $event = reset($events);
  73          $this->assertInstanceOf(report_viewed::class, $event);
  74          $this->assertEquals(report::TABLE, $event->objecttable);
  75          $this->assertEquals($report->get('id'), $event->objectid);
  76          $this->assertEquals($report->get('name'), $event->other['name']);
  77          $this->assertEquals($report->get('source'), $event->other['source']);
  78          $this->assertEquals($report->get_context()->id, $event->contextid);
  79      }
  80  
  81      /**
  82       * Test execute method for a user without permission to view reports
  83       */
  84      public function test_execute_access_exception(): void {
  85          $this->resetAfterTest();
  86  
  87          /** @var core_reportbuilder_generator $generator */
  88          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  89          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
  90  
  91          $user = $this->getDataGenerator()->create_user();
  92          $this->setUser($user);
  93  
  94          $this->expectException(report_access_exception::class);
  95          $this->expectExceptionMessage('You cannot view this report');
  96          view::execute($report->get('id'));
  97      }
  98  }