first commit

question/bank/usage/tests/behat/behat_qbank_usage.php

@@ -0,0 +1,59 @@
+<?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/>.
+
+// NOTE: no MOODLE_INTERNAL test here, this file may be required by behat before including /config.php.
+require_once(__DIR__ . '/../../../../../lib/behat/behat_base.php');
+require_once(__DIR__ . '/../../../../tests/behat/behat_question_base.php');
+
+use Behat\Mink\Exception\ExpectationException as ExpectationException,
+    Behat\Mink\Exception\ElementNotFoundException as ElementNotFoundException;
+
+/**
+ * Steps definitions to deal with the usage in question.
+ *
+ * @package    qbank_usage
+ * @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 behat_qbank_usage extends behat_question_base {
+
+    /**
+     * Looks for a table, then looks for a row that contains the given text.
+     * Once it finds the right row, it clicks a link in that row.
+     *
+     * @When I click :arg1 on the usage column
+     * @param string $linkname
+     */
+    public function i_click_on_the_usage_column($linkname) {
+        $exception = new ElementNotFoundException($this->getSession(),
+            'Cannot find any row on the page containing the text ' . $linkname);
+        $row = $this->find('css', sprintf('table tbody tr td.questionusage a:contains("%s")', $linkname), $exception);
+        $row->click();
+    }
+
+    /**
+     * Looks for the appropriate usage count in the column.
+     *
+     * @Then I should see :arg1 on the usage column
+     * @param string $linkdata
+     */
+    public function i_should_see_on_the_usage_column($linkdata) {
+        $exception = new ElementNotFoundException($this->getSession(),
+            'Cannot find any row with the usage count of ' . $linkdata . ' on the column named Usage');
+        $this->find('css', sprintf('table tbody tr td.questionusage a:contains("%s")', $linkdata), $exception);
+    }
+}

question/bank/usage/tests/behat/question_last_used_column.feature

@@ -0,0 +1,31 @@
+@qbank @qbank_usage @javascript
+Feature: Use the qbank plugin manager page for question last used
+  In order to check the plugin behaviour with enable and disable
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel | reference | name           |
+      | Course         | C1     | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext              |
+      | Test questions   | truefalse | First question | Answer the first question |
+
+  Scenario: Enable/disable question last usage column from the base view
+    Given I log in as "admin"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "Question usage"
+    When I click on "Disable" "link" in the "Question usage" "table_row"
+    And I am on the "Test quiz" "quiz activity" page
+    And I navigate to "Question bank" in current page administration
+    Then I should not see "Last used"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "Question usage" "table_row"
+    And I am on the "Test quiz" "quiz activity" page
+    And I navigate to "Question bank" in current page administration
+    And I should see "Last used"

question/bank/usage/tests/behat/question_usage_column.feature

@@ -0,0 +1,53 @@
+@qbank @qbank_usage
+Feature: Use the qbank plugin manager page for question usage
+  In order to check the plugin behaviour with enable and disable
+
+  Background:
+    Given the following "courses" exist:
+      | fullname | shortname | category |
+      | Course 1 | C1        | 0        |
+    And the following "activities" exist:
+      | activity   | name      | course | idnumber |
+      | quiz       | Test quiz | C1     | quiz1    |
+    And the following "question categories" exist:
+      | contextlevel | reference | name           |
+      | Course         | C1     | Test questions |
+    And the following "questions" exist:
+      | questioncategory | qtype     | name           | questiontext              |
+      | Test questions   | truefalse | First question | Answer the first question |
+
+  Scenario: Enable/disable question usage column from the base view
+    Given I log in as "admin"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I should see "Question usage"
+    When I click on "Disable" "link" in the "Question usage" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    Then I should not see "Usage"
+    And I navigate to "Plugins > Question bank plugins > Manage question bank plugins" in site administration
+    And I click on "Enable" "link" in the "Question usage" "table_row"
+    And I am on the "Test quiz" "mod_quiz > question bank" page
+    And I should see "Usage"
+
+  @javascript
+  Scenario: Question usage modal should work without any usage data
+    And I am on the "Test quiz" "mod_quiz > question bank" page logged in as "admin"
+    And I apply question bank filter "Category" with value "Test questions"
+    And I should see "Test questions"
+    And I should see "0" on the usage column
+    When I click "0" on the usage column
+    Then I should see "Version 1"
+    And I should see "v1 (latest)" in the "Question 1" "question"
+    And I click on "Close" "button" in the ".modal-dialog" "css_element"
+    And I should see "0" on the usage column
+
+  @javascript
+  Scenario: Question usage modal should work with usage data
+    Given quiz "Test quiz" contains the following questions:
+      | question       | page |
+      | First question | 1    |
+    And I am on the "Test quiz" "mod_quiz > question bank" page logged in as "admin"
+    And I apply question bank filter "Category" with value "Test questions"
+    And I should see "Test questions"
+    And I should see "1" on the usage column
+    When I click "1" on the usage column
+    Then "Test quiz" "table_row" should exist in the "question-usage_table" "region"

