/
main.go
271 lines (242 loc) · 5.88 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
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
package main
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"go/ast"
"go/parser"
"go/token"
"io"
"os"
"os/exec"
"path"
"path/filepath"
"runtime"
"sort"
"strings"
"github.com/juju/ansiterm"
"github.com/urfave/cli/v2"
"golang.org/x/tools/cover"
)
func main() {
app := cli.App{
Description: "Nice coverage output",
Flags: []cli.Flag{
&cli.BoolFlag{
Name: "reverse",
Aliases: []string{"r"},
},
},
Action: func(c *cli.Context) error {
reverse := c.Bool("reverse")
file := c.Args().First()
if file == "" {
return errors.New("please provide a coverage file")
}
return run(file, reverse)
},
}
if err := app.Run(os.Args); err != nil {
fmt.Printf("Error: %s\n", err)
}
}
func run(file string, reverse bool) error {
tabber := ansiterm.NewTabWriter(os.Stdout, 1, 8, 1, '\t', 0)
defer tabber.Flush()
profiles, err := cover.ParseProfiles(file)
if err != nil {
return err
}
var total, covered int64
dirs, err := findPkgs(profiles)
if err != nil {
return err
}
var coverfiles []coveredFile
for _, profile := range profiles {
var fileTotal, fileCovered int64
f, err := findFile(dirs, profile.FileName)
if err != nil {
return err
}
fe, err := test(f)
if err != nil {
return err
}
for _, f := range fe {
n, d := f.coverage(profile)
fileTotal += d
fileCovered += n
total = total + d
covered = covered + n
}
coverfiles = append(coverfiles, coveredFile{
filename: f,
percent: 100.0 * float64(fileCovered) / float64(fileTotal),
})
}
sort.Slice(coverfiles, func(i, j int) bool {
if reverse {
return coverfiles[i].percent >= coverfiles[j].percent
}
return coverfiles[i].percent < coverfiles[j].percent
})
for _, coverfile := range coverfiles {
tabber.SetForeground(getColor(coverfile.percent))
fmt.Fprintf(tabber, "%s\t%.1f%%\n", coverfile.filename, coverfile.percent)
}
fmt.Fprintf(tabber, "\t\t\n")
totalPercent := 100.0 * float64(covered) / float64(total)
tabber.SetForeground(getColor(totalPercent))
fmt.Fprintf(tabber, "Total:\t%.1f%%\n", totalPercent)
return nil
}
func getColor(percent float64) ansiterm.Color {
if percent <= 30 {
return ansiterm.Red
}
if percent > 30 && percent <= 70 {
return ansiterm.Yellow
}
if percent > 70 {
return ansiterm.Green
}
return ansiterm.Default
}
type coveredFile struct {
filename string
percent float64
}
func test(file string) ([]*FuncExtent, error) {
fset := token.NewFileSet()
parsedFile, err := parser.ParseFile(fset, file, nil, 0)
if err != nil {
return nil, err
}
visitor := &FuncVisitor{
fset: fset,
name: file,
astFile: parsedFile,
}
ast.Walk(visitor, visitor.astFile)
return visitor.funcs, nil
}
type FuncVisitor struct {
fset *token.FileSet
name string // Name of file.
astFile *ast.File
funcs []*FuncExtent
}
func (v *FuncVisitor) Visit(node ast.Node) ast.Visitor {
switch n := node.(type) {
case *ast.FuncDecl:
start := v.fset.Position(n.Pos())
end := v.fset.Position(n.End())
fe := &FuncExtent{
name: n.Name.Name,
startLine: start.Line,
startCol: start.Column,
endLine: end.Line,
endCol: end.Column,
}
v.funcs = append(v.funcs, fe)
}
return v
}
type FuncExtent struct {
name string
startLine int
startCol int
endLine int
endCol int
}
func (f *FuncExtent) coverage(profile *cover.Profile) (num, den int64) {
// We could avoid making this n^2 overall by doing a single scan and annotating the functions,
// but the sizes of the data structures is never very large and the scan is almost instantaneous.
var covered, total int64
// The blocks are sorted, so we can stop counting as soon as we reach the end of the relevant block.
for _, b := range profile.Blocks {
if b.StartLine > f.endLine || (b.StartLine == f.endLine && b.StartCol >= f.endCol) {
// Past the end of the function.
break
}
if b.EndLine < f.startLine || (b.EndLine == f.startLine && b.EndCol <= f.startCol) {
// Before the beginning of the function
continue
}
total += int64(b.NumStmt)
if b.Count > 0 {
covered += int64(b.NumStmt)
}
}
if total == 0 {
total = 1 // Avoid zero denominator.
}
return covered, total
}
type Pkg struct {
ImportPath string
Dir string
Error *struct {
Err string
}
}
func findPkgs(profiles []*cover.Profile) (map[string]*Pkg, error) {
// Run go list to find the location of every package we care about.
pkgs := make(map[string]*Pkg)
var list []string
for _, profile := range profiles {
if strings.HasPrefix(profile.FileName, ".") || filepath.IsAbs(profile.FileName) {
// Relative or absolute path.
continue
}
pkg := path.Dir(profile.FileName)
if _, ok := pkgs[pkg]; !ok {
pkgs[pkg] = nil
list = append(list, pkg)
}
}
if len(list) == 0 {
return pkgs, nil
}
// Note: usually run as "go tool cover" in which case $GOROOT is set,
// in which case runtime.GOROOT() does exactly what we want.
goTool := filepath.Join(runtime.GOROOT(), "bin/go")
cmd := exec.Command(goTool, append([]string{"list", "-e", "-json"}, list...)...)
var stderr bytes.Buffer
cmd.Stderr = &stderr
stdout, err := cmd.Output()
if err != nil {
return nil, fmt.Errorf("cannot run go list: %v\n%s", err, stderr.Bytes())
}
dec := json.NewDecoder(bytes.NewReader(stdout))
for {
var pkg Pkg
err := dec.Decode(&pkg)
if err == io.EOF {
break
}
if err != nil {
return nil, fmt.Errorf("decoding go list json: %v", err)
}
pkgs[pkg.ImportPath] = &pkg
}
return pkgs, nil
}
func findFile(pkgs map[string]*Pkg, file string) (string, error) {
if strings.HasPrefix(file, ".") || filepath.IsAbs(file) {
// Relative or absolute path.
return file, nil
}
pkg := pkgs[path.Dir(file)]
if pkg != nil {
if pkg.Dir != "" {
return filepath.Join(pkg.Dir, path.Base(file)), nil
}
if pkg.Error != nil {
return "", errors.New(pkg.Error.Err)
}
}
return "", fmt.Errorf("did not find package for %s in go list output", file)
}