first commit

question/bank/comment/tests/event/comment_created_deleted_test.php

@@ -0,0 +1,127 @@
+<?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/>.
+
+namespace qbank_comment\event;
+
+use advanced_testcase;
+use cache;
+use comment;
+use context;
+use context_course;
+use core_question_generator;
+use stdClass;
+
+/**
+ * Event tests for question comments.
+ *
+ * @package    qbank_comment
+ * @copyright  2021 Catalyst IT Australia Pty Ltd
+ * @author     Safat Shahin <safatshahin@catalyst-au.net>
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class comment_created_deleted_test extends advanced_testcase {
+
+    /** @var stdClass Keeps course object */
+    private $course;
+
+    /** @var context Keeps context */
+    private $context;
+
+    /** @var stdClass Keeps question object */
+    private $questiondata;
+
+    /** @var stdClass Keeps comment object */
+    private $comment;
+
+    /**
+     * Setup test data.
+     */
+    public function setUp(): void {
+        global $CFG;
+        require_once($CFG->dirroot . '/comment/lib.php');
+
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $generator = $this->getDataGenerator();
+
+        /** @var core_question_generator $questiongenerator */
+        $questiongenerator = $generator->get_plugin_generator('core_question');
+
+        // Create a course.
+        $this->course = $generator->create_course();
+        $this->context = context_course::instance($this->course->id);
+
+        // Create a question in the default category.
+        $contexts = new \core_question\local\bank\question_edit_contexts($this->context);
+        $cat = question_make_default_categories($contexts->all());
+        $this->questiondata = $questiongenerator->create_question('numerical', null,
+                ['name' => 'Example question', 'category' => $cat->id]);
+
+        // Ensure the question is not in the cache.
+        $cache = cache::make('core', 'questiondata');
+        $cache->delete($this->questiondata->id);
+
+        // Comment on question.
+        $args = new stdClass;
+        $args->context = $this->context;
+        $args->course = $this->course;
+        $args->area = 'question';
+        $args->itemid = $this->questiondata->id;
+        $args->component = 'qbank_comment';
+        $args->linktext = get_string('commentheader', 'qbank_comment');
+        $args->notoggle = true;
+        $args->autostart = true;
+        $args->displaycancel = false;
+        $this->comment = new comment($args);
+    }
+
+    /**
+     * Test comment_created event.
+     */
+    public function test_comment_created(): void {
+        // Triggering and capturing the event.
+        $sink = $this->redirectEvents();
+        $this->comment->add('New comment');
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Checking that the event contains the expected values.
+        $this->assertInstanceOf('\qbank_comment\event\comment_created', $event);
+        $this->assertEquals($this->context, $event->get_context());
+        $this->assertStringContainsString('\'qbank_comment\' for the question with ID \''.$this->questiondata->id.'\'',
+                $event->get_description());
+    }
+
+    /**
+     * Test comment_created event.
+     */
+    public function test_comment_deleted(): void {
+        // Triggering and capturing the event.
+        $newcomment = $this->comment->add('New comment to delete');
+        $sink = $this->redirectEvents();
+        $this->comment->delete($newcomment->id);
+        $events = $sink->get_events();
+        $this->assertCount(1, $events);
+        $event = reset($events);
+
+        // Checking that the event contains the expected values.
+        $this->assertInstanceOf('\qbank_comment\event\comment_deleted', $event);
+        $this->assertEquals($this->context, $event->get_context());
+        $this->assertStringContainsString('\'qbank_comment\' for the question with ID \''.$this->questiondata->id.'\'',
+                $event->get_description());
+    }
+}

question/bank/comment/tests/event/question_deleted_observer_test.php

@@ -0,0 +1,66 @@
+<?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/>.
+
+namespace qbank_comment\event;
+
+/**
+ * Tests for question_deleted_observer
+ *
+ * @package   qbank_comment
+ * @copyright 2023 onwards Catalyst IT EU {@link https://catalyst-eu.net}
+ * @author    Mark Johnson <mark.johnson@catalyst-eu.net>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ * @covers    \qbank_comment\event\question_deleted_observer
+ */
+class question_deleted_observer_test extends \advanced_testcase {
+
+    /**
+     * Deleting a question with comments should also delete the comments
+     *
+     * @return void
+     */
+    public function test_delete_question_with_comments(): void {
+        $this->resetAfterTest();
+        $this->setAdminUser();
+        $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        [, , , $questions] = $questiongenerator->setup_course_and_questions();
+        $question = reset($questions);
+
+        $context = \context_system::instance();
+        $commentgenerator = $this->getDataGenerator()->get_plugin_generator('core_comment');
+        /** @var \comment $comment */
+        $comment = $commentgenerator->create_comment([
+            'context' => $context,
+            'component' => 'qbank_comment',
+            'area' => 'question',
+            'itemid' => $question->id,
+            'content' => random_string(),
+        ]);
+
+        $this->assertEquals(1, $comment->count());
+
+        question_delete_question($question->id);
+
+        $newcomment = new \comment((object)[
+            'context' => $context,
+            'component' => 'qbank_comment',
+            'area' => 'question',
+            'itemid' => $question->id,
+        ]);
+
+        $this->assertEquals(0, $newcomment->count());
+    }
+}