[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\filters;
  20  
  21  use core_reportbuilder_generator;
  22  use external_api;
  23  use externallib_advanced_testcase;
  24  use core_reportbuilder\report_access_exception;
  25  use core_reportbuilder\local\models\filter;
  26  use core_user\reportbuilder\datasource\users;
  27  
  28  defined('MOODLE_INTERNAL') || die();
  29  
  30  global $CFG;
  31  require_once("{$CFG->dirroot}/webservice/tests/helpers.php");
  32  
  33  /**
  34   * Unit tests of external class for re-ordering report filters
  35   *
  36   * @package     core_reportbuilder
  37   * @covers      \core_reportbuilder\external\filters\reorder
  38   * @copyright   2021 Paul Holden <paulh@moodle.com>
  39   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  40   */
  41  class reorder_test extends externallib_advanced_testcase {
  42  
  43      /**
  44       * Text execute method
  45       */
  46      public function test_execute(): void {
  47          $this->resetAfterTest();
  48          $this->setAdminUser();
  49  
  50          /** @var core_reportbuilder_generator $generator */
  51          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  52  
  53          $report = $generator->create_report([
  54              'name' => 'My report',
  55              'source' => users::class,
  56              'default' => false,
  57          ]);
  58  
  59          // Add four filters.
  60          $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']);
  61          $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
  62          $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']);
  63          $filtercity = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']);
  64  
  65          // Move the city filter to second position.
  66          $result = reorder::execute($report->get('id'), $filtercity->get('id'), 2);
  67          $result = external_api::clean_returnvalue(reorder::execute_returns(), $result);
  68          $this->assertTrue($result['hasavailablefilters']);
  69          $this->assertEquals('User', $result['availablefilters'][0]['optiongroup']['text']);
  70          $this->assertNotEmpty($result['availablefilters'][0]['optiongroup']['values']);
  71          $this->assertTrue($result['hasactivefilters']);
  72          $this->assertCount(4, $result['activefilters']);
  73  
  74          // Assert report filters order.
  75          $filters = filter::get_filter_records($report->get('id'), 'filterorder');
  76  
  77          $filteridentifiers = array_map(static function(filter $filter): string {
  78              return $filter->get('uniqueidentifier');
  79          }, $filters);
  80  
  81          $this->assertEquals([
  82              'user:fullname',
  83              'user:city',
  84              'user:email',
  85              'user:country',
  86          ], $filteridentifiers);
  87      }
  88  
  89      /**
  90       * Test execute method for a user without permission to edit reports
  91       */
  92      public function test_execute_access_exception(): void {
  93          $this->resetAfterTest();
  94  
  95          /** @var core_reportbuilder_generator $generator */
  96          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  97  
  98          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
  99          $filter = $generator->create_filter(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
 100  
 101          $user = $this->getDataGenerator()->create_user();
 102          $this->setUser($user);
 103  
 104          $this->expectException(report_access_exception::class);
 105          $this->expectExceptionMessage('You cannot edit this report');
 106          reorder::execute($report->get('id'), $filter->get('id'), 1);
 107      }
 108  }