feat: Add Telegram notification

jkaninda · Sep 10, 2024 · 13ea619 · 13ea619
1 parent 90fd464
commit 13ea619
Show file tree

Hide file tree

Showing 22 changed files with 229 additions and 32 deletions.
diff --git a/cmd/backup.go b/cmd/backup.go
@@ -1,3 +1,9 @@
+// Package cmd /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package cmd
 
 import (

diff --git a/cmd/migrate.go b/cmd/migrate.go
@@ -1,3 +1,9 @@
+// Package cmd /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package cmd
 
 import (

diff --git a/cmd/restore.go b/cmd/restore.go
@@ -1,3 +1,9 @@
+// Package cmd /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package cmd
 
 import (

diff --git a/cmd/root.go b/cmd/root.go
@@ -1,7 +1,9 @@
-// Package cmd /*
-/*
-Copyright © 2024 Jonas Kaninda
-*/
+// Package cmd /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package cmd
 
 import (

diff --git a/cmd/version.go b/cmd/version.go
@@ -1,9 +1,11 @@
+// Package cmd /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package cmd
 
-/*
-Copyright © 2024 Jonas Kaninda
-*/
-
 import (
 	"fmt"
 	"github.com/spf13/cobra"

diff --git a/docker/Dockerfile b/docker/Dockerfile
@@ -36,7 +36,7 @@ ENV TARGET_DB_NAME=""
 ENV TARGET_DB_USERNAME=""
 ENV TARGET_DB_PASSWORD=""
 ARG DEBIAN_FRONTEND=noninteractive
-ENV VERSION="v1.2.4"
+ENV VERSION="v1.2.5"
 ENV BACKUP_CRON_EXPRESSION=""
 ARG WORKDIR="/config"
 ARG BACKUPDIR="/backup"

diff --git a/docs/reference/index.md b/docs/reference/index.md
@@ -62,6 +62,8 @@ Backup, restore and migrate targets, schedule and retention are configured using
 | TARGET_DB_NAME         | Optional, required for database migration          | Target database name                                 |
 | TARGET_DB_USERNAME     | Optional, required for database migration          | Target database username                             |
 | TARGET_DB_PASSWORD     | Optional, required for database migration          | Target database password                             |
+| TG_TOKEN               | Optional, required for Telegram notification       | Telegram token                                       |
+| TG_CHAT_ID             | Optional, required for Telegram notification       | Telegram Chat ID                                     |
 
 ---
 ## Run in Scheduled mode

diff --git a/main.go b/main.go
@@ -1,12 +1,11 @@
-package main
-
-//main
+// Package main /
 /*****
-*  MySQL Backup & Restore
-* @author    Jonas Kaninda
-* @license   MIT License <https://opensource.org/licenses/MIT>
-* @link      https://github.com/jkaninda/pg-bkup
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
 **/
+package main
+
 import "github.com/jkaninda/pg-bkup/cmd"
 
 func main() {

diff --git a/pkg/backup.go b/pkg/backup.go
@@ -1,7 +1,9 @@
-// Package pkg /*
-/*
-Copyright © 2024 Jonas Kaninda
-*/
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (
@@ -17,6 +19,7 @@ import (
 )
 
 func StartBackup(cmd *cobra.Command) {
+	utils.Welcome()
 	//Set env
 	utils.SetEnv("STORAGE_PATH", storagePath)
 	utils.GetEnv(cmd, "period", "BACKUP_CRON_EXPRESSION")
@@ -198,6 +201,8 @@ func localBackup(db *dbConfig, backupFileName string, disableCompression bool, p
 	}
 	utils.Info("Backup name is %s", finalFileName)
 	moveToBackup(finalFileName, storagePath)
+	//Send notification
+	utils.NotifySuccess(finalFileName)
 	//Delete old backup
 	if prune {
 		deleteOldBackup(backupRetention)
@@ -240,6 +245,8 @@ func s3Backup(db *dbConfig, backupFileName string, disableCompression bool, prun
 		}
 	}
 	utils.Done("Uploading backup archive to remote storage S3 ... done ")
+	//Send notification
+	utils.NotifySuccess(finalFileName)
 	//Delete temp
 	deleteTemp()
 }
@@ -273,6 +280,8 @@ func sshBackup(db *dbConfig, backupFileName, remotePath string, disableCompressi
 	}
 
 	utils.Done("Uploading backup archive to remote storage ... done ")
+	//Send notification
+	utils.NotifySuccess(finalFileName)
 	//Delete temp
 	deleteTemp()
 }

diff --git a/pkg/config.go b/pkg/config.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (
@@ -23,6 +29,10 @@ type targetDbConfig struct {
 	targetDbPassword string
 	targetDbName     string
 }
+type TgConfig struct {
+	Token  string
+	ChatId string
+}
 
 func getDbConfig(cmd *cobra.Command) *dbConfig {
 	//Set env

diff --git a/pkg/encrypt.go b/pkg/encrypt.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (

diff --git a/pkg/helper.go b/pkg/helper.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (
@@ -125,7 +131,7 @@ func testDatabaseConnection(db *dbConfig) {
 	// Run the command and capture any errors
 	err = cmd.Run()
 	if err != nil {
-		utils.Error("Error running psql command: %v\nOutput: %s\n", err, out.String())
+		utils.Fatal("Error running psql command: %v\nOutput: %s\n", err, out.String())
 		return
 	}
 	utils.Info("Successfully connected to %s database", db.dbName)

diff --git a/pkg/migrate.go b/pkg/migrate.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (
@@ -8,6 +14,7 @@ import (
 )
 
 func StartMigration(cmd *cobra.Command) {
+	utils.Welcome()
 	utils.Info("Starting database migration...")
 	//Get DB config
 	dbConf = getDbConfig(cmd)

diff --git a/pkg/restore.go b/pkg/restore.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (
@@ -10,7 +16,7 @@ import (
 )
 
 func StartRestore(cmd *cobra.Command) {
-
+	utils.Welcome()
 	//Set env
 	utils.SetEnv("STORAGE_PATH", storagePath)
 

diff --git a/pkg/scp.go b/pkg/scp.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 import (

diff --git a/pkg/scripts.go b/pkg/scripts.go
@@ -1,9 +1,11 @@
 package pkg
 
-// Package pkg /*
-/*
-Copyright © 2024 Jonas Kaninda
-*/
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 import (
 	"fmt"
 	"github.com/jkaninda/pg-bkup/utils"

diff --git a/pkg/var.go b/pkg/var.go
@@ -1,3 +1,9 @@
+// Package pkg /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package pkg
 
 const cronLogFile = "/var/log/pg-bkup.log"

diff --git a/utils/constant.go b/utils/constant.go
@@ -1,3 +1,9 @@
+// Package utils /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package utils
 
 const RestoreExample = "pg-bkup restore --dbname database --file db_20231219_022941.sql.gz\n" +

diff --git a/utils/logger.go b/utils/logger.go
@@ -1,3 +1,9 @@
+// Package utils /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package utils
 
 import (
@@ -51,9 +57,13 @@ func Fatal(msg string, args ...any) {
 	formattedMessage := fmt.Sprintf(msg, args...)
 	if len(args) == 0 {
 		fmt.Printf("%s ERROR: %s\n", currentTime, msg)
+		NotifyError(msg)
 	} else {
 		fmt.Printf("%s ERROR: %s\n", currentTime, formattedMessage)
+		NotifyError(formattedMessage)
+
 	}
+
 	os.Exit(1)
 	os.Kill.Signal()
 }
diff --git a/utils/notification.go b/utils/notification.go
@@ -0,0 +1,75 @@
+package utils
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"io/ioutil"
+	"net/http"
+	"os"
+)
+
+func sendMessage(msg string) {
+
+	Info("Sending notification... ")
+	chatId := os.Getenv("TG_CHAT_ID")
+	body, _ := json.Marshal(map[string]string{
+		"chat_id": chatId,
+		"text":    msg,
+	})
+	url := fmt.Sprintf("%s/sendMessage", getTgUrl())
+	// Create an HTTP post request
+	request, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
+	if err != nil {
+		panic(err)
+	}
+	request.Header.Add("Content-Type", "application/json")
+	client := &http.Client{}
+	response, err := client.Do(request)
+	if err != nil {
+		panic(err)
+	}
+	code := response.StatusCode
+	if code == 200 {
+		Info("Notification has been sent")
+	} else {
+		body, _ := ioutil.ReadAll(response.Body)
+		Error("Message not sent, error: %s", string(body))
+	}
+
+}
+func NotifySuccess(fileName string) {
+	var vars = []string{
+		"TG_TOKEN",
+		"TG_CHAT_ID",
+	}
+
+	//Telegram notification
+	err := CheckEnvVars(vars)
+	if err == nil {
+		message := "PostgreSQL Backup \n" +
+			"Database has been backed up \n" +
+			"Backup name is " + fileName
+		sendMessage(message)
+	}
+}
+func NotifyError(error string) {
+	var vars = []string{
+		"TG_TOKEN",
+		"TG_CHAT_ID",
+	}
+
+	//Telegram notification
+	err := CheckEnvVars(vars)
+	if err == nil {
+		message := "PostgreSQL Backup \n" +
+			"An error occurred during database backup \n" +
+			"Error: " + error
+		sendMessage(message)
+	}
+}
+
+func getTgUrl() string {
+	return fmt.Sprintf("https://api.telegram.org/bot%s", os.Getenv("TG_TOKEN"))
+
+}
diff --git a/utils/s3.go b/utils/s3.go
@@ -1,3 +1,9 @@
+// Package utils /
+/*****
+@author    Jonas Kaninda
+@license   MIT License <https://opensource.org/licenses/MIT>
+@Copyright © 2024 Jonas Kaninda
+**/
 package utils
 
 import (