[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\columns\sort;
  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\column;
  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 column sorting
  35   *
  36   * @package     core_reportbuilder
  37   * @covers      \core_reportbuilder\external\columns\sort\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          $report = $generator->create_report(['name' => 'My report', 'source' => users::class, 'default' => false]);
  53  
  54          // Add four columns.
  55          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:fullname']);
  56          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
  57          $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:country']);
  58          $columncity = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:city']);
  59  
  60          // Move the city column sort order to second position.
  61          $result = reorder::execute($report->get('id'), $columncity->get('id'), 2);
  62          $result = external_api::clean_returnvalue(reorder::execute_returns(), $result);
  63  
  64          $this->assertTrue($result['hassortablecolumns']);
  65          $this->assertCount(4, $result['sortablecolumns']);
  66          $columnid = $columncity->get('id');
  67          $sortablecolumn = array_filter($result['sortablecolumns'], function(array $column) use($columnid) {
  68              return $column['id'] == $columnid;
  69          });
  70          $sortablecolumn = reset($sortablecolumn);
  71          $this->assertEquals($columnid, $sortablecolumn['id']);
  72          $this->assertEquals('City/town', $sortablecolumn['title']);
  73          $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']);
  74          $this->assertEquals(0, $sortablecolumn['sortenabled']);
  75          $this->assertEquals(2, $sortablecolumn['sortorder']);
  76          $this->assertEquals('t/uplong', $sortablecolumn['sorticon']['key']);
  77          $this->assertEquals('moodle', $sortablecolumn['sorticon']['component']);
  78          $str = get_string('columnsortdirectiondesc', 'core_reportbuilder', 'City/town');
  79          $this->assertEquals($str, $sortablecolumn['sorticon']['title']);
  80  
  81          // Assert report column sort order.
  82          $columns = column::get_records(['reportid' => $report->get('id')], 'sortorder');
  83  
  84          $columnidentifiers = array_map(static function(column $column): string {
  85              return $column->get('uniqueidentifier');
  86          }, $columns);
  87  
  88          $this->assertEquals([
  89              'user:fullname',
  90              'user:city',
  91              'user:email',
  92              'user:country',
  93          ], $columnidentifiers);
  94      }
  95  
  96      /**
  97       * Test execute method for a user without permission to edit reports
  98       */
  99      public function test_execute_access_exception(): void {
 100          $this->resetAfterTest();
 101  
 102          /** @var core_reportbuilder_generator $generator */
 103          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
 104          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
 105          $column = $generator->create_column(['reportid' => $report->get('id'), 'uniqueidentifier' => 'user:email']);
 106  
 107          $user = $this->getDataGenerator()->create_user();
 108          $this->setUser($user);
 109  
 110          $this->expectException(report_access_exception::class);
 111          $this->expectExceptionMessage('You cannot edit this report');
 112          reorder::execute($report->get('id'), $column->get('id'), 2);
 113      }
 114  }