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/>.

/**

 * Quiz module external functions tests.

 *

 * @package    mod_quiz

 * @category   external

 * @copyright  2016 Juan Leyva <juan@moodle.com>

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

 * @since      Moodle 3.1

 */

namespace mod_quiz\external;

use core_external\external_api;

use core_question\local\bank\question_version_status;

use externallib_advanced_testcase;

use mod_quiz\question\display_options;

use mod_quiz\quiz_attempt;

use mod_quiz\quiz_settings;

use mod_quiz\structure;

use mod_quiz_external;

use moodle_exception;

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

global $CFG;

require_once($CFG->dirroot . '/webservice/tests/helpers.php');

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

/**

 * Silly class to access mod_quiz_external internal methods.

 *

 * @package mod_quiz

 * @copyright 2016 Juan Leyva <juan@moodle.com>

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

 * @since  Moodle 3.1

 */

class testable_mod_quiz_external extends mod_quiz_external {

    /**

     * Public accessor.

     *

     * @param  array $params Array of parameters including the attemptid and preflight data

     * @param  bool $checkaccessrules whether to check the quiz access rules or not

     * @param  bool $failifoverdue whether to return error if the attempt is overdue

     * @return  array containing the attempt object and access messages

     */

    public static function validate_attempt($params, $checkaccessrules = true, $failifoverdue = true) {

        return parent::validate_attempt($params, $checkaccessrules, $failifoverdue);

    }

    /**

     * Public accessor.

     *

     * @param  array $params Array of parameters including the attemptid

     * @return  array containing the attempt object and display options

     */

    public static function validate_attempt_review($params) {

        return parent::validate_attempt_review($params);

    }

}

/**

 * Quiz module external functions tests

 *

 * @package    mod_quiz

 * @category   external

 * @copyright  2016 Juan Leyva <juan@moodle.com>

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

 * @since      Moodle 3.1

 * @covers \mod_quiz_external

 */

class external_test extends externallib_advanced_testcase {

    use \quiz_question_helper_test_trait;

    /** @var \stdClass course record. */

    protected $course;

    /** @var \stdClass activity record. */

    protected $quiz;

    /** @var \context_module context instance. */

    protected $context;

    /** @var \stdClass */

    protected $cm;

    /** @var \stdClass user record. */

    protected $student;

    /** @var \stdClass user record. */

    protected $teacher;

    /** @var \stdClass user role record. */

    protected $studentrole;

    /** @var \stdClass  user role record. */

    protected $teacherrole;

    /**

     * Set up for every test

     */

    public function setUp(): void {

        global $DB;

        $this->resetAfterTest();

        $this->setAdminUser();

        // Setup test data.

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

        $this->quiz = $this->getDataGenerator()->create_module('quiz', ['course' => $this->course->id]);

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

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

        // Create users.

        $this->student = self::getDataGenerator()->create_user();

        $this->teacher = self::getDataGenerator()->create_user();

        // Users enrolments.

        $this->studentrole = $DB->get_record('role', ['shortname' => 'student']);

        $this->teacherrole = $DB->get_record('role', ['shortname' => 'editingteacher']);

        // Allow student to receive messages.

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

        assign_capability('mod/quiz:emailnotifysubmission', CAP_ALLOW, $this->teacherrole->id, $coursecontext, true);

        $this->getDataGenerator()->enrol_user($this->student->id, $this->course->id, $this->studentrole->id, 'manual');

        $this->getDataGenerator()->enrol_user($this->teacher->id, $this->course->id, $this->teacherrole->id, 'manual');

    }

    /**

     * Create a quiz with questions including a started or finished attempt optionally

     *

     * @param  boolean $startattempt whether to start a new attempt

     * @param  boolean $finishattempt whether to finish the new attempt

     * @param  string $behaviour the quiz preferredbehaviour, defaults to 'deferredfeedback'.

     * @param  boolean $includeqattachments whether to include a question that supports attachments, defaults to false.

     * @param  array $extraoptions extra options for Quiz.

     * @return array array containing the quiz, context and the attempt

     */

