mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-01-19 14:27:22 +01:00
Code Issues Projects Releases Wiki Activity

MDL-79716 mod_assign: Fix random failures PHPUnit test

Browse Source 
- Fix Clock API is not used correctly. We need to make sure
 not to reset the DI system halfway through a test.
 - Switched to use Message sink to speed up the test, no need
 to query the DB to verify the result anymore.
 - Used Data generator to create a submission
This commit is contained in:
Huong Nguyen 2024-07-04 14:34:13 +07:00
parent 9ad6cae1e2
commit d89d9ee420
No known key found for this signature in database
GPG Key ID: 40D88AB693A3E72A
1 changed files with 26 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
mod/assign/tests/notification_helper_test.php
View File

@ -29,10 +29,10 @@ final class notification_helper_test extends \advanced_testcase {
/** /**
* Run all the tasks related to the notifications. * Run all the tasks related to the notifications.
*/ */
public function run_notification_helper_tasks(): void { protected function run_notification_helper_tasks(): void {
$task = \core\task\manager::get_scheduled_task(\mod_assign\task\queue_all_assignment_due_soon_notification_tasks::class); $task = \core\task\manager::get_scheduled_task(\mod_assign\task\queue_all_assignment_due_soon_notification_tasks::class);
$task->execute(); $task->execute();
$clock = $this->mock_clock_with_frozen(); $clock = \core\di::get(\core\clock::class);
$adhoctask = \core\task\manager::get_next_adhoc_task($clock->time()); $adhoctask = \core\task\manager::get_next_adhoc_task($clock->time());
if ($adhoctask) { if ($adhoctask) {
@ -136,10 +136,9 @@ final class notification_helper_test extends \advanced_testcase {
'duedate' => $userduedate, 'duedate' => $userduedate,
]); ]);
// User5 will submit the assignment, excluding them from the results. $assignmentgenerator->create_submission([
$DB->insert_record('assign_submission', [
'assignment' => $assignment->id,
'userid' => $user5->id, 'userid' => $user5->id,
'assignid' => $assignment->cmid,
'status' => 'submitted', 'status' => 'submitted',
'timemodified' => $clock->time(), 'timemodified' => $clock->time(),
]); ]);
@ -158,6 +157,7 @@ final class notification_helper_test extends \advanced_testcase {
$generator = $this->getDataGenerator(); $generator = $this->getDataGenerator();
$helper = \core\di::get(notification_helper::class); $helper = \core\di::get(notification_helper::class);
$clock = $this->mock_clock_with_frozen(); $clock = $this->mock_clock_with_frozen();
$sink = $this->redirectMessages();
// Create a course and enrol a user. // Create a course and enrol a user.
$course = $generator->create_course(); $course = $generator->create_course();
@ -173,6 +173,7 @@ final class notification_helper_test extends \advanced_testcase {
'course' => $course->id, 'course' => $course->id,
'duedate' => $duedate, 'duedate' => $duedate,
]); ]);
$clock->bump(5);
// Run the tasks. // Run the tasks.
$this->run_notification_helper_tasks(); $this->run_notification_helper_tasks();
@ -184,24 +185,27 @@ final class notification_helper_test extends \advanced_testcase {
$duedate = $assignmentobj->get_instance($user1->id)->duedate; $duedate = $assignmentobj->get_instance($user1->id)->duedate;
// Get the notifications that should have been created during the adhoc task. // Get the notifications that should have been created during the adhoc task.
$notifications = $DB->get_records('notifications', ['useridto' => $user1->id]); $this->assertCount(1, $sink->get_messages_by_component('mod_assign'));
$this->assertCount(1, $notifications);
// Check the subject matches. // Check the subject matches.
$messages = $sink->get_messages_by_component('mod_assign');
$message = reset($messages);
$stringparams = [ $stringparams = [
'duedate' => userdate($duedate), 'duedate' => userdate($duedate),
'assignmentname' => $assignment->name, 'assignmentname' => $assignment->name,
'type' => $helper::TYPE_DUE_SOON, 'type' => $helper::TYPE_DUE_SOON,
]; ];
$expectedsubject = get_string('assignmentduesoonsubject', 'mod_assign', $stringparams); $expectedsubject = get_string('assignmentduesoonsubject', 'mod_assign', $stringparams);
$this->assertEquals($expectedsubject, reset($notifications)->subject); $this->assertEquals($expectedsubject, $message->subject);
// Clear sink.
$sink->clear();
// Run the tasks again. // Run the tasks again.
$this->run_notification_helper_tasks(); $this->run_notification_helper_tasks();
// There should still only be one notification because nothing has changed. // There should be no notification because nothing has changed.
$notifications = $DB->get_records('notifications', ['useridto' => $user1->id]); $this->assertEmpty($sink->get_messages_by_component('mod_assign'));
$this->assertCount(1, $notifications);
// Let's modify the 'duedate' for the assignment (it will still be within the 48 hour range). // Let's modify the 'duedate' for the assignment (it will still be within the 48 hour range).
$updatedata = new \stdClass(); $updatedata = new \stdClass();
@ -212,9 +216,10 @@ final class notification_helper_test extends \advanced_testcase {
// Run the tasks again. // Run the tasks again.
$this->run_notification_helper_tasks(); $this->run_notification_helper_tasks();
// There should now be two notifications. // There should be a new notification because the 'duedate' has been updated.
$notifications = $DB->get_records('notifications', ['useridto' => $user1->id]); $this->assertCount(1, $sink->get_messages_by_component('mod_assign'));
$this->assertCount(2, $notifications); // Clear sink.
$sink->clear();
// Let's modify the 'duedate' one more time. // Let's modify the 'duedate' one more time.
$updatedata = new \stdClass(); $updatedata = new \stdClass();
@ -223,18 +228,21 @@ final class notification_helper_test extends \advanced_testcase {
$DB->update_record('assign', $updatedata); $DB->update_record('assign', $updatedata);
// This time, the user will submit the assignment. // This time, the user will submit the assignment.
$DB->insert_record('assign_submission', [ $assignmentgenerator->create_submission([
'assignment' => $assignment->id,
'userid' => $user1->id, 'userid' => $user1->id,
'assignid' => $assignment->cmid,
'status' => 'submitted', 'status' => 'submitted',
'timemodified' => $clock->time(), 'timemodified' => $clock->time(),
]); ]);
$clock->bump(5);
// Run the tasks again. // Run the tasks again.
$this->run_notification_helper_tasks(); $this->run_notification_helper_tasks();
// No new notification should have been sent. // No new notification should have been sent.
$notifications = $DB->get_records('notifications', ['useridto' => $user1->id]); $this->assertEmpty($sink->get_messages_by_component('mod_assign'));
$this->assertCount(2, $notifications);
// Clear sink.
$sink->clear();
} }
} }