[Summary view]

Differences Between: [Versions 311 and 402] [Versions 311 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  /**
  18   * Tests for report completion events.
  19   *
  20   * @package    report_completion
  21   * @copyright  2014 onwards Ankit Agarwal<ankit.agrr@gmail.com>
  22   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  23   */
  24  
  25  namespace report_completion\event;
  26  
  27  /**
  28   * Class report_completion_events_testcase
  29   *
  30   * Class for tests related to completion report events.
  31   *
  32   * @package    report_completion
  33   * @copyright  2014 onwards Ankit Agarwal<ankit.agrr@gmail.com>
  34   * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
  35   */
  36  class events_test extends \advanced_testcase {
  37  
  38      /**
  39       * Setup testcase.
  40       */
  41      public function setUp(): void {
  42          $this->setAdminUser();
  43          $this->resetAfterTest();
  44      }
  45  
  46      /**
  47       * Test the report viewed event.
  48       *
  49       * It's not possible to use the moodle API to simulate the viewing of log report, so here we
  50       * simply create the event and trigger it.
  51       */
  52      public function test_report_viewed() {
  53          $course = $this->getDataGenerator()->create_course();
  54          $context = \context_course::instance($course->id);
  55          // Trigger event for completion report viewed.
  56          $event = \report_completion\event\report_viewed::create(array('context' => $context));
  57  
  58          // Trigger and capture the event.
  59          $sink = $this->redirectEvents();
  60          $event->trigger();
  61          $events = $sink->get_events();
  62          $event = reset($events);
  63  
  64          $this->assertInstanceOf('\report_completion\event\report_viewed', $event);
  65          $this->assertEquals($context, $event->get_context());
  66          $url = new \moodle_url('/report/completion/index.php', array('course' => $course->id));
  67          $this->assertEquals($url, $event->get_url());
  68          $this->assertEventContextNotUsed($event);
  69      }
  70  
  71      /**
  72       * Test the user report viewed event.
  73       *
  74       * It's not possible to use the moodle API to simulate the viewing of log report, so here we
  75       * simply create the event and trigger it.
  76       */
  77      public function test_user_report_viewed() {
  78          $course = $this->getDataGenerator()->create_course();
  79          $context = \context_course::instance($course->id);
  80          // Trigger event for completion report viewed.
  81          $event = \report_completion\event\user_report_viewed::create(array('context' => $context, 'relateduserid' => 3));
  82  
  83          // Trigger and capture the event.
  84          $sink = $this->redirectEvents();
  85          $event->trigger();
  86          $events = $sink->get_events();
  87          $event = reset($events);
  88  
  89          $this->assertInstanceOf('\report_completion\event\user_report_viewed', $event);
  90          $this->assertEquals($context, $event->get_context());
  91          $this->assertEquals(3, $event->relateduserid);
  92          $this->assertEquals(new \moodle_url('/report/completion/user.php', array('id' => 3, 'course' => $course->id)),
  93                  $event->get_url());
  94          $expected = array($course->id, 'course', 'report completion', "report/completion/user.php?id=3&course=$course->id",
  95                  $course->id);
  96          $this->assertEventLegacyLogData($expected, $event);
  97          $this->assertEventContextNotUsed($event);
  98      }
  99  }