Proyectos de Subversion Moodle

<?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 core;

use question_bank;

defined('MOODLE_INTERNAL') || die();

global $CFG;

require_once($CFG->libdir . '/questionlib.php');

require_once($CFG->dirroot . '/mod/quiz/locallib.php');

// Get the necessary files to perform backup and restore.

require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');

require_once($CFG->dirroot . '/backup/util/includes/restore_includes.php');

/**

 * Unit tests for (some of) ../questionlib.php.

 *

 * @package    core

 * @category   test

 * @copyright  2006 The Open University

 * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later

 */

class questionlib_test extends \advanced_testcase {

    /**

     * Test set up.

     *

     * This is executed before running any test in this file.

     */

    public function setUp(): void {

        $this->resetAfterTest();

    }

    /**

     * Setup a course, a quiz, a question category and a question for testing.

     *

     * @param string $type The type of question category to create.

     * @return array The created data objects

     */

    public function setup_quiz_and_questions($type = 'module') {

        // Create course category.

        $category = $this->getDataGenerator()->create_category();

        // Create course.

        $course = $this->getDataGenerator()->create_course(array(

            'numsections' => 5,

            'category' => $category->id

        ));

        $options = array(

            'course' => $course->id,

            'duedate' => time(),

        );

        // Generate an assignment with due date (will generate a course event).

        $quiz = $this->getDataGenerator()->create_module('quiz', $options);

        /** @var \core_question_generator $qgen */

        $qgen = $this->getDataGenerator()->get_plugin_generator('core_question');

        switch ($type) {

            case 'course':

                $context = \context_course::instance($course->id);

                break;

            case 'category':

                $context = \context_coursecat::instance($category->id);

                break;

            case 'system':

                $context = \context_system::instance();

                break;

            default:

                $context = \context_module::instance($quiz->cmid);

                break;

        }

        $qcat = $qgen->create_question_category(array('contextid' => $context->id));

        $questions = array(

                $qgen->create_question('shortanswer', null, array('category' => $qcat->id)),

                $qgen->create_question('shortanswer', null, array('category' => $qcat->id)),

        );

        quiz_add_quiz_question($questions[0]->id, $quiz);

        return array($category, $course, $quiz, $qcat, $questions);

    }

    /**

     * Assert that a category contains a specific number of questions.

     *

     * @param int $categoryid int Category id.

     * @param int $numberofquestions Number of question in a category.

     * @return void Questions in a category.

     */

    protected function assert_category_contains_questions(int $categoryid, int $numberofquestions): void {

        $questionsid = question_bank::get_finder()->get_questions_from_categories([$categoryid], null);

        $this->assertEquals($numberofquestions, count($questionsid));

    }

    public function test_question_reorder_qtypes(): void {

        $this->assertEquals(

            array(0 => 't2', 1 => 't1', 2 => 't3'),

            question_reorder_qtypes(array('t1' => '', 't2' => '', 't3' => ''), 't1', +1));

        $this->assertEquals(

            array(0 => 't1', 1 => 't2', 2 => 't3'),

            question_reorder_qtypes(array('t1' => '', 't2' => '', 't3' => ''), 't1', -1));

        $this->assertEquals(

            array(0 => 't2', 1 => 't1', 2 => 't3'),

            question_reorder_qtypes(array('t1' => '', 't2' => '', 't3' => ''), 't2', -1));

        $this->assertEquals(

            array(0 => 't1', 1 => 't2', 2 => 't3'),

            question_reorder_qtypes(array('t1' => '', 't2' => '', 't3' => ''), 't3', +1));

        $this->assertEquals(

            array(0 => 't1', 1 => 't2', 2 => 't3'),

            question_reorder_qtypes(array('t1' => '', 't2' => '', 't3' => ''), 'missing', +1));

    }

