mirror of
https://github.com/moodle/moodle.git
synced 2025-08-05 08:56:36 +02:00
MDL-9848 eventslib improvements and cleanup
This commit is contained in:
skodak
parent
cd26d8e047
commit
d46306de6a
10 changed files with 534 additions and 227 deletions
41
lib/simpletest/fixtures/events.php
Normal file
41
lib/simpletest/fixtures/events.php
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
<?php // $Id$
|
||||
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
// //
|
||||
// NOTICE OF COPYRIGHT //
|
||||
// //
|
||||
// Moodle - Modular Object-Oriented Dynamic Learning Environment //
|
||||
// http://moodle.org //
|
||||
// //
|
||||
// Copyright (C) 1999-2007 Martin Dougiamas http://dougiamas.com //
|
||||
// //
|
||||
// This program 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 2 of the License, or //
|
||||
// (at your option) any later version. //
|
||||
// //
|
||||
// This program 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: //
|
||||
// //
|
||||
// http://www.gnu.org/copyleft/gpl.html //
|
||||
// //
|
||||
///////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
$events = array (
|
||||
'test_instant' => array (
|
||||
'handlerfile' => '/lib/simpletest/testeventslib.php',
|
||||
'handlerfunction' => 'sample_function_handler',
|
||||
'schedule' => 'instant'
|
||||
),
|
||||
|
||||
'test_cron' => array (
|
||||
'handlerfile' => '/lib/simpletest/testeventslib.php',
|
||||
'handlerfunction' => array('sample_handler_class', 'static_method'),
|
||||
'schedule' => 'cron'
|
||||
)
|
||||
);
|
||||
|
||||
?>
|
||||
|
|
@ -1,24 +1,84 @@
|
|||
<?php
|
||||
|
||||
/** $Id */
|
||||
require_once(dirname(__FILE__) . '/../../config.php');
|
||||
/* $Id$ */
|
||||
|
||||
if (!defined('MOODLE_INTERNAL')) {
|
||||
die('Direct access to this script is forbidden.'); /// It must be included from a Moodle page
|
||||
}
|
||||
|
||||
global $CFG;
|
||||
require_once($CFG->libdir . '/simpletestlib.php');
|
||||
require_once($CFG->libdir . '/eventslib.php');
|
||||
require_once($CFG->libdir . '/dmllib.php');
|
||||
|
||||
// dummy test function
|
||||
function plusone($eventdata) {
|
||||
|
||||
return $eventdata+1;
|
||||
// test handler function
|
||||
function sample_function_handler($eventdata) {
|
||||
static $called = 0;
|
||||
static $ignorefail = false;
|
||||
|
||||
if ($eventdata == 'status') {
|
||||
return $called;
|
||||
|
||||
} else if ($eventdata == 'reset') {
|
||||
$called = 0;
|
||||
$ignorefail = false;
|
||||
return;
|
||||
|
||||
} else if ($eventdata == 'fail') {
|
||||
if ($ignorefail) {
|
||||
$called++;
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
} else if ($eventdata == 'ignorefail') {
|
||||
$ignorefail = true;
|
||||
return;
|
||||
|
||||
} else if ($eventdata == 'ok') {
|
||||
$called++;
|
||||
return true;
|
||||
}
|
||||
|
||||
error('Incorrect eventadata submitted: '.$eventdata);
|
||||
}
|
||||
|
||||
// test handler class with static method
|
||||
class sample_handler_class {
|
||||
function static_method($eventdata) {
|
||||
static $called = 0;
|
||||
static $ignorefail = false;
|
||||
|
||||
if ($eventdata == 'status') {
|
||||
return $called;
|
||||
|
||||
} else if ($eventdata == 'reset') {
|
||||
$called = 0;
|
||||
$ignorefail = false;
|
||||
return;
|
||||
|
||||
} else if ($eventdata == 'fail') {
|
||||
if ($ignorefail) {
|
||||
$called++;
|
||||
return true;
|
||||
} else {
|
||||
return false;
|
||||
}
|
||||
|
||||
} else if ($eventdata == 'ignorefail') {
|
||||
$ignorefail = true;
|
||||
return;
|
||||
|
||||
} else if ($eventdata == 'ok') {
|
||||
$called++;
|
||||
return true;
|
||||
}
|
||||
|
||||
error('Incorrect eventadata submitted: '.$eventdata);
|
||||
}
|
||||
}
|
||||
|
||||
class eventslib_test extends UnitTestCase {
|
||||
|
||||
var $handlerid;
|
||||
var $handler;
|
||||
var $storedhandler;
|
||||
/**
|
||||
* Create temporary entries in the database for these tests.
|
||||
* These tests have to work no matter the data currently in the database
|
||||
|
|
@ -26,71 +86,118 @@ class eventslib_test extends UnitTestCase {
|
|||
* data have to be artificially inseminated (:-) in the DB.
|
||||
*/
|
||||
function setUp() {
|
||||
|
||||
global $CFG;
|
||||
|
||||
// make a dummy event
|
||||
$eventhandler -> eventname = 'testevent';
|
||||
$eventhandler -> handlermodule = 'unittest';
|
||||
$eventhandler -> handlerfile = '/lib/simpletest/testeventslib.php';
|
||||
$eventhandler -> handlerfunction = 'plusone';
|
||||
$eventhandler -> schedule = 'instant';
|
||||
|
||||
$this -> handler = $eventhandler;
|
||||
$this -> handlerid = insert_record('events_handlers', $eventhandler);
|
||||
$this -> handler->id = $this->handlerid;
|
||||
|
||||
events_uninstall('unittest');
|
||||
sample_function_handler('reset');
|
||||
sample_handler_class::static_method('reset');
|
||||
events_update_definition('unittest');
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete temporary entries from the database
|
||||
*/
|
||||
function tearDown()
|
||||
{
|
||||
delete_records('events_handlers', 'id', $this->handlerid);
|
||||
function tearDown() {
|
||||
events_uninstall('unittest');
|
||||
}
|
||||
|
||||
/**
|
||||
* tests queue_handler() and events_process_queued_handler() and trigger_event()
|
||||
*/
|
||||
function test_events_process_queued_handler_handler() {
|
||||
|
||||
$eventdata = new object;
|
||||
$eventdata->eventdata = serialize(1);
|
||||
$eventdata->schedule = 'instant';
|
||||
|
||||
$eventid = insert_record('events_queue', $eventdata);
|
||||
|
||||
$id = queue_handler($this->handler, $eventid);
|
||||
$storedhandler = get_record('events_queue_handlers', 'id', $id);
|
||||
|
||||
$retval = events_process_queued_handler($storedhandler);
|
||||
$this->assertEqual(2, $retval);
|
||||
$this->storedhandler = $storedhandler;
|
||||
}
|
||||
|
||||
/**
|
||||
* tests events_dequeue()
|
||||
* Tests the installation of event handlers from file
|
||||
*/
|
||||
function test_events_dequeue() {
|
||||
$this->assertTrue(events_dequeue($this->storedhandler));
|
||||
function test__events_update_definition__install() {
|
||||
global $CFG;
|
||||
|
||||
$dbcount = count_records('events_handlers', 'handlermodule', 'unittest');
|
||||
$events = array();
|
||||
require($CFG->libdir.'/simpletest/fixtures/events.php');
|
||||
$filecount = count($events);
|
||||
$this->assertEqual($dbcount, $filecount, 'Equal number of handlers in file and db: %s');
|
||||
}
|
||||
|
||||
/**
|
||||
* tests trigger_event funtion()
|
||||
|
||||
/**
|
||||
* Tests the uninstallation of event handlers from file
|
||||
*/
|
||||
function test_trigger_event() {
|
||||
$eventdata = 2;
|
||||
$this->assertEqual(0, trigger_event('testevent', $eventdata));
|
||||
function test__events_update_definition__uninstall() {
|
||||
events_uninstall('unittest');
|
||||
$this->assertEqual(0, count_records('events_handlers', 'handlermodule', 'unittest'), 'All handlers should be uninstalled: %s');
|
||||
}
|
||||
|
||||
/**
|
||||
* tests trigger_event_is_registered funtion()
|
||||
|
||||
/**
|
||||
* Tests the update of event handlers from file
|
||||
*/
|
||||
function test__events_update_definition__update() {
|
||||
// first modify directly existing handler
|
||||
$handler = get_record('events_handlers', 'handlermodule', 'unittest', 'eventname', 'test_instant');
|
||||
|
||||
$original = $handler->handlerfunction;
|
||||
|
||||
// change handler in db
|
||||
set_field('events_handlers', 'handlerfunction', serialize('some_other_function_handler'), 'id', $handler->id);
|
||||
|
||||
// update the definition, it should revert the handler back
|
||||
events_update_definition('unittest');
|
||||
$handler = get_record('events_handlers', 'handlermodule', 'unittest', 'eventname', 'test_instant');
|
||||
$this->assertEqual($handler->handlerfunction, $original, 'update should sync db with file definition: %s');
|
||||
}
|
||||
|
||||
/**
|
||||
* tests events_trigger_is_registered funtion()
|
||||
*/
|
||||
function test_event_is_registered() {
|
||||
$this->assertTrue(event_is_registered('unittest', 'testevent'));
|
||||
function test__events_is_registered() {
|
||||
$this->assertTrue(events_is_registered('test_instant', 'unittest'));
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* tests events_trigger funtion()
|
||||
*/
|
||||
function test__events_trigger__instant() {
|
||||
$this->assertEqual(0, events_trigger('test_instant', 'ok'));
|
||||
$this->assertEqual(0, events_trigger('test_instant', 'ok'));
|
||||
$this->assertEqual(2, sample_function_handler('status'));
|
||||
}
|
||||
|
||||
/**
|
||||
* tests events_trigger funtion()
|
||||
*/
|
||||
function test__events_trigger__cron() {
|
||||
$this->assertEqual(0, events_trigger('test_cron', 'ok'));
|
||||
$this->assertEqual(0, sample_handler_class::static_method('status'));
|
||||
events_cron();
|
||||
$this->assertEqual(1, sample_handler_class::static_method('status'));
|
||||
}
|
||||
|
||||
/**
|
||||
* tests events_pending_count()
|
||||
*/
|
||||
function test__events_pending_count() {
|
||||
events_trigger('test_cron', 'ok');
|
||||
events_trigger('test_cron', 'ok');
|
||||
$this->assertEqual(2, events_pending_count('test_cron'), 'two events should in queue: %s');
|
||||
events_cron('test_cron');
|
||||
$this->assertEqual(0, events_pending_count('test_cron'), 'all messages should be already dequeued: %s');
|
||||
}
|
||||
|
||||
/**
|
||||
* tests events_trigger funtion() when instant handler fails
|
||||
*/
|
||||
function test__events_trigger__failed_instant() {
|
||||
$this->assertEqual(1, events_trigger('test_instant', 'fail'), 'fail first event: %s');
|
||||
$this->assertEqual(1, events_trigger('test_instant', 'ok'), 'this one should fail too: %s');
|
||||
$this->assertEqual(0, events_cron('test_instant'), 'all events should stay in queue: %s');
|
||||
$this->assertEqual(2, events_pending_count('test_instant'), 'two events should in queue: %s');
|
||||
$this->assertEqual(0, sample_function_handler('status'), 'verify no event dispatched yet: %s');
|
||||
sample_function_handler('ignorefail'); //ignore "fail" eventdata from now on
|
||||
$this->assertEqual(1, events_trigger('test_instant', 'ok'), 'this one should go to queue directly: %s');
|
||||
$this->assertEqual(3, events_pending_count('test_instant'), 'three events should in queue: %s');
|
||||
$this->assertEqual(0, sample_function_handler('status'), 'verify previous event was not dispatched: %s');
|
||||
$this->assertEqual(3, events_cron('test_instant'), 'all events should be dispatched: %s');
|
||||
$this->assertEqual(3, sample_function_handler('status'), 'verify three events were dispatched: %s');
|
||||
$this->assertEqual(0, events_pending_count('test_instant'), 'no events should in queue: %s');
|
||||
$this->assertEqual(0, events_trigger('test_instant', 'ok'), 'this event should be dispatched immediately: %s');
|
||||
$this->assertEqual(4, sample_function_handler('status'), 'verify event was dispatched: %s');
|
||||
$this->assertEqual(0, events_pending_count('test_instant'), 'no events should in queue: %s');
|
||||
}
|
||||
|
||||
|
||||
|
||||
}
|
||||
|
||||
?>
|
||||
Loading…
Add table
Add a link
Reference in a new issue