forked from flipgroup/golang-cover-diff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.go
234 lines (195 loc) · 5.41 KB
/
main.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
package main
import (
"context"
"fmt"
"os"
"regexp"
"sort"
"strconv"
"strings"
"math/rand"
"time"
"github.com/google/go-github/v38/github"
"golang.org/x/oauth2"
)
func init() {
rand.Seed(time.Now().UnixNano())
}
func main() {
ctx := context.Background()
// load given base and head `go test` cover profiles from disk
base, err := LoadCoverProfile(os.Args[1])
if err != nil {
panic(err)
}
head, err := LoadCoverProfile(os.Args[2])
if err != nil {
panic(err)
}
// generate and publish GitHub pull request message
createOrUpdateComment(
ctx,
summaryMessage(base.Coverage(), head.Coverage()),
buildTable(getModulePackageName(), base, head))
}
func buildTable(rootPkgName string, base, head *CoverProfile) string {
const tableRowSprintf = "%-80s %8s %8s %8s\n"
rootPkgName += "/"
// write report header
var buf strings.Builder
buf.WriteString(fmt.Sprintf(tableRowSprintf, "package", "before", "after", "delta"))
buf.WriteString(fmt.Sprintf(tableRowSprintf, "-------", "------", "-----", "-----"))
// write package lines
for _, pkgName := range getAllPackages(base, head) {
baseCov := base.Packages[pkgName].Coverage()
headCov := head.Packages[pkgName].Coverage()
buf.WriteString(fmt.Sprintf(tableRowSprintf,
relativePackage(rootPkgName, pkgName),
coverageDescription(baseCov),
coverageDescription(headCov),
diffDescription(baseCov, headCov)))
}
// write totals
buf.WriteString(fmt.Sprintf("%80s %8s %8s %8s\n",
"total:",
coverageDescription(base.Coverage()),
coverageDescription(head.Coverage()),
diffDescription(base.Coverage(), head.Coverage()),
))
return buf.String()
}
func createOrUpdateComment(ctx context.Context, title, details string) {
const coverageReportHeaderMarkdown = "### Coverage Report"
auth_token := os.Getenv("GITHUB_TOKEN")
if auth_token == "" {
fmt.Println("no GITHUB_TOKEN, unable to report back to GitHub pull request.")
return
}
ownerAndRepo := os.Getenv("GITHUB_REPOSITORY")
if ownerAndRepo == "" {
fmt.Println("no GITHUB_REPOSITORY, not reporting to GitHub.")
return
}
parts := strings.SplitN(ownerAndRepo, "/", 2)
owner := parts[0]
repo := parts[1]
prNumStr := os.Getenv("GITHUB_PULL_REQUEST_ID")
if prNumStr == "" {
fmt.Println("no GITHUB_PULL_REQUEST_ID, not reporting to GitHub.")
return
}
prNum, err := strconv.Atoi(prNumStr)
if err != nil {
fmt.Println("provided GITHUB_PULL_REQUEST_ID is not a valid number, not reporting to GitHub.")
return
}
ts := oauth2.StaticTokenSource(
&oauth2.Token{AccessToken: auth_token},
)
tc := oauth2.NewClient(context.Background(), ts)
client := github.NewClient(tc)
comments, _, err := client.Issues.ListComments(ctx, owner, repo, prNum, &github.IssueListCommentsOptions{})
if err != nil {
panic(err)
}
detailsLinkMarkdown := ""
detailsLinkUrl := strings.TrimSpace(os.Getenv("DETAILS_LINK_URL"))
if detailsLinkUrl != "" {
detailsLinkLabel := strings.TrimSpace(os.Getenv("DETAILS_LINK_LABEL"))
if detailsLinkLabel == "" {
detailsLinkLabel = "Link"
}
detailsLinkMarkdown = fmt.Sprintf("[%s](%s)\n", detailsLinkLabel, detailsLinkUrl)
}
// iterate over existing pull request comments - if existing coverage comment found then update
body := fmt.Sprintf("%s\n%s\n\n<details><summary>Details</summary>\n\n```\n%s```\n%s\n</details>\n",
coverageReportHeaderMarkdown,
title, details, detailsLinkMarkdown)
for _, c := range comments {
if c.Body == nil {
continue
}
if *c.Body == body {
// existing comment body is the same - no change required
return
}
if strings.HasPrefix(*c.Body, coverageReportHeaderMarkdown) {
// found existing cover comment - update
_, _, err = client.Issues.EditComment(ctx, owner, repo, *c.ID, &github.IssueComment{
Body: &body,
})
if err != nil {
panic(err)
}
return
}
}
// no coverage comment found - create new comment
_, _, err = client.Issues.CreateComment(ctx, owner, repo, prNum, &github.IssueComment{
Body: &body,
})
if err != nil {
panic(err)
}
}
func relativePackage(root, pkgName string) string {
pkgName = strings.TrimPrefix(pkgName, root)
if len(pkgName) > 80 {
pkgName = pkgName[:80]
}
return pkgName
}
func coverageDescription(coverage int) string {
if coverage < 0 {
return "-"
}
return fmt.Sprintf("%6.2f%%", float64(coverage)/100)
}
func diffDescription(base, head int) string {
if base < 0 && head < 0 {
return "n/a"
}
if base < 0 {
return "new"
}
if head < 0 {
return "gone"
}
return fmt.Sprintf("%+6.2f%%", float64(head-base)/100)
}
func summaryMessage(base, head int) string {
if base == head {
return "Coverage unchanged."
}
if base > head {
return fmt.Sprintf(":bell: Coverage decreased by `%.2f%%`.", float64(base-head)/100)
}
return fmt.Sprintf(":medal_sports: Coverage increased by `%.2f%%`.", float64(head-base)/100)
}
func getModulePackageName() string {
f, err := os.ReadFile("go.mod")
if err != nil {
// unable to determine package name
return ""
}
// found it, stop searching
modRegex := regexp.MustCompile(`module +([^\s]+)`)
return string(modRegex.FindSubmatch(f)[1])
}
func getAllPackages(profiles ...*CoverProfile) []string {
set := map[string]struct{}{}
for _, profile := range profiles {
for name := range profile.Packages {
set[name] = struct{}{}
}
}
var res []string
for name := range set {
res = append(res, name)
}
// sort into stable order
sort.Slice(res, func(i, j int) bool {
return res[i] < res[j]
})
return res
}