|
| 1 | +// gcov2lcov - convert golang coverage files to the lcov format. |
| 2 | +// |
| 3 | +// Copyright (c) 2019 Jan Delgado |
| 4 | +// Copyright (c) 2019 Richard S Allinson |
| 5 | +// |
| 6 | +// Credits: |
| 7 | +// This tool is based on covfmt (https://github.com/ricallinson/covfmt) and |
| 8 | +// uses some parts of goveralls (https://github.com/mattn/goveralls). |
| 9 | +// |
| 10 | +package main |
| 11 | + |
| 12 | +import ( |
| 13 | + "bufio" |
| 14 | + "errors" |
| 15 | + "flag" |
| 16 | + "go/build" |
| 17 | + "io" |
| 18 | + "log" |
| 19 | + "os" |
| 20 | + "path/filepath" |
| 21 | + "strconv" |
| 22 | + "strings" |
| 23 | +) |
| 24 | + |
| 25 | +type block struct { |
| 26 | + startLine int |
| 27 | + startChar int |
| 28 | + endLine int |
| 29 | + endChar int |
| 30 | + statements int |
| 31 | + covered int |
| 32 | +} |
| 33 | + |
| 34 | +var vscDirs = []string{".git", ".hg", ".bzr", ".svn"} |
| 35 | + |
| 36 | +type cacheEntry struct { |
| 37 | + file string |
| 38 | + err error |
| 39 | +} |
| 40 | + |
| 41 | +var pkgCache = map[string]cacheEntry{} |
| 42 | + |
| 43 | +// given a module+file spec (e.g. github.com/jandelgado/gcov2lcov/main.go), |
| 44 | +// strip of the module name and return the file name (e.g. main.go). |
| 45 | +func findFile(file string) (string, error) { |
| 46 | + dir, file := filepath.Split(file) |
| 47 | + var result cacheEntry |
| 48 | + var ok bool |
| 49 | + if result, ok = pkgCache[file]; !ok { |
| 50 | + pkg, err := build.Import(dir, ".", build.FindOnly) |
| 51 | + if err == nil { |
| 52 | + result = cacheEntry{filepath.Join(pkg.Dir, file), nil} |
| 53 | + } else { |
| 54 | + result = cacheEntry{"", err} |
| 55 | + } |
| 56 | + pkgCache[file] = result |
| 57 | + } |
| 58 | + return result.file, result.err |
| 59 | +} |
| 60 | + |
| 61 | +// findRepositoryRoot finds the VCS root dir of a given dir |
| 62 | +func findRepositoryRoot(dir string) (string, bool) { |
| 63 | + for _, vcsdir := range vscDirs { |
| 64 | + if d, err := os.Stat(filepath.Join(dir, vcsdir)); err == nil && d.IsDir() { |
| 65 | + return dir, true |
| 66 | + } |
| 67 | + } |
| 68 | + nextdir := filepath.Dir(dir) |
| 69 | + if nextdir == dir { |
| 70 | + return "", false |
| 71 | + } |
| 72 | + return findRepositoryRoot(nextdir) |
| 73 | +} |
| 74 | + |
| 75 | +func getCoverallsSourceFileName(name string) string { |
| 76 | + if dir, ok := findRepositoryRoot(name); ok { |
| 77 | + filename := strings.TrimPrefix(name, dir+string(os.PathSeparator)) |
| 78 | + return filename |
| 79 | + } |
| 80 | + return name |
| 81 | +} |
| 82 | + |
| 83 | +func writeLcovRecord(filePath string, blocks []*block, w io.StringWriter) error { |
| 84 | + |
| 85 | + writer := func(err error, s string) error { |
| 86 | + if err != nil { |
| 87 | + return err |
| 88 | + } |
| 89 | + _, err = w.WriteString(s) |
| 90 | + return err |
| 91 | + } |
| 92 | + var err error |
| 93 | + err = writer(err, "TN:\nSF:"+filePath+"\n") |
| 94 | + |
| 95 | + // Loop over functions |
| 96 | + // FN: line,name |
| 97 | + |
| 98 | + // FNF: total functions |
| 99 | + // FNH: covered functions |
| 100 | + |
| 101 | + // Loop over functions |
| 102 | + // FNDA: stats,name ? |
| 103 | + |
| 104 | + // Loop over lines |
| 105 | + total := 0 |
| 106 | + covered := 0 |
| 107 | + |
| 108 | + // Loop over each block and extract the lcov data needed. |
| 109 | + for _, b := range blocks { |
| 110 | + // For each line in a block we add an lcov entry and count the lines. |
| 111 | + for i := b.startLine; i <= b.endLine; i++ { |
| 112 | + total++ |
| 113 | + if b.covered > 0 { |
| 114 | + covered++ |
| 115 | + } |
| 116 | + err = writer(err, "DA:"+strconv.Itoa(i)+","+strconv.Itoa(b.covered)+"\n") |
| 117 | + } |
| 118 | + } |
| 119 | + |
| 120 | + err = writer(err, "LF:"+strconv.Itoa(total)+"\n") |
| 121 | + err = writer(err, "LH:"+strconv.Itoa(covered)+"\n") |
| 122 | + |
| 123 | + // Loop over branches |
| 124 | + // BRDA: ? |
| 125 | + |
| 126 | + // BRF: total branches |
| 127 | + // BRH: covered branches |
| 128 | + |
| 129 | + return writer(err, "end_of_record\n") |
| 130 | +} |
| 131 | + |
| 132 | +func writeLcov(blocks map[string][]*block, f io.Writer) error { |
| 133 | + w := bufio.NewWriter(f) |
| 134 | + for file, fileBlocks := range blocks { |
| 135 | + if err := writeLcovRecord(file, fileBlocks, w); err != nil { |
| 136 | + return err |
| 137 | + } |
| 138 | + } |
| 139 | + w.Flush() |
| 140 | + return nil |
| 141 | +} |
| 142 | + |
| 143 | +// Format being parsed is: |
| 144 | +// name.go:line.column,line.column numberOfStatements count |
| 145 | +// e.g. |
| 146 | +// github.com/jandelgado/golang-ci-template/main.go:6.14,8.2 1 1 |
| 147 | +func parseCoverageLine(line string) (string, *block, error) { |
| 148 | + path := strings.Split(line, ":") |
| 149 | + if len(path) != 2 { |
| 150 | + return "", nil, errors.New("unexpected format (path sep): " + line) |
| 151 | + } |
| 152 | + parts := strings.Split(path[1], " ") |
| 153 | + if len(parts) != 3 { |
| 154 | + return "", nil, errors.New("unexpected format (parts): " + line) |
| 155 | + } |
| 156 | + sections := strings.Split(parts[0], ",") |
| 157 | + if len(sections) != 2 { |
| 158 | + return "", nil, errors.New("unexpected format (pos): " + line) |
| 159 | + } |
| 160 | + start := strings.Split(sections[0], ".") |
| 161 | + end := strings.Split(sections[1], ".") |
| 162 | + |
| 163 | + safeAtoi := func(err error, s string) (int, error) { |
| 164 | + if err != nil { |
| 165 | + return 0, err |
| 166 | + } |
| 167 | + return strconv.Atoi(s) |
| 168 | + } |
| 169 | + b := &block{} |
| 170 | + var err error |
| 171 | + b.startLine, err = safeAtoi(nil, start[0]) |
| 172 | + b.startChar, err = safeAtoi(err, start[1]) |
| 173 | + b.endLine, err = safeAtoi(err, end[0]) |
| 174 | + b.endChar, err = safeAtoi(err, end[1]) |
| 175 | + b.statements, err = safeAtoi(err, parts[1]) |
| 176 | + b.covered, err = safeAtoi(err, parts[2]) |
| 177 | + |
| 178 | + return path[0], b, err |
| 179 | +} |
| 180 | + |
| 181 | +func parseCoverage(coverage io.Reader) map[string][]*block { |
| 182 | + scanner := bufio.NewScanner(coverage) |
| 183 | + blocks := map[string][]*block{} |
| 184 | + for scanner.Scan() { |
| 185 | + line := scanner.Text() |
| 186 | + if strings.HasPrefix(line, "mode:") { |
| 187 | + continue |
| 188 | + } |
| 189 | + if f, b, err := parseCoverageLine(line); err == nil { |
| 190 | + f, err := findFile(f) |
| 191 | + if err != nil { |
| 192 | + log.Printf("%v", err) |
| 193 | + continue |
| 194 | + } |
| 195 | + f = getCoverallsSourceFileName(f) |
| 196 | + // Make sure the filePath is a key in the map. |
| 197 | + if _, found := blocks[f]; !found { |
| 198 | + blocks[f] = []*block{} |
| 199 | + } |
| 200 | + blocks[f] = append(blocks[f], b) |
| 201 | + } else { |
| 202 | + log.Printf("%v", err) |
| 203 | + } |
| 204 | + |
| 205 | + } |
| 206 | + if err := scanner.Err(); err != nil { |
| 207 | + log.Fatal(scanner.Err()) |
| 208 | + } |
| 209 | + return blocks |
| 210 | +} |
| 211 | + |
| 212 | +func main() { |
| 213 | + infileName := flag.String("infile", "", "go coverage file to read, default: <stdin>") |
| 214 | + outfileName := flag.String("outfile", "", "lcov file to write, default: <stdout>") |
| 215 | + flag.Parse() |
| 216 | + if len(flag.Args()) > 0 { |
| 217 | + flag.Usage() |
| 218 | + os.Exit(1) |
| 219 | + } |
| 220 | + |
| 221 | + infile := os.Stdin |
| 222 | + outfile := os.Stdout |
| 223 | + var err error |
| 224 | + if *infileName != "" { |
| 225 | + infile, err = os.Open(*infileName) |
| 226 | + if err != nil { |
| 227 | + log.Fatalf("error opening input file: %v", err) |
| 228 | + } |
| 229 | + defer infile.Close() |
| 230 | + } |
| 231 | + if *outfileName != "" { |
| 232 | + outfile, err = os.Create(*outfileName) |
| 233 | + if err != nil { |
| 234 | + log.Fatalf("error opening output file: %v", err) |
| 235 | + } |
| 236 | + defer outfile.Close() |
| 237 | + } |
| 238 | + |
| 239 | + err = writeLcov(parseCoverage(infile), outfile) |
| 240 | + if err != nil { |
| 241 | + log.Fatalf("error writing lcov output: %v", err) |
| 242 | + } |
| 243 | +} |
0 commit comments