    public function test_match_grade_options(): void {

        $gradeoptions = question_bank::fraction_options_full();

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.3333333, 'error'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.333333, 'error'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.33333, 'error'));

        $this->assertFalse(match_grade_options($gradeoptions, 0.3333, 'error'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.3333333, 'nearest'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.333333, 'nearest'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.33333, 'nearest'));

        $this->assertEquals(0.3333333, match_grade_options($gradeoptions, 0.33, 'nearest'));

        $this->assertEquals(-0.1428571, match_grade_options($gradeoptions, -0.15, 'nearest'));

    }

    /**

     * This function tests that the functions responsible for moving questions to

     * different contexts also updates the tag instances associated with the questions.

     */

    public function test_altering_tag_instance_context(): void {

        global $CFG, $DB;

        // Set to admin user.

        $this->setAdminUser();

        // Create two course categories - we are going to delete one of these later and will expect

        // all the questions belonging to the course in the deleted category to be moved.

        $coursecat1 = $this->getDataGenerator()->create_category();

        $coursecat2 = $this->getDataGenerator()->create_category();

        // Create a couple of categories and questions.

        $context1 = \context_coursecat::instance($coursecat1->id);

        $context2 = \context_coursecat::instance($coursecat2->id);

        /** @var \core_question_generator $questiongenerator */

        $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question');

        $questioncat1 = $questiongenerator->create_question_category(array('contextid' =>

            $context1->id));

        $questioncat2 = $questiongenerator->create_question_category(array('contextid' =>

            $context2->id));

        $question1 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat1->id));

        $question2 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat1->id));

        $question3 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat2->id));

        $question4 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat2->id));

        // Now lets tag these questions.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $context1, array('tag 1', 'tag 2'));

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $context1, array('tag 3', 'tag 4'));

        \core_tag_tag::set_item_tags('core_question', 'question', $question3->id, $context2, array('tag 5', 'tag 6'));

        \core_tag_tag::set_item_tags('core_question', 'question', $question4->id, $context2, array('tag 7', 'tag 8'));

        // Test moving the questions to another category.

        question_move_questions_to_category(array($question1->id, $question2->id), $questioncat2->id);

        // Test that all tag_instances belong to one context.

        $this->assertEquals(8, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat2->contextid)));

        // Test moving them back.

        question_move_questions_to_category(array($question1->id, $question2->id), $questioncat1->id);

        // Test that all tag_instances are now reset to how they were initially.

        $this->assertEquals(4, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat1->contextid)));

        $this->assertEquals(4, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat2->contextid)));

        // Now test moving a whole question category to another context.

        question_move_category_to_context($questioncat1->id, $questioncat1->contextid, $questioncat2->contextid);

        // Test that all tag_instances belong to one context.

        $this->assertEquals(8, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat2->contextid)));

        // Now test moving them back.

        question_move_category_to_context($questioncat1->id, $questioncat2->contextid,

            \context_coursecat::instance($coursecat1->id)->id);

        // Test that all tag_instances are now reset to how they were initially.

        $this->assertEquals(4, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat1->contextid)));

        $this->assertEquals(4, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat2->contextid)));

        // Now we want to test deleting the course category and moving the questions to another category.

        question_delete_course_category($coursecat1, $coursecat2);

        // Test that all tag_instances belong to one context.

        $this->assertEquals(8, $DB->count_records('tag_instance', array('component' => 'core_question',

            'contextid' => $questioncat2->contextid)));

        // Create a course.

        $course = $this->getDataGenerator()->create_course();

        // Create some question categories and questions in this course.

        $coursecontext = \context_course::instance($course->id);

        $questioncat = $questiongenerator->create_question_category(array('contextid' => $coursecontext->id));

        $question1 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat->id));

        $question2 = $questiongenerator->create_question('shortanswer', null, array('category' => $questioncat->id));

        // Add some tags to these questions.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, array('tag 1', 'tag 2'));

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, array('tag 1', 'tag 2'));

        // Create a course that we are going to restore the other course to.

        $course2 = $this->getDataGenerator()->create_course();

        // Create backup file and save it to the backup location.

        $bc = new \backup_controller(\backup::TYPE_1COURSE, $course->id, \backup::FORMAT_MOODLE,

            \backup::INTERACTIVE_NO, \backup::MODE_GENERAL, 2);

        $bc->execute_plan();

        $results = $bc->get_results();

        $file = $results['backup_destination'];

        $fp = get_file_packer('application/vnd.moodle.backup');

        $filepath = $CFG->dataroot . '/temp/backup/test-restore-course';

        $file->extract_to_pathname($fp, $filepath);

        $bc->destroy();

        // Now restore the course.

        $rc = new \restore_controller('test-restore-course', $course2->id, \backup::INTERACTIVE_NO,

            \backup::MODE_GENERAL, 2, \backup::TARGET_NEW_COURSE);

        $rc->execute_precheck();

        $rc->execute_plan();

        // Get the created question category.

        $restoredcategory = $DB->get_record_select('question_categories', 'contextid = ? AND parent <> 0',

                array(\context_course::instance($course2->id)->id), '*', MUST_EXIST);

        // Check that there are two questions in the restored to course's context.

        $this->assertEquals(2, $DB->get_record_sql('SELECT COUNT(q.id) as questioncount

                                                               FROM {question} q

                                                               JOIN {question_versions} qv

                                                                 ON qv.questionid = q.id

                                                               JOIN {question_bank_entries} qbe

                                                                 ON qbe.id = qv.questionbankentryid

                                                              WHERE qbe.questioncategoryid = ?',

            [$restoredcategory->id])->questioncount);

        $rc->destroy();

    }

    /**

     * Test that deleting a question from the question bank works in the normal case.

     */

    public function test_question_delete_question(): void {

        global $DB;

        // Setup.

        $context = \context_system::instance();

        /** @var \core_question_generator $qgen */

        $qgen = $this->getDataGenerator()->get_plugin_generator('core_question');

        $qcat = $qgen->create_question_category(array('contextid' => $context->id));

        $q1 = $qgen->create_question('shortanswer', null, array('category' => $qcat->id));

        $q2 = $qgen->create_question('shortanswer', null, array('category' => $qcat->id));

        // Do.

        question_delete_question($q1->id);

        // Verify.

        $this->assertFalse($DB->record_exists('question', ['id' => $q1->id]));

        // Check that we did not delete too much.

        $this->assertTrue($DB->record_exists('question', ['id' => $q2->id]));

    }

    /**

     * Test that deleting a broken question from the question bank does not cause fatal errors.

     */

    public function test_question_delete_question_broken_data(): void {

        global $DB;

        // Setup.

        $context = \context_system::instance();

        /** @var \core_question_generator $qgen */

        $qgen = $this->getDataGenerator()->get_plugin_generator('core_question');

        $qcat = $qgen->create_question_category(array('contextid' => $context->id));

        $q1 = $qgen->create_question('shortanswer', null, array('category' => $qcat->id));

        // Now delete the category, to simulate what happens in old sites where

        // referential integrity has failed.

        $DB->delete_records('question_categories', ['id' => $qcat->id]);

        // Do.

        question_delete_question($q1->id);

        // Verify.

        $this->assertDebuggingCalled('Deleting question ' . $q1->id .

                ' which is no longer linked to a context. Assuming system context ' .

                'to avoid errors, but this may mean that some data like ' .

                'files, tags, are not cleaned up.');

        $this->assertFalse($DB->record_exists('question', ['id' => $q1->id]));

    }

    /**

     * Test deleting a broken question whose category refers to a missing context

     */

    public function test_question_delete_question_missing_context(): void {

        global $DB;

        $coursecategory = $this->getDataGenerator()->create_category();

        $context = $coursecategory->get_context();

        /** @var \core_question_generator $generator */

        $generator = $this->getDataGenerator()->get_plugin_generator('core_question');

        $questioncategory = $generator->create_question_category(['contextid' => $context->id]);

        $question = $generator->create_question('shortanswer', null, ['category' => $questioncategory->id]);

        // Now delete the context, to simulate what happens in old sites where

        // referential integrity has failed.

        $DB->delete_records('context', ['id' => $context->id]);

        question_delete_question($question->id);

        $this->assertDebuggingCalled('Deleting question ' . $question->id .

            ' which is no longer linked to a context. Assuming system context ' .

            'to avoid errors, but this may mean that some data like ' .

            'files, tags, are not cleaned up.');

        $this->assertFalse($DB->record_exists('question', ['id' => $question->id]));

    }

    /**

     * This function tests the question_category_delete_safe function.

     */

    public function test_question_category_delete_safe(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions();

        question_category_delete_safe($qcat);

        // Verify category deleted.

        $criteria = array('id' => $qcat->id);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

        // Verify questions deleted or moved.

        $this->assert_category_contains_questions($qcat->id, 0);

        // Verify question not deleted.

        $criteria = array('id' => $questions[0]->id);

        $this->assertEquals(1, $DB->count_records('question', $criteria));

    }

    /**

     * This function tests the question_delete_activity function.

     */

    public function test_question_delete_activity(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions();

        $cm = get_coursemodule_from_instance('quiz', $quiz->id);

        // Test the deletion.

        question_delete_activity($cm);

        // Verify category deleted.

        $criteria = array('id' => $qcat->id);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

        // Verify questions deleted or moved.

        $this->assert_category_contains_questions($qcat->id, 0);

    }

    /**

     * This function tests the question_delete_context function.

     */

    public function test_question_delete_context(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions();

        // Get the module context id.

        $result = question_delete_context($qcat->contextid);

        // Verify category deleted.

        $criteria = array('id' => $qcat->id);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

        // Verify questions deleted or moved.

        $this->assert_category_contains_questions($qcat->id, 0);

    }

    /**

     * This function tests the question_delete_course function.

     */

    public function test_question_delete_course(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('course');

        // Test the deletion.

        question_delete_course($course);

        // Verify category deleted.

        $criteria = array('id' => $qcat->id);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

        // Verify questions deleted or moved.

        $this->assert_category_contains_questions($qcat->id, 0);

    }

    /**

     * This function tests the question_delete_course_category function.

     */

    public function test_question_delete_course_category(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        // Test that the feedback works.

        question_delete_course_category($category, null);

        // Verify category deleted.

        $criteria = array('id' => $qcat->id);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

        // Verify questions deleted or moved.

        $this->assert_category_contains_questions($qcat->id, 0);

    }

    /**

     * This function tests the question_delete_course_category function when it is supposed to move question categories.

     */

    public function test_question_delete_course_category_move_qcats(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category1, $course1, $quiz1, $qcat1, $questions1) = $this->setup_quiz_and_questions('category');

        list($category2, $course2, $quiz2, $qcat2, $questions2) = $this->setup_quiz_and_questions('category');

        $questionsinqcat1 = count($questions1);

        $questionsinqcat2 = count($questions2);

        // Test the delete.

        question_delete_course_category($category1, $category2);

        // Verify category not deleted.

        $criteria = array('id' => $qcat1->id);

        $this->assertEquals(1, $DB->count_records('question_categories', $criteria));

        // Verify questions are moved.

        $params = array($qcat2->contextid);

        $actualquestionscount = $DB->count_records_sql("SELECT COUNT(*)

                                                              FROM {question} q

                                                              JOIN {question_versions} qv ON qv.questionid = q.id

                                                              JOIN {question_bank_entries} qbe ON qbe.id = qv.questionbankentryid

                                                              JOIN {question_categories} qc ON qc.id = qbe.questioncategoryid

                                                             WHERE qc.contextid = ?", $params);

        $this->assertEquals($questionsinqcat1 + $questionsinqcat2, $actualquestionscount);

        // Verify there is just a single top-level category.

        $criteria = array('contextid' => $qcat2->contextid, 'parent' => 0);

        $this->assertEquals(1, $DB->count_records('question_categories', $criteria));

        // Verify there is no question category in previous context.

        $criteria = array('contextid' => $qcat1->contextid);

        $this->assertEquals(0, $DB->count_records('question_categories', $criteria));

    }

    /**

     * This function tests the question_save_from_deletion function when it is supposed to make a new category and

     * move question categories to that new category.

     */

    public function test_question_save_from_deletion(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions();

        $context = \context::instance_by_id($qcat->contextid);

        $newcat = question_save_from_deletion(array_column($questions, 'id'),

                $context->get_parent_context()->id, $context->get_context_name());

        // Verify that the newcat itself is not a tep level category.

        $this->assertNotEquals(0, $newcat->parent);

        // Verify there is just a single top-level category.

        $this->assertEquals(1, $DB->count_records('question_categories', ['contextid' => $qcat->contextid, 'parent' => 0]));

    }

    /**

     * This function tests the question_save_from_deletion function when it is supposed to make a new category and

     * move question categories to that new category when quiz name is very long but less than 256 characters.

     */

    public function test_question_save_from_deletion_quiz_with_long_name(): void {

        global $DB;

        $this->resetAfterTest(true);

        $this->setAdminUser();

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions();

        // Moodle doesn't allow you to enter a name longer than 255 characters.

        $quiz->name = shorten_text(str_repeat('123456789 ', 26), 255);

        $DB->update_record('quiz', $quiz);

        $context = \context::instance_by_id($qcat->contextid);

        $newcat = question_save_from_deletion(array_column($questions, 'id'),

                $context->get_parent_context()->id, $context->get_context_name());

        // Verifying that the inserted record's name is expected or not.

        $this->assertEquals($DB->get_record('question_categories', ['id' => $newcat->id])->name, $newcat->name);

        // Verify that the newcat itself is not a top level category.

        $this->assertNotEquals(0, $newcat->parent);

        // Verify there is just a single top-level category.

        $this->assertEquals(1, $DB->count_records('question_categories', ['contextid' => $qcat->contextid, 'parent' => 0]));

    }

    /**

     * get_question_options should add the category object to the given question.

     */

    public function test_get_question_options_includes_category_object_single_question(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question = array_shift($questions);

        get_question_options($question);

        $this->assertEquals($qcat, $question->categoryobject);

    }

    /**

     * get_question_options should add the category object to all of the questions in

     * the given list.

     */

    public function test_get_question_options_includes_category_object_multiple_questions(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        get_question_options($questions);

        foreach ($questions as $question) {

            $this->assertEquals($qcat, $question->categoryobject);

        }

    }

    /**

     * get_question_options includes the tags for all questions in the list.

     */

    public function test_get_question_options_includes_question_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['baz', 'bop']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            $expectedtags = [];

            $actualtags = $question->tags;

            foreach ($tags as $tag) {

                $expectedtags[$tag->id] = $tag->get_display_name();

            }

            // The question should have a tags property populated with each tag id

            // and display name as a key vale pair.

            $this->assertEquals($expectedtags, $actualtags);

            $actualtagobjects = $question->tagobjects;

            sort($tags);

            sort($actualtagobjects);

            // The question should have a full set of each tag object.

            $this->assertEquals($tags, $actualtagobjects);

            // The question should not have any course tags.

            $this->assertEmpty($question->coursetagobjects);

        }

    }

    /**

     * get_question_options includes the course tags for all questions in the list.

     */

    public function test_get_question_options_includes_course_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $coursecontext = \context_course::instance($course->id);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['baz', 'bop']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            $expectedcoursetags = [];

            $actualcoursetags = $question->coursetags;

            foreach ($tags as $tag) {

                $expectedcoursetags[$tag->id] = $tag->get_display_name();

            }

            // The question should have a coursetags property populated with each tag id

            // and display name as a key vale pair.

            $this->assertEquals($expectedcoursetags, $actualcoursetags);

            $actualcoursetagobjects = $question->coursetagobjects;

            sort($tags);

            sort($actualcoursetagobjects);

            // The question should have a full set of the course tag objects.

            $this->assertEquals($tags, $actualcoursetagobjects);

            // The question should not have any other tags.

            $this->assertEmpty($question->tagobjects);

            $this->assertEmpty($question->tags);

        }

    }

    /**

     * get_question_options only categorises a tag as a course tag if it is in a

     * course context that is different from the question context.

     */

    public function test_get_question_options_course_tags_in_course_question_context(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('course');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $coursecontext = \context_course::instance($course->id);

        // Create course level tags in the course context that matches the question

        // course context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['baz', 'bop']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            $actualtagobjects = $question->tagobjects;

            sort($tags);

            sort($actualtagobjects);

            // The tags should not be considered course tags because they are in

            // the same context as the question. That makes them question tags.

            $this->assertEmpty($question->coursetagobjects);

            // The course context tags should be returned in the regular tag object

            // list.

            $this->assertEquals($tags, $actualtagobjects);

        }

    }

    /**

     * get_question_options includes the tags and course tags for all questions in the list

     * if each question has course and question level tags.

     */

    public function test_get_question_options_includes_question_and_course_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $coursecontext = \context_course::instance($course->id);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['cfoo', 'cbar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['baz', 'bop']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['cbaz', 'cbop']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $alltags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            $tags = array_filter($alltags, function($tag) use ($qcontext) {

                return $tag->taginstancecontextid == $qcontext->id;

            });

            $coursetags = array_filter($alltags, function($tag) use ($coursecontext) {

                return $tag->taginstancecontextid == $coursecontext->id;

            });

            $expectedtags = [];

            $actualtags = $question->tags;

            foreach ($tags as $tag) {

                $expectedtags[$tag->id] = $tag->get_display_name();

            }

            // The question should have a tags property populated with each tag id

            // and display name as a key vale pair.

            $this->assertEquals($expectedtags, $actualtags);

            $actualtagobjects = $question->tagobjects;

            sort($tags);

            sort($actualtagobjects);

            // The question should have a full set of each tag object.

            $this->assertEquals($tags, $actualtagobjects);

            $actualcoursetagobjects = $question->coursetagobjects;

            sort($coursetags);

            sort($actualcoursetagobjects);

            // The question should have a full set of course tag objects.

            $this->assertEquals($coursetags, $actualcoursetagobjects);

        }

    }

    /**

     * get_question_options should update the context id to the question category

     * context id for any non-course context tag that isn't in the question category

     * context.

     */

    public function test_get_question_options_normalises_question_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $systemcontext = \context_system::instance();

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['baz', 'bop']);

        $q1tags = \core_tag_tag::get_item_tags('core_question', 'question', $question1->id);

        $q2tags = \core_tag_tag::get_item_tags('core_question', 'question', $question2->id);

        $q1tag = array_shift($q1tags);

        $q2tag = array_shift($q2tags);

        // Change two of the tag instances to be a different (non-course) context to the

        // question tag context. These tags should then be normalised back to the question

        // tag context.

        \core_tag_tag::change_instances_context([$q1tag->taginstanceid, $q2tag->taginstanceid], $systemcontext);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            // The database should have been updated with the correct context id.

            foreach ($tags as $tag) {

                $this->assertEquals($qcontext->id, $tag->taginstancecontextid);

            }

            // The tag objects on the question should have been updated with the

            // correct context id.

            foreach ($question->tagobjects as $tag) {

                $this->assertEquals($qcontext->id, $tag->taginstancecontextid);

            }

        }

    }

    /**

     * get_question_options if the question is a course level question then tags

     * in that context should not be consdered course tags, they are question tags.

     */

    public function test_get_question_options_includes_course_context_question_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('course');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $coursecontext = \context_course::instance($course->id);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['baz', 'bop']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            // Tags in a course context that matches the question context should

            // not be considered course tags.

            $this->assertEmpty($question->coursetagobjects);

            $this->assertEmpty($question->coursetags);

            $actualtagobjects = $question->tagobjects;

            sort($tags);

            sort($actualtagobjects);

            // The tags should be considered question tags not course tags.

            $this->assertEquals($tags, $actualtagobjects);

        }

    }

    /**

     * get_question_options should return tags from all course contexts by default.

     */

    public function test_get_question_options_includes_multiple_courses_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $coursecontext = \context_course::instance($course->id);

        // Create a sibling course.

        $siblingcourse = $this->getDataGenerator()->create_course(['category' => $course->category]);

        $siblingcoursecontext = \context_course::instance($siblingcourse->id);

        // Create course tags.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['c1']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['c1']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $siblingcoursecontext, ['c2']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $siblingcoursecontext, ['c2']);

        get_question_options($questions, true);

        foreach ($questions as $question) {

            $this->assertCount(2, $question->coursetagobjects);

            foreach ($question->coursetagobjects as $tag) {

                if ($tag->name == 'c1') {

                    $this->assertEquals($coursecontext->id, $tag->taginstancecontextid);

                } else {

                    $this->assertEquals($siblingcoursecontext->id, $tag->taginstancecontextid);

                }

            }

        }

    }

    /**

     * get_question_options should filter the course tags by the given list of courses.

     */

    public function test_get_question_options_includes_filter_course_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $coursecontext = \context_course::instance($course->id);

        // Create a sibling course.

        $siblingcourse = $this->getDataGenerator()->create_course(['category' => $course->category]);

        $siblingcoursecontext = \context_course::instance($siblingcourse->id);

        // Create course tags.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['foo']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['bar']);

        // Create sibling course tags. These should be filtered out.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $siblingcoursecontext, ['filtered1']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $siblingcoursecontext, ['filtered2']);

        // Ask to only receive course tags from $course (ignoring $siblingcourse tags).

        get_question_options($questions, true, [$course]);

        foreach ($questions as $question) {

            foreach ($question->coursetagobjects as $tag) {

                // We should only be seeing course tags from $course. The tags from

                // $siblingcourse should have been filtered out.

                $this->assertEquals($coursecontext->id, $tag->taginstancecontextid);

            }

        }

    }

    /**

     * question_move_question_tags_to_new_context should update all of the

     * question tags contexts when they are moving down (from system to course

     * category context).

     */

    public function test_question_move_question_tags_to_new_context_system_to_course_cat_qtags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('system');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $newcontext = \context_coursecat::instance($category->id);

        foreach ($questions as $question) {

            $question->contextid = $qcat->contextid;

        }

        // Create tags in the system context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['foo', 'bar']);

        question_move_question_tags_to_new_context($questions, $newcontext);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            // All of the tags should have their context id set to the new context.

            foreach ($tags as $tag) {

                $this->assertEquals($newcontext->id, $tag->taginstancecontextid);

            }

        }

    }

    /**

     * question_move_question_tags_to_new_context should update all of the question tags

     * contexts when they are moving down (from system to course category context)

     * but leave any tags in the course context where they are.

     */

    public function test_question_move_question_tags_to_new_context_system_to_course_cat_qtags_and_course_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('system');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $coursecontext = \context_course::instance($course->id);

        $newcontext = \context_coursecat::instance($category->id);

        foreach ($questions as $question) {

            $question->contextid = $qcat->contextid;

        }

        // Create tags in the system context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['foo']);

        // Create tags in the course context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $coursecontext, ['ctag']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $coursecontext, ['ctag']);

        question_move_question_tags_to_new_context($questions, $newcontext);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            foreach ($tags as $tag) {

                if ($tag->name == 'ctag') {

                    // Course tags should remain in the course context.

                    $this->assertEquals($coursecontext->id, $tag->taginstancecontextid);

                } else {

                    // Other tags should be updated.

                    $this->assertEquals($newcontext->id, $tag->taginstancecontextid);

                }

            }

        }

    }

    /**

     * question_move_question_tags_to_new_context should update all of the question

     * contexts tags when they are moving up (from course category to system context).

     */

    public function test_question_move_question_tags_to_new_context_course_cat_to_system_qtags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $newcontext = \context_system::instance();

        foreach ($questions as $question) {

            $question->contextid = $qcat->contextid;

        }

        // Create tags in the course category context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo', 'bar']);

        \core_tag_tag::set_item_tags('core_question', 'question', $question2->id, $qcontext, ['foo', 'bar']);

        question_move_question_tags_to_new_context($questions, $newcontext);

        foreach ($questions as $question) {

            $tags = \core_tag_tag::get_item_tags('core_question', 'question', $question->id);

            // All of the tags should have their context id set to the new context.

            foreach ($tags as $tag) {

                $this->assertEquals($newcontext->id, $tag->taginstancecontextid);

            }

        }

    }

    /**

     * question_move_question_tags_to_new_context should update all of the question

     * tags contexts when they are moving up (from course category context to system

     * context) but leave any tags in the course context where they are.

     */

    public function test_question_move_question_tags_to_new_context_course_cat_to_system_qtags_and_course_tags(): void {

        list($category, $course, $quiz, $qcat, $questions) = $this->setup_quiz_and_questions('category');

        $question1 = $questions[0];

        $question2 = $questions[1];

        $qcontext = \context::instance_by_id($qcat->contextid);

        $coursecontext = \context_course::instance($course->id);

        $newcontext = \context_system::instance();

        foreach ($questions as $question) {

            $question->contextid = $qcat->contextid;

        }

        // Create tags in the system context.

        \core_tag_tag::set_item_tags('core_question', 'question', $question1->id, $qcontext, ['foo']);