File: pull_checkout.go

package info (click to toggle)
tea-cli 0.9.2-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 1,364 kB
  • sloc: makefile: 120; sh: 17
file content (167 lines) | stat: -rw-r--r-- 5,171 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
// Copyright 2020 The Gitea Authors. All rights reserved.
// Use of this source code is governed by a MIT-style
// license that can be found in the LICENSE file.

package task

import (
	"fmt"

	"code.gitea.io/sdk/gitea"
	"code.gitea.io/tea/modules/config"
	local_git "code.gitea.io/tea/modules/git"
	"code.gitea.io/tea/modules/workaround"

	"github.com/go-git/go-git/v5"
	git_config "github.com/go-git/go-git/v5/config"
	git_plumbing "github.com/go-git/go-git/v5/plumbing"
)

// PullCheckout checkout current workdir to the head branch of specified pull request
func PullCheckout(
	login *config.Login,
	repoOwner, repoName string,
	forceCreateBranch bool,
	index int64,
	callback func(string) (string, error),
) error {
	client := login.Client()
	pr, _, err := client.GetPullRequest(repoOwner, repoName, index)
	if err != nil {
		return fmt.Errorf("couldn't fetch PR: %s", err)
	}
	if err := workaround.FixPullHeadSha(client, pr); err != nil {
		return err
	}

	// FIXME: should use ctx.LocalRepo..?
	localRepo, err := local_git.RepoForWorkdir()
	if err != nil {
		return err
	}

	// find or create a matching remote
	remoteURL := remoteURLForPR(login, pr)
	newRemoteName := fmt.Sprintf("pulls/%v", pr.Head.Repository.Owner.UserName)
	// verify related remote is in local repo, otherwise add it
	localRemote, err := localRepo.GetOrCreateRemote(remoteURL, newRemoteName)
	if err != nil {
		return err
	}
	localRemoteName := localRemote.Config().Name

	localRemoteBranchName, err := doPRFetch(login, pr, localRepo, localRemote, callback)
	if err != nil {
		return err
	}

	return doPRCheckout(localRepo, pr, localRemoteName, localRemoteBranchName, remoteURL, forceCreateBranch)
}

func isRemoteDeleted(pr *gitea.PullRequest) bool {
	return pr.Head.Ref == fmt.Sprintf("refs/pull/%d/head", pr.Index)
}

func remoteURLForPR(login *config.Login, pr *gitea.PullRequest) string {
	repo := pr.Head.Repository
	if isRemoteDeleted(pr) {
		repo = pr.Base.Repository
	}
	if len(login.SSHKey) != 0 {
		// login.SSHKey is nonempty, if user specified a key manually or we automatically
		// found a matching private key on this machine during login creation.
		// this means, we are very likely to have a working ssh setup.
		return repo.SSHURL
	}
	return repo.CloneURL
}

func doPRFetch(
	login *config.Login,
	pr *gitea.PullRequest,
	localRepo *local_git.TeaRepo,
	localRemote *git.Remote,
	callback func(string) (string, error),
) (string, error) {
	localRemoteName := localRemote.Config().Name
	localBranchName := pr.Head.Ref
	// get auth & fetch remote via its configured protocol
	url, err := localRepo.TeaRemoteURL(localRemoteName)
	if err != nil {
		return "", err
	}
	auth, err := local_git.GetAuthForURL(url, login.Token, login.SSHKey, callback)
	if err != nil {
		return "", err
	}
	fetchOpts := &git.FetchOptions{Auth: auth}
	if isRemoteDeleted(pr) {
		// When the head branch is already deleted, pr.Head.Ref points to
		// `refs/pull/<idx>/head`, where the commits stay available.
		// This ref must be fetched explicitly, and does not allow pushing, so we use it
		// only in this case as fallback.
		localBranchName = fmt.Sprintf("pulls/%d", pr.Index)
		fetchOpts.RefSpecs = []git_config.RefSpec{git_config.RefSpec(fmt.Sprintf("%s:refs/remotes/%s/%s",
			pr.Head.Ref,
			localRemoteName,
			localBranchName,
		))}
	}
	fmt.Printf("Fetching PR %v (head %s:%s) from remote '%s'\n", pr.Index, url, pr.Head.Ref, localRemoteName)

	err = localRemote.Fetch(fetchOpts)
	if err == git.NoErrAlreadyUpToDate {
		fmt.Println(err)
	} else if err != nil {
		return "", err
	}
	return localBranchName, nil
}

func doPRCheckout(
	localRepo *local_git.TeaRepo,
	pr *gitea.PullRequest,
	localRemoteName,
	localRemoteBranchName,
	remoteURL string,
	forceCreateBranch bool,
) error {
	// determine the ref to checkout, depending on existence of a matching commit on a local branch
	var info string
	var checkoutRef git_plumbing.ReferenceName

	if b, _ := localRepo.TeaFindBranchBySha(pr.Head.Sha, remoteURL); b != nil {

		// if a matching branch exists, use that
		checkoutRef = git_plumbing.NewBranchReferenceName(b.Name)
		info = fmt.Sprintf("Found matching local branch %s, checking it out", checkoutRef.Short())

	} else if forceCreateBranch {

		// create a branch if wanted
		localBranchName := fmt.Sprintf("pulls/%v", pr.Index)
		if isRemoteDeleted(pr) {
			localBranchName += "-" + pr.Head.Ref
		}
		checkoutRef = git_plumbing.NewBranchReferenceName(localBranchName)
		if err := localRepo.TeaCreateBranch(localBranchName, localRemoteBranchName, localRemoteName); err == nil {
			info = fmt.Sprintf("Created branch '%s'\n", localBranchName)
		} else if err == git.ErrBranchExists {
			info = "There may be changes since you last checked out, run `git pull` to get them."
		} else {
			return err
		}

	} else {

		// use the remote tracking branch
		checkoutRef = git_plumbing.NewRemoteReferenceName(localRemoteName, localRemoteBranchName)
		info = fmt.Sprintf(
			"Checking out remote tracking branch %s. To make changes, create a new branch:\n  git checkout %s",
			checkoutRef.String(), localRemoteBranchName)

	}

	fmt.Println(info)
	return localRepo.TeaCheckout(checkoutRef)
}