Merge pull request #49 from jkaninda/develop

Develop

.github/workflows/build.yml

@@ -35,5 +35,5 @@ jobs:
           file: "./docker/Dockerfile"
           platforms: linux/amd64,linux/arm64
           tags: |
-           "${{env.BUILDKIT_IMAGE}}:v0.6"
+           "${{env.BUILDKIT_IMAGE}}:v0.7"
            "${{env.BUILDKIT_IMAGE}}:latest"

.gitignore

@@ -7,4 +7,5 @@ test.md
 .DS_Store
 mysql-bkup
 /.DS_Store
-/.idea
+/.idea
+bin

Makefile

@@ -0,0 +1,32 @@
+BINARY_NAME=mysql-bkup
+include .env
+export
+run:
+	go run .
+
+build:
+	go build -o bin/${BINARY_NAME} .
+
+compile:
+	GOOS=darwin GOARCH=arm64 go build -o bin/${BINARY_NAME}-darwin-arm64 .
+	GOOS=darwin GOARCH=amd64 go build -o bin/${BINARY_NAME}-darwin-amd64 .
+	GOOS=linux GOARCH=arm64 go build -o bin/${BINARY_NAME}-linux-arm64 .
+	GOOS=linux GOARCH=amd64 go build -o bin/${BINARY_NAME}-linux-amd64 .
+
+docker-build:
+	docker build -f docker/Dockerfile  -t jkaninda/mysql-bkup:latest .
+
+docker-run: docker-build
+	docker run --rm --network internal --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" jkaninda/mysql-bkup  bkup backup --prune --keep-last 2
+
+
+docker-run-scheduled: docker-build
+	docker run --rm --network internal --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -v "./backup:/backup"  jkaninda/mysql-bkup  bkup backup --prune --keep-last=2 --mode scheduled --period "* * * * *"
+
+
+docker-run-scheduled-s3: docker-build
+	docker run --rm --network internal --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${BUCKET_NAME}" -e "S3_ENDPOINT=${S3_ENDPOINT}" jkaninda/mysql-bkup  bkup backup --storage s3 --mode scheduled --path /custom-path --period "* * * * *"
+
+docker-restore-s3: docker-build
+	docker run --rm --network internal --privileged --device /dev/fuse --name mysql-bkup -e "DB_HOST=${DB_HOST}" -e "DB_NAME=${DB_NAME}" -e "DB_USERNAME=${DB_USERNAME}" -e "DB_PASSWORD=${DB_PASSWORD}" -e "ACCESS_KEY=${ACCESS_KEY}" -e "SECRET_KEY=${SECRET_KEY}" -e "BUCKET_NAME=${BUCKET_NAME}" -e "S3_ENDPOINT=${S3_ENDPOINT}" -e "FILE_NAME=${FILE_NAME}" jkaninda/mysql-bkup  bkup restore --storage s3 --path /custom-path
+

README.md

@@ -38,23 +38,25 @@ MySQL Backup and Restoration tool. Backup database to AWS S3 storage or any S3 A
 
 ## Usage
 
-| Options               | Shorts | Usage                                                              |
-|-----------------------|--------|--------------------------------------------------------------------|
-| mysql-bkup            | bkup   | CLI utility                                                        |
-| backup                |        | Backup database operation                                          |
-| restore               |        | Restore database operation                                         |
-| history               |        | Show the history of backup                                         |
-| --storage             | -s     | Set storage. local or s3 (default: local)                          |
-| --file                | -f     | Set file name for restoration                                      |
-| --path                |        | Set s3 path without file name. eg: /custom_path                    |
-| --dbname              | -d     | Set database name                                                  |
-| --port                | -p     | Set database port (default: 3306)                                  |
-| --mode                | -m     | Set execution mode. default or scheduled (default: default)        |
-| --disable-compression |        | Disable database backup compression                                |
-| --period              |        | Set crontab period for scheduled mode only. (default: "0 1 * * *") |
-| --timeout             | -t     | Set timeout (default: 60s)                                         |
-| --help                | -h     | Print this help message and exit                                   |
-| --version             | -V     | Print version information and exit                                 |
+| Options               | Shorts | Usage                                                                 |
+|-----------------------|--------|-----------------------------------------------------------------------|
+| mysql-bkup            | bkup   | CLI utility                                                           |
+| backup                |        | Backup database operation                                             |
+| restore               |        | Restore database operation                                            |
+| history               |        | Show the history of backup                                            |
+| --storage             | -s     | Set storage. local or s3 (default: local)                             |
+| --file                | -f     | Set file name for restoration                                         |
+| --path                |        | Set s3 path without file name. eg: /custom_path                       |
+| --dbname              | -d     | Set database name                                                     |
+| --port                | -p     | Set database port (default: 3306)                                     |
+| --mode                | -m     | Set execution mode. default or scheduled (default: default)           |
+| --disable-compression |        | Disable database backup compression                                   |
+| --prune               |        | Delete old backup                                                     |
+| --keep-last           |        | keep all backup and delete within this time interval, default 7 days  |
+| --period              |        | Set crontab period for scheduled mode only. (default: "0 1 * * *")    |
+| --timeout             | -t     | Set timeout (default: 60s)                                            |
+| --help                | -h     | Print this help message and exit                                      |
+| --version             | -V     | Print version information and exit                                    |
 
 
 ## Environment variables

