<?php
// This file is part of Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.

/**
 * This file contains the class that handles testing of course events.
 *
 * @package core_course
 * @copyright  2016 Stephen Bourget
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */

namespace core_course\event;

/**
 * This file contains the class that handles testing of course events.
 *
 * @package core_course
 * @copyright  2016 Stephen Bourget
 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
 */
final class events_test extends \advanced_testcase {

    /**
     * Tests set up
     */
    protected function setUp(): void {
        global $CFG;
        require_once($CFG->dirroot . '/course/lib.php');
        parent::setUp();
        $this->resetAfterTest();
    }

    /**
     * Test the course category viewed.
     *
     * There is no external API for viewing a category, so the unit test will simply
     * create and trigger the event and ensure data is returned as expected.
     */
    public function test_course_category_viewed_event(): void {

        // Create a category.
        $category = $this->getDataGenerator()->create_category();

        // Trigger an event: course category viewed.
        $eventparams = array(
            'objectid' => $category->id,
            'context' => \context_system::instance(),
        );

        $event = \core\event\course_category_viewed::create($eventparams);
        // Trigger and capture the event.
        $sink = $this->redirectEvents();
        $event->trigger();
        $events = $sink->get_events();
        $event = reset($events);

        // Check that the event data is valid.
        $this->assertInstanceOf('\core\event\course_category_viewed', $event);
        $this->assertEquals($category->id, $event->objectid);
        $this->assertDebuggingNotCalled();
        $sink->close();

    }

    /**
     * Test the course information viewed.
     *
     * There is no external API for viewing course information so the unit test will simply
     * create and trigger the event and ensure data is returned as expected.
     */
    public function test_course_information_viewed_event(): void {

        // Create a course.
        $data = new \stdClass();
        $course = $this->getDataGenerator()->create_course($data);

        // Trigger an event: course category viewed.
        $eventparams = array(
            'objectid' => $course->id,
            'context' => \context_course::instance($course->id),
        );

        $event = \core\event\course_information_viewed::create($eventparams);
        // Trigger and capture the event.
        $sink = $this->redirectEvents();
        $event->trigger();
        $events = $sink->get_events();
        $event = reset($events);

        // Check that the event data is valid.
        $this->assertInstanceOf('\core\event\course_information_viewed', $event);
        $this->assertEquals($course->id, $event->objectid);
        $this->assertDebuggingNotCalled();
        $sink->close();

    }

    /**
     * Test the courses searched.
     *
     * There is no external API for viewing course information so the unit test will simply
     * create and trigger the event and ensure data is returned as expected.
     */
    public function test_courses_searched_event(): void {

        // Trigger an event: courses searched.
        $search = 'mysearch';
        $eventparams = array(
            'context' => \context_system::instance(),
            'other' => array('query' => $search)
        );

        $event = \core\event\courses_searched::create($eventparams);
        // Trigger and capture the event.
        $sink = $this->redirectEvents();
        $event->trigger();
        $events = $sink->get_events();
        $event = reset($events);

        // Check that the event data is valid.
        $this->assertInstanceOf('\core\event\courses_searched', $event);
        $this->assertEquals($search, $event->other['query']);
        $this->assertDebuggingNotCalled();
        $sink->close();

    }

    /**
     * Test the course activities overview page viewed.
     *
     * There is no external API for viewing course information so the unit test will simply
     * create and trigger the event and ensure data is returned as expected.
     *
     * @covers \core\event\course_overview_viewed
     */
    public function test_course_overview_viewed_event(): void {

        // Create a course.
        $data = new \stdClass();
        $course = $this->getDataGenerator()->create_course($data);

        $eventparams = [
            'context' => \context_course::instance($course->id),
        ];
        $event = \core\event\course_overview_viewed::create($eventparams);

        // Trigger and capture the event.
        $sink = $this->redirectEvents();
        $event->trigger();
        $events = $sink->get_events();
        $event = reset($events);

        // Check that the event data is valid.
        $this->assertInstanceOf('\core\event\course_overview_viewed', $event);
        $this->assertEquals($course->id, $event->courseid);
        $this->assertDebuggingNotCalled();
        $sink->close();

    }
}
