Merge pull request #4697 from msupply-foundation/4696-Limit-number-of-backups

Add backup cleanup to backup script

Author: andreievg

server/cli/src/backup/README.md

@@ -30,6 +30,8 @@ You will need to specify a backup folder in the configuration `.yaml` files - to
 
 Backup will contain a folder with all of the app_data (plugins, static files, etc..) and a folder with either sqlite files or postgres database dump. 
 
+`max_number_of_backups` in configuration `.yaml` file can be used to limit number of backups that will be kept in backup folder, this will be checked during each backup and extra backup folder will be deleted
+
 ### Restore
 
 To restore run: 

server/cli/src/backup/backup.rs

@@ -10,10 +10,17 @@ pub(crate) fn backup(settings: &Settings) -> Result<(), BackupError> {
         pg_bin_dir,
     } = get_dirs_from_settings(settings)?;
 
+    let max_number_of_backups = settings
+        .backup
+        .as_ref()
+        .map(|b| b.max_number_of_backups)
+        .flatten();
+
     let Dirs {
         backup_name,
         file_dir,
         database_dir,
+        backups_dir,
     } = create_backup_dir(backup_dir)?;
 
     copy_files(settings, &file_dir)?;
@@ -25,6 +32,8 @@ pub(crate) fn backup(settings: &Settings) -> Result<(), BackupError> {
         copy_sqlite_files(settings, &database_dir)?;
     }
 
+    cleanup_backups(&backups_dir, max_number_of_backups)?;
+
     println!("Backup completed in folder {backup_name}");
     Ok(())
 }
@@ -33,6 +42,7 @@ struct Dirs {
     backup_name: String,
     file_dir: PathBuf,
     database_dir: PathBuf,
+    backups_dir: PathBuf,
 }
 
 fn create_backup_dir(output_dir: String) -> Result<Dirs, BackupError> {
@@ -41,9 +51,10 @@ fn create_backup_dir(output_dir: String) -> Result<Dirs, BackupError> {
         .format("D%Y_%m_%dT%H_%M_%S")
         .to_string();
 
-    let base_dir = PathBuf::from_str(&output_dir)
-        .map_err(|_| BackupError::InvalidPath(output_dir.to_string()))?
-        .join(&backup_name);
+    let backups_dir = PathBuf::from_str(&output_dir)
+        .map_err(|_| BackupError::InvalidPath(output_dir.to_string()))?;
+
+    let base_dir = backups_dir.join(&backup_name);
 
     fs::create_dir_all(&base_dir)
         .map_err(|e| BackupError::CannotCreateBackupFolder(e, base_dir.clone()))?;
@@ -60,6 +71,7 @@ fn create_backup_dir(output_dir: String) -> Result<Dirs, BackupError> {
         backup_name,
         file_dir,
         database_dir,
+        backups_dir,
     })
 }
 
@@ -137,3 +149,35 @@ fn copy_sqlite_files(
 
     Ok(())
 }
+
+fn cleanup_backups(
+    backups_dir: &PathBuf,
+    max_number_of_backups: Option<u32>,
+) -> Result<(), BackupError> {
+    let Some(max_number_of_backups) = &max_number_of_backups else {
+        return Ok(());
+    };
+
+    let mut paths: Vec<PathBuf> = fs::read_dir(backups_dir)?
+        .into_iter()
+        .filter_map(Result::ok)
+        .map(|e| e.path())
+        .filter(|f| f.is_dir())
+        .collect();
+
+    paths.sort();
+
+    let max_number_of_backups = *max_number_of_backups as usize;
+    let number_of_backups_to_delete = if paths.len() <= max_number_of_backups {
+        0
+    } else {
+        paths.len() - max_number_of_backups
+    };
+
+    for path in paths.iter().take(number_of_backups_to_delete) {
+        println!("Deleting old backup: {:?}", path);
+        let _ = fs::remove_dir_all(path);
+    }
+
+    Ok(())
+}

server/cli/src/backup/mod.rs

@@ -75,6 +75,7 @@ fn get_dirs_from_settings(settings: &Settings) -> Result<DirSettings, BackupErro
     let Some(BackupSettings {
         backup_dir,
         pg_bin_dir,
+        ..
     }) = settings.backup.clone()
     else {
         return Err(BackupError::BackupConfigurationMissing);

server/cli/src/cli.rs

@@ -134,7 +134,9 @@ enum Action {
         #[clap(short, long)]
         sub_context: Option<String>,
     },
-    /// Will back up database to a generated folder (the name of which will be returned). Folder will be generated in the backup directory specified by configuration file
+    /// Will back up database to a generated folder (the name of which will be returned).
+    /// Folder will be generated in the backup directory specified by configuration file.
+    /// User can specify max number of backup to keep, see example configuration file
     Backup,
     Restore(RestoreArguments),
 }

server/configuration/example.yaml

@@ -40,4 +40,4 @@
 # backup: # see cli backup/restore
 #   backup_dir: "~/Documents/omSupply_backup"
 #   pg_bin_dir: "/Applications/Postgres.app/Contents/Versions/16/bin"  # Optional
-
+#   max_number_of_backups: 10  # Optional, defaults to unlimited 

server/service/src/settings.rs

@@ -48,6 +48,8 @@ pub struct BackupSettings {
     pub backup_dir: String,
     // Directory containing postgres binaries (in case pg_dump and pg_restore are not in PATH)
     pub pg_bin_dir: Option<String>,
+    // Number of backups to keep
+    pub max_number_of_backups: Option<u32>,
 }
 
 pub fn is_develop() -> bool {