build.sh

@@ -1,14 +0,0 @@
-#!/usr/bin/env bash
-if [ $# -eq 0 ]
-  then
-    tag='latest'
-  else
-    tag=$1
-fi
-
-#go build
-CGO_ENABLED=0 GOOS=linux go build
-
-docker build -f docker/Dockerfile  -t jkaninda/mysql-bkup:$tag .
-
-#docker compose up -d --force-recreate

cmd/backup.go

@@ -23,6 +23,8 @@ func init() {
 	//Backup
 	BackupCmd.PersistentFlags().StringP("mode", "m", "default", "Set execution mode. default or scheduled")
 	BackupCmd.PersistentFlags().StringP("period", "", "0 1 * * *", "Set schedule period time")
+	BackupCmd.PersistentFlags().BoolP("prune", "", false, "Prune old backup")
+	BackupCmd.PersistentFlags().IntP("keep-last", "", 7, "keep all backup and delete within this time interval, default 7 days")
 	BackupCmd.PersistentFlags().BoolP("disable-compression", "", false, "Disable backup compression")
 
 }

cmd/root.go

@@ -5,7 +5,6 @@ Copyright © 2024 Jonas Kaninda  <jonaskaninda@gmail.com>
 package cmd
 
 import (
-	"fmt"
 	"github.com/jkaninda/mysql-bkup/utils"
 	"github.com/spf13/cobra"
 	"os"
@@ -18,16 +17,6 @@ var rootCmd = &cobra.Command{
 	Long:    `MySQL Database backup and restoration tool. Backup database to AWS S3 storage or any S3 Alternatives for Object Storage.`,
 	Example: utils.MainExample,
 	Version: appVersion,
-	//TODO: To remove
-	//For old user || To remove
-	Run: func(cmd *cobra.Command, args []string) {
-		if operation != "" {
-			if operation == "backup" || operation == "restore" {
-				fmt.Println(utils.Notice)
-				utils.Fatal("New config required, please check --help")
-			}
-		}
-	},
 }
 var operation = ""
 var s3Path = "/mysql-bkup"
@@ -49,11 +38,6 @@ func init() {
 	rootCmd.PersistentFlags().IntP("port", "p", 3306, "Set database port")
 	rootCmd.PersistentFlags().StringVarP(&operation, "operation", "o", "", "Set operation, for old version only")
 
-	rootCmd.PersistentFlags().StringP("mode", "m", "default", "Set execution mode. default or scheduled")
-	rootCmd.PersistentFlags().StringP("period", "", "0 1 * * *", "Set schedule period time")
-	rootCmd.PersistentFlags().BoolP("disable-compression", "", false, "Disable backup compression")
-	rootCmd.PersistentFlags().StringP("file", "f", "", "File name of database")
-
 	rootCmd.AddCommand(VersionCmd)
 	rootCmd.AddCommand(BackupCmd)
 	rootCmd.AddCommand(RestoreCmd)

docker/Dockerfile

@@ -16,7 +16,7 @@ ENV DB_USERNAME=""
 ENV DB_PASSWORD=""
 ENV DB_PORT="3306"
 ENV STORAGE=local
-ENV BUCKETNAME=""
+ENV BUCKET_NAME=""
 ENV ACCESS_KEY=""
 ENV SECRET_KEY=""
 ENV S3_ENDPOINT=https://s3.amazonaws.com

pkg/backup.go

@@ -11,12 +11,11 @@ import (
 	"log"
 	"os"
 	"os/exec"
+	"path/filepath"
 	"time"
 )
 
 func StartBackup(cmd *cobra.Command) {
-	_, _ = cmd.Flags().GetString("operation")
-
 	//Set env
 	utils.SetEnv("STORAGE_PATH", storagePath)
 	utils.GetEnv(cmd, "dbname", "DB_NAME")
@@ -28,15 +27,17 @@ func StartBackup(cmd *cobra.Command) {
 	storage = utils.GetEnv(cmd, "storage", "STORAGE")
 	file = utils.GetEnv(cmd, "file", "FILE_NAME")
 	disableCompression, _ = cmd.Flags().GetBool("disable-compression")
+	keepLast, _ := cmd.Flags().GetInt("keep-last")
+	prune, _ := cmd.Flags().GetBool("prune")
 	executionMode, _ = cmd.Flags().GetString("mode")
 
 	if executionMode == "default" {
 		if storage == "s3" {
 			utils.Info("Backup database to s3 storage")
-			s3Backup(disableCompression, s3Path)
+			s3Backup(disableCompression, s3Path, prune, keepLast)
 		} else {
 			utils.Info("Backup database to local storage")
-			BackupDatabase(disableCompression)
+			BackupDatabase(disableCompression, prune, keepLast)
 
 		}
 	} else if executionMode == "scheduled" {
@@ -72,7 +73,7 @@ func scheduledMode() {
 }
 
 // BackupDatabase backup database
-func BackupDatabase(disableCompression bool) {
+func BackupDatabase(disableCompression bool, prune bool, keepLast int) {
 	dbHost = os.Getenv("DB_HOST")
 	dbPassword := os.Getenv("DB_PASSWORD")
 	dbUserName := os.Getenv("DB_USERNAME")
@@ -140,6 +141,10 @@ func BackupDatabase(disableCompression bool) {
 				log.Fatal(err)
 			}
 			utils.Done("Database has been backed up")
+			//Delete old backup
+			if prune {
+				deleteOldBackup(keepLast)
+			}
 
 		}
 
@@ -155,8 +160,39 @@ func BackupDatabase(disableCompression bool) {
 
 }
 
-func s3Backup(disableCompression bool, s3Path string) {
+func s3Backup(disableCompression bool, s3Path string, prune bool, keepLast int) {
 	// Backup Database to S3 storage
 	MountS3Storage(s3Path)
-	BackupDatabase(disableCompression)
+	BackupDatabase(disableCompression, prune, keepLast)
+}
+
+func deleteOldBackup(keepLast int) {
+	utils.Info("Deleting old backups...")
+	storagePath = os.Getenv("STORAGE_PATH")
+	// Define the directory path
+	backupDir := storagePath + "/"
+	// Get current time
+	currentTime := time.Now()
+	// Walk through files in the directory
+	err := filepath.Walk(backupDir, func(path string, info os.FileInfo, err error) error {
+		if err != nil {
+			return err
+		}
+		// Check if the file is older than defined day days
+		if info.Mode().IsRegular() && info.ModTime().Before(currentTime.AddDate(0, 0, -keepLast)) {
+			// Remove the file
+			err := os.Remove(path)
+			if err != nil {
+				utils.Fatal("Error removing file ", path, err)
+			} else {
+				utils.Done("Removed file: ", path)
+			}
+		}
+		return nil
+	})
+
+	if err != nil {
+		utils.Fatal("Error walking through directory: ", err)
+	}
+
 }

utils/constant.go

@@ -1,11 +1,5 @@
 package utils
 
-const Notice = "Please remove --operation flag.\n" +
-	"Use: \n" +
-	"- backup for database backup operation [eg: bkup backup -d  database_name ...]\n" +
-	"- restore for database restore operation [eg. bkup restore -d database_name ...]\n" +
-	"Example: bkup backup --storage s3 ...( instead of < bkup --operation backup >)\n" +
-	"We are sorry for this inconvenient\n"
 const RestoreExample = "mysql-bkup restore --dbname database --file db_20231219_022941.sql.gz\n" +
 	"bkup restore --dbname database --storage s3 --path /custom-path --file db_20231219_022941.sql.gz"
 const BackupExample = "mysql-bkup backup --dbname database --disable-compression\n" +