fix duplicate DA record processing (#3)

Author: jandelgado

CHANGELOG.md

@@ -0,0 +1,10 @@
+# changelog for gcov2lcov
+
+## 1.0.1 [2020-04-25]
+
+* avoid duplicate DA records for same lines (see
+  https://github.com/jandelgado/gcov2lcov-action/issues/2)
+
+## 1.0.0 [2019-10-07]
+
+* initial release

README.md

@@ -34,9 +34,67 @@ gcov2lcov -inputfile=coverage.out -outfile=coverage.lcov
 
 ## Build and Test
 
-* `make test`  to run unit tests
+* `make test`  to run tests
 * `make build` to build binary in `bin/` directory
-* `make inttest` to run unit integration test
+
+## Tracefile format reference
+
+The following desription is taken from the [geninfo
+manpage](http://ltp.sourceforge.net/coverage/lcov/geninfo.1.php) of the [lcov
+homepage](http://ltp.sourceforge.net/coverage/lcov/):
+
+```
+A tracefile is made up of several human-readable lines of text, divided into sections. If available, a tracefile begins with the testname which is stored in the following format:
+
+TN:<test name>
+
+For each source file referenced in the .da file, there is a section containing filename and coverage data:
+
+SF:<absolute path to the source file>
+
+Following is a list of line numbers for each function name found in the source file:
+
+FN:<line number of function start>,<function name>
+
+Next, there is a list of execution counts for each instrumented function:
+
+FNDA:<execution count>,<function name>
+
+This list is followed by two lines containing the number of functions found and hit:
+
+FNF:<number of functions found> FNH:<number of function hit>
+
+Branch coverage information is stored which one line per branch:
+
+BRDA:<line number>,<block number>,<branch number>,<taken>
+
+Block number and branch number are gcc internal IDs for the branch. Taken is either '-' if the basic block containing the branch was never executed or a number indicating how often that branch was taken.
+
+Branch coverage summaries are stored in two lines:
+
+BRF:<number of branches found> BRH:<number of branches hit>
+
+Then there is a list of execution counts for each instrumented line (i.e. a line which resulted in executable code):
+
+DA:<line number>,<execution count>[,<checksum>]
+
+Note that there may be an optional checksum present for each instrumented line. The current geninfo implementation uses an MD5 hash as checksumming algorithm.
+
+At the end of a section, there is a summary about how many lines were found and how many were actually instrumented:
+
+LH:<number of lines with a non-zero execution count> LF:<number of instrumented lines>
+
+Each sections ends with:
+
+end_of_record
+
+In addition to the main source code file there are sections for all #included files which also contain executable code.
+
+Note that the absolute path of a source file is generated by interpreting the contents of the respective .bb file (see gcov (1) for more information on this file type). Relative filenames are prefixed with the directory in which the .bb file is found.
+
+Note also that symbolic links to the .bb file will be resolved so that the actual file path is used instead of the path to a link. This approach is necessary for the mechanism to work with the /proc/gcov files.
+
+```
 
 ## Author
 

main.go

@@ -18,6 +18,7 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"sort"
 	"strconv"
 	"strings"
 )
@@ -80,6 +81,16 @@ func getCoverallsSourceFileName(name string) string {
 	return name
 }
 
+func keysOfMap(m map[int]int) []int {
+	keys := make([]int, len(m))
+	i := 0
+	for k := range m {
+		keys[i] = k
+		i++
+	}
+	return keys
+}
+
 func writeLcovRecord(filePath string, blocks []*block, w io.StringWriter) error {
 
 	writer := func(err error, s string) error {
@@ -105,18 +116,28 @@ func writeLcovRecord(filePath string, blocks []*block, w io.StringWriter) error
 	total := 0
 	covered := 0
 
+	// maps line number to sum of covered
+	coverMap := map[int]int{}
+
 	// Loop over each block and extract the lcov data needed.
 	for _, b := range blocks {
 		// For each line in a block we add an lcov entry and count the lines.
 		for i := b.startLine; i <= b.endLine; i++ {
-			total++
-			if b.covered > 0 {
-				covered++
+			if b.covered < 1 {
+				continue
 			}
-			err = writer(err, "DA:"+strconv.Itoa(i)+","+strconv.Itoa(b.covered)+"\n")
+			coverMap[i] += b.covered
 		}
 	}
 
+	lines := keysOfMap(coverMap)
+	sort.Ints(lines)
+	for _, line := range lines {
+		err = writer(err, "DA:"+strconv.Itoa(line)+","+strconv.Itoa(coverMap[line])+"\n")
+		total++
+		covered += coverMap[line]
+	}
+
 	err = writer(err, "LF:"+strconv.Itoa(total)+"\n")
 	err = writer(err, "LH:"+strconv.Itoa(covered)+"\n")
 
@@ -178,7 +199,7 @@ func parseCoverageLine(line string) (string, *block, error) {
 	return path[0], b, err
 }
 
-func parseCoverage(coverage io.Reader) map[string][]*block {
+func parseCoverage(coverage io.Reader) (map[string][]*block, error) {
 	scanner := bufio.NewScanner(coverage)
 	blocks := map[string][]*block{}
 	for scanner.Scan() {
@@ -189,7 +210,7 @@ func parseCoverage(coverage io.Reader) map[string][]*block {
 		if f, b, err := parseCoverageLine(line); err == nil {
 			f, err := findFile(f)
 			if err != nil {
-				log.Printf("%v", err)
+				log.Printf("warn: %v", err)
 				continue
 			}
 			f = getCoverallsSourceFileName(f)
@@ -199,14 +220,22 @@ func parseCoverage(coverage io.Reader) map[string][]*block {
 			}
 			blocks[f] = append(blocks[f], b)
 		} else {
-			log.Printf("%v", err)
+			log.Printf("warn: %v", err)
 		}
 
 	}
 	if err := scanner.Err(); err != nil {
-		log.Fatal(scanner.Err())
+		return nil, err
+	}
+	return blocks, nil
+}
+
+func convertCoverage(in io.Reader, out io.Writer) error {
+	blocks, err := parseCoverage(in)
+	if err != nil {
+		return err
 	}
-	return blocks
+	return writeLcov(blocks, out)
 }
 
 func main() {
@@ -236,8 +265,8 @@ func main() {
 		defer outfile.Close()
 	}
 
-	err = writeLcov(parseCoverage(infile), outfile)
+	err = convertCoverage(infile, outfile)
 	if err != nil {
-		log.Fatalf("error writing lcov output: %v", err)
+		log.Fatalf("convert: %v", err)
 	}
 }

main_test.go

@@ -3,12 +3,22 @@
 package main
 
 import (
+	"bytes"
 	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
 )
 
+func TestKeysOfMapReturnsAllKeysOfMap(t *testing.T) {
+	m := map[int]int{1: 10, 10: 100}
+
+	keys := keysOfMap(m)
+	assert.Contains(t, keys, 1)
+	assert.Contains(t, keys, 10)
+	assert.Equal(t, 2, len(keys))
+}
+
 func TestParseCoverageLineFailsOnInvalidLines(t *testing.T) {
 	_, _, err := parseCoverageLine("main.go")
 	assert.NotNil(t, err)
@@ -39,14 +49,15 @@ func TestParseCoverageLineOfParsesValidLineCorrectly(t *testing.T) {
 
 func TestParseCoverage(t *testing.T) {
 
-	// note: in this integrative test the package path must match the actual
+	// note: in this integrative test, the package path must match the actual
 	// repository name of this project.
 	cov := `mode: set
 github.com/jandelgado/gcov2lcov/main.go:6.14,8.3 2 1`
 
 	reader := strings.NewReader(cov)
-	res := parseCoverage(reader)
+	res, err := parseCoverage(reader)
 
+	assert.NoError(t, err)
 	assert.Equal(t, 1, len(res))
 	for k, blks := range res {
 		assert.Equal(t, 1, len(blks))
@@ -60,3 +71,31 @@ github.com/jandelgado/gcov2lcov/main.go:6.14,8.3 2 1`
 		assert.Equal(t, 1, b.covered)
 	}
 }
+
+func TestConvertCoverage(t *testing.T) {
+	// note: in this integrative test, the package path must match the actual
+	// repository name of this project. Format:
+	//   name.go:line.column,line.column numberOfStatements count
+	cov := `mode: set
+github.com/jandelgado/gcov2lcov/main.go:6.14,8.3 2 1
+github.com/jandelgado/gcov2lcov/main.go:7.14,9.3 2 0
+github.com/jandelgado/gcov2lcov/main.go:10.1,11.10 2 2`
+
+	in := strings.NewReader(cov)
+	out := bytes.NewBufferString("")
+	err := convertCoverage(in, out)
+
+	expected := `TN:
+SF:main.go
+DA:6,1
+DA:7,1
+DA:8,1
+DA:10,2
+DA:11,2
+LF:5
+LH:7
+end_of_record
+`
+	assert.NoError(t, err)
+	assert.Equal(t, expected, out.String())
+}

testdata/coverage.out

@@ -1,3 +1,4 @@
 mode: set
 github.com/jandelgado/gcov2lcov/main.go:45.44,49.38 4 1
+github.com/jandelgado/gcov2lcov/main.go:46.44,50.38 4 0
 github.com/jandelgado/gcov2lcov/main.go:58.2,58.32 1 1