Add new feature to backup jenkins relying on thinBackup plugin

app/cmd/backup.go

@@ -0,0 +1,95 @@
+package cmd
+
+import (
+	"net/http"
+	"os"
+	"time"
+
+	"github.com/jenkins-zh/jenkins-cli/app/cmd/common"
+	"github.com/jenkins-zh/jenkins-cli/app/i18n"
+	"github.com/jenkins-zh/jenkins-cli/client"
+	"github.com/spf13/cobra"
+)
+
+//BackupOption is an option for backup
+type BackupOption struct {
+	RoundTripper http.RoundTripper
+	BackupDir    string
+	WaitTime     int
+	//Check the backup directory if a new full-date directory exists which means backup succeeds, after triggering thinBackup plugin to backup
+	CheckBackup bool
+}
+
+var backupOption BackupOption
+
+func init() {
+	rootCmd.AddCommand(backupCmd)
+	healthCheckRegister.Register(getCmdPath(backupCmd), &backupOption)
+	backupCmd.Flags().StringVar(&backupOption.BackupDir, "backup-dir", "", i18n.T("the backup directory in thinBackup setting"))
+	backupCmd.Flags().IntVarP(&backupOption.WaitTime, "wait-time", "t", 300, i18n.T("the maximum time you would like to wait for jenkins to be idle and make a backup"))
+	backupCmd.Flags().BoolVar(&backupOption.CheckBackup, "check", false, i18n.T("if this value is set to true, it will check if a new full-backup directory exists in the backup directory"))
+}
+
+var backupCmd = &cobra.Command{
+	Use:   "backup",
+	Short: i18n.T("Backup your global and job specific configurations."),
+	Long: i18n.T(`Backup your global and job specific configurations. 
+	This command uses Thin Backup Plugin, so please be sure that you have the plugin installed in your jenkins.`),
+	RunE: backupOption.Backup,
+}
+
+//Check will find out whether Thin Backup Plugin installed or not
+func (o *BackupOption) Check() (err error) {
+	opt := PluginOptions{
+		Option: common.Option{RoundTripper: o.RoundTripper},
+	}
+	_, err = opt.FindPlugin("thinBackup")
+	return
+}
+
+//Backup will trigger thinBackup plugin to make a backup
+func (o *BackupOption) Backup(cmd *cobra.Command, _ []string) (err error) {
+	jClient := &client.CoreClient{
+		JenkinsCore: client.JenkinsCore{
+			RoundTripper: backupOption.RoundTripper,
+		},
+	}
+	GetCurrentJenkinsAndClient(&(jClient.JenkinsCore))
+	cmd.Println("Please wait while making a backup.")
+	now := time.Now()
+	err = ThinBackupAPI(jClient)
+	if err != nil {
+		cmd.Println("Backup failed. Please see logging message(yourJenkinsHome/backup.log) for detailed reasons.")
+		return err
+	}
+	for i := 0; o.WaitTime-i*15 > 0 && o.CheckBackup; i++ {
+		time.Sleep(15 * time.Second)
+		stat, err := os.Stat(o.BackupDir)
+		if err == nil {
+			//check if the directory be modified and it is a hint that a backup may succeed
+			if stat.ModTime().After(now) {
+				modifyTime := stat.ModTime().Format("03:04:05")
+				hour := modifyTime[0:2]
+				min := modifyTime[3:5]
+				//check if thinBackup plugin createed the bakcup directory
+				_, err = os.Stat(o.BackupDir + "/FULL-" + stat.ModTime().Format("2006-01-02") + "_" + hour + "-" + min)
+				if err == nil {
+					cmd.Println("Back up successfully!")
+					return nil
+				}
+			}
+		}
+	}
+	if !o.CheckBackup {
+		cmd.Println("Trigger thinBackup plugin to backup successfully, please check the backup directory to make sure the backup succeeds or thinBackup is waiting jenkins to be idle.")
+	} else {
+		cmd.Println("Backup failed or thinBackup is still waiting for jenkins to be idle to perform a backup. Please see logging message(yourJenkinsHome/backup.log) for detailed reasons.")
+	}
+	return
+}
+
+//ThinBackupAPI requests backupManual api
+func ThinBackupAPI(client *client.CoreClient) (err error) {
+	_, err = client.RequestWithoutData(http.MethodGet, "/thinBackup/backupManual", nil, nil, 200)
+	return err
+}

go.sum

@@ -747,6 +747,8 @@ golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.2/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
+golang.org/x/tools v0.1.5 h1:ouewzE6p+/VEB31YYnTbEJdi8pFqKp4P4n85vwo3DHA=
+golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.1.6 h1:SIasE1FVIQOWz2GEAHFOmoW7xchJcqlucjSULTL0Ag4=
 golang.org/x/tools v0.1.6/go.mod h1:LGqMHiF4EqQNHR1JncWGqT5BVaXmza+X+BDGol+dOxo=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=