[Summary view]

   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;
  20  
  21  use advanced_testcase;
  22  use core_reportbuilder_generator;
  23  use core_user\reportbuilder\datasource\users;
  24  
  25  /**
  26   * Unit tests for custom report details exporter
  27   *
  28   * @package     core_reportbuilder
  29   * @covers      \core_reportbuilder\external\custom_report_details_exporter
  30   * @copyright   2022 Paul Holden <paulh@moodle.com>
  31   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  32   */
  33  class custom_report_details_exporter_test extends advanced_testcase {
  34  
  35      /**
  36       * Test exported data structure
  37       */
  38      public function test_export(): void {
  39          global $PAGE;
  40  
  41          $this->resetAfterTest();
  42  
  43          $user = $this->getDataGenerator()->create_user();
  44          $this->setUser($user);
  45  
  46          /** @var core_reportbuilder_generator $generator */
  47          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  48          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
  49  
  50          $exporter = new custom_report_details_exporter($report);
  51          $export = $exporter->export($PAGE->get_renderer('core_reportbuilder'));
  52  
  53          // The exporter outputs the persistent details, plus two other properties.
  54          $this->assertEquals($report->get('name'), $export->name);
  55          $this->assertEquals($report->get('source'), $export->source);
  56  
  57          // Source name should be the name of the source.
  58          $this->assertEquals(users::get_name(), $export->sourcename);
  59  
  60          // We use the user exporter for the modifier of the report.
  61          $this->assertObjectHasAttribute('modifiedby', $export);
  62          $this->assertEquals(fullname($user), $export->modifiedby->fullname);
  63      }
  64  }