Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.
<?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/>.

< /** < * Tests for the quiz overview report. < * < * @package quiz_overview < * @copyright 2014 The Open University < * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later < */
> namespace quiz_overview; > > use core_question\local\bank\question_version_status; > use mod_quiz\external\submit_question_version; > use question_engine; > use quiz; > use quiz_attempt; > use quiz_attempts_report; > use quiz_overview_options; > use quiz_overview_report; > use quiz_overview_table;
defined('MOODLE_INTERNAL') || die(); global $CFG; require_once($CFG->dirroot . '/mod/quiz/locallib.php'); require_once($CFG->dirroot . '/mod/quiz/report/reportlib.php'); require_once($CFG->dirroot . '/mod/quiz/report/default.php'); require_once($CFG->dirroot . '/mod/quiz/report/overview/report.php');
> require_once($CFG->dirroot . '/mod/quiz/report/overview/overview_form.php');
require_once($CFG->dirroot . '/mod/quiz/report/overview/tests/helpers.php');
> require_once($CFG->dirroot . '/mod/quiz/tests/quiz_question_helper_test_trait.php');
/** * Tests for the quiz overview report. *
> * @package quiz_overview
* @copyright 2014 The Open University * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later */
< class quiz_overview_report_testcase extends advanced_testcase {
> class report_test extends \advanced_testcase { > use \quiz_question_helper_test_trait;
/** * Data provider for test_report_sql. * * @return array the data for the test sub-cases. */
< public function report_sql_cases() {
> public function report_sql_cases(): array {
return [[null], ['csv']]; // Only need to test on or off, not all download types. } /** * Test how the report queries the database. *
< * @param bool $isdownloading a download type, or null.
> * @param string|null $isdownloading a download type, or null.
* @dataProvider report_sql_cases */
< public function test_report_sql($isdownloading) {
> public function test_report_sql(?string $isdownloading): void {
global $DB;
< $this->resetAfterTest(true);
> $this->resetAfterTest();
// Create a course and a quiz. $generator = $this->getDataGenerator(); $course = $generator->create_course(); $quizgenerator = $generator->get_plugin_generator('mod_quiz'); $quiz = $quizgenerator->create_instance(array('course' => $course->id, 'grademethod' => QUIZ_GRADEHIGHEST, 'grade' => 100.0, 'sumgrades' => 10.0, 'attempts' => 10)); // Add one question.
> /** @var core_question_generator $questiongenerator */
$questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question'); $cat = $questiongenerator->create_question_category(); $q = $questiongenerator->create_question('essay', 'plain', ['category' => $cat->id]); quiz_add_quiz_question($q->id, $quiz, 0 , 10); // Create some students and enrol them in the course. $student1 = $generator->create_user(); $student2 = $generator->create_user(); $student3 = $generator->create_user(); $generator->enrol_user($student1->id, $course->id); $generator->enrol_user($student2->id, $course->id); $generator->enrol_user($student3->id, $course->id); // This line is not really necessary for the test asserts below, // but what it does is add an extra user row returned by // get_enrolled_with_capabilities_join because of a second enrolment. // The extra row returned used to make $table->query_db complain // about duplicate records. So this is really a test that an extra // student enrolment does not cause duplicate records in this query. $generator->enrol_user($student2->id, $course->id, null, 'self'); // Also create a user who should not appear in the reports, // because they have a role with neither 'mod/quiz:attempt' // nor 'mod/quiz:reviewmyattempts'. $tutor = $generator->create_user(); $generator->enrol_user($tutor->id, $course->id, 'teacher'); // The test data. $timestamp = 1234567890; $attempts = array( array($quiz, $student1, 1, 0.0, quiz_attempt::FINISHED), array($quiz, $student1, 2, 5.0, quiz_attempt::FINISHED), array($quiz, $student1, 3, 8.0, quiz_attempt::FINISHED), array($quiz, $student1, 4, null, quiz_attempt::ABANDONED), array($quiz, $student1, 5, null, quiz_attempt::IN_PROGRESS), array($quiz, $student2, 1, null, quiz_attempt::ABANDONED), array($quiz, $student2, 2, null, quiz_attempt::ABANDONED), array($quiz, $student2, 3, 7.0, quiz_attempt::FINISHED), array($quiz, $student2, 4, null, quiz_attempt::ABANDONED), array($quiz, $student2, 5, null, quiz_attempt::ABANDONED), ); // Load it in to quiz attempts table. foreach ($attempts as $attemptdata) { list($quiz, $student, $attemptnumber, $sumgrades, $state) = $attemptdata; $timestart = $timestamp + $attemptnumber * 3600; $quizobj = quiz::create($quiz->id, $student->id); $quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context()); $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour); // Create the new attempt and initialize the question sessions. $attempt = quiz_create_attempt($quizobj, $attemptnumber, null, $timestart, false, $student->id); $attempt = quiz_start_new_attempt($quizobj, $quba, $attempt, $attemptnumber, $timestamp); $attempt = quiz_attempt_save_started($quizobj, $quba, $attempt); // Process some responses from the student. $attemptobj = quiz_attempt::create($attempt->id); switch ($state) { case quiz_attempt::ABANDONED: $attemptobj->process_abandon($timestart + 300, false); break; case quiz_attempt::IN_PROGRESS: // Do nothing. break; case quiz_attempt::FINISHED: // Save answer and finish attempt. $attemptobj->process_submitted_actions($timestart + 300, false, [ 1 => ['answer' => 'My essay by ' . $student->firstname, 'answerformat' => FORMAT_PLAIN]]); $attemptobj->process_finish($timestart + 600, false); // Manually grade it. $quba = $attemptobj->get_question_usage(); $quba->get_question_attempt(1)->manual_grade( 'Comment', $sumgrades, FORMAT_HTML, $timestart + 1200); question_engine::save_questions_usage_by_activity($quba);
< $update = new stdClass();
> $update = new \stdClass();
$update->id = $attemptobj->get_attemptid(); $update->timemodified = $timestart + 1200; $update->sumgrades = $quba->get_total_mark(); $DB->update_record('quiz_attempts', $update); quiz_save_best_grade($attemptobj->get_quiz(), $student->id); break; } } // Actually getting the SQL to run is quite hard. Do a minimal set up of // some objects.
< $context = context_module::instance($quiz->cmid);
> $context = \context_module::instance($quiz->cmid);
$cm = get_coursemodule_from_id('quiz', $quiz->cmid); $qmsubselect = quiz_report_qm_filter_select($quiz); $studentsjoins = get_enrolled_with_capabilities_join($context, '', array('mod/quiz:attempt', 'mod/quiz:reviewmyattempts')); $empty = new \core\dml\sql_join(); // Set the options. $reportoptions = new quiz_overview_options('overview', $quiz, $cm, null); $reportoptions->attempts = quiz_attempts_report::ENROLLED_ALL; $reportoptions->onlygraded = true; $reportoptions->states = array(quiz_attempt::IN_PROGRESS, quiz_attempt::OVERDUE, quiz_attempt::FINISHED); // Now do a minimal set-up of the table class. $q->slot = 1; $q->maxmark = 10; $table = new quiz_overview_table($quiz, $context, $qmsubselect, $reportoptions, $empty, $studentsjoins, array(1 => $q), null); $table->download = $isdownloading; // Cannot call the is_downloading API, because it gives errors. $table->define_columns(array('fullname')); $table->sortable(true, 'uniqueid');
< $table->define_baseurl(new moodle_url('/mod/quiz/report.php'));
> $table->define_baseurl(new \moodle_url('/mod/quiz/report.php'));
$table->setup(); // Run the query. $table->setup_sql_queries($studentsjoins); $table->query_db(30, false); // Should be 4 rows, matching count($table->rawdata) tested below. // The count is only done if not downloading. if (!$isdownloading) { $this->assertEquals(4, $table->totalrows); } // Verify what was returned: Student 1's best and in progress attempts. // Student 2's finshed attempt, and Student 3 with no attempt. // The array key is {student id}#{attempt number}. $this->assertEquals(4, count($table->rawdata)); $this->assertArrayHasKey($student1->id . '#3', $table->rawdata); $this->assertEquals(1, $table->rawdata[$student1->id . '#3']->gradedattempt); $this->assertArrayHasKey($student1->id . '#3', $table->rawdata); $this->assertEquals(0, $table->rawdata[$student1->id . '#5']->gradedattempt); $this->assertArrayHasKey($student2->id . '#3', $table->rawdata); $this->assertEquals(1, $table->rawdata[$student2->id . '#3']->gradedattempt); $this->assertArrayHasKey($student3->id . '#0', $table->rawdata); $this->assertEquals(0, $table->rawdata[$student3->id . '#0']->gradedattempt); // Check the calculation of averages. $averagerow = $table->compute_average_row('overallaverage', $studentsjoins); $this->assertStringContainsString('75.00', $averagerow['sumgrades']); $this->assertStringContainsString('75.00', $averagerow['qsgrade1']); if (!$isdownloading) { $this->assertStringContainsString('(2)', $averagerow['sumgrades']); $this->assertStringContainsString('(2)', $averagerow['qsgrade1']); } // Ensure that filtering by initial does not break it. // This involves setting a private properly of the base class, which is // only really possible using reflection :-(.
< $reflectionobject = new ReflectionObject($table);
> $reflectionobject = new \ReflectionObject($table);
while ($parent = $reflectionobject->getParentClass()) { $reflectionobject = $parent; } $prefsproperty = $reflectionobject->getProperty('prefs'); $prefsproperty->setAccessible(true); $prefs = $prefsproperty->getValue($table); $prefs['i_first'] = 'A'; $prefsproperty->setValue($table, $prefs); list($fields, $from, $where, $params) = $table->base_sql($studentsjoins); $table->set_count_sql("SELECT COUNT(1) FROM (SELECT $fields FROM $from WHERE $where) temp WHERE 1 = 1", $params); $table->set_sql($fields, $from, $where, $params); $table->query_db(30, false); // Just verify that this does not cause a fatal error. } /** * Bands provider. * @return array */
< public function get_bands_count_and_width_provider() {
> public function get_bands_count_and_width_provider(): array {
return [ [10, [20, .5]], [20, [20, 1]], [30, [15, 2]], // TODO MDL-55068 Handle bands better when grade is 50. // [50, [10, 5]], [100, [20, 5]], [200, [20, 10]], ]; } /** * Test bands. * * @dataProvider get_bands_count_and_width_provider * @param int $grade grade * @param array $expected */
< public function test_get_bands_count_and_width($grade, $expected) { < $this->resetAfterTest(true);
> public function test_get_bands_count_and_width(int $grade, array $expected): void { > $this->resetAfterTest();
$quizgenerator = $this->getDataGenerator()->get_plugin_generator('mod_quiz'); $quiz = $quizgenerator->create_instance(['course' => SITEID, 'grade' => $grade]); $this->assertEquals($expected, quiz_overview_report::get_bands_count_and_width($quiz)); } /** * Test delete_selected_attempts function. */
< public function test_delete_selected_attempts() { < $this->resetAfterTest(true);
> public function test_delete_selected_attempts(): void { > $this->resetAfterTest();
$timestamp = 1234567890; $timestart = $timestamp + 3600; // Create a course and a quiz. $generator = $this->getDataGenerator(); $course = $generator->create_course(); $quizgenerator = $generator->get_plugin_generator('mod_quiz'); $quiz = $quizgenerator->create_instance([ 'course' => $course->id, 'grademethod' => QUIZ_GRADEHIGHEST, 'grade' => 100.0, 'sumgrades' => 10.0, 'attempts' => 10 ]); // Add one question.
> /** @var core_question_generator $questiongenerator */
$questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question'); $cat = $questiongenerator->create_question_category(); $q = $questiongenerator->create_question('essay', 'plain', ['category' => $cat->id]); quiz_add_quiz_question($q->id, $quiz, 0 , 10); // Create student and enrol them in the course. // Note: we create two enrolments, to test the problem reported in MDL-67942. $student = $generator->create_user(); $generator->enrol_user($student->id, $course->id); $generator->enrol_user($student->id, $course->id, null, 'self');
< $context = context_module::instance($quiz->cmid);
> $context = \context_module::instance($quiz->cmid);
$cm = get_coursemodule_from_id('quiz', $quiz->cmid); $allowedjoins = get_enrolled_with_capabilities_join($context, '', ['mod/quiz:attempt', 'mod/quiz:reviewmyattempts']);
< $quizattemptsreport = new testable_quiz_attempts_report();
> $quizattemptsreport = new \testable_quiz_attempts_report();
// Create the new attempt and initialize the question sessions. $quizobj = quiz::create($quiz->id, $student->id); $quba = question_engine::make_questions_usage_by_activity('mod_quiz', $quizobj->get_context()); $quba->set_preferred_behaviour($quizobj->get_quiz()->preferredbehaviour); $attempt = quiz_create_attempt($quizobj, 1, null, $timestart, false, $student->id); $attempt = quiz_start_new_attempt($quizobj, $quba, $attempt, 1, $timestamp); $attempt = quiz_attempt_save_started($quizobj, $quba, $attempt); // Delete the student's attempt. $quizattemptsreport->delete_selected_attempts($quiz, $cm, [$attempt->id], $allowedjoins); }
> /** } > * Test question regrade for selected versions. > * > * @covers ::regrade_question > */ > public function test_regrade_question() { > global $DB; > $this->resetAfterTest(); > $this->setAdminUser(); > > $course = $this->getDataGenerator()->create_course(); > $quiz = $this->create_test_quiz($course); > $cm = get_fast_modinfo($course->id)->get_cm($quiz->cmid); > $context = \context_module::instance($quiz->cmid); > > /** @var core_question_generator $questiongenerator */ > $questiongenerator = $this->getDataGenerator()->get_plugin_generator('core_question'); > // Create a couple of questions. > $cat = $questiongenerator->create_question_category(['contextid' => $context->id]); > $q = $questiongenerator->create_question('shortanswer', null, > ['category' => $cat->id, 'name' => 'Toad scores 0.8']); > > // Create a version, the last one draft. > // Sadly, update_question is a bit dodgy, so it can't handle updating the answer score. > $q2 = $questiongenerator->update_question($q, null, > ['name' => 'Toad now scores 1.0']); > $toadanswer = $DB->get_record_select('question_answers', > 'question = ? AND ' . $DB->sql_compare_text('answer') . ' = ?', > [$q2->id, 'toad'], '*', MUST_EXIST); > $DB->set_field('question_answers', 'fraction', 1, ['id' => $toadanswer->id]); > > // Add the question to the quiz. > quiz_add_quiz_question($q2->id, $quiz, 0, 10); > > // Attempt the quiz, submitting response 'toad'. > $quizobj = quiz::create($quiz->id); > $attempt = quiz_prepare_and_start_new_attempt($quizobj, 1, null); > $attemptobj = quiz_attempt::create($attempt->id); > $attemptobj->process_submitted_actions(time(), false, [1 => ['answer' => 'toad']]); > $attemptobj->process_finish(time(), false); > > // We should be using 'always latest' version, which is currently v2, so should be right. > $this->assertEquals(10, $attemptobj->get_question_usage()->get_total_mark()); > > // Now change the quiz to use fixed version 1. > $slot = $quizobj->get_question($q2->id); > submit_question_version::execute($slot->slotid, 1); > > // Regrade. > $report = new quiz_overview_report(); > $report->init('overview', 'quiz_overview_settings_form', $quiz, $cm, $course); > $report->regrade_attempt($attempt); > > // The mark should now be 8. > $attemptobj = quiz_attempt::create($attempt->id); > $this->assertEquals(8, $attemptobj->get_question_usage()->get_total_mark()); > > // Now add two more versions, the second of which is draft. > $q3 = $questiongenerator->update_question($q, null, > ['name' => 'Toad now scores 0.5']); > $toadanswer = $DB->get_record_select('question_answers', > 'question = ? AND ' . $DB->sql_compare_text('answer') . ' = ?', > [$q3->id, 'toad'], '*', MUST_EXIST); > $DB->set_field('question_answers', 'fraction', 0.5, ['id' => $toadanswer->id]); > > $q4 = $questiongenerator->update_question($q, null, > ['name' => 'Toad now scores 0.3', > 'status' => question_version_status::QUESTION_STATUS_DRAFT]); > $toadanswer = $DB->get_record_select('question_answers', > 'question = ? AND ' . $DB->sql_compare_text('answer') . ' = ?', > [$q4->id, 'toad'], '*', MUST_EXIST); > $DB->set_field('question_answers', 'fraction', 0.3, ['id' => $toadanswer->id]); > > // Now change the quiz back to always latest and regrade again. > submit_question_version::execute($slot->slotid, 0); > $report->clear_regrade_date_cache(); > $report->regrade_attempt($attempt); > > // Score should now be 5, because v3 is the latest non-draft version. > $attemptobj = quiz_attempt::create($attempt->id); > $this->assertEquals(5, $attemptobj->get_question_usage()->get_total_mark()); > }