Merge pull request #16 from bcdevtools/imp/command-gen-config-auto-backup

imp: command gen config auto backup

Author: 0xbcdev

README.md

@@ -26,6 +26,8 @@ nmngd node zip-snapshot ~/.node_home
 ### For validator node
 ```bash
 nmngd node auto-backup-priv-validator-state-json ~/.node_home --binary xxxd
+# generate setup for auto-backup-pvs
+nmngd node auto-backup-priv-validator-state-json ~/.node_home --binary xxxd --gen-setup
 ```
 
 ## Run web server

cmd/node/auto_backup_priv_validator_state.go

@@ -18,6 +18,7 @@ import (
 const (
 	flagKeep                   = "keep"
 	flagBinaryKillByAutoBackup = "binary"
+	flagGenSetup               = "gen-setup"
 )
 
 const (
@@ -31,14 +32,19 @@ const (
 
 func GetAutoBackupPrivValidatorStateCmd() *cobra.Command {
 	var cmd = &cobra.Command{
-		Use:   commandAutoBackupPrivValidatorState + " [node_home]",
-		Short: "Designed to be run as a service, it will automatically backup the `priv_validator_state.json`, and kill the node process if the content of the file is decreased",
-		Args:  cobra.ExactArgs(1),
+		Use:     commandAutoBackupPrivValidatorState + " [node_home]",
+		Aliases: []string{"auto-backup-pvs", "auto-backup-priv-validator-state"},
+		Short:   "Designed to be run as a service, it will automatically backup the `priv_validator_state.json`, and kill the node process if the content of the file is decreased",
+		Args:    cobra.ExactArgs(1),
 		Run: func(cmd *cobra.Command, args []string) {
 			utils.MustNotUserRoot()
 
-			nodeHomeDirectory := strings.TrimSpace(args[0])
+			nodeHomeDirectory := strings.TrimSuffix(strings.TrimSpace(args[0]), "/")
 			validateNodeHomeDirectory(nodeHomeDirectory)
+			if !strings.Contains(nodeHomeDirectory, "/") {
+				utils.ExitWithErrorMsg("ERR: node home directory must be absolute path, eg: /home/user/.nodeHome")
+				return
+			}
 
 			currentUser, err := user.Current()
 			if err != nil {
@@ -47,6 +53,11 @@ func GetAutoBackupPrivValidatorStateCmd() *cobra.Command {
 			}
 			userHomeDir := currentUser.HomeDir
 
+			if !strings.HasPrefix(nodeHomeDirectory, userHomeDir) {
+				utils.ExitWithErrorMsg("ERR: node home directory must be under user home directory:", userHomeDir)
+				return
+			}
+
 			backupDstPath := path.Join(userHomeDir, fmt.Sprintf(".backup_priv_validator_state_%s", constants.BINARY_NAME))
 			createBackupDirIfNotExists(backupDstPath)
 			fmt.Println("INF: backup directory:", backupDstPath)
@@ -82,6 +93,11 @@ func GetAutoBackupPrivValidatorStateCmd() *cobra.Command {
 			_, binaryNameToKill := path.Split(binaryPathToKill)
 			fmt.Println("INF: binary to kill:", binaryNameToKill, "at", binaryPathToKill)
 
+			if cmd.Flags().Changed(flagGenSetup) {
+				genSetupThenExit(nodeHomeDirectory, binaryPathToKill, keepRecent, currentUser)
+				return
+			}
+
 			privValStateJsonFilePath := path.Join(nodeHomeDirectory, "data", "priv_validator_state.json")
 			fmt.Println("INF: priv_validator_state.json file path:", privValStateJsonFilePath)
 
@@ -279,6 +295,7 @@ How to recover:
 
 	cmd.Flags().Int(flagKeep, 3, "Keep the last N backups")
 	cmd.Flags().String(flagBinaryKillByAutoBackup, "", "Absolute path of the chain binary to be killed by process when priv_validator_state.json has problem")
+	cmd.Flags().Bool(flagGenSetup, false, "Display guide to setup instead of running business logic")
 
 	return cmd
 }
@@ -453,3 +470,40 @@ func loadLatestBackupPrivValidatorStateOrExitWithErr(backupDstPath string) types
 
 	return *pvs
 }
+
+func genSetupThenExit(nodeHomeDirectory, binaryPathToKill string, keepRecent int, currentUser *user.User) {
+	const serviceFileName = "auto-backup-pvs"
+	fmt.Println("Input chain name (eg: Cosmos Hub):")
+	chainName := utils.ReadText(false)
+	fmt.Println("Mainnet or Testnet?")
+	networkType := utils.ReadText(false)
+	fmt.Println("INF: setup guide:")
+	fmt.Println("1. Create service file")
+	fmt.Println("> sudo vi /etc/systemd/system/" + serviceFileName + ".service")
+	fmt.Printf(`[Unit]
+Description=Auto backup priv_validator_state.json for Validator on %s %s
+After=network.target
+#
+[Service]
+User=%s
+ExecStart=%s/go/bin/%s start %s --%s %s --%s %d
+RestartSec=1
+Restart=on-failure
+LimitNOFILE=1024
+#
+[Install]
+WantedBy=multi-user.target
+`, chainName, networkType, currentUser.Username, currentUser.HomeDir, constants.BINARY_NAME, nodeHomeDirectory, flagBinaryKillByAutoBackup, binaryPathToKill, flagKeep, keepRecent)
+	fmt.Println("2. Setup visudo")
+	fmt.Println("> sudo visudo")
+	fmt.Printf(strings.ReplaceAll(strings.ReplaceAll(`# Allow user @USER@ to manage @SVC@ service
+@USER@ ALL= NOPASSWD: /usr/bin/systemctl start @SVC@
+@USER@ ALL= NOPASSWD: /usr/bin/systemctl stop @SVC@
+@USER@ ALL= NOPASSWD: /usr/bin/systemctl restart @SVC@
+@USER@ ALL= NOPASSWD: /usr/bin/systemctl enable @SVC@ # Do not allow disable
+@USER@ ALL= NOPASSWD: /usr/bin/systemctl status @SVC@
+`, "@USER@", currentUser.Username), "@SVC@", serviceFileName))
+	fmt.Println("3. Enable service to automatically run at startup")
+	fmt.Println("> sudo systemctl daemon-reload && sudo systemctl enable " + serviceFileName + ".service")
+	os.Exit(0)
+}