Merge pull request #10110 from dolthub/elian/7628

#7628: Refactor `dolt backup` to use SQL interface

Author: elianddb

go/cmd/dolt/cli/arg_parser_helpers.go

@@ -46,15 +46,6 @@ func ParseAuthor(authorStr string) (string, string, error) {
 	return name, email, nil
 }
 
-const (
-	SyncBackupId        = "sync"
-	SyncBackupUrlId     = "sync-url"
-	RestoreBackupId     = "restore"
-	AddBackupId         = "add"
-	RemoveBackupId      = "remove"
-	RemoveBackupShortId = "rm"
-)
-
 var branchForceFlagDesc = "Reset {{.LessThan}}branchname{{.GreaterThan}} to {{.LessThan}}startpoint{{.GreaterThan}}, even if {{.LessThan}}branchname{{.GreaterThan}} exists already. Without {{.EmphasisLeft}}-f{{.EmphasisRight}}, {{.EmphasisLeft}}dolt branch{{.EmphasisRight}} refuses to change an existing branch. In combination with {{.EmphasisLeft}}-d{{.EmphasisRight}} (or {{.EmphasisLeft}}--delete{{.EmphasisRight}}), allow deleting the branch irrespective of its merged status. In combination with -m (or {{.EmphasisLeft}}--move{{.EmphasisRight}}), allow renaming the branch even if the new branch name already exists, the same applies for {{.EmphasisLeft}}-c{{.EmphasisRight}} (or {{.EmphasisLeft}}--copy{{.EmphasisRight}})."
 
 // CreateCommitArgParser creates the argparser shared dolt commit cli and DOLT_COMMIT.
@@ -391,36 +382,21 @@ func CreateGlobalArgParser(name string) *argparser.ArgParser {
 	return ap
 }
 
-var awsParams = []string{dbfactory.AWSRegionParam, dbfactory.AWSCredsTypeParam, dbfactory.AWSCredsFileParam, dbfactory.AWSCredsProfile}
+var AwsParams = []string{dbfactory.AWSRegionParam, dbfactory.AWSCredsTypeParam, dbfactory.AWSCredsFileParam, dbfactory.AWSCredsProfile}
 var ossParams = []string{dbfactory.OSSCredsFileParam, dbfactory.OSSCredsProfile}
 
