mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 14:27:22 +01:00
9843e5ece5
This locking system is designed to be used everywhere requiring locking in Moodle. Each use of the locking system can be configured to use a different type of locking (or the same type with a different configuration). The first supported lock types are memcache, memcached, file (flock), db (specific handlers for pg, mysql and mariadb).
112 lines
4.0 KiB
PHP
112 lines
4.0 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/>.
|
|
|
|
/**
|
|
* lock unit tests
|
|
*
|
|
* @package core
|
|
* @category test
|
|
* @copyright 2013 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
|
|
defined('MOODLE_INTERNAL') || die();
|
|
|
|
|
|
/**
|
|
* Unit tests for our locking implementations.
|
|
*
|
|
* @package core
|
|
* @category test
|
|
* @copyright 2013 Damyon Wiese
|
|
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
*/
|
|
class lock_testcase extends advanced_testcase {
|
|
|
|
/**
|
|
* Some lock types will store data in the database.
|
|
*/
|
|
protected function setUp() {
|
|
$this->resetAfterTest(true);
|
|
}
|
|
|
|
/**
|
|
* Run a suite of tests on a lock factory.
|
|
* @param \core\lock\lock_factory $lockfactory - A lock factory to test
|
|
*/
|
|
protected function run_on_lock_factory(\core\lock\lock_factory $lockfactory) {
|
|
|
|
if ($lockfactory->is_available()) {
|
|
// This should work.
|
|
$lock1 = $lockfactory->get_lock('abc', 2);
|
|
$this->assertNotEmpty($lock1, 'Get a lock');
|
|
|
|
if ($lockfactory->supports_timeout()) {
|
|
if ($lockfactory->supports_recursion()) {
|
|
$lock2 = $lockfactory->get_lock('abc', 2);
|
|
$this->assertNotEmpty($lock2, 'Get a stacked lock');
|
|
$this->assertTrue($lock2->release(), 'Release a stacked lock');
|
|
} else {
|
|
// This should timeout.
|
|
$lock2 = $lockfactory->get_lock('abc', 2);
|
|
$this->assertFalse($lock2, 'Cannot get a stacked lock');
|
|
}
|
|
}
|
|
// Release the lock.
|
|
$this->assertTrue($lock1->release(), 'Release a lock');
|
|
// Get it again.
|
|
$lock3 = $lockfactory->get_lock('abc', 2);
|
|
|
|
$this->assertNotEmpty($lock3, 'Get a lock again');
|
|
// Release the lock again.
|
|
$this->assertTrue($lock3->release(), 'Release a lock again');
|
|
// Release the lock again (shouldn't hurt).
|
|
$this->assertFalse($lock3->release(), 'Release a lock that is not held');
|
|
if (!$lockfactory->supports_auto_release()) {
|
|
// Test that a lock can be claimed after the timeout period.
|
|
$lock4 = $lockfactory->get_lock('abc', 2, 2);
|
|
$this->assertNotEmpty($lock4, 'Get a lock');
|
|
sleep(3);
|
|
|
|
$lock5 = $lockfactory->get_lock('abc', 2, 2);
|
|
$this->assertNotEmpty($lock5, 'Get another lock after a timeout');
|
|
$this->assertTrue($lock5->release(), 'Release the lock');
|
|
$this->assertTrue($lock4->release(), 'Release the lock');
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tests the testable lock factories.
|
|
* @return void
|
|
*/
|
|
public function test_locks() {
|
|
// Run the suite on the current configured default (may be non-core).
|
|
$defaultfactory = \core\lock\lock_config::get_lock_factory('default');
|
|
$this->run_on_lock_factory($defaultfactory);
|
|
|
|
// Manually create the core no-configuration factories.
|
|
$dblockfactory = new \core\lock\db_record_lock_factory('test');
|
|
$this->run_on_lock_factory($dblockfactory);
|
|
|
|
$filelockfactory = new \core\lock\file_lock_factory('test');
|
|
$this->run_on_lock_factory($filelockfactory);
|
|
|
|
}
|
|
|
|
}
|
|
|