    private function create_quiz_with_questions($startattempt = false, $finishattempt = false, $behaviour = 'deferredfeedback',

            $includeqattachments = false, $extraoptions = []) {

        // Create a new quiz with attempts.

        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');

        $data = ['course' => $this->course->id,

                      'sumgrades' => 2,

                      'preferredbehaviour' => $behaviour];

        $data = array_merge($data, $extraoptions);

        $quiz = $quizgenerator->create_instance($data);

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

        // Create a couple of questions.

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

        $cat = $questiongenerator->create_question_category();

        $question = $questiongenerator->create_question('numerical', null, ['category' => $cat->id]);

        quiz_add_quiz_question($question->id, $quiz);

        $question = $questiongenerator->create_question('numerical', null, ['category' => $cat->id]);

        quiz_add_quiz_question($question->id, $quiz);

        if ($includeqattachments) {

            $question = $questiongenerator->create_question('essay', null, ['category' => $cat->id, 'attachments' => 1,

                'attachmentsrequired' => 1]);

            quiz_add_quiz_question($question->id, $quiz);

        }

        $quizobj = quiz_settings::create($quiz->id, $this->student->id);

        // Set grade to pass.

        $item = \grade_item::fetch(['courseid' => $this->course->id, 'itemtype' => 'mod',

                                        'itemmodule' => 'quiz', 'iteminstance' => $quiz->id, 'outcomeid' => null]);

        $item->gradepass = 80;

        $item->update();

        if ($startattempt or $finishattempt) {

            // Now, do one attempt.

            $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->student->id);

            quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);

            quiz_attempt_save_started($quizobj, $quba, $attempt);

            $attemptobj = quiz_attempt::create($attempt->id);

            if ($finishattempt) {

                // Process some responses from the student.

                $tosubmit = [1 => ['answer' => '3.14']];

                $attemptobj->process_submitted_actions(time(), false, $tosubmit);

                // Finish the attempt.

                $attemptobj->process_finish(time(), false);

            }