question/bank/usage/tests/helper_test.php

@@ -0,0 +1,260 @@
+<?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_usage;
+
+defined('MOODLE_INTERNAL') || die();
+
+use mod_quiz\quiz_attempt;
+
+global $CFG;
+require_once($CFG->dirroot . '/mod/quiz/tests/quiz_question_helper_test_trait.php');
+
+/**
+ * Helper test.
+ *
+ * @package    qbank_usage
+ * @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
+ * @coversDefaultClass \qbank_usage\helper
+ */
+class helper_test extends \advanced_testcase {
+
+    use \quiz_question_helper_test_trait;
+
+    /**
+     * @var \stdClass $quiz
+     */
+    protected $quiz;
+
+    /**
+     * @var \stdClass $user
+     */
+    protected $user;
+
+    /**
+     * @var \core_question_generator $questiongenerator
+     */
+    protected $questiongenerator;
+
+    /**
+     * @var array $questions
+     */
+    protected $questions = [];
+
+    /**
+     * Test setup.
+     */
+    public function setup(): void {
+        $this->resetAfterTest();
+        $layout = '1,2,0';
+        // Make a user to do the quiz.
+        $this->user = $this->getDataGenerator()->create_user();
+        $course = $this->getDataGenerator()->create_course();
+        // Make a quiz.
+        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');
+        $this->quiz = $quizgenerator->create_instance(['course' => $course->id,
+                'grade' => 100.0, 'sumgrades' => 2, 'layout' => $layout]);
+
+        $this->questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        $cat = $this->questiongenerator->create_question_category();
+
+        $page = 1;
+        foreach (explode(',', $layout) as $slot) {
+            if ($slot == 0) {
+                $page += 1;
+                continue;
+            }
+
+            $question = $this->questiongenerator->create_question('shortanswer', null, ['category' => $cat->id]);
+            quiz_add_quiz_question($question->id, $this->quiz, $page);
+            $this->questions [] = $question;
+        }
+    }
+
+    /**
+     * Record a quiz attempt.
+     *
+     * @return void
+     */
+    protected function attempt_quiz(): void {
+        $quizobj = \mod_quiz\quiz_settings::create($this->quiz->id, $this->user->id);
+
+        $quba = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());
+        $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);
+        $timenow = time();
+        $attempt = quiz_create_attempt($quizobj, 1, false, $timenow, false, $this->user->id);
+        quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);
+        quiz_attempt_save_started($quizobj, $quba, $attempt);
+        quiz_attempt::create($attempt->id);
+    }
+
+    /**
+     * Test question attempt count.
+     *
+     * @covers ::get_question_attempts_count_in_quiz
+     */
+    public function test_get_question_attempts_count_in_quiz(): void {
+        $this->attempt_quiz();
+        foreach ($this->questions as $question) {
+            $questionattemptcount = helper::get_question_attempts_count_in_quiz($question->id, $this->quiz->id);
+            // Test the attempt count matches the usage count, each question should have one count.
+            $this->assertEquals(1, $questionattemptcount);
+        }
+    }
+
+    /**
+     * Test test usage data.
+     *
+     * @covers ::get_question_entry_usage_count
+     */
+    public function test_get_question_entry_usage_count(): void {
+        foreach ($this->questions as $question) {
+            $count = helper::get_question_entry_usage_count(\question_bank::load_question($question->id));
+            // Test that the attempt data matches the usage data for the count.
+            $this->assertEquals(1, $count);
+        }
+    }
+
+    /**
+     * If a question has been included via a random question attempt, this should be counted as a usage.
+     *
+     * @covers ::get_question_entry_usage_count
+     * @return void
+     */
+    public function test_get_random_question_attempts_usage_count(): void {
+        $this->setAdminUser();
+        $cat = $this->questiongenerator->create_question_category();
+        $question = $this->questiongenerator->create_question('shortanswer', null, ['category' => $cat->id]);
+        $this->add_random_questions($this->quiz->id, 1, $cat->id, 1);
+
+        $qdef = \question_bank::load_question($question->id);
+        $count = helper::get_question_entry_usage_count($qdef);
+        $this->assertEquals(0, $count);
+
+        $this->attempt_quiz();
+
+        $count = helper::get_question_entry_usage_count($qdef);
+        $this->assertEquals(1, $count);
+    }
+
+    /**
+     * When a question referenced directly is edited, the usage count of all versions remains the same.
+     *
+     * When checking usage of separate versions, the new version should show usages but the original version should not.
+     *
+     * @covers ::get_question_entry_usage_count
+     * @return void
+     */
+    public function test_edited_question_usage_counts(): void {
+        foreach ($this->questions as $question) {
+            $qdef = \question_bank::load_question($question->id);
+            $count1 = helper::get_question_entry_usage_count($qdef);
+            // Each question should have 1 usage.
+            $this->assertEquals(1, $count1);
+
+            $newversion = $this->questiongenerator->update_question($question);
+            $newqdef = \question_bank::load_question($newversion->id);
+
+            // Either version should return the same count if not checking a specific version.
+            $count2 = helper::get_question_entry_usage_count($qdef);
+            $this->assertEquals(1, $count2);
+            $count3 = helper::get_question_entry_usage_count($newqdef);
+            $this->assertEquals(1, $count3);
+            // Checking the specific version count should return the counts for each version.
+            // The original version is no longer included in the quiz, so has 0 usages.
+            $count4 = helper::get_question_entry_usage_count($qdef, true);
+            $this->assertEquals(0, $count4);
+            // The new version is now included in the quiz, so has 1 usage.
+            $count5 = helper::get_question_entry_usage_count($newqdef, true);
+            $this->assertEquals(1, $count5);
+        }
+    }
+
+    /**
+     * When a question referenced directly with attempts is edited, the usage count of all versions remains the same.
+     *
+     * When checking usage of separate versions, both versions should show usage.
+     *
+     * @covers ::get_question_entry_usage_count
+     * @return void
+     */
+    public function test_edited_attempted_question_usage_counts(): void {
+        $this->attempt_quiz();
+
+        foreach ($this->questions as $question) {
+            $qdef = \question_bank::load_question($question->id);
+            $count1 = helper::get_question_entry_usage_count($qdef);
+            // Each question should have 1 usage.
+            $this->assertEquals(1, $count1);
+
+            $newversion = $this->questiongenerator->update_question($question);
+            $newqdef = \question_bank::load_question($newversion->id);
+
+            // Either version should return the same count if not checking a specific version.
+            $count2 = helper::get_question_entry_usage_count($qdef);
+            $this->assertEquals(1, $count2);
+            $count3 = helper::get_question_entry_usage_count($newqdef);
+            $this->assertEquals(1, $count3);
+            // Checking the specific version count should return the counts for each version.
+            // The original version is no longer included in the quiz. However, the is still an attempt using this question version,
+            // so it has 1 usage.
+            $count4 = helper::get_question_entry_usage_count($qdef, true);
+            $this->assertEquals(1, $count4);
+            // The new version is now included in the quiz, so has 1 usage.
+            $count5 = helper::get_question_entry_usage_count($newqdef, true);
+            $this->assertEquals(1, $count5);
+        }
+    }
+
+    /**
+     * When a random question with attempts is edited, it should still have the same usage count.
+     *
+     * When checking usage of separate versions, the original version should still show usage but the new version should not.
+     *
+     * @covers ::get_question_entry_usage_count
+     * @return void
+     */
+    public function test_edited_attempted_random_question_usage_count(): void {
+        $this->setAdminUser();
+        $cat = $this->questiongenerator->create_question_category();
+        $question = $this->questiongenerator->create_question('shortanswer', null, ['category' => $cat->id]);
+        $this->add_random_questions($this->quiz->id, 1, $cat->id, 1);
+
+        $this->attempt_quiz();
+
+        $qdef = \question_bank::load_question($question->id);
+        $count1 = helper::get_question_entry_usage_count($qdef);
+        $this->assertEquals(1, $count1);
+
+        $newversion = $this->questiongenerator->update_question($question);
+        $newqdef = \question_bank::load_question($newversion->id);
+
+        // Either version should return the same count if not checking a specific version.
+        $count2 = helper::get_question_entry_usage_count($qdef);
+        $this->assertEquals(1, $count2);
+        $count3 = helper::get_question_entry_usage_count($newqdef);
+        $this->assertEquals(1, $count3);
+        // Checking the specific version count should return the counts for each version.
+        // There is still an attempt of the original version has part of the random question attempt, so it has 1 usage.
+        $count4 = helper::get_question_entry_usage_count($qdef, true);
+        $this->assertEquals(1, $count4);
+        // There is no attempt of the new version, so it has 0 usages.
+        $count5 = helper::get_question_entry_usage_count($newqdef, true);
+        $this->assertEquals(0, $count5);
+    }
+}

