Add sources to coverage.py formatter (#247)

- coverage.py formatter was not parsing <source> tags. Making
  format-coverage to fail when it was run in a different working
  directory to the directory the tests ran
- Updates integration-test for coverage.py so it runs on a
  different working directory.

Author: Ale Paredes

formatters/coveragepy/coveragepy.go

@@ -41,30 +41,32 @@ func (r *Formatter) Format() (formatters.Report, error) {
 		return rep, errors.WithStack(err)
 	}
 
-	c := &xmlFile{}
-	err = xml.NewDecoder(fx).Decode(c)
+	coverageFile := &xmlFile{}
+	err = xml.NewDecoder(fx).Decode(coverageFile)
 	if err != nil {
 		return rep, errors.WithStack(err)
 	}
 
 	gitHead, _ := env.GetHead()
-	for _, pp := range c.Packages {
-		for _, cc := range pp.Classes {
-			sf, err := formatters.NewSourceFile(cc.FileName, gitHead)
+	for _, xmlPackage := range coverageFile.Packages {
+		for _, xmlClass := range xmlPackage.Classes {
+			fileName := coverageFile.getFullFilePath(xmlClass.FileName)
+			logrus.Debugf("creating test file report for %s", fileName)
+			sourceFile, err := formatters.NewSourceFile(fileName, gitHead)
 			if err != nil {
 				return rep, errors.WithStack(err)
 			}
 			num := 1
-			for _, l := range cc.Lines {
+			for _, l := range xmlClass.Lines {
 				for num < l.Number {
-					sf.Coverage = append(sf.Coverage, formatters.NullInt{})
+					sourceFile.Coverage = append(sourceFile.Coverage, formatters.NullInt{})
 					num++
 				}
 				ni := formatters.NewNullInt(l.Hits)
-				sf.Coverage = append(sf.Coverage, ni)
+				sourceFile.Coverage = append(sourceFile.Coverage, ni)
 				num++
 			}
-			err = rep.AddSourceFile(sf)
+			err = rep.AddSourceFile(sourceFile)
 			if err != nil {
 				return rep, errors.WithStack(err)
 			}

formatters/coveragepy/xml.go

@@ -1,9 +1,18 @@
 package coveragepy
 
-import "encoding/xml"
+import (
+	"encoding/xml"
+	"fmt"
+	"os"
+)
+
+type Source struct {
+	Path string `xml:",chardata"`
+}
 
 type xmlFile struct {
 	XMLName  xml.Name `xml:"coverage"`
+	Sources  []Source `xml:"sources>source"`
 	Packages []struct {
 		Name    string `xml:"name,attr"`
 		Classes []struct {
@@ -15,3 +24,16 @@ type xmlFile struct {
 		} `xml:"classes>class"`
 	} `xml:"packages>package"`
 }
+
+func (covpyFile xmlFile) getFullFilePath(filename string) string {
+	fullFilePath := filename
+
+	for _, source := range covpyFile.Sources {
+		filepath := fmt.Sprintf("%s/%s", source.Path, filename)
+		if _, err := os.Stat(filepath); err == nil {
+			fullFilePath = filepath
+			break
+		}
+	}
+	return fullFilePath
+}

integration-tests/coverage_py/Dockerfile

@@ -29,7 +29,8 @@ RUN git config --global user.name "Your Name"
 RUN git add ignore.me
 RUN git commit -m "testing"
 
+WORKDIR ..
 ENV CC_TEST_REPORTER_ID=c4881e09870b0fac1291c93339b36ffe36210a2645c1ad25e52d8fda3943fb4d
-RUN test-reporter format-coverage -d
+RUN test-reporter format-coverage -d -t coverage.py python-test-reporter/coverage.xml
 RUN cat coverage/codeclimate.json
 RUN test-reporter upload-coverage -d -s 2