Merge pull request #168 from jkaninda/nightly

Nightly

.golangci.yml

@@ -27,7 +27,6 @@ linters:
     - gosimple
     - govet
     - ineffassign
-    # - lll
     - misspell
     - nakedret
     - prealloc

Dockerfile

@@ -1,4 +1,4 @@
-FROM golang:1.23.4 AS build
+FROM golang:1.23.5 AS build
 WORKDIR /app
 ARG appVersion=""
 
@@ -10,7 +10,7 @@ RUN go mod download
 # Build
 RUN CGO_ENABLED=0 GOOS=linux go build -ldflags="-X 'github.com/jkaninda/mysql-bkup/utils.Version=${appVersion}'" -o /app/mysql-bkup
 
-FROM alpine:3.21.0
+FROM alpine:3.21.2
 ENV TZ=UTC
 ARG WORKDIR="/config"
 ARG BACKUPDIR="/backup"

README.md

@@ -74,7 +74,6 @@ To run a one time backup, bind your local volume to `/backup` in the container a
  docker run --rm --network your_network_name \
  -v $PWD/backup:/backup/ \
  -e "DB_HOST=dbhost" \
- -e "DB_PORT=3306" \
  -e "DB_USERNAME=username" \
  -e "DB_PASSWORD=password" \
  jkaninda/mysql-bkup backup -d database_name
@@ -88,19 +87,7 @@ Alternatively, pass a `--env-file` in order to use a full config as described be
  -v $PWD/backup:/backup/ \
  jkaninda/mysql-bkup backup -d database_name
 ```
-### Simple restore using Docker CLI
 
-To restore a database, bind your local volume to `/backup` in the container and run the `restore` command:
-
-```shell
- docker run --rm --network your_network_name \
- -v $PWD/backup:/backup/ \
- -e "DB_HOST=dbhost" \
- -e "DB_PORT=3306" \
- -e "DB_USERNAME=username" \
- -e "DB_PASSWORD=password" \
- jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz
-```
 ### Simple backup in docker compose file
 
 ```yaml

cmd/backup.go

