Merge pull request #130 from jkaninda/refactor

jkaninda · web-flow · commit 40557af437ba · 2024-10-20T06:58:20.000+02:00
Refactor
diff --git a/.env.example b/.env.example
@@ -27,6 +27,8 @@ TZ=Europe/Paris
 
 ### Backup Cron Expression
 #BACKUP_CRON_EXPRESSION=@midnight
+##Delete old backup created more than specified days ago
+#BACKUP_RETENTION_DAYS=7
 
 ####SSH Storage
 #SSH_HOST_NAME=
diff --git a/cmd/backup.go b/cmd/backup.go
@@ -20,7 +20,7 @@ var BackupCmd = &cobra.Command{
 		if len(args) == 0 {
 			pkg.StartBackup(cmd)
 		} else {
-			utils.Fatal("Error, no argument required")
+			utils.Fatal(`"backup" accepts no argument %q`, args)
 		}
 	},
 }
diff --git a/cmd/migrate.go b/cmd/migrate.go
@@ -19,7 +19,7 @@ var MigrateCmd = &cobra.Command{
 		if len(args) == 0 {
 			pkg.StartMigration(cmd)
 		} else {
-			utils.Fatal("Error, no argument required")
+			utils.Fatal(`"migrate" accepts no argument %q`, args)
 
 		}
 
diff --git a/cmd/restore.go b/cmd/restore.go
@@ -14,7 +14,7 @@ var RestoreCmd = &cobra.Command{
 		if len(args) == 0 {
 			pkg.StartRestore(cmd)
 		} else {
-			utils.Fatal("Error, no argument required")
+			utils.Fatal(`"restore" accepts no argument %q`, args)
 
 		}
 
diff --git a/docs/how-tos/backup-to-s3.md b/docs/how-tos/backup-to-s3.md
@@ -74,6 +74,8 @@ services:
       - AWS_ACCESS_KEY=xxxx
       - AWS_SECRET_KEY=xxxxx
       # - BACKUP_CRON_EXPRESSION=0 1 * * * # Optional
+      #Delete old backup created more than specified days ago
+      #- BACKUP_RETENTION_DAYS=7
       ## In case you are using S3 alternative such as Minio and your Minio instance is not secured, you change it to true
       - AWS_DISABLE_SSL="false"
      # mysql-bkup container must be connected to the same network with your database
diff --git a/docs/how-tos/backup-to-ssh.md b/docs/how-tos/backup-to-ssh.md
@@ -79,6 +79,8 @@ services:
       - REMOTE_PATH=/home/jkaninda/backups
       - SSH_IDENTIFY_FILE=/tmp/id_ed25519
      # - BACKUP_CRON_EXPRESSION=0 1 * * * # Optional
+      #Delete old backup created more than specified days ago
+      #- BACKUP_RETENTION_DAYS=7
       ## We advise you to use a private jey instead of password
       #- SSH_PASSWORD=password
      # mysql-bkup container must be connected to the same network with your database
diff --git a/docs/how-tos/backup.md b/docs/how-tos/backup.md
@@ -75,6 +75,8 @@ services:
       - DB_USERNAME=username
       - DB_PASSWORD=password
       - BACKUP_CRON_EXPRESSION=0 1 * * *
+      #Delete old backup created more than specified days ago
+      #- BACKUP_RETENTION_DAYS=7
     # mysql-bkup container must be connected to the same network with your database
     networks:
       - web
diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -26,8 +26,6 @@ Backup, restore and migrate targets, schedule and retention are configured using
 | --dbname              | -d     | Database name                                                                          |
 | --port                | -p     | Database port (default: 3306)                                                          |
 | --disable-compression |        | Disable database backup compression                                                    |
-| --prune               |        | Delete old backup, default disabled                                                    |
-| --keep-last           |        | Delete old backup created more than specified days ago, default 7 days                 |
 | --cron-expression     |        | Backup cron expression, eg: (* * * * *) or @daily                                      |
 | --help                | -h     | Print this help message and exit                                                       |
 | --version             | -V     | Print version information and exit                                                     |
@@ -52,6 +50,7 @@ Backup, restore and migrate targets, schedule and retention are configured using
 | GPG_PASSPHRASE         | Optional, required to encrypt and restore backup              | GPG passphrase                                                  |
 | GPG_PUBLIC_KEY         | Optional, required to encrypt backup                          | GPG public key, used to encrypt backup (/config/public_key.asc) |
 | BACKUP_CRON_EXPRESSION | Optional if it was provided from the `--cron-expression` flag | Backup cron expression for docker in scheduled mode             |
+| BACKUP_RETENTION_DAYS  | Optional                                                      | Delete old backup created more than specified days ago          |
 | SSH_HOST               | Optional, required for SSH storage                            | ssh remote hostname or ip                                       |
 | SSH_USER               | Optional, required for SSH storage                            | ssh remote user                                                 |
 | SSH_PASSWORD           | Optional, required for SSH storage                            | ssh remote user's password                                      |
diff --git a/pkg/backup.go b/pkg/backup.go
@@ -46,6 +46,7 @@ func StartBackup(cmd *cobra.Command) {
 func scheduledMode(db *dbConfig, config *BackupConfig) {
 	utils.Info("Running in Scheduled mode")
 	utils.Info("Backup cron expression:  %s", config.cronExpression)
+	utils.Info("The next scheduled time is: %v", utils.CronNextTime(config.cronExpression).Format(timeFormat))
 	utils.Info("Storage type %s ", config.storage)
 
 	//Test backup
@@ -58,6 +59,8 @@ func scheduledMode(db *dbConfig, config *BackupConfig) {
 
 	_, err := c.AddFunc(config.cronExpression, func() {
 		BackupTask(db, config)
+		utils.Info("Next backup time is: %v", utils.CronNextTime(config.cronExpression).Format(timeFormat))
+
 	})
 	if err != nil {
 		return
@@ -119,6 +122,7 @@ func startMultiBackup(bkConfig *BackupConfig, configFile string) {
 		if utils.IsValidCronExpression(bkConfig.cronExpression) {
 			utils.Info("Running MultiBackup in Scheduled mode")
 			utils.Info("Backup cron expression:  %s", bkConfig.cronExpression)
+			utils.Info("The next scheduled time is: %v", utils.CronNextTime(bkConfig.cronExpression).Format(timeFormat))
 			utils.Info("Storage type %s ", bkConfig.storage)
 
 			//Test backup
@@ -132,6 +136,8 @@ func startMultiBackup(bkConfig *BackupConfig, configFile string) {
 			_, err := c.AddFunc(bkConfig.cronExpression, func() {
 				// Create a channel
 				multiBackupTask(conf.Databases, bkConfig)
+				utils.Info("Next backup time is: %v", utils.CronNextTime(bkConfig.cronExpression).Format(timeFormat))
+
 			})
 			if err != nil {
 				return
diff --git a/pkg/config.go b/pkg/config.go
@@ -172,7 +172,6 @@ func initAWSConfig() *AWSConfig {
 func initBackupConfig(cmd *cobra.Command) *BackupConfig {
 	utils.SetEnv("STORAGE_PATH", storagePath)
 	utils.GetEnv(cmd, "cron-expression", "BACKUP_CRON_EXPRESSION")
-	utils.GetEnv(cmd, "period", "BACKUP_CRON_EXPRESSION")
 	utils.GetEnv(cmd, "path", "REMOTE_PATH")
 	//Get flag value and set env
 	remotePath := utils.GetEnvVariable("REMOTE_PATH", "SSH_REMOTE_PATH")
diff --git a/pkg/var.go b/pkg/var.go
@@ -12,6 +12,7 @@ const algorithm = "aes256"
 const gpgHome = "/config/gnupg"
 const gpgExtension = "gpg"
 const workingDir = "/config"
+const timeFormat = "2006-01-02 at 15:04:05"
 
 var (
 	storage                  = "local"
diff --git a/utils/notification.go b/utils/notification.go
@@ -6,7 +6,6 @@ import (
 	"encoding/json"
 	"fmt"
 	"github.com/go-mail/mail"
-	"github.com/robfig/cron/v3"
 	"html/template"
 	"io/ioutil"
 	"net/http"
@@ -177,7 +176,3 @@ func getTgUrl() string {
 	return fmt.Sprintf("https://api.telegram.org/bot%s", os.Getenv("TG_TOKEN"))
 
 }
-func IsValidCronExpression(cronExpr string) bool {
-	_, err := cron.ParseStandard(cronExpr)
-	return err == nil
-}
diff --git a/utils/utils.go b/utils/utils.go
@@ -8,11 +8,13 @@ package utils
 
 import (
 	"fmt"
+	"github.com/robfig/cron/v3"
 	"github.com/spf13/cobra"
 	"io"
 	"io/fs"
 	"os"
 	"strconv"
+	"time"
 )
 
 // FileExists checks if the file does exist
@@ -187,3 +189,26 @@ func EnvWithDefault(envName string, defaultValue string) string {
 	}
 	return value
 }
+
+// IsValidCronExpression verify cronExpression and returns boolean
+func IsValidCronExpression(cronExpr string) bool {
+	// Parse the cron expression
+	_, err := cron.ParseStandard(cronExpr)
+	return err == nil
+}
+
+// CronNextTime returns cronExpression next time
+func CronNextTime(cronExpr string) time.Time {
+	// Parse the cron expression
+	schedule, err := cron.ParseStandard(cronExpr)
+	if err != nil {
+		Error("Error parsing cron expression:", err)
+		return time.Time{}
+	}
+	// Get the current time
+	now := time.Now()
+	// Get the next scheduled time
+	next := schedule.Next(now)
+	//Info("The next scheduled time is: %v\n", next)
+	return next
+}

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ var BackupCmd = &cobra.Command{`
`20`	`20`	`if len(args) == 0 {`
`21`	`21`	`pkg.StartBackup(cmd)`
`22`	`22`	`} else {`
`23`		`- utils.Fatal("Error, no argument required")`
	`23`	+ utils.Fatal(`"backup" accepts no argument %q`, args)
`24`	`24`	`}`
`25`	`25`	`},`
`26`	`26`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@ var MigrateCmd = &cobra.Command{`
`19`	`19`	`if len(args) == 0 {`
`20`	`20`	`pkg.StartMigration(cmd)`
`21`	`21`	`} else {`
`22`		`- utils.Fatal("Error, no argument required")`
	`22`	+ utils.Fatal(`"migrate" accepts no argument %q`, args)
`23`	`23`
`24`	`24`	`}`
`25`	`25`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ var RestoreCmd = &cobra.Command{`
`14`	`14`	`if len(args) == 0 {`
`15`	`15`	`pkg.StartRestore(cmd)`
`16`	`16`	`} else {`
`17`		`- utils.Fatal("Error, no argument required")`
	`17`	+ utils.Fatal(`"restore" accepts no argument %q`, args)
`18`	`18`
`19`	`19`	`}`
`20`	`20`