move capi backup to .plural dir and add multi-cluster backup support

cmd/plural/crypto.go

@@ -53,7 +53,6 @@ const Gitignore = `/**/.terraform
 *.swo
 .DS_STORE
 .vscode
-/bootstrap/capi/
 `
 
 // IMPORTANT

pkg/bootstrap/bootstrap.go

@@ -11,7 +11,7 @@ import (
 	"github.com/pluralsh/plural/pkg/manifest"
 	"github.com/pluralsh/plural/pkg/provider"
 	"github.com/pluralsh/plural/pkg/utils"
-	"github.com/pluralsh/plural/pkg/utils/capi"
+	"github.com/pluralsh/plural/pkg/utils/backup"
 )
 
 func bootstrapClusterExists() bool {
@@ -45,6 +45,8 @@ func getBootstrapSteps(runPlural ActionFunc, additionalFlags []string) ([]*Step,
 		return nil, err
 	}
 
+	clusterBackup := backup.NewCAPIBackup(man.Cluster)
+
 	return []*Step{
 		{
 			Name: "Destroy provider cluster",
@@ -81,7 +83,7 @@ func getBootstrapSteps(runPlural ActionFunc, additionalFlags []string) ([]*Step,
 			Name:    "Deploy cluster",
 			Args:    append([]string{"plural", "--bootstrap", "wkspace", "helm", "bootstrap"}, flags...),
 			Execute: runPlural,
-			Skip:    capi.MoveBackupExists(),
+			Skip:    clusterBackup.Exists(),
 		},
 		{
 			Name: "Restore cluster",
@@ -93,9 +95,9 @@ func getBootstrapSteps(runPlural ActionFunc, additionalFlags []string) ([]*Step,
 					},
 				}
 
-				return capi.RestoreMoveBackup(options)
+				return clusterBackup.Restore(options)
 			},
-			Skip: !capi.MoveBackupExists(),
+			Skip: !clusterBackup.Exists(),
 		},
 		{
 			Name:    "Wait for cluster",
@@ -137,9 +139,9 @@ func getBootstrapSteps(runPlural ActionFunc, additionalFlags []string) ([]*Step,
 					},
 				}
 
-				err := capi.SaveMoveBackup(options)
+				err := clusterBackup.Save(options)
 				if err != nil {
-					_ = capi.RemoveStateBackup()
+					_ = clusterBackup.Remove()
 					utils.Error("error during saving state backup: %s", err)
 				}
 			},
@@ -191,7 +193,7 @@ func getBootstrapSteps(runPlural ActionFunc, additionalFlags []string) ([]*Step,
 			Args:    []string{"plural", "--bootstrap", "bootstrap", "cluster", "delete", "bootstrap"},
 			Execute: runPlural,
 			OnAfter: func() {
-				err := capi.RemoveStateBackup()
+				err := clusterBackup.Remove()
 				if err != nil {
 					utils.Error("error during removing state backup: %s", err)
 				}

pkg/utils/capi/move.go → pkg/utils/backup/capi.go

@@ -1,4 +1,4 @@
-package capi
+package backup
 
 import (
 	"fmt"
@@ -7,75 +7,75 @@ import (
 
 	apiclient "sigs.k8s.io/cluster-api/cmd/clusterctl/client"
 
-	"github.com/pluralsh/plural/pkg/utils/git"
-	"github.com/pluralsh/plural/pkg/utils/pathing"
+	"github.com/pluralsh/plural/pkg/config"
 )
 
-var (
-	clusterStateDir = ""
-)
+type CAPIBackup struct {
+	dirPath string
+}
 
-func init() {
-	gitRootDir, err := git.Root()
-	if err != nil {
-		panic(err)
+func (this CAPIBackup) createDir() {
+	if this.Exists() {
+		return
 	}
 
-	clusterStateDir = pathing.SanitizeFilepath(filepath.Join(gitRootDir, "bootstrap", "capi"))
+	_ = os.MkdirAll(this.dirPath, os.ModePerm)
 }
 
-func MoveBackupExists() bool {
-	_, err := os.Stat(clusterStateDir)
+func (this CAPIBackup) Exists() bool {
+	_, err := os.Stat(this.dirPath)
 	return !os.IsNotExist(err)
 }
 
-func SaveMoveBackup(options apiclient.MoveOptions) error {
+func (this CAPIBackup) Save(options apiclient.MoveOptions) error {
 	client, err := apiclient.New("")
 	if err != nil {
 		return err
 	}
 
-	if !MoveBackupExists() {
-		err = os.Mkdir(clusterStateDir, os.ModePerm)
-		if err != nil {
-			return err
-		}
-	}
-
+	this.createDir()
 	if len(options.FromKubeconfig.Context) == 0 || len(options.FromKubeconfig.Path) == 0 {
 		return fmt.Errorf("both FromKubeconfig context and path have to be configured\n")
 	}
 
-	options.ToDirectory = clusterStateDir
+	options.ToDirectory = this.dirPath
 	options.Namespace = "bootstrap"
 
 	return client.Move(options)
 }
 
-func RestoreMoveBackup(options apiclient.MoveOptions) error {
+func (this CAPIBackup) Restore(options apiclient.MoveOptions) error {
 	client, err := apiclient.New("")
 	if err != nil {
 		return err
 	}
 
-	if !MoveBackupExists() {
-		return fmt.Errorf("could not find move backup to restore from")
-	}
-
 	if len(options.ToKubeconfig.Context) == 0 || len(options.ToKubeconfig.Path) == 0 {
 		return fmt.Errorf("both ToKubeconfig context and path have to be configured\n")
 	}
 
-	options.FromDirectory = clusterStateDir
+	if !this.Exists() {
+		return fmt.Errorf("could not find move backup to restore from")
+	}
+
+	options.FromDirectory = this.dirPath
 	options.Namespace = "bootstrap"
 
 	return client.Move(options)
 }
 
-func RemoveStateBackup() error {
-	if !MoveBackupExists() {
+func (this CAPIBackup) Remove() error {
+	if !this.Exists() {
 		return nil
 	}
 
-	return os.Remove(clusterStateDir)
+	return os.RemoveAll(this.dirPath)
+}
+
+func NewCAPIBackup(cluster string) Backup[apiclient.MoveOptions] {
+	path, _ := config.PluralDir()
+
+	return CAPIBackup{
+		dirPath: filepath.Join(path, backupsDir, cluster),
+	}
 }

pkg/utils/backup/types.go

@@ -0,0 +1,14 @@
+package backup
+
+type BackupOptions any
+
+const (
+	backupsDir = "backups"
+)
+
+type Backup[T BackupOptions] interface {
+	Exists() bool
+	Save(opts T) error
+	Restore(opts T) error
+	Remove() error
+}