MDL-40053 events: Write unit tests for note events

notes/tests/events_test.php

@@ -0,0 +1,146 @@
+<?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/>.
+
+/**
+ * Tests for notes events.
+ *
+ * @package    core_notes
+ * @copyright  2013 Ankit Agarwal
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+/**
+ * Class core_notes_events_testcase
+ *
+ * Class for tests related to notes events.
+ *
+ * @package    core_notes
+ * @copyright  2013 Ankit Agarwal
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later.
+ */
+class core_notes_events_testcase extends advanced_testcase {
+
+    /** @var  stdClass A note object. */
+    private $eventnote;
+
+    public function setUp() {
+
+        $this->resetAfterTest();
+        $this->setAdminUser();
+
+        $course = $this->getDataGenerator()->create_course();
+        $user = $this->getDataGenerator()->create_user();
+        $gen = $this->getDataGenerator()->get_plugin_generator('core_notes');
+        $this->eventnote = $gen->create_instance(array('courseid' => $course->id, 'userid' => $user->id));
+
+    }
+
+    /**
+     * Tests for event note_deleted.
+     */
+    public function test_note_deleted_event() {
+        // Delete a note.
+        $sink = $this->redirectEvents();
+        note_delete($this->eventnote);
+        $events = $sink->get_events();
+        $event = array_pop($events); // Delete note event.
+        $sink->close();
+
+        // Validate event data.
+        $this->assertInstanceOf('\core\event\note_deleted', $event);
+        $this->assertEquals($this->eventnote->id, $event->objectid);
+        $this->assertEquals($this->eventnote->usermodified, $event->userid);
+        $this->assertEquals($this->eventnote->userid, $event->relateduserid);
+        $this->assertEquals('post', $event->objecttable);
+        $this->assertEquals(null, $event->get_url());
+        $this->assertEquals($this->eventnote, $event->get_record_snapshot('post', $event->objectid));
+        $this->assertEquals(NOTES_STATE_SITE, $event->other['publishstate']);
+
+        // Test legacy data.
+        $logurl = new \moodle_url('index.php',
+                array('course' => $this->eventnote->courseid, 'user' => $this->eventnote->userid));
+        $logurl->set_anchor('note-' . $this->eventnote->id);
+        $arr = array($this->eventnote->courseid, 'notes', 'delete', $logurl, 'delete note');
+        $this->assertEventLegacyLogData($arr, $event);
+    }
+
+    /**
+     * Tests for event note_created.
+     */
+    public function test_note_created_event() {
+
+        // Delete a note.
+        $sink = $this->redirectEvents();
+        $note = clone $this->eventnote;
+        unset($note->id);
+        note_save($note);
+        $events = $sink->get_events();
+        $event = array_pop($events); // Delete note event.
+        $sink->close();
+
+        // Validate event data.
+        $this->assertInstanceOf('\core\event\note_created', $event);
+        $this->assertEquals($note->id, $event->objectid);
+        $this->assertEquals($note->usermodified, $event->userid);
+        $this->assertEquals($note->userid, $event->relateduserid);
+        $this->assertEquals('post', $event->objecttable);
+        $this->assertEquals($note, $event->get_record_snapshot('post', $event->objectid));
+        $this->assertEquals(NOTES_STATE_SITE, $event->other['publishstate']);
+
+        // Test legacy data.
+        $logurl = new \moodle_url('index.php',
+            array('course' => $note->courseid, 'user' => $note->userid));
+        $logurl->set_anchor('note-' . $note->id);
+        $arr = array($note->courseid, 'notes', 'add', $logurl, 'add note');
+        $this->assertEventLegacyLogData($arr, $event);
+
+    }
+
+    /**
+     * Tests for event note_updated.
+     */
+    public function test_note_updated_event() {
+
+        // Delete a note.
+        $sink = $this->redirectEvents();
+        $note = clone $this->eventnote;
+        $note->publishstate = NOTES_STATE_DRAFT;
+        note_save($note);
+        $events = $sink->get_events();
+        $event = array_pop($events); // Delete note event.
+        $sink->close();
+
+        // Validate event data.
+        $this->assertInstanceOf('\core\event\note_updated', $event);
+        $this->assertEquals($note->id, $event->objectid);
+        $this->assertEquals($note->usermodified, $event->userid);
+        $this->assertEquals($note->userid, $event->relateduserid);
+        $this->assertEquals('post', $event->objecttable);
+        $this->assertEquals($note, $event->get_record_snapshot('post', $event->objectid));
+        $this->assertEquals(NOTES_STATE_DRAFT, $event->other['publishstate']);
+
+        // Test legacy data.
+        $logurl = new \moodle_url('index.php',
+            array('course' => $note->courseid, 'user' => $note->userid));
+        $logurl->set_anchor('note-' . $note->id);
+        $arr = array($note->courseid, 'notes', 'update', $logurl, 'update note');
+        $this->assertEventLegacyLogData($arr, $event);
+
+    }
+}
+