[Summary view]

Differences Between: [Versions 400 and 402] [Versions 401 and 402]

   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;
  20  
  21  use core_reportbuilder_generator;
  22  use core_external\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 adding report columns
  35   *
  36   * @package     core_reportbuilder
  37   * @covers      \core_reportbuilder\external\columns\add
  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 add_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 column.
  60          $result = add::execute($report->get('id'), 'user:fullname');
  61          $result = external_api::clean_returnvalue(add::execute_returns(), $result);
  62  
  63          $this->assertTrue($result['hassortablecolumns']);
  64          $this->assertCount(1, $result['sortablecolumns']);
  65          $sortablecolumn = reset($result['sortablecolumns']);
  66          $this->assertEquals('Full name', $sortablecolumn['title']);
  67          $this->assertEquals(SORT_ASC, $sortablecolumn['sortdirection']);
  68          $this->assertEquals(0, $sortablecolumn['sortenabled']);
  69          $this->assertEquals(1, $sortablecolumn['sortorder']);
  70          $this->assertEquals('t/uplong', $sortablecolumn['sorticon']['key']);
  71          $this->assertEquals('moodle', $sortablecolumn['sorticon']['component']);
  72          $str = get_string('columnsortdirectiondesc', 'core_reportbuilder', 'Full name');
  73          $this->assertEquals($str, $sortablecolumn['sorticon']['title']);
  74  
  75          // Assert report columns.
  76          $columns = column::get_records(['reportid' => $report->get('id')]);
  77          $this->assertCount(1, $columns);
  78          $this->assertEquals('user:fullname', reset($columns)->get('uniqueidentifier'));
  79      }
  80  
  81      /**
  82       * Test execute method for a user without permission to edit 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 edit this report');
  96          add::execute($report->get('id'), 'user:fullname');
  97      }
  98  }