Merge pull request #7088 from dolthub/steph/clone-branch

add `--single-branch` flag for `dolt clone`

go/cmd/dolt/cli/arg_parser_helpers.go

@@ -125,6 +125,7 @@ func CreateCloneArgParser() *argparser.ArgParser {
 	ap.SupportsString(dbfactory.OSSCredsFileParam, "", "file", "OSS credentials file.")
 	ap.SupportsString(dbfactory.OSSCredsProfile, "", "profile", "OSS profile to use.")
 	ap.SupportsString(UserFlag, "u", "user", "User name to use when authenticating with the remote. Gets password from the environment variable {{.EmphasisLeft}}DOLT_REMOTE_PASSWORD{{.EmphasisRight}}.")
+	ap.SupportsFlag(SingleBranchFlag, "", "Clone only the history leading to the tip of a single branch, either specified by --branch or the remote's HEAD (default).")
 	return ap
 }
 

go/cmd/dolt/cli/flags.go

@@ -59,6 +59,7 @@ const (
 	ShallowFlag          = "shallow"
 	ShowIgnoredFlag      = "ignored"
 	SilentFlag           = "silent"
+	SingleBranchFlag     = "single-branch"
 	SkipEmptyFlag        = "skip-empty"
 	SoftResetParam       = "soft"
 	SquashParam          = "squash"

go/cmd/dolt/commands/clone.go

@@ -98,6 +98,7 @@ func (cmd CloneCmd) Exec(ctx context.Context, commandStr string, args []string,
 func clone(ctx context.Context, apr *argparser.ArgParseResults, dEnv *env.DoltEnv) errhand.VerboseError {
 	remoteName := apr.GetValueOrDefault(cli.RemoteParam, "origin")
 	branch := apr.GetValueOrDefault(cli.BranchParam, "")
+	singleBranch := apr.Contains(cli.SingleBranchFlag)
 	dir, urlStr, verr := parseArgs(apr)
 	if verr != nil {
 		return verr
@@ -143,7 +144,7 @@ func clone(ctx context.Context, apr *argparser.ArgParseResults, dEnv *env.DoltEn
 	// Nil out the old Dolt env so we don't accidentally operate on the wrong database
 	dEnv = nil
 
-	err = actions.CloneRemote(ctx, srcDB, remoteName, branch, clonedEnv)
+	err = actions.CloneRemote(ctx, srcDB, remoteName, branch, singleBranch, clonedEnv)
 	if err != nil {
 		// If we're cloning into a directory that already exists do not erase it. Otherwise
 		// make best effort to delete the directory we created.

go/libraries/doltcore/dtestutils/testcommands/multienv.go

@@ -195,7 +195,7 @@ func (mr *MultiRepoTestSetup) CloneDB(fromRemote, dbName string) {
 		mr.Errhand(err)
 	}
 
-	err = actions.CloneRemote(ctx, srcDB, r.Name, "", dEnv)
+	err = actions.CloneRemote(ctx, srcDB, r.Name, "", false, dEnv)
 	if err != nil {
 		mr.Errhand(err)
 	}

go/libraries/doltcore/env/actions/clone.go

@@ -156,7 +156,7 @@ func sortedKeys(m map[string]iohelp.ReadStats) []string {
 	return keys
 }
 
-func CloneRemote(ctx context.Context, srcDB *doltdb.DoltDB, remoteName, branch string, dEnv *env.DoltEnv) error {
+func CloneRemote(ctx context.Context, srcDB *doltdb.DoltDB, remoteName, branch string, singleBranch bool, dEnv *env.DoltEnv) error {
 	eventCh := make(chan pull.TableFileEvent, 128)
 
 	wg := &sync.WaitGroup{}
@@ -214,25 +214,26 @@ func CloneRemote(ctx context.Context, srcDB *doltdb.DoltDB, remoteName, branch s
 	// every branch in the remote. We iterate through local branches and
 	// create remote refs corresponding to each of them. We delete all of
 	// the local branches except for the one corresponding to |branch|.
-	for _, brnch := range branches {
-		cs, _ := doltdb.NewCommitSpec(brnch.GetPath())
-		cm, err := dEnv.DoltDB.Resolve(ctx, cs, nil)
-		if err != nil {
-			return fmt.Errorf("%w: %s; %s", ErrFailedToResolveBranchRef, brnch.String(), err.Error())
+	for _, br := range branches {
+		if !singleBranch || br.GetPath() == branch {
+			cs, _ := doltdb.NewCommitSpec(br.GetPath())
+			cm, err := dEnv.DoltDB.Resolve(ctx, cs, nil)
+			if err != nil {
+				return fmt.Errorf("%w: %s; %s", ErrFailedToResolveBranchRef, br.String(), err.Error())
 
-		}
+			}
 
-		remoteRef := ref.NewRemoteRef(remoteName, brnch.GetPath())
-		err = dEnv.DoltDB.SetHeadToCommit(ctx, remoteRef, cm)
-		if err != nil {
-			return fmt.Errorf("%w: %s; %s", ErrFailedToCreateRemoteRef, remoteRef.String(), err.Error())
+			remoteRef := ref.NewRemoteRef(remoteName, br.GetPath())
+			err = dEnv.DoltDB.SetHeadToCommit(ctx, remoteRef, cm)
+			if err != nil {
+				return fmt.Errorf("%w: %s; %s", ErrFailedToCreateRemoteRef, remoteRef.String(), err.Error())
 
+			}
 		}
-
-		if brnch.GetPath() != branch {
-			err := dEnv.DoltDB.DeleteBranch(ctx, brnch, nil)
+		if br.GetPath() != branch {
+			err := dEnv.DoltDB.DeleteBranch(ctx, br, nil)
 			if err != nil {
-				return fmt.Errorf("%w: %s; %s", ErrFailedToDeleteBranch, brnch.String(), err.Error())
+				return fmt.Errorf("%w: %s; %s", ErrFailedToDeleteBranch, br.String(), err.Error())
 			}
 		}
 	}

go/libraries/doltcore/sqle/database_provider.go

@@ -527,7 +527,7 @@ func (p *DoltDatabaseProvider) cloneDatabaseFromRemote(
 		return nil, err
 	}
 
-	err = actions.CloneRemote(ctx, srcDB, remoteName, branch, dEnv)
+	err = actions.CloneRemote(ctx, srcDB, remoteName, branch, false, dEnv)
 	if err != nil {
 		return nil, err
 	}

integration-tests/bats/remotes.bats

@@ -1008,6 +1008,51 @@ create_five_remote_branches_main_and_master() {
     [[ "$output" =~ "remotes/origin/branch-two" ]] || false
 }
 
+@test "remotes: clone --single-branch does not create remote refs for all remote branches" {
+    create_three_remote_branches
+    cd dolt-repo-clones
+    dolt clone --single-branch http://localhost:50051/test-org/test-repo
+    cd test-repo
+    run dolt branch -a
+    [ "$status" -eq 0 ]
+    [[ "$output" =~ "* main" ]] || false
+    [[ ! "$output" =~ " branch-one" ]] || false
+    [[ ! "$output" =~ " branch-two" ]] || false
+    [[ "$output" =~ "remotes/origin/main" ]] || false
+    [[ ! "$output" =~ "remotes/origin/branch-one" ]] || false
+    [[ ! "$output" =~ "remotes/origin/branch-two" ]] || false
+}
+
+@test "remotes: clone --branch specifies which branch to clone" {
+    create_three_remote_branches
+    cd dolt-repo-clones
+    dolt clone --branch branch-one http://localhost:50051/test-org/test-repo
+    cd test-repo
+    run dolt branch -a
+    [ "$status" -eq 0 ]
+    [[ "$output" =~ "* branch-one" ]] || false
+    [[ ! "$output" =~ " main" ]] || false
+    [[ ! "$output" =~ " branch-two" ]] || false
+    [[ "$output" =~ "remotes/origin/main" ]] || false
+    [[ "$output" =~ "remotes/origin/branch-one" ]] || false
+    [[ "$output" =~ "remotes/origin/branch-two" ]] || false
+}
+
+@test "remotes: clone --single-branch --branch does not create all remote refs" {
+    create_three_remote_branches
+    cd dolt-repo-clones
+    dolt clone --branch branch-one --single-branch http://localhost:50051/test-org/test-repo
+    cd test-repo
+    run dolt branch -a
+    [ "$status" -eq 0 ]
+    [[ "$output" =~ "* branch-one" ]] || false
+    [[ ! "$output" =~ " main" ]] || false
+    [[ ! "$output" =~ " branch-two" ]] || false
+    [[ ! "$output" =~ "remotes/origin/main" ]] || false
+    [[ "$output" =~ "remotes/origin/branch-one" ]] || false
+    [[ ! "$output" =~ "remotes/origin/branch-two" ]] || false
+}
+
 @test "remotes: fetch creates new remote refs for new remote branches" {
     create_main_remote_branch