2 // This file is part of Moodle - http://moodle.org/
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.
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.
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/>.
18 * Tests for event manager, base event and observers.
22 * @copyright 2013 Petr Skoda {@link http://skodak.org}
23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
26 defined('MOODLE_INTERNAL') ||
die();
28 require_once(__DIR__
.'/fixtures/event_fixtures.php');
30 class core_event_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 public function test_event_properties() {
37 $system = \context_system
::instance();
38 $event = \core_tests\event\unittest_executed
::create(array('context'=>$system, 'objectid'=>5, 'other'=>array('sample'=>null, 'xx'=>10)));
40 $this->assertSame('\core_tests\event\unittest_executed', $event->eventname
);
41 $this->assertSame('core_tests', $event->component
);
42 $this->assertSame('executed', $event->action
);
43 $this->assertSame('unittest', $event->target
);
44 $this->assertSame(5, $event->objectid
);
45 $this->assertSame('u', $event->crud
);
46 $this->assertSame(\core\event\base
::LEVEL_PARTICIPATING
, $event->edulevel
);
48 $this->assertEquals($system, $event->get_context());
49 $this->assertSame($system->id
, $event->contextid
);
50 $this->assertSame($system->contextlevel
, $event->contextlevel
);
51 $this->assertSame($system->instanceid
, $event->contextinstanceid
);
53 $this->assertSame($USER->id
, $event->userid
);
54 $this->assertSame(0, $event->courseid
);
56 $this->assertNull($event->relateduserid
);
57 $this->assertFalse(isset($event->relateduserid
));
59 $this->assertSame(0, $event->anonymous
);
61 $this->assertSame(array('sample'=>null, 'xx'=>10), $event->other
);
62 $this->assertTrue(isset($event->other
['xx']));
63 $this->assertFalse(isset($event->other
['sample']));
65 $this->assertLessThanOrEqual(time(), $event->timecreated
);
69 $this->fail('Exception expected on event modification');
70 } catch (\moodle_exception
$e) {
71 $this->assertInstanceOf('coding_exception', $e);
76 $this->fail('Exception expected on event modification');
77 } catch (\moodle_exception
$e) {
78 $this->assertInstanceOf('coding_exception', $e);
81 $event2 = \core_tests\event\unittest_executed
::create(array('contextid'=>$system->id
, 'objectid'=>5, 'anonymous'=>1, 'other'=>array('sample'=>null, 'xx'=>10)));
82 $this->assertEquals($event->get_context(), $event2->get_context());
83 $this->assertSame(1, $event2->anonymous
);
85 $event3 = \core_tests\event\unittest_executed
::create(array('contextid'=>$system->id
, 'objectid'=>5, 'anonymous'=>true, 'other'=>array('sample'=>null, 'xx'=>10)));
86 $this->assertSame(1, $event3->anonymous
);
89 public function test_event_properties_guessing() {
91 $this->resetAfterTest();
93 $course = $this->getDataGenerator()->create_course();
94 $forum = $this->getDataGenerator()->create_module('forum', array('course' => $course->id
));
95 $context = context_module
::instance($forum->cmid
);
96 $event = \core_tests\event\unittest_executed
::create(array('context' => $context, 'objectid' => 5));
98 // Check guessed course ID, and default properties.
99 $this->assertSame('\core_tests\event\unittest_executed', $event->eventname
);
100 $this->assertSame('core_tests', $event->component
);
101 $this->assertSame('executed', $event->action
);
102 $this->assertSame('unittest', $event->target
);
103 $this->assertSame(5, $event->objectid
);
104 $this->assertEquals($context, $event->get_context());
105 $this->assertEquals($course->id
, $event->courseid
);
106 $this->assertSame($USER->id
, $event->userid
);
107 $this->assertNull($event->relateduserid
);
109 $user = $this->getDataGenerator()->create_user();
110 $context = context_user
::instance($user->id
);
111 $event = \core_tests\event\unittest_executed
::create(array('contextid' => $context->id
, 'objectid' => 5));
113 // Check guessing on contextid, and user context level.
114 $this->assertEquals($context, $event->get_context());
115 $this->assertEquals($context->id
, $event->contextid
);
116 $this->assertEquals($context->contextlevel
, $event->contextlevel
);
117 $this->assertSame(0, $event->courseid
);
118 $this->assertSame($USER->id
, $event->userid
);
119 $this->assertSame($user->id
, $event->relateduserid
);
122 public function test_observers_parsing() {
128 'callback' => array('\core_tests\event\unittest_observer', 'observe_all_alt'),
131 'eventname' => '\core_tests\event\unittest_executed',
132 'callback' => '\core_tests\event\unittest_observer::observe_one',
133 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
137 'callback' => array('\core_tests\event\unittest_observer', 'observe_all'),
138 'includefile' => null,
143 'eventname' => '\core\event\unknown_executed',
144 'callback' => '\core_tests\event\unittest_observer::broken_observer',
148 'eventname' => '\core_tests\event\unittest_executed',
149 'callback' => '\core_tests\event\unittest_observer::external_observer',
155 $result = \core\event\manager
::phpunit_replace_observers($observers);
156 $this->assertCount(3, $result);
159 $observer = new stdClass();
160 $observer->callable
= '\core_tests\event\unittest_observer::external_observer';
161 $observer->priority
= 200;
162 $observer->internal
= false;
163 $observer->includefile
= null;
164 $observer->plugintype
= null;
165 $observer->plugin
= null;
166 $expected[0] = $observer;
167 $observer = new stdClass();
168 $observer->callable
= '\core_tests\event\unittest_observer::observe_one';
169 $observer->priority
= 0;
170 $observer->internal
= true;
171 $observer->includefile
= $CFG->dirroot
.'/lib/tests/fixtures/event_fixtures.php';
172 $observer->plugintype
= null;
173 $observer->plugin
= null;
174 $expected[1] = $observer;
176 $this->assertEquals($expected, $result['\core_tests\event\unittest_executed']);
179 $observer = new stdClass();
180 $observer->callable
= '\core_tests\event\unittest_observer::broken_observer';
181 $observer->priority
= 100;
182 $observer->internal
= true;
183 $observer->includefile
= null;
184 $observer->plugintype
= null;
185 $observer->plugin
= null;
186 $expected[0] = $observer;
188 $this->assertEquals($expected, $result['\core\event\unknown_executed']);
191 $observer = new stdClass();
192 $observer->callable
= array('\core_tests\event\unittest_observer', 'observe_all');
193 $observer->priority
= 10;
194 $observer->internal
= true;
195 $observer->includefile
= null;
196 $observer->plugintype
= null;
197 $observer->plugin
= null;
198 $expected[0] = $observer;
199 $observer = new stdClass();
200 $observer->callable
= array('\core_tests\event\unittest_observer', 'observe_all_alt');
201 $observer->priority
= 0;
202 $observer->internal
= true;
203 $observer->includefile
= null;
204 $observer->plugintype
= null;
205 $observer->plugin
= null;
206 $expected[1] = $observer;
208 $this->assertEquals($expected, $result['\core\event\base']);
210 // Now test broken stuff...
214 'eventname' => 'core_tests\event\unittest_executed', // Fix leading backslash.
215 'callback' => '\core_tests\event\unittest_observer::observe_one',
216 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
217 'internal' => 1, // Cast to bool.
220 $result = \core\event\manager
::phpunit_replace_observers($observers);
221 $this->assertCount(1, $result);
223 $observer = new stdClass();
224 $observer->callable
= '\core_tests\event\unittest_observer::observe_one';
225 $observer->priority
= 0;
226 $observer->internal
= true;
227 $observer->includefile
= $CFG->dirroot
.'/lib/tests/fixtures/event_fixtures.php';
228 $observer->plugintype
= null;
229 $observer->plugin
= null;
230 $expected[0] = $observer;
231 $this->assertEquals($expected, $result['\core_tests\event\unittest_executed']);
235 // Missing eventclass.
236 'callback' => '\core_tests\event\unittest_observer::observe_one',
237 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
240 $result = \core\event\manager
::phpunit_replace_observers($observers);
241 $this->assertCount(0, $result);
242 $this->assertDebuggingCalled();
246 'eventname' => '', // Empty eventclass.
247 'callback' => '\core_tests\event\unittest_observer::observe_one',
248 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
251 $result = \core\event\manager
::phpunit_replace_observers($observers);
252 $this->assertCount(0, $result);
253 $this->assertDebuggingCalled();
257 'eventname' => '\core_tests\event\unittest_executed',
259 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
262 $result = \core\event\manager
::phpunit_replace_observers($observers);
263 $this->assertCount(0, $result);
264 $this->assertDebuggingCalled();
268 'eventname' => '\core_tests\event\unittest_executed',
269 'callback' => '', // Empty callable.
270 'includefile' => 'lib/tests/fixtures/event_fixtures.php',
273 $result = \core\event\manager
::phpunit_replace_observers($observers);
274 $this->assertCount(0, $result);
275 $this->assertDebuggingCalled();
279 'eventname' => '\core_tests\event\unittest_executed',
280 'callback' => '\core_tests\event\unittest_observer::observe_one',
281 'includefile' => 'lib/tests/fixtures/event_fixtures.php_xxx', // Missing file.
284 $result = \core\event\manager
::phpunit_replace_observers($observers);
285 $this->assertCount(0, $result);
286 $this->assertDebuggingCalled();
289 public function test_normal_dispatching() {
292 'eventname' => '\core_tests\event\unittest_executed',
293 'callback' => '\core_tests\event\unittest_observer::observe_one',
297 'callback' => '\core_tests\event\unittest_observer::observe_all',
298 'includefile' => null,
304 \core\event\manager
::phpunit_replace_observers($observers);
305 \core_tests\event\unittest_observer
::reset();
307 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
309 $this->assertFalse($event1->is_triggered());
310 $this->assertFalse($event1->is_dispatched());
311 $this->assertFalse($event1->is_restored());
313 $this->assertTrue($event1->is_triggered());
314 $this->assertTrue($event1->is_dispatched());
315 $this->assertFalse($event1->is_restored());
317 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
321 array('observe_all-nesting-1', 'observe_one-1', 'observe_all-666', 'observe_one-666', 'observe_all-2', 'observe_one-2'),
322 \core_tests\event\unittest_observer
::$info);
325 public function test_event_sink() {
326 $sink = $this->redirectEvents();
327 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
329 $this->assertSame(1, $sink->count());
330 $retult = $sink->get_events();
331 $this->assertSame($event1, $retult[0]);
333 $event2 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
335 $this->assertSame(2, $sink->count());
336 $retult = $sink->get_events();
337 $this->assertSame($event1, $retult[0]);
338 $this->assertSame($event2, $retult[1]);
341 $this->assertSame(0, $sink->count());
342 $this->assertSame(array(), $sink->get_events());
344 $event3 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>3, 'xx'=>10)));
346 $this->assertSame(1, $sink->count());
347 $retult = $sink->get_events();
348 $this->assertSame($event3, $retult[0]);
351 $event4 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>4, 'xx'=>10)));
353 $this->assertSame(1, $sink->count());
354 $retult = $sink->get_events();
355 $this->assertSame($event3, $retult[0]);
358 public function test_ignore_exceptions() {
362 'eventname' => '\core_tests\event\unittest_executed',
363 'callback' => '\core_tests\event\unittest_observer::observe_one',
367 'eventname' => '\core_tests\event\unittest_executed',
368 'callback' => '\core_tests\event\unittest_observer::broken_observer',
373 \core\event\manager
::phpunit_replace_observers($observers);
374 \core_tests\event\unittest_observer
::reset();
376 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
378 $this->assertDebuggingCalled();
380 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
382 $this->assertDebuggingCalled();
385 array('broken_observer-1', 'observe_one-1', 'broken_observer-2', 'observe_one-2'),
386 \core_tests\event\unittest_observer
::$info);
389 public function test_external_buffer() {
392 $this->preventResetByRollback();
397 'eventname' => '\core_tests\event\unittest_executed',
398 'callback' => '\core_tests\event\unittest_observer::observe_one',
402 'eventname' => '\core_tests\event\unittest_executed',
403 'callback' => '\core_tests\event\unittest_observer::external_observer',
409 \core\event\manager
::phpunit_replace_observers($observers);
410 \core_tests\event\unittest_observer
::reset();
412 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
414 $event2 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
418 array('external_observer-1', 'observe_one-1', 'external_observer-2', 'observe_one-2'),
419 \core_tests\event\unittest_observer
::$info);
421 \core\event\manager
::phpunit_replace_observers($observers);
422 \core_tests\event\unittest_observer
::reset();
424 $this->assertSame(array(), \core_tests\event\unittest_observer
::$info);
426 $trans = $DB->start_delegated_transaction();
428 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
430 $event2 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
434 array('observe_one-1', 'observe_one-2'),
435 \core_tests\event\unittest_observer
::$info);
437 $trans->allow_commit();
440 array('observe_one-1', 'observe_one-2', 'external_observer-1', 'external_observer-2'),
441 \core_tests\event\unittest_observer
::$info);
443 \core\event\manager
::phpunit_replace_observers($observers);
444 \core_tests\event\unittest_observer
::reset();
446 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
448 $trans = $DB->start_delegated_transaction();
449 $event2 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>2, 'xx'=>10)));
452 $trans->rollback(new \
moodle_exception('xxx'));
453 $this->fail('Expecting exception');
454 } catch (\moodle_exception
$e) {
455 $this->assertInstanceOf('moodle_exception', $e);
459 array('external_observer-1', 'observe_one-1', 'observe_one-2'),
460 \core_tests\event\unittest_observer
::$info);
463 public function test_rollback() {
466 $this->resetAfterTest();
467 $this->preventResetByRollback();
471 'eventname' => '\core_tests\event\unittest_executed',
472 'callback' => '\core_tests\event\unittest_observer::external_observer',
477 \core\event\manager
::phpunit_replace_observers($observers);
478 \core_tests\event\unittest_observer
::reset();
480 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
482 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
483 $this->assertCount(1, \core_tests\event\unittest_observer
::$event);
484 \core_tests\event\unittest_observer
::reset();
486 $transaction1 = $DB->start_delegated_transaction();
488 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
489 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
491 $transaction2 = $DB->start_delegated_transaction();
493 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
494 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
497 $transaction2->rollback(new Exception('x'));
498 $this->fail('Expecting exception');
499 } catch (Exception
$e) {}
500 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
502 $this->assertTrue($DB->is_transaction_started());
505 $transaction1->rollback(new Exception('x'));
506 $this->fail('Expecting exception');
507 } catch (Exception
$e) {}
508 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
510 $this->assertFalse($DB->is_transaction_started());
512 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
513 $this->assertCount(1, \core_tests\event\unittest_observer
::$event);
516 public function test_forced_rollback() {
519 $this->resetAfterTest();
520 $this->preventResetByRollback();
524 'eventname' => '\core_tests\event\unittest_executed',
525 'callback' => '\core_tests\event\unittest_observer::external_observer',
530 \core\event\manager
::phpunit_replace_observers($observers);
531 \core_tests\event\unittest_observer
::reset();
533 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
535 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
536 $this->assertCount(1, \core_tests\event\unittest_observer
::$event);
537 \core_tests\event\unittest_observer
::reset();
539 $transaction1 = $DB->start_delegated_transaction();
541 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
542 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
544 $transaction2 = $DB->start_delegated_transaction();
546 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
547 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
549 $DB->force_transaction_rollback();
550 $this->assertCount(0, \core_tests\event\unittest_observer
::$event);
552 $this->assertFalse($DB->is_transaction_started());
554 \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)))->trigger();
555 $this->assertCount(1, \core_tests\event\unittest_observer
::$event);
558 public function test_deprecated() {
561 $this->resetAfterTest(true);
563 $event = \core_tests\event\deprecated_event1
::create();
564 $this->assertDebuggingCalled('level property is deprecated, use edulevel property instead');
566 $this->assertSame($event::LEVEL_TEACHING
, $event->level
);
567 $this->assertDebuggingCalled('level property is deprecated, use edulevel property instead');
569 $this->assertTrue(isset($event->level
));
570 $this->assertDebuggingCalled('level property is deprecated, use edulevel property instead');
572 $this->assertSame($event::LEVEL_TEACHING
, $event->edulevel
);
575 public function test_legacy() {
578 $this->resetAfterTest(true);
582 'eventname' => '\core_tests\event\unittest_executed',
583 'callback' => '\core_tests\event\unittest_observer::observe_one',
587 'callback' => '\core_tests\event\unittest_observer::observe_all',
588 'includefile' => null,
594 $DB->delete_records('log', array());
595 $this->expectException('coding_exception');
596 events_update_definition('unittest');
598 $DB->delete_records_select('events_handlers', "component <> 'unittest'");
600 $this->assertDebuggingCalled(self
::DEBUGGING_MSG
, DEBUG_DEVELOPER
);
601 $this->assertEquals(3, $DB->count_records('events_handlers'));
602 set_config('loglifetime', 60*60*24*5);
604 \core\event\manager
::phpunit_replace_observers($observers);
605 \core_tests\event\unittest_observer
::reset();
607 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>5, 'xx'=>10)));
610 $event2 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>6, 'xx'=>11)));
611 $event2->nest
= true;
615 array('observe_all-5', 'observe_one-5', 'observe_all-nesting-6', 'observe_one-6', 'observe_all-666', 'observe_one-666'),
616 \core_tests\event\unittest_observer
::$info);
618 $this->assertSame($event1, \core_tests\event\unittest_observer
::$event[0]);
619 $this->assertSame($event1, \core_tests\event\unittest_observer
::$event[1]);
621 $logs = $DB->get_records('log', array(), 'id ASC');
622 $this->assertCount(0, $logs);
625 public function test_restore_event() {
626 $event1 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
627 $data1 = $event1->get_data();
629 $event2 = \core\event\base
::restore($data1, array('origin'=>'clid'));
630 $data2 = $event2->get_data();
632 $this->assertTrue($event2->is_triggered());
633 $this->assertTrue($event2->is_restored());
634 $this->assertEquals($data1, $data2);
635 $this->assertInstanceOf('core_tests\event\unittest_executed', $event2);
637 $this->assertEquals($event1->get_context(), $event2->get_context());
639 // Now test problematic data.
641 $data3['eventname'] = '\\a\\b\\c';
642 $event3 = \core\event\base
::restore($data3, array());
643 $this->assertFalse($event3, 'Class name must match');
646 unset($data4['userid']);
647 $event4 = \core\event\base
::restore($data4, array());
648 $this->assertInstanceOf('core_tests\event\unittest_executed', $event4);
649 $this->assertDebuggingCalled();
653 $event5 = \core\event\base
::restore($data5, array());
654 $this->assertInstanceOf('core_tests\event\unittest_executed', $event5);
655 $this->assertDebuggingCalled();
659 public function test_trigger_problems() {
660 $this->resetAfterTest(true);
662 $event = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>5, 'xx'=>10)));
666 $this->fail('Exception expected on double trigger');
667 } catch (\moodle_exception
$e) {
668 $this->assertInstanceOf('coding_exception', $e);
671 $data = $event->get_data();
672 $restored = \core_tests\event\unittest_executed
::restore($data, array());
673 $this->assertTrue($restored->is_triggered());
674 $this->assertTrue($restored->is_restored());
677 $restored->trigger();
678 $this->fail('Exception expected on triggering of restored event');
679 } catch (\moodle_exception
$e) {
680 $this->assertInstanceOf('coding_exception', $e);
683 $event = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>5, 'xx'=>10)));
685 \core\event\manager
::dispatch($event);
686 $this->fail('Exception expected on manual event dispatching');
687 } catch (\moodle_exception
$e) {
688 $this->assertInstanceOf('coding_exception', $e);
692 public function test_bad_events() {
693 $this->resetAfterTest(true);
696 $event = \core_tests\event\unittest_executed
::create(array('other'=>array('sample'=>5, 'xx'=>10)));
697 $this->fail('Exception expected when context and contextid missing');
698 } catch (\moodle_exception
$e) {
699 $this->assertInstanceOf('coding_exception', $e);
702 $event = \core_tests\event\bad_event
1::create(array('context'=>\context_system
::instance()));
705 $this->fail('Exception expected when $data not valid');
706 } catch (\moodle_exception
$e) {
707 $this->assertInstanceOf('\coding_exception', $e);
710 $event = \core_tests\event\bad_event
2::create(array('context'=>\context_system
::instance()));
713 $this->fail('Exception expected when $data not valid');
714 } catch (\moodle_exception
$e) {
715 $this->assertInstanceOf('\coding_exception', $e);
718 $event = \core_tests\event\bad_event
2b
::create(array('context'=>\context_system
::instance()));
720 $this->assertDebuggingCalled();
722 $event = \core_tests\event\bad_event
3::create(array('context'=>\context_system
::instance()));
724 $this->assertDebuggingCalled();
726 $event = \core_tests\event\bad_event
4::create(array('context'=>\context_system
::instance()));
728 $this->assertDebuggingCalled();
730 $event = \core_tests\event\bad_event
5::create(array('context'=>\context_system
::instance()));
732 $this->assertDebuggingCalled();
734 $event = \core_tests\event\bad_event
6::create(array('objectid'=>1, 'context'=>\context_system
::instance()));
736 $this->assertDebuggingCalled('Unknown table specified in objecttable field');
738 $event = \core_tests\event\bad_event
7::create(array('objectid'=>1, 'context'=>\context_system
::instance()));
741 $this->fail('Exception expected when $data contains objectid but objecttable not specified');
742 } catch (\moodle_exception
$e) {
743 $this->assertInstanceOf('\coding_exception', $e);
746 $event = \core_tests\event\bad_event
8::create(array('context'=>\context_system
::instance()));
748 $this->assertDebuggingCalled('Event property objectid must be set when objecttable is defined');
751 public function test_problematic_events() {
752 $this->resetAfterTest(true);
754 $event1 = \core_tests\event\problematic_event1
::create(array('context'=>\context_system
::instance()));
755 $this->assertDebuggingNotCalled();
756 $this->assertNull($event1->xxx
);
757 $this->assertDebuggingCalled();
759 $event2 = \core_tests\event\problematic_event1
::create(array('xxx'=>0, 'context'=>\context_system
::instance()));
760 $this->assertDebuggingCalled();
762 set_debugging(DEBUG_NONE
);
763 $event3 = \core_tests\event\problematic_event1
::create(array('xxx'=>0, 'context'=>\context_system
::instance()));
764 $this->assertDebuggingNotCalled();
765 set_debugging(DEBUG_DEVELOPER
);
767 $event4 = \core_tests\event\problematic_event1
::create(array('context'=>\context_system
::instance(), 'other'=>array('a'=>1)));
769 $this->assertDebuggingNotCalled();
771 $event5 = \core_tests\event\problematic_event1
::create(array('context'=>\context_system
::instance(), 'other'=>(object)array('a'=>1)));
772 $this->assertDebuggingNotCalled();
774 $this->assertDebuggingCalled();
776 $url = new moodle_url('/admin/');
777 $event6 = \core_tests\event\problematic_event1
::create(array('context'=>\context_system
::instance(), 'other'=>array('a'=>$url)));
778 $this->assertDebuggingNotCalled();
780 $this->assertDebuggingCalled();
782 // Check that whole float numbers do not trigger debugging messages.
783 $event7 = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(),
784 'other' => array('wholenumber' => 90.0000, 'numberwithdecimals' => 54.7656, 'sample' => 1)));
786 $this->assertDebuggingNotCalled();
788 $event = \core_tests\event\problematic_event2
::create(array());
789 $this->assertDebuggingNotCalled();
790 $event = \core_tests\event\problematic_event2
::create(array('context'=>\context_system
::instance()));
791 $this->assertDebuggingCalled();
793 $event = \core_tests\event\problematic_event3
::create(array('other'=>1));
794 $this->assertDebuggingNotCalled();
795 $event = \core_tests\event\problematic_event3
::create(array());
796 $this->assertDebuggingCalled();
799 public function test_record_snapshots() {
802 $this->resetAfterTest(true);
804 $event = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
805 $course1 = $DB->get_record('course', array('id'=>1));
806 $this->assertNotEmpty($course1);
808 $event->add_record_snapshot('course', $course1);
810 $result = $event->get_record_snapshot('course', $course1->id
);
811 // Convert to arrays because record snapshot returns a clone of the object.
812 $this->assertSame((array)$course1, (array)$result);
814 $user = $event->get_record_snapshot('user', 1);
815 $this->assertEquals(1, $user->id
);
816 $this->assertSame('guest', $user->username
);
818 $event->add_record_snapshot('course', $course1);
821 $event->add_record_snapshot('course', $course1);
822 $this->fail('Updating of snapshots after trigger is not ok');;
823 } catch (\moodle_exception
$e) {
824 $this->assertInstanceOf('\coding_exception', $e);
827 $event2 = \core_tests\event\unittest_executed
::restore($event->get_data(), array());
829 $event2->get_record_snapshot('course', $course1->id
);
830 $this->fail('Reading of snapshots from restored events is not ok');;
831 } catch (\moodle_exception
$e) {
832 $this->assertInstanceOf('\coding_exception', $e);
836 public function test_get_name() {
837 $event = \core_tests\event\noname_event
::create(array('other' => array('sample' => 1, 'xx' => 10)));
838 $this->assertEquals("core_tests: noname event", $event->get_name());
841 public function test_iteration() {
842 $event = \core_tests\event\unittest_executed
::create(array('context'=>\context_system
::instance(), 'other'=>array('sample'=>1, 'xx'=>10)));
845 foreach ($event as $k => $v) {
849 $this->assertSame($event->get_data(), $data);
852 public function test_context_not_used() {
853 // TODO: MDL-69688 - This test is far away from my understanding. It throws a
854 // "Trying to get property 'instanceid' of non-object" notice, so
855 // it's not clear for me what the test is doing. This was detected
856 // when preparing tests for PHPUnit 8 (MDL-67673) and, at the end
857 // all that was done is to move the annotation (deprecated) to
858 // explicit expectation. Still try commenting it out and you'll see
860 if (PHP_VERSION_ID
>= 80000) {
861 $this->expectWarning();
863 $this->expectNotice();
865 $event = \core_tests\event\context_used_in_event
::create(array('other' => array('sample' => 1, 'xx' => 10)));
866 $this->assertEventContextNotUsed($event);
868 $eventcontext = phpunit_event_mock
::testable_get_event_context($event);
869 phpunit_event_mock
::testable_set_event_context($event, null);
870 $this->assertEventContextNotUsed($event);
874 * Test that all observer information is returned correctly.
876 public function test_get_all_observers() {
877 // Retrieve all observers.
878 $observers = \core\event\manager
::get_all_observers();
880 // Expected information from the workshop allocation scheduled observer.
881 $expected = new stdClass();
882 $expected->callable
= '\workshopallocation_scheduled\observer::workshop_viewed';
883 $expected->priority
= 0;
884 $expected->internal
= true;
885 $expected->includefile
= null;
886 $expected->plugintype
= 'workshopallocation';
887 $expected->plugin
= 'scheduled';
889 // May be more than one observer for the mod_workshop event.
891 foreach ($observers['\mod_workshop\event\course_module_viewed'] as $observer) {
892 if ($expected == $observer) {
897 $this->assertTrue($found);
901 * Test formatting of the get_explanation method.
902 * This formats the information from an events class docblock.
904 public function test_get_explanation() {
905 $explanation = \core_tests\event\full_docblock
::get_explanation();
907 $expected = "This is an explanation of the event.
908 - I'm making a point here.
909 - I have a second {@link something} point here.
910 - whitespace is intentional to test it's removal.
911 I have something else *Yeah* that.";
913 $this->assertEquals($explanation, $expected);
915 $explanation = \core_tests\event\docblock_test2
::get_explanation();
917 $expected = "We have only the description in the docblock
920 $this->assertEquals($explanation, $expected);
922 $explanation = \core_tests\event\docblock_test3
::get_explanation();
923 $expected = "Calendar event created event.";
924 $this->assertEquals($explanation, $expected);
929 * Test that general information about an event is returned
930 * by the get_static_info() method.
932 public function test_get_static_info() {
933 $staticinfo = \core_tests\event\static_info_viewing
::get_static_info();
936 'eventname' => '\\core_tests\\event\\static_info_viewing',
937 'component' => 'core_tests',
938 'target' => 'static_info',
939 'action' => 'viewing',
942 'objecttable' => 'mod_unittest'
944 $this->assertEquals($staticinfo, $expected);
948 * This tests the internal method of \core\event\manager::get_observing_classes.
950 * What we are testing is if we can subscribe to a parent event class, instead of only
951 * the base event class or the final, implemented event class. This enables us to subscribe
952 * to things like all course module view events, all comment created events, etc.
954 public function test_observe_parent_event() {
955 $this->resetAfterTest();
957 // Ensure this has been reset prior to using it.
958 \core_tests\event\unittest_observer
::reset();
960 $course = $this->getDataGenerator()->create_course();
961 $feed = $this->getDataGenerator()->create_module('feedback', ['course' => $course->id
]);
962 $context = context_module
::instance($feed->cmid
);
964 'context' => $context,
965 'courseid' => $course->id
,
966 'objectid' => $feed->id
969 // This assertion ensures that basic observe use case did not break.
970 \core\event\manager
::phpunit_replace_observers([[
971 'eventname' => '\core_tests\event\course_module_viewed',
972 'callback' => ['\core_tests\event\unittest_observer', 'observe_all_alt'],
975 $pageevent = \core_tests\event\course_module_viewed
::create($data);
976 $pageevent->trigger();
978 $this->assertSame(['observe_all_alt'], \core_tests\event\unittest_observer
::$info, 'Error observing triggered event');
980 \core_tests\event\unittest_observer
::reset();
982 // This assertion tests that we can observe an abstract (parent) class instead of the implemented class.
983 \core\event\manager
::phpunit_replace_observers([[
984 'eventname' => '\core\event\course_module_viewed',
985 'callback' => ['\core_tests\event\unittest_observer', 'observe_all_alt'],
988 $pageevent = \core_tests\event\course_module_viewed
::create($data);
989 $pageevent->trigger();
991 $this->assertSame(['observe_all_alt'], \core_tests\event\unittest_observer
::$info, 'Error observing parent class event');
993 \core_tests\event\unittest_observer
::reset();