question/bank/usage/tests/question_usage_test.php

@@ -0,0 +1,86 @@
+<?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_usage;
+
+use mod_quiz\quiz_attempt;
+
+/**
+ * Tests for the data of question usage from differnet areas like helper or usage table.
+ *
+ * @package    qbank_usage
+ * @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
+ * @coversDefaultClass \qbank_usage\tables\question_usage_table
+ * @covers \qbank_usage_output_fragment_question_usage
+ */
+class question_usage_test extends \advanced_testcase {
+
+    /**
+     * Test question usage data.
+     */
+    public function test_question_usage(): void {
+        global $PAGE;
+        $this->resetAfterTest(true);
+        $layout = '1,2,0';
+        // Make a user to do the quiz.
+        $user = $this->getDataGenerator()->create_user();
+        $course = $this->getDataGenerator()->create_course();
+        // Make a quiz.
+        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');
+        $quiz = $quizgenerator->create_instance(['course' => $course->id,
+            'grade' => 100.0, 'sumgrades' => 2, 'layout' => $layout]);
+
+        $quizobj = \mod_quiz\quiz_settings::create($quiz->id, $user->id);
+
+        $quba = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());
+        $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);
+
+        $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');
+        $cat = $questiongenerator->create_question_category();
+
+        $questions = [];
+        $page = 1;
+        foreach (explode(',', $layout) as $slot) {
+            if ($slot == 0) {
+                $page += 1;
+                continue;
+            }
+
+            $question = $questiongenerator->create_question('shortanswer', null, ['category' => $cat->id]);
+            quiz_add_quiz_question($question->id, $quiz, $page);
+            $questions[] = $question;
+        }
+
+        $timenow = time();
+        $attempt = quiz_create_attempt($quizobj, 1, false, $timenow, false, $user->id);
+        quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);
+        quiz_attempt_save_started($quizobj, $quba, $attempt);
+        $attemptdata = quiz_attempt::create($attempt->id);
+
+        $this->setAdminUser();
+        $PAGE->set_url(new \moodle_url('/'));
+        foreach ($questions as $question) {
+            $questionusagetable = qbank_usage_output_fragment_question_usage(['questionid' => $question->id]);
+            // Test usage table contains the quiz data which was attempted.
+            $this->assertStringContainsString($quiz->name, $questionusagetable);
+
+            // Test usage table contains the course data where the quiz was attempted.
+            $this->assertStringContainsString($course->fullname, $questionusagetable);
+        }
+    }
+}