            return [$quiz, $context, $quizobj, $attempt, $attemptobj, $quba];

        } else {

            return [$quiz, $context, $quizobj];

        }

    }

    /*

     * Test get quizzes by courses

     */

    public function test_mod_quiz_get_quizzes_by_courses(): void {

        global $DB;

        // Create additional course.

        $course2 = self::getDataGenerator()->create_course();

        // Second quiz.

        $record = new \stdClass();

        $record->course = $course2->id;

        $record->intro = '<button>Test with HTML allowed.</button>';

        $quiz2 = self::getDataGenerator()->create_module('quiz', $record);

        // Execute real Moodle enrolment as we'll call unenrol() method on the instance later.

        $enrol = enrol_get_plugin('manual');

        $enrolinstances = enrol_get_instances($course2->id, true);

        foreach ($enrolinstances as $courseenrolinstance) {

            if ($courseenrolinstance->enrol == "manual") {

                $instance2 = $courseenrolinstance;

                break;

            }

        }

        $enrol->enrol_user($instance2, $this->student->id, $this->studentrole->id);

        self::setUser($this->student);

        $returndescription = mod_quiz_external::get_quizzes_by_courses_returns();

        // Create what we expect to be returned when querying the two courses.

        // First for the student user.

        $allusersfields = ['id', 'coursemodule', 'course', 'name', 'intro', 'introformat', 'introfiles', 'lang',

                                'timeopen', 'timeclose', 'grademethod', 'section', 'visible', 'groupmode', 'groupingid',

                                'attempts', 'timelimit', 'grademethod', 'decimalpoints', 'questiondecimalpoints', 'sumgrades',

                                'grade', 'preferredbehaviour', 'hasfeedback'];

        $userswithaccessfields = ['attemptonlast', 'reviewattempt', 'reviewcorrectness', 'reviewmaxmarks', 'reviewmarks',

                                        'reviewspecificfeedback', 'reviewgeneralfeedback', 'reviewrightanswer',

                                        'reviewoverallfeedback', 'questionsperpage', 'navmethod',

                                        'browsersecurity', 'delay1', 'delay2', 'showuserpicture', 'showblocks',

                                        'completionattemptsexhausted', 'completionpass', 'autosaveperiod', 'hasquestions',

                                        'overduehandling', 'graceperiod', 'canredoquestions', 'allowofflineattempts'];

        $managerfields = ['shuffleanswers', 'timecreated', 'timemodified', 'password', 'subnet'];

        // Add expected coursemodule and other data.

        $quiz1 = $this->quiz;

        $quiz1->coursemodule = $quiz1->cmid;

        $quiz1->introformat = 1;

        $quiz1->section = 0;

        $quiz1->visible = true;

        $quiz1->groupmode = 0;

        $quiz1->groupingid = 0;

        $quiz1->hasquestions = 0;

        $quiz1->hasfeedback = 0;

        $quiz1->completionpass = 0;

        $quiz1->autosaveperiod = get_config('quiz', 'autosaveperiod');

        $quiz1->introfiles = [];

        $quiz1->lang = '';

        $quiz2->coursemodule = $quiz2->cmid;

        $quiz2->introformat = 1;

        $quiz2->section = 0;

        $quiz2->visible = true;

        $quiz2->groupmode = 0;

        $quiz2->groupingid = 0;

        $quiz2->hasquestions = 0;

        $quiz2->hasfeedback = 0;

        $quiz2->completionpass = 0;

        $quiz2->autosaveperiod = get_config('quiz', 'autosaveperiod');

        $quiz2->introfiles = [];

        $quiz2->lang = '';

        foreach (array_merge($allusersfields, $userswithaccessfields) as $field) {

            $expected1[$field] = $quiz1->{$field};

            $expected2[$field] = $quiz2->{$field};

        }

        $expectedquizzes = [$expected2, $expected1];

        // Call the external function passing course ids.

        $result = mod_quiz_external::get_quizzes_by_courses([$course2->id, $this->course->id]);

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedquizzes, $result['quizzes']);

        $this->assertCount(0, $result['warnings']);

        // Call the external function without passing course id.

        $result = mod_quiz_external::get_quizzes_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedquizzes, $result['quizzes']);

        $this->assertCount(0, $result['warnings']);

        // Unenrol user from second course and alter expected quizzes.

        $enrol->unenrol_user($instance2, $this->student->id);

        array_shift($expectedquizzes);

        // Call the external function without passing course id.

        $result = mod_quiz_external::get_quizzes_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedquizzes, $result['quizzes']);

        // Call for the second course we unenrolled the user from, expected warning.

        $result = mod_quiz_external::get_quizzes_by_courses([$course2->id]);

        $this->assertCount(1, $result['warnings']);

        $this->assertEquals('1', $result['warnings'][0]['warningcode']);

        $this->assertEquals($course2->id, $result['warnings'][0]['itemid']);

        // Now, try as a teacher for getting all the additional fields.

        self::setUser($this->teacher);

        foreach ($managerfields as $field) {

            $expectedquizzes[0][$field] = $quiz1->{$field};

        }

        $result = mod_quiz_external::get_quizzes_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedquizzes, $result['quizzes']);

        // Admin also should get all the information.

        self::setAdminUser();

        $result = mod_quiz_external::get_quizzes_by_courses([$this->course->id]);

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertEquals($expectedquizzes, $result['quizzes']);

        // Now, prevent access.

        $enrol->enrol_user($instance2, $this->student->id);

        self::setUser($this->student);

        $quiz2->timeclose = time() - DAYSECS;

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

        $result = mod_quiz_external::get_quizzes_by_courses();

        $result = external_api::clean_returnvalue($returndescription, $result);

        $this->assertCount(2, $result['quizzes']);

        // We only see a limited set of fields.

        $this->assertCount(5, $result['quizzes'][0]);

        $this->assertEquals($quiz2->id, $result['quizzes'][0]['id']);

        $this->assertEquals($quiz2->cmid, $result['quizzes'][0]['coursemodule']);

        $this->assertEquals($quiz2->course, $result['quizzes'][0]['course']);

        $this->assertEquals($quiz2->name, $result['quizzes'][0]['name']);

        $this->assertEquals($quiz2->course, $result['quizzes'][0]['course']);

        $this->assertFalse(isset($result['quizzes'][0]['timelimit']));

    }

    /**

     * Test test_view_quiz

     */

    public function test_view_quiz(): void {

        global $DB;

        // Test invalid instance id.

        try {

            mod_quiz_external::view_quiz(0);

            $this->fail('Exception expected due to invalid mod_quiz instance id.');

        } catch (moodle_exception $e) {

            $this->assertEquals('invalidrecord', $e->errorcode);

        }

        // Test not-enrolled user.

        $usernotenrolled = self::getDataGenerator()->create_user();

        $this->setUser($usernotenrolled);

        try {

            mod_quiz_external::view_quiz($this->quiz->id);

            $this->fail('Exception expected due to not enrolled user.');

        } catch (moodle_exception $e) {

            $this->assertEquals('requireloginerror', $e->errorcode);

        }

        // Test user with full capabilities.

        $this->setUser($this->student);

        // Trigger and capture the event.

        $sink = $this->redirectEvents();

        $result = mod_quiz_external::view_quiz($this->quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::view_quiz_returns(), $result);

        $this->assertTrue($result['status']);

        $events = $sink->get_events();

        $this->assertCount(1, $events);

        $event = array_shift($events);

        // Checking that the event contains the expected values.

        $this->assertInstanceOf('\mod_quiz\event\course_module_viewed', $event);

        $this->assertEquals($this->context, $event->get_context());

        $moodlequiz = new \moodle_url('/mod/quiz/view.php', ['id' => $this->cm->id]);

        $this->assertEquals($moodlequiz, $event->get_url());

        $this->assertEventContextNotUsed($event);

        $this->assertNotEmpty($event->get_name());

        // Test user with no capabilities.

        // We need a explicit prohibit since this capability is only defined in authenticated user and guest roles.

        assign_capability('mod/quiz:view', CAP_PROHIBIT, $this->studentrole->id, $this->context->id);

        // Empty all the caches that may be affected  by this change.

        accesslib_clear_all_caches_for_unit_testing();

        \course_modinfo::clear_instance_cache();

        try {

            mod_quiz_external::view_quiz($this->quiz->id);

            $this->fail('Exception expected due to missing capability.');

        } catch (moodle_exception $e) {

            $this->assertEquals('requireloginerror', $e->errorcode);

        }

    }

    public function test_get_user_attempts(): void {

        // Create a quiz with one attempt finished.

        [$quiz, $context, $quizobj, $attempt, $attemptobj] = $this->create_quiz_with_questions(true, true);

        $this->setUser($this->student);

        $result = mod_quiz_external::get_user_attempts($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        $this->assertEquals($quiz->id, $result['attempts'][0]['quiz']);

        $this->assertEquals($this->student->id, $result['attempts'][0]['userid']);

        $this->assertEquals(1, $result['attempts'][0]['attempt']);

        $this->assertArrayHasKey('sumgrades', $result['attempts'][0]);

        $this->assertEquals(1.0, $result['attempts'][0]['sumgrades']);

        // Test filters. Only finished.

        $result = mod_quiz_external::get_user_attempts($quiz->id, 0, 'finished', false);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        // Test filters. All attempts.

        $result = mod_quiz_external::get_user_attempts($quiz->id, 0, 'all', false);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        // Test filters. Unfinished.

        $result = mod_quiz_external::get_user_attempts($quiz->id, 0, 'unfinished', false);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(0, $result['attempts']);

        // Start a new attempt, but not finish it.

        $timenow = time();

        $attempt = quiz_create_attempt($quizobj, 2, false, $timenow, false, $this->student->id);

        $quba = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());

        $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);

        quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);

        quiz_attempt_save_started($quizobj, $quba, $attempt);

        // Test filters. All attempts.

        $result = mod_quiz_external::get_user_attempts($quiz->id, 0, 'all', false);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(2, $result['attempts']);

        // Test filters. Unfinished.

        $result = mod_quiz_external::get_user_attempts($quiz->id, 0, 'unfinished', false);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        // Test manager can see user attempts.

        $this->setUser($this->teacher);

        $result = mod_quiz_external::get_user_attempts($quiz->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($this->student->id, $result['attempts'][0]['userid']);

        $result = mod_quiz_external::get_user_attempts($quiz->id, $this->student->id, 'all');

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(2, $result['attempts']);

        $this->assertEquals($this->student->id, $result['attempts'][0]['userid']);

        // Invalid parameters.

        try {

            mod_quiz_external::get_user_attempts($quiz->id, $this->student->id, 'INVALID_PARAMETER');

            $this->fail('Exception expected due to missing capability.');

        } catch (\invalid_parameter_exception $e) {

            $this->assertEquals('invalidparameter', $e->errorcode);

        }

    }

    public function test_get_user_attempts_with_extra_grades(): void {

        global $DB;

        // Create a quiz with one attempt finished.

        [$quiz, , , $attempt, $attemptobj] = $this->create_quiz_with_questions(true, true);

        // Add some extra grade items.

        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');

        $listeninggrade = $quizgenerator->create_grade_item(['quizid' => $attemptobj->get_quizid(), 'name' => 'Listening']);

        $readinggrade = $quizgenerator->create_grade_item(['quizid' => $attemptobj->get_quizid(), 'name' => 'Reading']);

        $structure = $attemptobj->get_quizobj()->get_structure();

        $structure->update_slot_grade_item($structure->get_slot_by_number(1), $listeninggrade->id);

        $structure->update_slot_grade_item($structure->get_slot_by_number(2), $readinggrade->id);

        $this->setUser($this->student);

        $result = mod_quiz_external::get_user_attempts($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        // Verify additional grades.

        $this->assertEquals(['name' => 'Listening', 'grade' => 1, 'maxgrade' => 1], $result['attempts'][0]['gradeitemmarks'][0]);

        $this->assertEquals(['name' => 'Reading', 'grade' => 0, 'maxgrade' => 1], $result['attempts'][0]['gradeitemmarks'][1]);

        // Now change the review options, so marks are not displayed, and check the result.

        $DB->set_field('quiz', 'reviewmarks', 0, ['id' => $quiz->id]);

        $result = mod_quiz_external::get_user_attempts($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        $this->assertArrayNotHasKey('gradeitemmarks', $result['attempts'][0]);

    }

    /**

     * Test get_user_attempts with marks hidden

     */

    public function test_get_user_attempts_with_marks_hidden(): void {

        // Create quiz with one attempt finished and hide the mark.

        list($quiz, $context, $quizobj, $attempt, $attemptobj) = $this->create_quiz_with_questions(

                true, true, 'deferredfeedback', false,

                ['marksduring' => 0, 'marksimmediately' => 0, 'marksopen' => 0, 'marksclosed' => 0]);

        // Student cannot see the grades.

        $this->setUser($this->student);

        $result = mod_quiz_external::get_user_attempts($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        $this->assertEquals($quiz->id, $result['attempts'][0]['quiz']);

        $this->assertEquals($this->student->id, $result['attempts'][0]['userid']);

        $this->assertEquals(1, $result['attempts'][0]['attempt']);

        $this->assertArrayHasKey('sumgrades', $result['attempts'][0]);

        $this->assertEquals(null, $result['attempts'][0]['sumgrades']);

        // Test manager can see user grades.

        $this->setUser($this->teacher);

        $result = mod_quiz_external::get_user_attempts($quiz->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_attempts_returns(), $result);

        $this->assertCount(1, $result['attempts']);

        $this->assertEquals($attempt->id, $result['attempts'][0]['id']);

        $this->assertEquals($quiz->id, $result['attempts'][0]['quiz']);

        $this->assertEquals($this->student->id, $result['attempts'][0]['userid']);

        $this->assertEquals(1, $result['attempts'][0]['attempt']);

        $this->assertArrayHasKey('sumgrades', $result['attempts'][0]);

        $this->assertEquals(1.0, $result['attempts'][0]['sumgrades']);

    }

    /**

     * Test get_user_best_grade

     */

    public function test_get_user_best_grade(): void {

        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');

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

        $questioncat = $questiongenerator->create_question_category();

        // Create a new quiz.

        $quizapi1 = $quizgenerator->create_instance([

                'name' => 'Test Quiz API 1',

                'course' => $this->course->id,

                'sumgrades' => 1

        ]);

        $quizapi2 = $quizgenerator->create_instance([

                'name' => 'Test Quiz API 2',

                'course' => $this->course->id,

                'sumgrades' => 1,

                'marksduring' => 0,

                'marksimmediately' => 0,

                'marksopen' => 0,

                'marksclosed' => 0

        ]);

        // Create a question.

        $question = $questiongenerator->create_question('numerical', null, ['category' => $questioncat->id]);

        // Add question to the quizzes.

        quiz_add_quiz_question($question->id, $quizapi1);

        quiz_add_quiz_question($question->id, $quizapi2);

        // Create quiz object.

        $quizapiobj1 = quiz_settings::create($quizapi1->id, $this->student->id);

        $quizapiobj2 = quiz_settings::create($quizapi2->id, $this->student->id);

        // Set grade to pass.

        $item = \grade_item::fetch([

                'courseid' => $this->course->id,

                'itemtype' => 'mod',

                'itemmodule' => 'quiz',

                'iteminstance' => $quizapi1->id,

                'outcomeid' => null

        ]);

        $item->gradepass = 80;

        $item->update();

        $item = \grade_item::fetch([

                'courseid' => $this->course->id,

                'itemtype' => 'mod',

                'itemmodule' => 'quiz',

                'iteminstance' => $quizapi2->id,

                'outcomeid' => null

        ]);

        $item->gradepass = 80;

        $item->update();

        // Start the passing attempt.

        $quba1 = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizapiobj1->get_context());

        $quba1->set_preferred_behaviour($quizapiobj1->get_quiz()->preferredbehaviour);

        $quba2 = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizapiobj2->get_context());

        $quba2->set_preferred_behaviour($quizapiobj2->get_quiz()->preferredbehaviour);

        // Start the testing for quizapi1 that allow the student to view the grade.

        $this->setUser($this->student);

        $result = mod_quiz_external::get_user_best_grade($quizapi1->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        // No grades yet.

        $this->assertFalse($result['hasgrade']);

        $this->assertTrue(!isset($result['grade']));

        // Start the attempt.

        $timenow = time();

        $attempt = quiz_create_attempt($quizapiobj1, 1, false, $timenow, false, $this->student->id);

        quiz_start_new_attempt($quizapiobj1, $quba1, $attempt, 1, $timenow);

        quiz_attempt_save_started($quizapiobj1, $quba1, $attempt);

        // Process some responses from the student.

        $attemptobj = quiz_attempt::create($attempt->id);

        $attemptobj->process_submitted_actions($timenow, false, [1 => ['answer' => '3.14']]);

        // Finish the attempt.

        $attemptobj->process_finish($timenow, false);

        $result = mod_quiz_external::get_user_best_grade($quizapi1->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        // Now I have grades.

        $this->assertTrue($result['hasgrade']);

        $this->assertEquals(100.0, $result['grade']);

        $this->assertEquals(80, $result['gradetopass']);

        // We should not see other users grades.

        $anotherstudent = self::getDataGenerator()->create_user();

        $this->getDataGenerator()->enrol_user($anotherstudent->id, $this->course->id, $this->studentrole->id, 'manual');

        try {

            mod_quiz_external::get_user_best_grade($quizapi1->id, $anotherstudent->id);

            $this->fail('Exception expected due to missing capability.');

        } catch (\required_capability_exception $e) {

            $this->assertEquals('nopermissions', $e->errorcode);

        }

        // Teacher must be able to see student grades.

        $this->setUser($this->teacher);

        $result = mod_quiz_external::get_user_best_grade($quizapi1->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        $this->assertTrue($result['hasgrade']);

        $this->assertEquals(100.0, $result['grade']);

        $this->assertEquals(80, $result['gradetopass']);

        // Invalid user.

        try {

            mod_quiz_external::get_user_best_grade($this->quiz->id, -1);

            $this->fail('Exception expected due to missing capability.');

        } catch (\dml_missing_record_exception $e) {

            $this->assertEquals('invaliduser', $e->errorcode);

        }

        // End the testing for quizapi1 that allow the student to view the grade.

        // Start the testing for quizapi2 that do not allow the student to view the grade.

        $this->setUser($this->student);

        $result = mod_quiz_external::get_user_best_grade($quizapi2->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        // No grades yet.

        $this->assertFalse($result['hasgrade']);

        $this->assertTrue(!isset($result['grade']));

        // Start the attempt.

        $timenow = time();

        $attempt = quiz_create_attempt($quizapiobj2, 1, false, $timenow, false, $this->student->id);

        quiz_start_new_attempt($quizapiobj2, $quba2, $attempt, 1, $timenow);

        quiz_attempt_save_started($quizapiobj2, $quba2, $attempt);

        // Process some responses from the student.

        $attemptobj = quiz_attempt::create($attempt->id);

        $attemptobj->process_submitted_actions($timenow, false, [1 => ['answer' => '3.14']]);

        // Finish the attempt.

        $attemptobj->process_finish($timenow, false);

        $result = mod_quiz_external::get_user_best_grade($quizapi2->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        // Now I have grades but I will not be allowed to see it.

        $this->assertFalse($result['hasgrade']);

        $this->assertTrue(!isset($result['grade']));

        // Teacher must be able to see student grades.

        $this->setUser($this->teacher);

        $result = mod_quiz_external::get_user_best_grade($quizapi2->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_user_best_grade_returns(), $result);

        $this->assertTrue($result['hasgrade']);

        $this->assertEquals(100.0, $result['grade']);

        // End the testing for quizapi2 that do not allow the student to view the grade.

    }

    /**

     * Test get_combined_review_options.

     * This is a basic test, this is already tested in display_options_testcase.

     */

    public function test_get_combined_review_options(): void {

        global $DB;

        // Create a new quiz with attempts.

        $quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz');

        $data = ['course' => $this->course->id,

                      'sumgrades' => 1];

        $quiz = $quizgenerator->create_instance($data);

        // Create a couple of questions.

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

        $cat = $questiongenerator->create_question_category();

        $question = $questiongenerator->create_question('numerical', null, ['category' => $cat->id]);

        quiz_add_quiz_question($question->id, $quiz);

        $quizobj = quiz_settings::create($quiz->id, $this->student->id);

        // Set grade to pass.

        $item = \grade_item::fetch(['courseid' => $this->course->id, 'itemtype' => 'mod',

                                        'itemmodule' => 'quiz', 'iteminstance' => $quiz->id, 'outcomeid' => null]);

        $item->gradepass = 80;

        $item->update();

        // Start the passing attempt.

        $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->student->id);

        quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);

        quiz_attempt_save_started($quizobj, $quba, $attempt);

        $this->setUser($this->student);

        $result = mod_quiz_external::get_combined_review_options($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        // Expected values.

        $expected = [

            "someoptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 0],

                ["name" => "marks", "value" => 2],

            ],

            "alloptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 0],

                ["name" => "marks", "value" => 2],

            ],

            "warnings" => [],

        ];

        $this->assertEquals($expected, $result);

        // Now, finish the attempt.

        $attemptobj = quiz_attempt::create($attempt->id);

        $attemptobj->process_finish($timenow, false);

        $expected = [

            "someoptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 2],

            ],

            "alloptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 2],

            ],

            "warnings" => [],

        ];

        // We should see now the overall feedback.

        $result = mod_quiz_external::get_combined_review_options($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        $this->assertEquals($expected, $result);

        // Start a new attempt, but not finish it.

        $timenow = time();

        $attempt = quiz_create_attempt($quizobj, 2, false, $timenow, false, $this->student->id);

        $quba = \question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context());

        $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour);

        quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timenow);

        quiz_attempt_save_started($quizobj, $quba, $attempt);

        $expected = [

            "someoptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 2],

            ],

            "alloptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 0],

                ["name" => "marks", "value" => 2],

            ],

            "warnings" => [],

        ];

        $result = mod_quiz_external::get_combined_review_options($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        $this->assertEquals($expected, $result);

        // Teacher, for see student options.

        $this->setUser($this->teacher);

        $result = mod_quiz_external::get_combined_review_options($quiz->id, $this->student->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        $this->assertEquals($expected, $result);

        // Invalid user.

        try {

            mod_quiz_external::get_combined_review_options($quiz->id, -1);

            $this->fail('Exception expected due to missing capability.');

        } catch (\dml_missing_record_exception $e) {

            $this->assertEquals('invaliduser', $e->errorcode);

        }

    }

    /**

     * Test get_combined_review_options when the user has an override.

     *

     * @covers ::get_combined_review_options

     * @covers ::get_combined_review_options_parameters

     * @covers ::get_combined_review_options_returns

     */

    public function test_get_combined_review_options_with_overrides(): void {

        global $DB;

        // Create a closed quiz with review marks only when quiz is closed.

        list($quiz, $context, $quizobj) = $this->create_quiz_with_questions(true, true, 'deferredfeedback', false, [

            'timeclose' => time() - HOURSECS,

            'marksduring' => 0,

            'maxmarksduring' => 0,

            'marksimmediately' => 0,

            'maxmarksimmediately' => 0,

            'marksopen' => 0,

            'maxmarksopen' => 0,

            'marksclosed' => 1,

            'maxmarksclosed' => 1,

        ]);

        // Check that the student can see the marks because the quiz is closed.

        $this->setUser($this->student);

        $expected = [

            "someoptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 2],

            ],

            "alloptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 2],

            ],

            "warnings" => [],

        ];

        $result = mod_quiz_external::get_combined_review_options($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        $this->assertEquals($expected, $result);

        // Add an override for the student to increase the close time.

        $DB->insert_record('quiz_overrides', [

            'quiz' => $quiz->id,

            'userid' => $this->student->id,

            'timeclose' => time() + HOURSECS,

        ]);

        // Check that now the marks option has changed.

        $expected = [

            "someoptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 0],

            ],

            "alloptions" => [

                ["name" => "feedback", "value" => 1],

                ["name" => "generalfeedback", "value" => 1],

                ["name" => "rightanswer", "value" => 1],

                ["name" => "overallfeedback", "value" => 1],

                ["name" => "marks", "value" => 0],

            ],

            "warnings" => [],

        ];

        $result = mod_quiz_external::get_combined_review_options($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::get_combined_review_options_returns(), $result);

        $this->assertEquals($expected, $result);

    }

    /**

     * Test start_attempt

     */

    public function test_start_attempt(): void {

        global $DB;

        // Create a new quiz with questions.

        list($quiz, $context, $quizobj) = $this->create_quiz_with_questions();

        $this->setUser($this->student);

        // Try to open attempt in closed quiz.

        $quiz->timeopen = time() - WEEKSECS;

        $quiz->timeclose = time() - DAYSECS;

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

        $result = mod_quiz_external::start_attempt($quiz->id);

        $result = external_api::clean_returnvalue(mod_quiz_external::start_attempt_returns(), $result);

        $this->assertEquals([], $result['attempt']);

        $this->assertCount(1, $result['warnings']);

        // Now with a password.

        $quiz->timeopen = 0;

        $quiz->timeclose = 0;

        $quiz->password = 'abc';

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

        try {

            mod_quiz_external::start_attempt($quiz->id, [["name" => "quizpassword", "value" => 'bad']]);

            $this->fail('Exception expected due to invalid passwod.');

        } catch (moodle_exception $e) {

            $this->assertEquals(get_string('passworderror', 'quizaccess_password'), $e->errorcode);

        }

        // Now, try everything correct.

        $result = mod_quiz_external::start_attempt($quiz->id, [["name" => "quizpassword", "value" => 'abc']]);

        $result = external_api::clean_returnvalue(mod_quiz_external::start_attempt_returns(), $result);

        $this->assertEquals(1, $result['attempt']['attempt']);

        $this->assertEquals($this->student->id, $result['attempt']['userid']);

        $this->assertEquals($quiz->id, $result['attempt']['quiz']);

        $this->assertCount(0, $result['warnings']);

        $attemptid = $result['attempt']['id'];

        // We are good, try to start a new attempt now.