/
git.go
257 lines (231 loc) · 7.51 KB
/
git.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
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package git
import (
"bytes"
"fmt"
"log"
"os"
"os/exec"
"path/filepath"
"strings"
"cloud.google.com/go/internal/gapicgen/execv"
"gopkg.in/src-d/go-git.v4"
)
// ChangeInfo represents a change and its associated metadata.
type ChangeInfo struct {
Body string
Title string
Package string
PackageDir string
GoogleapisHash string
}
// FormatChanges turns a slice of changes into formatted string that will match
// the conventional commit footer pattern. This will allow these changes to be
// parsed into the changelog.
func FormatChanges(changes []*ChangeInfo, onlyGapicChanges bool) string {
if len(changes) == 0 {
return ""
}
var sb strings.Builder
sb.WriteString("\nChanges:\n\n")
for _, c := range changes {
if onlyGapicChanges && c.Package == "" {
continue
}
title := c.Title
if c.Package != "" {
// Try to add in pkg affected into conventional commit scope.
titleParts := strings.SplitN(c.Title, ":", 2)
if len(titleParts) == 2 {
// If a scope is already provided, remove it.
if i := strings.Index(titleParts[0], "("); i > 0 {
titleParts[0] = titleParts[0][:i]
}
var breakChangeIndicator string
if strings.HasSuffix(titleParts[0], "!") {
// If the change is marked as breaking we need to move the
// bang to after the added scope.
titleParts[0] = titleParts[0][:len(titleParts[0])-1]
breakChangeIndicator = "!"
}
titleParts[0] = fmt.Sprintf("%s(%s)%s", titleParts[0], c.Package, breakChangeIndicator)
}
title = strings.Join(titleParts, ":")
}
sb.WriteString(fmt.Sprintf("%s\n", title))
// Format the commit body to conventional commit footer standards.
splitBody := strings.Split(c.Body, "\n")
for i := range splitBody {
splitBody[i] = fmt.Sprintf(" %s", splitBody[i])
}
body := strings.Join(splitBody, "\n")
sb.WriteString(fmt.Sprintf("%s\n\n", body))
}
// If the buffer is empty except for the "Changes:" text return an empty
// string.
if sb.Len() == 11 {
return ""
}
return sb.String()
}
// ParseChangeInfo gets the ChangeInfo for a given googleapis hash.
func ParseChangeInfo(googleapisDir string, hashes []string, gapicPkgs map[string]string) ([]*ChangeInfo, error) {
var changes []*ChangeInfo
for _, hash := range hashes {
// Get commit title and body
c := execv.Command("git", "show", "--pretty=format:%s~~%b", "-s", hash)
c.Dir = googleapisDir
b, err := c.Output()
if err != nil {
return nil, err
}
ss := strings.Split(string(b), "~~")
if len(ss) != 2 {
return nil, fmt.Errorf("expected two segments for commit, got %d: %s", len(ss), b)
}
title, body := strings.TrimSpace(ss[0]), strings.TrimSpace(ss[1])
// Add link so corresponding googleapis commit.
body = fmt.Sprintf("%s\nSource-Link: https://github.com/googleapis/googleapis/commit/%s", body, hash)
// Try to map files updated to a package in google-cloud-go. Assumes only
// one servies protos are updated per commit. Multile versions are okay.
files, err := filesChanged(googleapisDir, hash)
if err != nil {
return nil, err
}
var pkg, pkgDir string
for _, file := range files {
if file == "" {
continue
}
importPath := gapicPkgs[filepath.Dir(file)]
if importPath != "" {
pkg = parseConventionalCommitPkg(importPath)
pkgDir = strings.TrimPrefix(importPath, "cloud.google.com/go/")
break
}
}
changes = append(changes, &ChangeInfo{
Title: title,
Body: body,
Package: pkg,
PackageDir: pkgDir,
GoogleapisHash: hash,
})
}
return changes, nil
}
// parseConventionalCommitPkg parses the package context for conventional commit
// messages.
func parseConventionalCommitPkg(importPath string) string {
s := strings.TrimPrefix(importPath, "cloud.google.com/go/")
ss := strings.Split(s, "/")
// remove the version, i.e /apiv1
return strings.Join(ss[:len(ss)-1], "/")
}
// CommitsSinceHash gathers all of the commits since the provided hash for the
// given gitDir. The inclusive parameter tells if the provided hash should also
// be returned in the slice.
func CommitsSinceHash(gitDir, hash string, inclusive bool) ([]string, error) {
var commitRange string
if inclusive {
commitRange = fmt.Sprintf("%s^..", hash)
} else {
commitRange = fmt.Sprintf("%s..", hash)
}
c := execv.Command("git", "rev-list", commitRange)
c.Dir = gitDir
b, err := c.Output()
if err != nil {
return nil, err
}
return strings.Split(strings.TrimSpace(string(b)), "\n"), nil
}
// UpdateFilesSinceHash returns a listed of files updated since the provided
// hash for the given gitDir.
func UpdateFilesSinceHash(gitDir, hash string) ([]string, error) {
// The provided diff-filter flags restricts to files that have been:
// - (A) Added
// - (C) Copied
// - (M) Modified
// - (R) Renamed
c := execv.Command("git", "diff-tree", "--no-commit-id", "--name-only", "--diff-filter=ACMR", "-r", fmt.Sprintf("%s..HEAD", hash))
c.Dir = gitDir
b, err := c.Output()
if err != nil {
return nil, err
}
return strings.Split(string(b), "\n"), nil
}
// HasChanges reports whether the given directory has uncommitted git changes.
func HasChanges(dir string) (bool, error) {
c := execv.Command("bash", "-c", "git status --short")
c.Dir = dir
b, err := c.Output()
return len(b) > 0, err
}
// DeepClone clones a repository in the given directory.
func DeepClone(repo, dir string) error {
log.Printf("cloning %s\n", repo)
_, err := git.PlainClone(dir, false, &git.CloneOptions{
URL: repo,
Progress: os.Stdout,
})
return err
}
// FindModifiedFiles locates modified files in the git directory provided.
func FindModifiedFiles(dir string) ([]string, error) {
return findModifiedFiles(dir, "-m")
}
// FindModifiedAndUntrackedFiles locates modified and untracked files in the git
// directory provided.
func FindModifiedAndUntrackedFiles(dir string) ([]string, error) {
return findModifiedFiles(dir, "-mo")
}
func findModifiedFiles(dir string, filter string) ([]string, error) {
c := execv.Command("git", "ls-files", filter)
c.Dir = dir
out, err := c.Output()
if err != nil {
return nil, err
}
return strings.Split(string(bytes.TrimSpace(out)), "\n"), nil
}
// ResetFile reverts all changes made to a file in the provided directory.
func ResetFile(dir, filename string) error {
c := exec.Command("git", "checkout", "HEAD", "--", filename)
c.Dir = dir
return c.Run()
}
// FileDiff returns the git diff for the specified file.
func FileDiff(dir, filename string) (string, error) {
c := exec.Command("git", "diff", "--unified=0", filename)
c.Dir = dir
out, err := c.Output()
if err != nil {
return "", err
}
return strings.TrimSpace(string(out)), nil
}
// filesChanged returns a list of files changed in a commit for the provdied
// hash in the given gitDir.
func filesChanged(gitDir, hash string) ([]string, error) {
c := execv.Command("git", "show", "--pretty=format:", "--name-only", hash)
c.Dir = gitDir
b, err := c.Output()
if err != nil {
return nil, err
}
return strings.Split(string(b), "\n"), nil
}