moodle/lib/tests/event/context_locked_test.php
2023-04-13 11:35:06 +01:00

98 lines
3.8 KiB
PHP

<?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/>.
namespace core\event;
/**
* Unit tests for the context_locked and context_unlocked events.
*
* @package core
* @category test
* @copyright 2019 University of Nottingham
* @author Neill Magill <neill.magill@nottingham.ac.uk>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class context_locked_test extends \advanced_testcase {
/**
* Locks an unlocked context and checks that a core\event\context_locked event is created.
*
* @param \context $context
*/
protected function lock_context(\context $context) {
self::assertFalse($context->is_locked());
$locksink = $this->redirectEvents();
$context->set_locked(true);
// This second call should not create an event as the lock status has not changed.
$context->set_locked(true);
$lockevents = $locksink->get_events();
$locksink->close();
self::assertCount(1, $lockevents);
self::assertContainsOnlyInstancesOf(context_locked::class, $lockevents);
self::assertEquals($context->id, $lockevents[0]->objectid);
$this->assertSame('context', $lockevents[0]->objecttable);
$this->assertEquals($context, $lockevents[0]->get_context());
}
/**
* Tests that events are created when contexts are locked and unlocked.
*/
public function test_creation() {
$this->resetAfterTest();
$category = self::getDataGenerator()->create_category();
$catcontext = \context_coursecat::instance($category->id);
$course = self::getDataGenerator()->create_course(['category' => $category->id]);
$coursecontext = \context_course::instance($course->id);
/** @var \mod_forum_generator $activitygenerator */
$activitygenerator = self::getDataGenerator()->get_plugin_generator('mod_forum');
$activity = $activitygenerator->create_instance(['course' => $course->id]);
$activitycontext = \context_module::instance($activity->cmid);
$this->lock_context($catcontext);
$this->unlock_context($catcontext);
$this->lock_context($coursecontext);
$this->unlock_context($coursecontext);
$this->lock_context($activitycontext);
$this->unlock_context($activitycontext);
}
/**
* Unlocks a locked context and checks that a core\event\context_unlocked event is created.
*
* @param \context $context
*/
protected function unlock_context(\context $context) {
self::assertTrue($context->is_locked());
$unlocksink = $this->redirectEvents();
$context->set_locked(false);
// This second call should not create an event as the lock status has not changed.
$context->set_locked(false);
$unlockevents = $unlocksink->get_events();
$unlocksink->close();
self::assertCount(1, $unlockevents);
self::assertContainsOnlyInstancesOf(context_unlocked::class, $unlockevents);
self::assertEquals($context->id, $unlockevents[0]->objectid);
$this->assertSame('context', $unlockevents[0]->objecttable);
$this->assertEquals($context, $unlockevents[0]->get_context());
}
}