-
Notifications
You must be signed in to change notification settings - Fork 1
/
git_cli.go
553 lines (482 loc) · 16 KB
/
git_cli.go
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
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
package gits
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"net/url"
"os"
"path/filepath"
"strings"
"time"
"github.com/jenkins-x/jx/pkg/auth"
"github.com/jenkins-x/jx/pkg/util"
gitcfg "gopkg.in/src-d/go-git.v4/config"
)
const (
replaceInvalidBranchChars = '_'
)
// GitCLI implements common git actions based on git CLI
type GitCLI struct{}
// NewGitCLI creates a new GitCLI instance
func NewGitCLI() *GitCLI {
return &GitCLI{}
}
// FindGitConfigDir tries to find the `.git` directory either in the current directory or in parent directories
func (g *GitCLI) FindGitConfigDir(dir string) (string, string, error) {
d := dir
var err error
if d == "" {
d, err = os.Getwd()
if err != nil {
return "", "", err
}
}
for {
gitDir := filepath.Join(d, ".git/config")
f, err := util.FileExists(gitDir)
if err != nil {
return "", "", err
}
if f {
return d, gitDir, nil
}
dirPath := strings.TrimSuffix(d, "/")
if dirPath == "" {
return "", "", nil
}
p, _ := filepath.Split(dirPath)
if d == "/" || p == d {
return "", "", nil
}
d = p
}
}
// Clone clones the given git URL into the given directory
func (g *GitCLI) Clone(url string, dir string) error {
return g.gitCmd(dir, "clone", url, ".")
}
// Pull pulls the git repository in the given directory
func (g *GitCLI) Pull(dir string) error {
return g.gitCmd(dir, "pull")
}
// CloneOrPull clones the given git URL or pull if it already exists
func (g *GitCLI) CloneOrPull(url string, dir string) error {
empty, err := util.IsEmpty(dir)
if err != nil {
return err
}
if !empty {
return g.Pull(dir)
}
return g.Clone(url, dir)
}
// PullUpstream pulls the remote upstream branch into master branch into the given directory
func (g *GitCLI) PullUpstream(dir string) error {
return g.gitCmd(dir, "pull", "-r", "upstream", "master")
}
// AddRemote adds a remote repository at the given URL and with the given name
func (g *GitCLI) AddRemote(dir string, name string, url string) error {
return g.gitCmd(dir, "remote", "add", name, url)
}
// UpdateRemote updates the URL of the remote repository
func (g *GitCLI) UpdateRemote(dir, url string) error {
return g.gitCmd(dir, "remote", "set-url", "origin", url)
}
// Stash stashes the current changes from the given directory
func (g *GitCLI) Stash(dir string) error {
return g.gitCmd(dir, "stash")
}
// CheckoutRemoteBranch checks out the given remote tracking branch
func (g *GitCLI) CheckoutRemoteBranch(dir string, branch string) error {
remoteBranch := "origin/" + branch
remoteBranches, err := g.RemoteBranches(dir)
if err != nil {
return err
}
if util.StringArrayIndex(remoteBranches, remoteBranch) < 0 {
return g.gitCmd(dir, "checkout", "-t", remoteBranch)
}
cur, err := g.Branch(dir)
if err != nil {
return err
}
if cur == branch {
return nil
}
return g.Checkout(dir, branch)
}
// RemoteBranches returns the remote branches
func (g *GitCLI) RemoteBranches(dir string) ([]string, error) {
answer := []string{}
text, err := g.gitCmdWithOutput(dir, "branch", "-r")
if err != nil {
return answer, err
}
lines := strings.Split(text, "\n")
for _, line := range lines {
columns := strings.Split(line, " ")
for _, col := range columns {
if col != "" {
answer = append(answer, col)
break
}
}
}
return answer, nil
}
// Checkout checks out the given branch
func (g *GitCLI) Checkout(dir string, branch string) error {
return g.gitCmd(dir, "checkout", branch)
}
// Init inits a git repository into the given directory
func (g *GitCLI) Init(dir string) error {
return g.gitCmd(dir, "init")
}
// Remove removes the given file from a git repository located at the given directory
func (g *GitCLI) Remove(dir, fileName string) error {
return g.gitCmd(dir, "rm", "-r", fileName)
}
// Status returns the status of the git repository at the given directory
func (g *GitCLI) Status(dir string) error {
return g.gitCmd(dir, "status")
}
// Branch returns the current branch of the repository located at the given directory
func (g *GitCLI) Branch(dir string) (string, error) {
return g.gitCmdWithOutput(dir, "rev-parse", "--abbrev-ref", "HEAD")
}
// Push pushes the changes from the repository at the given directory
func (g *GitCLI) Push(dir string) error {
return g.gitCmd(dir, "push", "origin", "HEAD")
}
// ForcePushBranch does a force push of the local branch into the remote branch of the repository at the given directory
func (g *GitCLI) ForcePushBranch(dir string, localBranch string, remoteBranch string) error {
return g.gitCmd(dir, "push", "-f", "origin", localBranch+":"+remoteBranch)
}
// PushMaster pushes the master branch into the origin
func (g *GitCLI) PushMaster(dir string) error {
return g.gitCmd(dir, "push", "-u", "origin", "master")
}
// Pushtag pushes the given tag into the origin
func (g *GitCLI) PushTag(dir string, tag string) error {
return g.gitCmd(dir, "push", "origin", tag)
}
// Add does a git add for all the given arguments
func (g *GitCLI) Add(dir string, args ...string) error {
add := append([]string{"add"}, args...)
return g.gitCmd(dir, add...)
}
// HasChanges indicates if there are any changes in the repository from the given directory
func (g *GitCLI) HasChanges(dir string) (bool, error) {
text, err := g.gitCmdWithOutput(dir, "status", "-s")
if err != nil {
return false, err
}
text = strings.TrimSpace(text)
return len(text) > 0, nil
}
// CommiIfChanges does a commit if there are any changes in the repository at the given directory
func (g *GitCLI) CommitIfChanges(dir string, message string) error {
changed, err := g.HasChanges(dir)
if err != nil {
return err
}
if !changed {
return nil
}
return g.CommitDir(dir, message)
}
// CommitDir commits all changes from the given directory
func (g *GitCLI) CommitDir(dir string, message string) error {
return g.gitCmd(dir, "commit", "-m", message)
}
// AddCommit perform an add and commit of the changes from the repository at the given directory with the given messages
func (g *GitCLI) AddCommmit(dir string, msg string) error {
return g.gitCmd("", "commit", "-a", "-m", msg, "--allow-empty")
}
func (g *GitCLI) gitCmd(dir string, args ...string) error {
cmd := util.Command{
Dir: dir,
Name: "git",
Args: args,
}
_, err := cmd.RunWithoutRetry()
return err
}
func (g *GitCLI) gitCmdWithOutput(dir string, args ...string) (string, error) {
cmd := util.Command{
Dir: dir,
Name: "git",
Args: args,
}
return cmd.RunWithoutRetry()
}
// CreatePushURL creates the git repository URL with the username and password encoded for HTTPS based URLs
func (g *GitCLI) CreatePushURL(cloneURL string, userAuth *auth.UserAuth) (string, error) {
u, err := url.Parse(cloneURL)
if err != nil {
// already a git/ssh url?
return cloneURL, nil
}
if userAuth.Username != "" || userAuth.ApiToken != "" {
u.User = url.UserPassword(userAuth.Username, userAuth.ApiToken)
return u.String(), nil
}
return cloneURL, nil
}
// RepoName formats the repository names based on the organization
func (g *GitCLI) RepoName(org, repoName string) string {
if org != "" {
return org + "/" + repoName
}
return repoName
}
// Server returns the git server of the repository at the given directory
func (g *GitCLI) Server(dir string) (string, error) {
repo, err := g.Info(dir)
if err != nil {
return "", err
}
return repo.HostURL(), err
}
// Info returns the git info of the repository at the given directory
func (g *GitCLI) Info(dir string) (*GitRepositoryInfo, error) {
text, err := g.gitCmdWithOutput(dir, "status")
if err != nil && strings.Contains(text, "Not a git repository") {
return nil, fmt.Errorf("you are not in a Git repository - promotion command should be executed from an application directory")
}
text, err = g.gitCmdWithOutput(dir, "config", "--get", "remote.origin.url")
rUrl := strings.TrimSpace(text)
repo, err := ParseGitURL(rUrl)
if err != nil {
return nil, fmt.Errorf("failed to parse git URL %s due to %s", rUrl, err)
}
return repo, err
}
// ConvertToValidBranchName converts the given branch name into a valid git branch string
// replacing any dodgy characters
func (g *GitCLI) ConvertToValidBranchName(name string) string {
name = strings.TrimSuffix(name, "/")
name = strings.TrimSuffix(name, ".lock")
var buffer bytes.Buffer
last := ' '
for _, ch := range name {
if ch <= 32 {
ch = replaceInvalidBranchChars
}
switch ch {
case '~':
ch = replaceInvalidBranchChars
case '^':
ch = replaceInvalidBranchChars
case ':':
ch = replaceInvalidBranchChars
case ' ':
ch = replaceInvalidBranchChars
case '\n':
ch = replaceInvalidBranchChars
case '\r':
ch = replaceInvalidBranchChars
case '\t':
ch = replaceInvalidBranchChars
}
if ch != replaceInvalidBranchChars || last != replaceInvalidBranchChars {
buffer.WriteString(string(ch))
}
last = ch
}
return buffer.String()
}
// GetAuthorEmailForCommit returns the author email from commit message with the given SHA
func (g *GitCLI) GetAuthorEmailForCommit(dir string, sha string) (string, error) {
text, err := g.gitCmdWithOutput(dir, "show", "-s", "--format=%aE", sha)
if err != nil {
return "", fmt.Errorf("failed to invoke git %s in %s due to %s", "show "+sha, dir, err)
}
return strings.TrimSpace(text), nil
}
// SetRemoteURL sets the remote URL of the remote with the given name
func (g *GitCLI) SetRemoteURL(dir string, name string, gitURL string) error {
err := g.gitCmd(dir, "remote", "add", name, gitURL)
if err != nil {
err = g.gitCmd(dir, "remote", "set-url", name, gitURL)
if err != nil {
return err
}
}
return nil
}
func (g *GitCLI) parseGitConfig(gitConf string) (*gitcfg.Config, error) {
if gitConf == "" {
return nil, fmt.Errorf("no GitConfDir defined")
}
cfg := gitcfg.NewConfig()
data, err := ioutil.ReadFile(gitConf)
if err != nil {
return nil, fmt.Errorf("failed to load %s due to %s", gitConf, err)
}
err = cfg.Unmarshal(data)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal %s due to %s", gitConf, err)
}
return cfg, nil
}
// DiscoverRemoteGitURL discovers the remote git URL from the given git configuration
func (g *GitCLI) DiscoverRemoteGitURL(gitConf string) (string, error) {
cfg, err := g.parseGitConfig(gitConf)
if err != nil {
return "", fmt.Errorf("failed to unmarshal %s due to %s", gitConf, err)
}
remotes := cfg.Remotes
if len(remotes) == 0 {
return "", nil
}
rUrl := g.GetRemoteUrl(cfg, "origin")
if rUrl == "" {
rUrl = g.GetRemoteUrl(cfg, "upstream")
}
return rUrl, nil
}
// DiscoverUpstreamGitURL discovers the upstream git URL from the given git configuration
func (g *GitCLI) DiscoverUpstreamGitURL(gitConf string) (string, error) {
cfg, err := g.parseGitConfig(gitConf)
if err != nil {
return "", fmt.Errorf("failed to unmarshal %s due to %s", gitConf, err)
}
remotes := cfg.Remotes
if len(remotes) == 0 {
return "", nil
}
rUrl := g.GetRemoteUrl(cfg, "upstream")
if rUrl == "" {
rUrl = g.GetRemoteUrl(cfg, "origin")
}
return rUrl, nil
}
func (g *GitCLI) firstRemoteUrl(remote *gitcfg.RemoteConfig) string {
if remote != nil {
urls := remote.URLs
if urls != nil && len(urls) > 0 {
return urls[0]
}
}
return ""
}
// GetRemoteUrl returns the remote URL from the given git config
func (g *GitCLI) GetRemoteUrl(config *gitcfg.Config, name string) string {
if config.Remotes != nil {
return g.firstRemoteUrl(config.Remotes[name])
}
return ""
}
// RemoteBranches returns all remote branches with the given prefix
func (g *GitCLI) RemoteBranchNames(dir string, prefix string) ([]string, error) {
answer := []string{}
text, err := g.gitCmdWithOutput(dir, "branch", "-a")
if err != nil {
return answer, err
}
lines := strings.Split(text, "\n")
for _, line := range lines {
line = strings.TrimSpace(strings.TrimPrefix(line, "* "))
if prefix != "" {
line = strings.TrimPrefix(line, prefix)
}
answer = append(answer, line)
}
return answer, nil
}
// GetPreviousGitTagSHA returns the previous git tag from the repository at the given directory
func (g *GitCLI) GetPreviousGitTagSHA(dir string) (string, error) {
// when in a release branch we need to skip 2 rather that 1 to find the revision of the previous tag
// no idea why! :)
return g.gitCmdWithOutput(dir, "rev-list", "--tags", "--skip=2", "--max-count=1")
}
// GetRevisionBeforeDate returns the revision before the given date
func (g *GitCLI) GetRevisionBeforeDate(dir string, t time.Time) (string, error) {
dateText := util.FormatDate(t)
return g.GetRevisionBeforeDateText(dir, dateText)
}
// GetRevisionBeforeDateText returns the revision before the given date in format "MonthName dayNumber year"
func (g *GitCLI) GetRevisionBeforeDateText(dir string, dateText string) (string, error) {
branch, err := g.Branch(dir)
if err != nil {
return "", err
}
return g.gitCmdWithOutput(dir, "rev-list", "-1", "--before=\""+dateText+"\"", "--max-count=1", branch)
}
// GetCurrentGitTagSHA return the SHA of the current git tag from the repository at the given directory
func (g *GitCLI) GetCurrentGitTagSHA(dir string) (string, error) {
return g.gitCmdWithOutput(dir, "rev-list", "--tags", "--max-count=1")
}
// FetchTags fetches all the tags
func (g *GitCLI) FetchTags(dir string) error {
return g.gitCmd("", "fetch", "--tags", "-v")
}
// Tags returns all tags from the repository at the given directory
func (g *GitCLI) Tags(dir string) ([]string, error) {
tags := []string{}
text, err := g.gitCmdWithOutput(dir, "tag")
if err != nil {
return tags, err
}
text = strings.TrimSuffix(text, "\n")
return strings.Split(text, "\n"), nil
}
// CreateTag creates a tag with the given name and message in the repository at the given directory
func (g *GitCLI) CreateTag(dir string, tag string, msg string) error {
return g.gitCmd("", "tag", "-fa", tag, "-m", msg)
}
// PrintCreateRepositoryGenerateAccessToken prints the access token URL of a git repository
func (g *GitCLI) PrintCreateRepositoryGenerateAccessToken(server *auth.AuthServer, username string, o io.Writer) {
tokenUrl := ProviderAccessTokenURL(server.Kind, server.URL, username)
fmt.Fprintf(o, "To be able to create a repository on %s we need an API Token\n", server.Label())
fmt.Fprintf(o, "Please click this URL %s\n\n", util.ColorInfo(tokenUrl))
fmt.Fprint(o, "Then COPY the token and enter in into the form below:\n\n")
}
// IsFork indicates if the repository at the given directory is a fork
func (g *GitCLI) IsFork(gitProvider GitProvider, gitInfo *GitRepositoryInfo, dir string) (bool, error) {
// lets ignore errors as that just means there's no config
originUrl, _ := g.gitCmdWithOutput(dir, "config", "--get", "remote.origin.url")
upstreamUrl, _ := g.gitCmdWithOutput(dir, "config", "--get", "remote.upstream.url")
if originUrl != upstreamUrl && originUrl != "" && upstreamUrl != "" {
return true, nil
}
repo, err := gitProvider.GetRepository(gitInfo.Organisation, gitInfo.Name)
if err != nil {
return false, err
}
return repo.Fork, nil
}
// ToGitLabels converts the list of label names into an array of GitLabels
func (g *GitCLI) ToGitLabels(names []string) []GitLabel {
answer := []GitLabel{}
for _, n := range names {
answer = append(answer, GitLabel{Name: n})
}
return answer
}
// Version returns the git version
func (g *GitCLI) Version() (string, error) {
return g.gitCmdWithOutput("", "version")
}
// Username return the username from the git configuration
func (g *GitCLI) Username(dir string) (string, error) {
return g.gitCmdWithOutput("", "config", "--global", "--get", "user.name")
}
// SetUsername sets the username in the git configuration
func (g *GitCLI) SetUsername(dir string, username string) error {
return g.gitCmd(dir, "config", "--global", "--add", "user.name", username)
}
// Email returns the email from the git configuration
func (g *GitCLI) Email(dir string) (string, error) {
return g.gitCmdWithOutput(dir, "config", "--global", "--get", "user.email")
}
// SetEmail sets the given email in the git configuration
func (g *GitCLI) SetEmail(dir string, email string) error {
return g.gitCmd(dir, "config", "--global", "--add", "user.email", email)
}
// CreateBranch creates a branch with the given name in the git repository from the given directory
func (g *GitCLI) CreateBranch(dir string, branch string) error {
return g.gitCmd(dir, "branch", branch)
}