[Summary view]

Differences Between: [Versions 400 and 402] [Versions 400 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\audiences;
  20  
  21  use context_system;
  22  use core_reportbuilder\local\models\audience;
  23  use core_reportbuilder_generator;
  24  use external_api;
  25  use externallib_advanced_testcase;
  26  use core_reportbuilder\report_access_exception;
  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 deleting report audiences
  36   *
  37   * @package     core_reportbuilder
  38   * @covers      \core_reportbuilder\external\audiences\delete
  39   * @copyright   2021 David Matamoros <davidmc@moodle.com>
  40   * @license     http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
  41   */
  42  class delete_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  
  54          $report = $generator->create_report([
  55              'name' => 'My report',
  56              'source' => users::class,
  57              'default' => false,
  58          ]);
  59  
  60          $audience1 = $generator->create_audience([
  61              'reportid' => $report->get('id'),
  62              'configdata' => [],
  63          ]);
  64          $audience2 = $generator->create_audience([
  65              'reportid' => $report->get('id'),
  66              'configdata' => [],
  67          ]);
  68  
  69          $audiences = audience::get_records(['reportid' => $report->get('id')]);
  70          $this->assertCount(2, $audiences);
  71  
  72          // Delete the first audience.
  73          $result = delete::execute($report->get('id'), $audience1->get_persistent()->get('id'));
  74          $result = external_api::clean_returnvalue(delete::execute_returns(), $result);
  75          $this->assertTrue($result);
  76  
  77          $audiences = audience::get_records(['reportid' => $report->get('id')]);
  78          $this->assertCount(1, $audiences);
  79          $audience = reset($audiences);
  80          $this->assertEquals($audience2->get_persistent()->get('id'), $audience->get('id'));
  81      }
  82  
  83      /**
  84       * Test execute method for a user without permission to edit reports
  85       */
  86      public function test_execute_access_exception(): void {
  87          $this->resetAfterTest();
  88  
  89          /** @var core_reportbuilder_generator $generator */
  90          $generator = $this->getDataGenerator()->get_plugin_generator('core_reportbuilder');
  91  
  92          $report = $generator->create_report(['name' => 'My report', 'source' => users::class]);
  93          $audience1 = $generator->create_audience([
  94              'reportid' => $report->get('id'),
  95              'configdata' => [],
  96          ]);
  97  
  98          $user = $this->getDataGenerator()->create_user();
  99          $this->setUser($user);
 100  
 101          $this->expectException(report_access_exception::class);
 102          $this->expectExceptionMessage('You cannot edit this report');
 103          delete::execute($report->get('id'), $audience1->get_persistent()->get('id'));
 104      }
 105  }