mirror_php/moodle
1
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-04-13 20:42:22 +02:00
Code Issues Projects Releases Wiki Activity

MDL-69615 core_backup: Send backup report email once the tasks are done

Browse Source
This commit is contained in:
Huong Nguyen 2023-12-27 16:14:07 +07:00
parent badf45d722
commit 028c0384a2
7 changed files with 289 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
backup/util/helper/backup_cron_helper.class.php
View File

@ -137,9 +137,11 @@ abstract class backup_cron_automated_helper {
$rs->close();
// Send email to admin if necessary.
if ($emailpending) {
self::send_backup_status_to_admin($admin);
}
set_config(
'backup_auto_emailpending',
$emailpending ? 1 : 0,
'backup',
);
} finally {
// Everything is finished release lock.
$lock->release();
@ -188,7 +190,7 @@ abstract class backup_cron_automated_helper {
* @param stdClass $admin
* @return array
*/
private static function send_backup_status_to_admin($admin) {
public static function send_backup_status_to_admin($admin) {
global $DB, $CFG;
mtrace("Sending email to admin");
@ -386,7 +388,22 @@ abstract class backup_cron_automated_helper {
'courseid' => $backupcourse->courseid,
'adminid' => $admin->id
));
\core\task\manager::queue_adhoc_task($asynctask);
$taskid = \core\task\manager::queue_adhoc_task($asynctask);
// Get the queued tasks.
$queuedtasks = [];
if ($value = get_config('backup', 'backup_auto_adhoctasks')) {
$queuedtasks = explode(',', $value);
}
if ($taskid) {
$queuedtasks[] = (int) $taskid;
}
// Save the queued tasks.
set_config(
'backup_auto_adhoctasks',
implode(',', $queuedtasks),
'backup',
);
$backupcourse->laststatus = self::BACKUP_STATUS_QUEUED;
$DB->update_record('backup_courses', $backupcourse);

1
lang/en/admin.php
View File

@ -1397,6 +1397,7 @@ $string['tasklockcleanuptask'] = 'Clean up ad hoc task metadata';
$string['taskadmintitle'] = 'Tasks';
$string['taskanalyticscleanup'] = 'Analytics cleanup';
$string['taskautomatedbackup'] = 'Automated backups';
$string['taskautomatedbackup_report'] = 'Automated backups report';
$string['taskbackupcleanup'] = 'Clean backup tables, logs and files';
$string['taskbadgescron'] = 'Award badges';
$string['taskbadgesmessagecron'] = 'Background processing for sending badges notifications';

86
lib/classes/task/automated_backup_report_task.php Normal file
View File

@ -0,0 +1,86 @@
<?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\task;
/**
* Report task for core automation backup.
*
* @package core
* @copyright 2024 Huong Nguyen <huongnv13@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class automated_backup_report_task extends scheduled_task {
/**
* Get a descriptive name for the task (shown to admins).
*
* @return string
*/
public function get_name(): string {
return get_string('taskautomatedbackup_report', 'admin');
}
/**
* Do the job.
*/
public function execute(): void {
global $DB, $CFG;
$queuedtasks = [];
if ($value = get_config('backup', 'backup_auto_adhoctasks')) {
$queuedtasks = explode(',', $value);
}
if (!empty($queuedtasks)) {
// Some automated backup tasks are still running.
// Check the status for each task.
foreach ($queuedtasks as $taskid) {
if (!$DB->record_exists('task_adhoc', ['id' => $taskid])) {
// The task has been completed. Remove it from the queue.
if (($key = array_search($taskid, $queuedtasks)) !== false) {
unset($queuedtasks[$key]);
}
}
}
// Update the queue.
set_config(
'backup_auto_adhoctasks',
implode(',', $queuedtasks),
'backup',
);
}
if (empty($queuedtasks) && get_config('backup', 'backup_auto_emailpending')) {
// All the automated backup tasks have been completed. Send the report.
$admin = get_admin();
if (!$admin) {
mtrace("Error: No admin account was found");
return;
}
// Send email to admin if necessary.
require_once($CFG->dirroot . '/backup/util/includes/backup_includes.php');
require_once($CFG->dirroot . '/backup/util/helper/backup_cron_helper.class.php');
\backup_cron_automated_helper::send_backup_status_to_admin($admin);
// Remove the configs.
unset_config(
'backup_auto_adhoctasks',
'backup',
);
unset_config(
'backup_auto_emailpending',
'backup',
);
}
}
}

21
lib/classes/task/task_trait.php
View File

@ -32,9 +32,28 @@ trait task_trait {
*/
protected function execute_task(string $taskclass): void {
// Run the scheduled task.
ob_start();
$this->start_output_buffering();
$task = manager::get_scheduled_task($taskclass);
$task->execute();
$this->stop_output_buffering();
}
/**
* Helper to start output buffering.
*/
protected function start_output_buffering(): void {
ob_start();
}
/**
* Helper to stop output buffering.
*
* @return string|null The output buffer contents or null if output buffering is not active.
*/
protected function stop_output_buffering(): ?string {
$output = ob_get_contents();
ob_end_clean();
return $output;
}
}

9
lib/db/tasks.php
View File

@ -457,4 +457,13 @@ $tasks = array(
'dayofweek' => 'R',
'month' => '*',
],
[
'classname' => 'core\task\automated_backup_report_task',
'blocking' => 0,
'minute' => '*',
'hour' => '*',
'day' => '*',
'month' => '*',
'dayofweek' => '*',
],
);

150
lib/tests/task/automated_backup_task_test.php Normal file
View File

@ -0,0 +1,150 @@
<?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\task;
defined('MOODLE_INTERNAL') || die();
global $CFG;
require_once($CFG->dirroot . '/backup/util/helper/backup_cron_helper.class.php');
/**
* Class containing unit tests for the task do the automation backup and report.
*
* @package core
* @copyright 2024 Huong Nguyen <huongnv13@gmail.com>
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class automated_backup_task_test extends \advanced_testcase {
use task_trait;
/**
* Test the automated backup and report tasks.
*
* @covers \automated_backup_report_task::execute
* @covers \backup_cron_automated_helper::send_backup_status_to_admin
* @covers \backup_cron_automated_helper::run_automated_backup
* @covers \backup_cron_automated_helper::check_and_push_automated_backups
*/
public function test_automated_backup(): void {
global $DB;
$this->resetAfterTest();
// Enable automated back up.
set_config(
'backup_auto_active',
true,
'backup',
);
set_config(
'backup_auto_weekdays',
'1111111',
'backup',
);
// Create courses.
$course1 = $this->getDataGenerator()->create_course();
$course2 = $this->getDataGenerator()->create_course();
// Create course backups.
$DB->insert_records(
'backup_courses',
[
[
'courseid' => $course1->id,
'laststatus' => \backup_cron_automated_helper::BACKUP_STATUS_NOTYETRUN,
'nextstarttime' => time() - 10,
],
[
'courseid' => $course2->id,
'laststatus' => \backup_cron_automated_helper::BACKUP_STATUS_NOTYETRUN,
'nextstarttime' => time() - 10,
],
],
);
// Verify that we don't have any running backup tasks.
$this->assertEmpty(get_config('backup', 'backup_auto_adhoctasks'));
$this->assertEmpty(get_config('backup', 'backup_auto_emailpending'));
// Redirect messages to sink.
$sink = $this->redirectMessages();
// Trigger the automated backup scheduled task.
$this->execute_task('\core\task\automated_backup_task');
$messages = $sink->get_messages();
$sink->close();
// Scheduled task should not send report yet, because there are still running backup tasks.
$this->assertCount(0, $messages);
// Check that the backup tasks have been created.
$this->assertTrue($DB->record_exists('backup_courses', ['courseid' => $course1->id]));
$this->assertTrue($DB->record_exists('backup_courses', ['courseid' => $course2->id]));
$this->assertNotEmpty(get_config('backup', 'backup_auto_adhoctasks'));
$this->assertEquals(1, get_config('backup', 'backup_auto_emailpending'));
// Redirect messages to sink and stop buffer output from CLI task.
$sink = $this->redirectMessages();
// Trigger the automated backup report scheduled task.
$this->execute_task('\core\task\automated_backup_report_task');
$messages = $sink->get_messages();
$sink->close();
// Scheduled task should not send report yet, because there are still running backup tasks.
$this->assertCount(0, $messages);
// Execute only one ad-hoc backup task.
$value = get_config('backup', 'backup_auto_adhoctasks');
$queuedtasks = explode(',', $value);
$task = manager::get_adhoc_task($queuedtasks[0]);
$this->start_output_buffering();
$task->execute();
$this->stop_output_buffering();
manager::adhoc_task_complete($task);
// Redirect messages to sink and stop buffer output from CLI task.
$sink = $this->redirectMessages();
// Trigger the automated backup report scheduled task.
$this->execute_task('\core\task\automated_backup_report_task');
$messages = $sink->get_messages();
$sink->close();
// Scheduled task should not send report yet, because there are still running backup tasks.
$this->assertCount(0, $messages);
// Execute the remaining ad-hoc backup task.
$this->start_output_buffering();
$this->runAdhocTasks('\core\task\course_backup_task');
$this->stop_output_buffering();
// Redirect messages to sink.
$sink = $this->redirectMessages();
// Trigger the automated backup report scheduled task.
$this->execute_task('\core\task\automated_backup_report_task');
$messages = $sink->get_messages();
$sink->close();
// Verify that all the backup tasks have been completed and all the configs have been cleared.
$this->assertEmpty(get_config('backup', 'backup_auto_adhoctasks'));
$this->assertEmpty(get_config('backup', 'backup_auto_emailpending'));
// Verify that the report has been sent.
$this->assertCount(1, $messages);
$message = reset($messages);
$this->assertEquals(get_admin()->id, $message->useridto);
$this->assertEquals('backup', $message->eventtype);
}
}

2
version.php
View File

@ -29,7 +29,7 @@
defined('MOODLE_INTERNAL') || die();
$version = 2024011200.00; // YYYYMMDD = weekly release date of this DEV branch.
$version = 2024011200.01; // YYYYMMDD = weekly release date of this DEV branch.
// RR = release increments - 00 in DEV branches.
// .XX = incremental changes.
$release = '4.4dev (Build: 20240112)'; // Human-friendly version name