-func ProcessBackupArgs(apr *argparser.ArgParseResults, scheme, backupUrl string) (map[string]string, error) {
-	params := map[string]string{}
-
-	var err error
-	switch scheme {
-	case dbfactory.AWSScheme:
-		err = AddAWSParams(backupUrl, apr, params)
-	case dbfactory.OSSScheme:
-		err = AddOSSParams(backupUrl, apr, params)
-	default:
-		err = VerifyNoAwsParams(apr)
-	}
-	return params, err
-}
-
 func AddAWSParams(remoteUrl string, apr *argparser.ArgParseResults, params map[string]string) error {
 	isAWS := strings.HasPrefix(remoteUrl, "aws")
 
 	if !isAWS {
-		for _, p := range awsParams {
+		for _, p := range AwsParams {
 			if _, ok := apr.GetValue(p); ok {
 				return fmt.Errorf("%s param is only valid for aws cloud remotes in the format aws://dynamo-table:s3-bucket/database", p)
 			}
 		}
 	}
 
-	for _, p := range awsParams {
+	for _, p := range AwsParams {
 		if val, ok := apr.GetValue(p); ok {
 			params[p] = val
 		}
@@ -450,7 +426,7 @@ func AddOSSParams(remoteUrl string, apr *argparser.ArgParseResults, params map[s
 }
 
 func VerifyNoAwsParams(apr *argparser.ArgParseResults) error {
-	if awsParams := apr.GetValues(awsParams...); len(awsParams) > 0 {
+	if awsParams := apr.GetValues(AwsParams...); len(awsParams) > 0 {
 		awsParamKeys := make([]string, 0, len(awsParams))
 		for k := range awsParams {
 			awsParamKeys = append(awsParamKeys, k)

go/cmd/dolt/commands/backup.go

@@ -70,7 +70,6 @@ var dumpZshCommand = &commands.GenZshCompCmd{}
 
 var commandsWithoutCliCtx = []cli.Command{
 	commands.CloneCmd{},
-	commands.BackupCmd{},
 	commands.LoginCmd{},
 	credcmds.Commands,
 	cvcmds.Commands,

go/cmd/dolt/dolt.go

@@ -53,6 +53,8 @@ const (
 	tempTablesDir = "temptf"
 
 	TmpDirName = "tmp"
+
+	InvalidRemoteNameCharacters = " \t\n\r./\\!@#$%^&*(){}[],.<>'\"?=+|"
 )
 
 var zeroHashStr = (hash.Hash{}).String()
@@ -64,15 +66,15 @@ var ErrRemoteAlreadyExists = errors.New("remote already exists")
 var ErrInvalidRemoteURL = errors.New("remote URL invalid")
 var ErrRemoteNotFound = errors.New("remote not found")
 var ErrInvalidRemoteName = errors.New("remote name invalid")
-var ErrBackupAlreadyExists = errors.New("backup already exists")
-var ErrInvalidBackupURL = errors.New("backup URL invalid")
-var ErrBackupNotFound = errors.New("backup not found")
-var ErrInvalidBackupName = errors.New("backup name invalid")
-var ErrFailedToDeleteBackup = errors.New("failed to delete backup")
+var ErrBackupAlreadyExists = goerrors.NewKind("backup '%s' already exists")
+var ErrBackupInvalidUrl = goerrors.NewKind("backup URL '%s' is invalid")
+var ErrBackupNotFound = goerrors.NewKind("backup '%s' not found")
+var ErrBackupInvalidName = goerrors.NewKind("backup name '%s' is invalid")
+var ErrBackupFailedDelete = goerrors.NewKind("backup '%s' failed to delete")
 var ErrFailedToReadFromDb = errors.New("failed to read from db")
 var ErrFailedToDeleteRemote = errors.New("failed to delete remote")
 var ErrFailedToWriteRepoState = errors.New("failed to write repo state")
-var ErrRemoteAddressConflict = errors.New("address conflict with a remote")
+var ErrRemoteAddressConflict = goerrors.NewKind("address conflict with a remote: '%s' -> %s")
 var ErrDoltRepositoryNotFound = errors.New("can no longer find .dolt dir on disk")
 var ErrFailedToAccessDB = goerrors.NewKind("failed to access '%s' database: can no longer find .dolt dir on disk")
 var ErrDatabaseIsLocked = errors.New("the database is locked by another dolt process")
@@ -1023,7 +1025,7 @@ func (dEnv *DoltEnv) AddRemote(r Remote) error {
 		return ErrRemoteAlreadyExists
 	}
 
-	if strings.IndexAny(r.Name, " \t\n\r./\\!@#$%^&*(){}[],.<>'\"?=+|") != -1 {
+	if strings.IndexAny(r.Name, InvalidRemoteNameCharacters) != -1 {
 		return ErrInvalidRemoteName
 	}
 
@@ -1034,7 +1036,7 @@ func (dEnv *DoltEnv) AddRemote(r Remote) error {
 
 	// can have multiple remotes with the same address, but no conflicting backups
 	if rem, found := CheckRemoteAddressConflict(absRemoteUrl, nil, dEnv.RepoState.Backups); found {
-		return fmt.Errorf("%w: '%s' -> %s", ErrRemoteAddressConflict, rem.Name, rem.Url)
+		return ErrRemoteAddressConflict.New(rem.Name, rem.Url)
 	}
 
 	r.Url = absRemoteUrl
@@ -1052,21 +1054,21 @@ func (dEnv *DoltEnv) GetBackups() (*concurrentmap.Map[string, Remote], error) {
 
 func (dEnv *DoltEnv) AddBackup(r Remote) error {
 	if _, ok := dEnv.RepoState.Backups.Get(r.Name); ok {
-		return ErrBackupAlreadyExists
+		return ErrBackupAlreadyExists.New(r.Name)
 	}
 
-	if strings.IndexAny(r.Name, " \t\n\r./\\!@#$%^&*(){}[],.<>'\"?=+|") != -1 {
-		return ErrInvalidBackupName
+	if strings.IndexAny(r.Name, InvalidRemoteNameCharacters) != -1 {
+		return ErrBackupInvalidName.New(r.Name)
 	}
 
 	_, absRemoteUrl, err := GetAbsRemoteUrl(dEnv.FS, dEnv.Config, r.Url)
 	if err != nil {
-		return fmt.Errorf("%w; %s", ErrInvalidBackupURL, err.Error())
+		return ErrBackupInvalidUrl.New(r.Url, err.Error())
 	}
 
 	// no conflicting remote or backup addresses
-	if rem, found := CheckRemoteAddressConflict(absRemoteUrl, dEnv.RepoState.Remotes, dEnv.RepoState.Backups); found {
-		return fmt.Errorf("%w: '%s' -> %s", ErrRemoteAddressConflict, rem.Name, rem.Url)
+	if conflict, found := CheckRemoteAddressConflict(absRemoteUrl, dEnv.RepoState.Remotes, dEnv.RepoState.Backups); found {
+		return ErrRemoteAddressConflict.New(conflict.Name, conflict.Url)
 	}
 
 	r.Url = absRemoteUrl
@@ -1110,7 +1112,7 @@ func (dEnv *DoltEnv) RemoveRemote(ctx context.Context, name string) error {
 func (dEnv *DoltEnv) RemoveBackup(ctx context.Context, name string) error {
 	backup, ok := dEnv.RepoState.Backups.Get(name)
 	if !ok {
-		return ErrBackupNotFound
+		return ErrBackupNotFound.New(name)
 	}
 
 	dEnv.RepoState.RemoveBackup(backup)