MDL-55188 events: First deprecation of eventslib.php
[moodle.git] / lib / tests / eventslib_test.php
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/>.
17 /**
18  * Tests events subsystem.
19  *
20  * @package    core_event
21  * @subpackage phpunit
22  * @copyright  2007 onwards Martin Dougiamas (http://dougiamas.com)
23  * @author     Petr Skoda {@link http://skodak.org}
24  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
25  */
27 defined('MOODLE_INTERNAL') || die();
30 class core_eventslib_testcase extends advanced_testcase {
32     const DEBUGGING_MSG = 'Events API using $handlers array has been deprecated in favour of Events 2 API, please use it instead.';
34     /**
35      * Create temporary entries in the database for these tests.
36      * These tests have to work no matter the data currently in the database
37      * (meaning they should run on a brand new site). This means several items of
38      * data have to be artificially inseminated (:-) in the DB.
39      */
40     protected function setUp() {
41         parent::setUp();
42         // Set global category settings to -1 (not force).
43         eventslib_sample_function_handler('reset');
44         eventslib_sample_handler_class::static_method('reset');
46         $this->resetAfterTest();
47     }
49     /**
50      * Tests the installation of event handlers from file
51      */
52     public function test_events_update_definition__install() {
53         global $DB;
55         events_update_definition('unittest');
56         $this->assertDebuggingCalledCount(4);
58         $dbcount = $DB->count_records('events_handlers', array('component'=>'unittest'));
59         $handlers = array();
60         require(__DIR__.'/fixtures/events.php');
61         $this->assertCount($dbcount, $handlers, 'Equal number of handlers in file and db: %s');
62     }
64     /**
65      * Tests the uninstallation of event handlers from file.
66      */
67     public function test_events_update_definition__uninstall() {
68         global $DB;
70         events_update_definition('unittest');
71         $this->assertDebuggingCalledCount(4);
73         events_uninstall('unittest');
74         $this->assertDebuggingCalledCount(4);
75         $this->assertEquals(0, $DB->count_records('events_handlers', array('component'=>'unittest')), 'All handlers should be uninstalled: %s');
76     }
78     /**
79      * Tests the update of event handlers from file.
80      */
81     public function test_events_update_definition__update() {
82         global $DB;
84         events_update_definition('unittest');
85         $this->assertDebuggingCalledCount(4);
87         // First modify directly existing handler.
88         $handler = $DB->get_record('events_handlers', array('component'=>'unittest', 'eventname'=>'test_instant'));
90         $original = $handler->handlerfunction;
92         // Change handler in db.
93         $DB->set_field('events_handlers', 'handlerfunction', serialize('some_other_function_handler'), array('id'=>$handler->id));
95         // Update the definition, it should revert the handler back.
96         events_update_definition('unittest');
97         $this->assertDebuggingCalledCount(4);
98         $handler = $DB->get_record('events_handlers', array('component'=>'unittest', 'eventname'=>'test_instant'));
99         $this->assertSame($handler->handlerfunction, $original, 'update should sync db with file definition: %s');
100     }
102     /**
103      * Tests events_trigger_is_registered() function.
104      */
105     public function test_events_is_registered() {
107         events_update_definition('unittest');
108         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
110         $this->assertTrue(events_is_registered('test_instant', 'unittest'));
111         $this->assertDebuggingCalled('events_is_registered() has been deprecated along with all Events 1 API in favour of Events 2' .
112             ' API, please use it instead.', DEBUG_DEVELOPER);
113     }
115     /**
116      * Tests events_trigger_legacy() function.
117      */
118     public function test_events_trigger_legacy_instant() {
120         events_update_definition('unittest');
121         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
123         $this->assertEquals(0, events_trigger_legacy('test_instant', 'ok'));
124         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
125         $this->assertEquals(0, events_trigger_legacy('test_instant', 'ok'));
126         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
127         $this->assertEquals(2, eventslib_sample_function_handler('status'));
128     }
130     /**
131      * Tests events_trigger_legacy() function.
132      */
133     public function test_events_trigger__cron() {
135         events_update_definition('unittest');
136         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
138         $this->assertEquals(0, events_trigger_legacy('test_cron', 'ok'));
139         $this->assertEquals(0, eventslib_sample_handler_class::static_method('status'));
140         events_cron('test_cron');
141         // The events_cron one + one for each triggered event above (triggered in events_dispatch).
142         $this->assertDebuggingCalledCount(2, array(self::DEBUGGING_MSG, self::DEBUGGING_MSG),
143             array(DEBUG_DEVELOPER, DEBUG_DEVELOPER));
144         $this->assertEquals(1, eventslib_sample_handler_class::static_method('status'));
145     }
147     /**
148      * Tests events_pending_count() function.
149      */
150     public function test_events_pending_count() {
152         events_update_definition('unittest');
153         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
155         events_trigger_legacy('test_cron', 'ok');
156         $this->assertDebuggingNotCalled();
157         events_trigger_legacy('test_cron', 'ok');
158         $this->assertDebuggingNotCalled();
159         events_cron('test_cron');
160         // The events_cron one + one for each triggered event above (triggered in events_dispatch).
161         $this->assertDebuggingCalledCount(3);
162         $this->assertEquals(0, events_pending_count('test_cron'), 'all messages should be already dequeued: %s');
163         $this->assertDebuggingCalled('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2' .
164             ' API, please use it instead.', DEBUG_DEVELOPER);
165     }
167     /**
168      * Tests events_trigger_legacy() function when instant handler fails.
169      */
170     public function test_events_trigger__failed_instant() {
171         global $CFG;
173         events_update_definition('unittest');
174         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
176         $olddebug = $CFG->debug;
178         $this->assertEquals(1, events_trigger_legacy('test_instant', 'fail'), 'fail first event: %s');
179         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
180         $this->assertEquals(1, events_trigger_legacy('test_instant', 'ok'), 'this one should fail too: %s');
181         $this->assertDebuggingNotCalled();
183         $this->assertEquals(0, events_cron('test_instant'), 'all events should stay in queue: %s');
184         // events_cron + one for each dispatched event.
185         $this->assertDebuggingCalledCount(3);
187         $this->assertEquals(2, events_pending_count('test_instant'), 'two events should in queue: %s');
188         $this->assertDebuggingCalled('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2' .
189             ' API, please use it instead.', DEBUG_DEVELOPER);
191         $this->assertEquals(0, eventslib_sample_function_handler('status'), 'verify no event dispatched yet: %s');
192         eventslib_sample_function_handler('ignorefail'); // Ignore "fail" eventdata from now on.
193         $this->assertEquals(1, events_trigger_legacy('test_instant', 'ok'), 'this one should go to queue directly: %s');
194         $this->assertDebuggingNotCalled();
196         $this->assertEquals(3, events_pending_count('test_instant'), 'three events should in queue: %s');
197         $this->assertDebuggingCalled('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2' .
198             ' API, please use it instead.', DEBUG_DEVELOPER);
200         $this->assertEquals(0, eventslib_sample_function_handler('status'), 'verify previous event was not dispatched: %s');
201         $this->assertEquals(3, events_cron('test_instant'), 'all events should be dispatched: %s');
202         // events_cron + one for each dispatched event.
203         $this->assertDebuggingCalledCount(4);
205         $this->assertEquals(3, eventslib_sample_function_handler('status'), 'verify three events were dispatched: %s');
206         $this->assertEquals(0, events_pending_count('test_instant'), 'no events should in queue: %s');
207         $this->assertDebuggingCalled('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2' .
208             ' API, please use it instead.', DEBUG_DEVELOPER);
210         $this->assertEquals(0, events_trigger_legacy('test_instant', 'ok'), 'this event should be dispatched immediately: %s');
211         $this->assertDebuggingCalled(self::DEBUGGING_MSG, DEBUG_DEVELOPER);
213         $this->assertEquals(4, eventslib_sample_function_handler('status'), 'verify event was dispatched: %s');
214         $this->assertEquals(0, events_pending_count('test_instant'), 'no events should in queue: %s');
215         $this->assertDebuggingCalled('events_pending_count() has been deprecated along with all Events 1 API in favour of Events 2' .
216             ' API, please use it instead.', DEBUG_DEVELOPER);
217     }
219     /**
220      * Tests that events_trigger throws an exception.
221      */
222     public function test_events_trigger_exception() {
223         $this->expectException('coding_exception');
224         events_trigger('test_instant', 'ok');
225     }
228 /**
229  * Test handler function.
230  */
231 function eventslib_sample_function_handler($eventdata) {
232     static $called = 0;
233     static $ignorefail = false;
235     if ($eventdata == 'status') {
236         return $called;
238     } else if ($eventdata == 'reset') {
239         $called = 0;
240         $ignorefail = false;
241         return;
243     } else if ($eventdata == 'fail') {
244         if ($ignorefail) {
245             $called++;
246             return true;
247         } else {
248             return false;
249         }
251     } else if ($eventdata == 'ignorefail') {
252         $ignorefail = true;
253         return;
255     } else if ($eventdata == 'ok') {
256         $called++;
257         return true;
258     }
260     print_error('invalideventdata', '', '', $eventdata);
264 /**
265  * Test handler class with static method.
266  */
267 class eventslib_sample_handler_class {
268     public static function static_method($eventdata) {
269         static $called = 0;
270         static $ignorefail = false;
272         if ($eventdata == 'status') {
273             return $called;
275         } else if ($eventdata == 'reset') {
276             $called = 0;
277             $ignorefail = false;
278             return;
280         } else if ($eventdata == 'fail') {
281             if ($ignorefail) {
282                 $called++;
283                 return true;
284             } else {
285                 return false;
286             }
288         } else if ($eventdata == 'ignorefail') {
289             $ignorefail = true;
290             return;
292         } else if ($eventdata == 'ok') {
293             $called++;
294             return true;
295         }
297         print_error('invalideventdata', '', '', $eventdata);
298     }