MDL-68733 question behat: question tag generator and use in quiz test

mod/quiz/tests/behat/editing_add_random.feature

@@ -18,33 +18,34 @@ Feature: Adding random questions to a quiz based on category and tags
       | activity   | name   | intro                                           | course | idnumber |
       | quiz       | Quiz 1 | Quiz 1 for testing the Add random question form | C1     | quiz1    |
     And the following "question categories" exist:
-      | contextlevel | reference | name                |
-      | Course       | C1        | Questions Category 1|
-      | Course       | C1        | Questions Category 2|
+      | contextlevel | reference | name                 |
+      | Course       | C1        | Questions Category 1 |
+      | Course       | C1        | Questions Category 2 |
     And the following "questions" exist:
       | questioncategory     | qtype | name            | user     | questiontext    |
       | Questions Category 1 | essay | question 1 name | admin    | Question 1 text |
       | Questions Category 1 | essay | question 2 name | teacher1 | Question 2 text |
+    And the following "core_question > Tags" exist:
+      | question        | tag |
+      | question 1 name | foo |
+      | question 2 name | bar |
 
   Scenario: Available tags are shown in the autocomplete tag field
-    Given I log in as "teacher1"
-    And I am on "Course 1" course homepage
-    When I navigate to "Question bank > Questions" in current page administration
-    And I choose "Edit question" action for "question 1 name" in the question bank
-    And I set the following fields to these values:
-      | Tags | foo |
-    And I press "id_submitbutton"
-    And I choose "Manage tags" action for "question 2 name" in the question bank
-    And I set the following fields in the "Question tags" "dialogue" to these values:
-      | Tags | bar |
-    And I press "Save changes"
-    And I am on the "Quiz 1" "mod_quiz > Edit" page
-    And I open the "last" add to quiz menu
+    Given I am on the "Quiz 1" "mod_quiz > Edit" page logged in as "teacher1"
+    When I open the "last" add to quiz menu
     And I follow "a random question"
     And I open the autocomplete suggestions list
     Then "foo" "autocomplete_suggestions" should exist
     And "bar" "autocomplete_suggestions" should exist
 
+  Scenario: A random question can be added to the quiz
+    Given I am on the "Quiz 1" "mod_quiz > Edit" page logged in as "teacher1"
+    When I open the "last" add to quiz menu
+    And I follow "a random question"
+    And I set the field "Tags" to "foo"
+    And I press "Add random question"
+    Then I should see "Random (Questions Category 1, tags: foo)" on quiz page "1"
+
   Scenario: Teacher without moodle/question:useall should not see the add a random question menu item
     Given the following "permission overrides" exist:
       | capability             | permission | role           | contextlevel | reference |

question/tests/generator/behat_core_question_generator.php

@@ -0,0 +1,60 @@
+<?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/>.
+
+/**
+ * Behat data generator for core_question.
+ *
+ * @package   core_question
+ * @category  test
+ * @copyright 2020 The Open University
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die();
+
+
+/**
+ * Behat data generator for core_question.
+ */
+class behat_core_question_generator extends behat_generator_base {
+
+    protected function get_creatable_entities(): array {
+        // Note, for historical reasons, questions and question categories
+        // are generated by behat_core_generator.
+        return [
+            'Tags' => [
+                'datagenerator' => 'question_tag',
+                'required' => ['question', 'tag'],
+                'switchids' => ['question' => 'questionid'],
+            ],
+        ];
+    }
+
+    /**
+     * Look up the id of a question from its name.
+     *
+     * @param string $questionname the question name, for example 'Question 1'.
+     * @return int corresponding id.
+     */
+    protected function get_question_id(string $questionname): int {
+        global $DB;
+
+        if (!$id = $DB->get_field('question', 'id', ['name' => $questionname])) {
+            throw new Exception('There is no question with name "' . $questionname . '".');
+        }
+        return $id;
+    }
+}

question/tests/generator/lib.php

@@ -71,10 +71,12 @@ class core_question_generator extends component_generator_base {
      * examples from the appropriate {@link question_test_helper} subclass.
      * Then, any files you want to change from the value in the base example you
      * can override using $overrides.
+     *
      * @param string $qtype the question type to create an example of.
      * @param string $which as for the corresponding argument of
      *      {@link question_test_helper::get_question_form_data}. null for the default one.
      * @param array|stdClass $overrides any fields that should be different from the base example.
+     * @return stdClass the question data.
      */
     public function create_question($qtype, $which = null, $overrides = null) {
         global $CFG;
@@ -93,6 +95,17 @@ class core_question_generator extends component_generator_base {
         return $this->update_question($question, $which, $overrides);
     }
 
+    /**
+     * Create a tag on a question.
+     *
+     * @param array $data with two elements ['questionid' => 123, 'tag' => 'mytag'].
+     */
+    public function create_question_tag(array $data): void {
+        $question = question_bank::load_question($data['questionid']);
+        core_tag_tag::add_item_tag('core_question', 'question', $question->id,
+                context::instance_by_id($question->contextid), $data['tag'], 0);
+    }
+
     /**
      * Update an existing question.
      *
@@ -100,6 +113,7 @@ class core_question_generator extends component_generator_base {
      * @param string $which as for the corresponding argument of
      *      {@link question_test_helper::get_question_form_data}. null for the default one.
      * @param array|stdClass $overrides any fields that should be different from the base example.
+     * @return stdClass the question data.
      */
     public function update_question($question, $which = null, $overrides = null) {
         global $CFG, $DB;

question/type/questiontypebase.php

@@ -461,7 +461,7 @@ class question_type {
             $event->trigger();
         }
 
-        $transaction->allow_commit ();
+        $transaction->allow_commit();
 
         return $question;
     }