@@ -44,7 +44,7 @@ var BackupCmd = &cobra.Command{
 }
 
 func init() {
-	// Backup
+	//Backup
 	BackupCmd.PersistentFlags().StringP("storage", "s", "local", "Define storage: local, s3, ssh, ftp, azure")
 	BackupCmd.PersistentFlags().StringP("path", "P", "", "Storage path without file name. e.g: /custom_path or ssh remote path `/home/foo/backup`")
 	BackupCmd.PersistentFlags().StringP("cron-expression", "e", "", "Backup cron expression (e.g., `0 0 * * *` or `@daily`)")

cmd/restore.go

@@ -46,7 +46,7 @@ var RestoreCmd = &cobra.Command{
 }
 
 func init() {
-	// Restore
+	//Restore
 	RestoreCmd.PersistentFlags().StringP("file", "f", "", "File name of database")
 	RestoreCmd.PersistentFlags().StringP("storage", "s", "local", "Define storage: local, s3, ssh, ftp")
 	RestoreCmd.PersistentFlags().StringP("path", "P", "", "AWS S3 path without file name. eg: /custom_path or ssh remote path `/home/foo/backup`")

cmd/root.go

@@ -38,6 +38,7 @@ var rootCmd = &cobra.Command{
 	Example: utils.MainExample,
 	Version: appVersion,
 }
+var operation = ""
 
 // Execute adds all child commands to the root command and sets flags appropriately.
 // This is called by main.main(). It only needs to happen once to the rootCmd.

docs/quickstart/index.md

@@ -18,7 +18,6 @@ To run a one-time backup, bind your local volume to `/backup` in the container a
 docker run --rm --network your_network_name \
   -v $PWD/backup:/backup/ \
   -e "DB_HOST=dbhost" \
-  -e "DB_PORT=3306" \
   -e "DB_USERNAME=username" \
   -e "DB_PASSWORD=password" \
   jkaninda/mysql-bkup backup -d database_name
@@ -35,19 +34,6 @@ docker run --rm --network your_network_name \
   jkaninda/mysql-bkup backup -d database_name
 ```
 
-### Simple restore using Docker CLI
-
-To restore a database, bind your local volume to `/backup` in the container and run the `restore` command:
-
-```shell
- docker run --rm --network your_network_name \
- -v $PWD/backup:/backup/ \
- -e "DB_HOST=dbhost" \
- -e "DB_PORT=3306" \
- -e "DB_USERNAME=username" \
- -e "DB_PASSWORD=password" \
- jkaninda/mysql-bkup restore -d database_name -f backup_file.sql.gz
-```
 ---
 
 ## Simple Backup Using Docker Compose

pkg/azure.go

@@ -39,11 +39,7 @@ func azureBackup(db *dbConfig, config *BackupConfig) {
 	utils.Info("Backup database to Azure Blob Storage")
 
 	// Backup database
-	err := BackupDatabase(db, config.backupFileName, disableCompression)
+	BackupDatabase(db, config.backupFileName, disableCompression)
-	if err != nil {
-		recoverMode(err, "Error backing up database")
-		return
-	}
 	finalFileName := config.backupFileName
 	if config.encryption {
 		encryptBackup(config)

pkg/backup.go

@@ -72,17 +72,13 @@ func scheduledMode(db *dbConfig, config *BackupConfig) {
 
 	// Test backup
 	utils.Info("Testing backup configurations...")
-	err := testDatabaseConnection(db)
+	testDatabaseConnection(db)
-	if err != nil {
-		utils.Error("Error connecting to database: %s", db.dbName)
-		utils.Fatal("Error: %s", err)
-	}
 	utils.Info("Testing backup configurations...done")
 	utils.Info("Creating backup job...")
 	// Create a new cron instance
 	c := cron.New()
 
-	_, err = c.AddFunc(config.cronExpression, func() {
+	_, err := c.AddFunc(config.cronExpression, func() {
 		BackupTask(db, config)
 		utils.Info("Next backup time is: %v", utils.CronNextTime(config.cronExpression).Format(timeFormat))
 
@@ -151,7 +147,6 @@ func startMultiBackup(bkConfig *BackupConfig, configFile string) {
 	if bkConfig.cronExpression == "" {
 		multiBackupTask(conf.Databases, bkConfig)
 	} else {
-		backupRescueMode = conf.BackupRescueMode
 		// Check if cronExpression is valid
 		if utils.IsValidCronExpression(bkConfig.cronExpression) {
 			utils.Info("Running backup in Scheduled mode")
@@ -162,11 +157,7 @@ func startMultiBackup(bkConfig *BackupConfig, configFile string) {
 			// Test backup
 			utils.Info("Testing backup configurations...")
 			for _, db := range conf.Databases {
-				err = testDatabaseConnection(getDatabase(db))
+				testDatabaseConnection(getDatabase(db))
-				if err != nil {
-					recoverMode(err, fmt.Sprintf("Error connecting to database: %s", db.Name))
-					continue
-				}
 			}
 			utils.Info("Testing backup configurations...done")
 			utils.Info("Creating backup job...")
@@ -196,19 +187,16 @@ func startMultiBackup(bkConfig *BackupConfig, configFile string) {
 }
 
 // BackupDatabase backup database
-func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool) error {
+func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool) {
 	storagePath = os.Getenv("STORAGE_PATH")
 
 	utils.Info("Starting database backup...")
 
 	err := os.Setenv("MYSQL_PWD", db.dbPassword)
 	if err != nil {
-		return fmt.Errorf("failed to set MYSQL_PWD environment variable: %v", err)
+		return
-	}
-	err = testDatabaseConnection(db)
-	if err != nil {
-		return fmt.Errorf("failed to connect to the database: %v", err)
 	}
+	testDatabaseConnection(db)
 	// Backup Database database
 	utils.Info("Backing up database...")
 
@@ -223,24 +211,24 @@ func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool
 		)
 		output, err := cmd.Output()
 		if err != nil {
-			return fmt.Errorf("failed to backup database: %v", err)
+			utils.Fatal(err.Error())
 		}
 
 		// save output
 		file, err := os.Create(filepath.Join(tmpPath, backupFileName))
 		if err != nil {
-			return fmt.Errorf("failed to create backup file: %v", err)
+			utils.Fatal(err.Error())
 		}
 		defer func(file *os.File) {
 			err := file.Close()
 			if err != nil {
-				return
+				utils.Fatal(err.Error())
 			}
 		}(file)
 
 		_, err = file.Write(output)
 		if err != nil {
-			return err
+			utils.Fatal(err.Error())
 		}
 		utils.Info("Database has been backed up")
 
@@ -249,14 +237,14 @@ func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool
 		cmd := exec.Command("mysqldump", "-h", db.dbHost, "-P", db.dbPort, "-u", db.dbUserName, db.dbName)
 		stdout, err := cmd.StdoutPipe()
 		if err != nil {
-			return fmt.Errorf("failed to backup database: %v", err)
+			log.Fatal(err)
 		}
 		gzipCmd := exec.Command("gzip")
 		gzipCmd.Stdin = stdout
 		gzipCmd.Stdout, err = os.Create(filepath.Join(tmpPath, backupFileName))
 		err = gzipCmd.Start()
 		if err != nil {
-			return fmt.Errorf("failed to backup database: %v", err)
+			return
 		}
 		if err := cmd.Run(); err != nil {
 			log.Fatal(err)
@@ -264,18 +252,13 @@ func BackupDatabase(db *dbConfig, backupFileName string, disableCompression bool
 		if err := gzipCmd.Wait(); err != nil {
 			log.Fatal(err)
 		}
+		utils.Info("Database has been backed up")
 
 	}
-	utils.Info("Database has been backed up")
-	return nil
 }
 func localBackup(db *dbConfig, config *BackupConfig) {
 	utils.Info("Backup database to local storage")
-	err := BackupDatabase(db, config.backupFileName, disableCompression)
+	BackupDatabase(db, config.backupFileName, disableCompression)
-	if err != nil {
-		recoverMode(err, "Error backing up database")
-		return
-	}
 	finalFileName := config.backupFileName
 	if config.encryption {
 		encryptBackup(config)
@@ -350,17 +333,3 @@ func encryptBackup(config *BackupConfig) {
 	}
 
 }
-func recoverMode(err error, msg string) {
-	if err != nil {
-		if backupRescueMode {
-			utils.NotifyError(fmt.Sprintf("%s : %v", msg, err))
-			utils.Error("Error: %s", msg)
-			utils.Error("Backup rescue mode is enabled")
-			utils.Error("Backup will continue")
-		} else {
-			utils.Error("Error: %s", msg)
-			utils.Fatal("Error: %v", err)
-		}
-	}
-
-}

pkg/config.go

@@ -42,9 +42,8 @@ type Database struct {
 	Path     string `yaml:"path"`
 }
 type Config struct {
-	CronExpression   string     `yaml:"cronExpression"`
+	Databases      []Database `yaml:"databases"`
-	BackupRescueMode bool       `yaml:"backupRescueMode"`
+	CronExpression string     `yaml:"cronExpression"`
-	Databases        []Database `yaml:"databases"`
 }
 
 type dbConfig struct {
@@ -115,7 +114,7 @@ func initDbConfig(cmd *cobra.Command) *dbConfig {
 	utils.GetEnv(cmd, "dbname", "DB_NAME")
 	dConf := dbConfig{}
 	dConf.dbHost = os.Getenv("DB_HOST")
-	dConf.dbPort = utils.EnvWithDefault("DB_PORT", "3306")
+	dConf.dbPort = os.Getenv("DB_PORT")
 	dConf.dbName = os.Getenv("DB_NAME")
 	dConf.dbUserName = os.Getenv("DB_USERNAME")
 	dConf.dbPassword = os.Getenv("DB_PASSWORD")
@@ -145,26 +144,15 @@ func getDatabase(database Database) *dbConfig {
 
 // Helper function to get environment variable or use a default value
 func getEnvOrDefault(currentValue, envKey, suffix, defaultValue string) string {
-	// Return the current value if it's already set
 	if currentValue != "" {
 		return currentValue
 	}
-
-	// Check for suffixed or prefixed environment variables if a suffix is provided
 	if suffix != "" {
-		suffixUpper := strings.ToUpper(suffix)
+		envSuffix := os.Getenv(fmt.Sprintf("%s_%s", envKey, strings.ToUpper(suffix)))
-		envSuffix := os.Getenv(fmt.Sprintf("%s_%s", envKey, suffixUpper))
 		if envSuffix != "" {
 			return envSuffix
 		}
-
-		envPrefix := os.Getenv(fmt.Sprintf("%s_%s", suffixUpper, envKey))
-		if envPrefix != "" {
-			return envPrefix
-		}
 	}
-
-	// Fall back to the default value using a helper function
 	return utils.EnvWithDefault(envKey, defaultValue)
 }
 

pkg/helper.go

@@ -66,10 +66,10 @@ func deleteTemp() {
 }
 
 // TestDatabaseConnection  tests the database connection
-func testDatabaseConnection(db *dbConfig) error {
+func testDatabaseConnection(db *dbConfig) {
 	err := os.Setenv("MYSQL_PWD", db.dbPassword)
 	if err != nil {
-		return fmt.Errorf("failed to set MYSQL_PWD environment variable: %v", err)
+		return
 	}
 	utils.Info("Connecting to %s database ...", db.dbName)
 	// Set database name for notification error
@@ -81,11 +81,11 @@ func testDatabaseConnection(db *dbConfig) error {
 	cmd.Stderr = &out
 	err = cmd.Run()
 	if err != nil {
-		return fmt.Errorf("failed to connect to %s database: %v", db.dbName, err)
+		utils.Fatal("Error testing database connection: %v\nOutput: %s", err, out.String())
 
 	}
 	utils.Info("Successfully connected to %s database", db.dbName)
-	return nil
+
 }
 
 // checkPubKeyFile checks gpg public key

pkg/migrate.go

@@ -51,10 +51,7 @@ func StartMigration(cmd *cobra.Command) {
 	conf := &RestoreConfig{}
 	conf.file = backupFileName
 	// Backup source Database
-	err := BackupDatabase(dbConf, backupFileName, true)
+	BackupDatabase(dbConf, backupFileName, true)
-	if err != nil {
-		utils.Fatal("Error backing up database: %s", err)
-	}
 	// Restore source database into target database
 	utils.Info("Restoring [%s] database into [%s] database...", dbConf.dbName, targetDbConf.targetDbName)
 	RestoreDatabase(&newDbConfig, conf)

pkg/remote.go

@@ -39,11 +39,7 @@ import (
 func sshBackup(db *dbConfig, config *BackupConfig) {
 	utils.Info("Backup database to Remote server")
 	// Backup database
-	err := BackupDatabase(db, config.backupFileName, disableCompression)
+	BackupDatabase(db, config.backupFileName, disableCompression)
-	if err != nil {
-		recoverMode(err, "Error backing up database")
-		return
-	}
 	finalFileName := config.backupFileName
 	if config.encryption {
 		encryptBackup(config)
@@ -160,11 +156,7 @@ func ftpBackup(db *dbConfig, config *BackupConfig) {
 	utils.Info("Backup database to the remote FTP server")
 
 	// Backup database
-	err := BackupDatabase(db, config.backupFileName, disableCompression)
+	BackupDatabase(db, config.backupFileName, disableCompression)
-	if err != nil {
-		recoverMode(err, "Error backing up database")
-		return
-	}
 	finalFileName := config.backupFileName
 	if config.encryption {
 		encryptBackup(config)

pkg/restore.go

@@ -118,10 +118,7 @@ func RestoreDatabase(db *dbConfig, conf *RestoreConfig) {
 		if err != nil {
 			return
 		}
-		err = testDatabaseConnection(db)
+		testDatabaseConnection(db)
-		if err != nil {
-			utils.Fatal("Error connecting to the database %v", err)
-		}
 		utils.Info("Restoring database...")
 
 		extension := filepath.Ext(filepath.Join(tmpPath, conf.file))

pkg/s3.go

@@ -39,11 +39,7 @@ func s3Backup(db *dbConfig, config *BackupConfig) {
 
 	utils.Info("Backup database to s3 storage")
 	// Backup database
-	err := BackupDatabase(db, config.backupFileName, disableCompression)
+	BackupDatabase(db, config.backupFileName, disableCompression)
-	if err != nil {
-		recoverMode(err, "Error backing up database")
-		return
-	}
 	finalFileName := config.backupFileName
 	if config.encryption {
 		encryptBackup(config)

pkg/var.go

@@ -42,7 +42,6 @@ var (
 	usingKey                 = false
 	backupSize         int64 = 0
 	startTime                = time.Now()
-	backupRescueMode         = false
 )
 
 // dbHVars Required environment variables for database
@@ -62,6 +61,13 @@ var tdbRVars = []string{
 var dbConf *dbConfig
 var targetDbConf *targetDbConfig
 
+// sshVars Required environment variables for SSH remote server storage
+var sshVars = []string{
+	"SSH_USER",
+	"SSH_HOST_NAME",
+	"SSH_PORT",
+	"REMOTE_PATH",
+}
 var ftpVars = []string{
 	"FTP_HOST_NAME",
 	"FTP_USER",

templates/email-error.tmpl

@@ -60,10 +60,10 @@
 
     <p>We recommend investigating the issue as soon as possible to prevent potential data loss or service disruptions.</p>
 
-    <p>For more information, visit the <a href="https://jkaninda.github.io/mysql-bkup">mysql-bkup documentation</a>.</p>
+    <p>For more information, visit the <a href="https://jkaninda.github.io/pg-bkup">pg-bkup documentation</a>.</p>
 
     <footer>
-        &copy; 2024 <a href="https://github.com/jkaninda/mysql-bkup">mysql-bkup</a> | Automated Backup System
+        &copy; 2024 <a href="https://github.com/jkaninda/pg-bkup">pg-bkup</a> | Automated Backup System
     </footer>
 </body>
 </html>