Make simplecov json formatter more flexible (#488)

* Make simplecov json formatter more flexible

* add tests

* bump circleci xcode version

* read simplecov version from report to fallback to legacy formatter

Author: f-moya

.circleci/config.yml

@@ -9,7 +9,7 @@ linux_image: &linux_image
 
 macos_image: &macos_image
   macos:
-    xcode: "11.3.0"
+    xcode: "11.4.0"
 
 setup_macos_env: &setup_macos_env
 

formatters/simplecov/json_formatter.go

@@ -3,6 +3,7 @@ package simplecov
 import (
 	"encoding/json"
 	"os"
+	"fmt"
 
 	"github.com/Sirupsen/logrus"
 	"github.com/codeclimate/test-reporter/env"
@@ -31,6 +32,19 @@ type simplecovJsonFormatterReport struct {
 	CoverageType map[string]fileCoverage `json:"coverage"`
 }
 
+func reportIsOnLegacyFormat(simplecovVersion string) bool {
+	var major, minor, patch int
+	fmt.Sscanf(simplecovVersion, "%d.%d.%d", &major, &minor, &patch)
+
+	if major < 1 {
+		if minor < 18 {
+			return true
+		}
+	}
+
+	return false
+}
+
 func transformLineCoverageToCoverage(ln []interface{}) formatters.Coverage {
 	coverage := make([]formatters.NullInt, len(ln))
 	ignoredLine := formatters.NullInt{-1, false}
@@ -61,14 +75,17 @@ func jsonFormat(r Formatter, rep formatters.Report) (formatters.Report, error) {
 
 	var m simplecovJsonFormatterReport
 	decoder := json.NewDecoder(jf)
-	decoder.DisallowUnknownFields()
 
 	err = decoder.Decode(&m)
 
 	if err != nil {
 		return rep, errors.WithStack(err)
 	}
 
+	if reportIsOnLegacyFormat(m.Meta.SimpleCovVersion) {
+		return rep, errors.WithStack(errors.Errorf("Simplecov report is on legacy format, falling back to legacy formatter."))
+	}
+
 	gitHead, _ := env.GetHead()
 	for n, ls := range m.CoverageType {
 		fe, err := formatters.NewSourceFile(n, gitHead)

formatters/simplecov/simplecov-with-groups.json

@@ -0,0 +1,158 @@
+{
+  "meta": {
+    "simplecov_version": "0.19.0"
+  },
+  "coverage": {
+    "development/mygem/lib/mygem/errors.rb": {
+      "lines": [
+        1,
+        null,
+        1,
+        1,
+        0,
+        null,
+        null,
+        null,
+        1,
+        null,
+        null,
+        null,
+        1,
+        null,
+        null,
+        null,
+        1,
+        null,
+        null,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/definition_manager.rb": {
+      "lines": [
+        1,
+        1,
+        1,
+        null,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        1,
+        8,
+        null,
+        null,
+        1,
+        19,
+        null,
+        null,
+        1,
+        null,
+        1,
+        8,
+        null,
+        null,
+        1,
+        11,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/interface.rb": {
+      "lines": [
+        1,
+        null,
+        1,
+        1,
+        null,
+        1,
+        8,
+        null,
+        null,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/implements.rb": {
+      "lines": [
+        1,
+        null,
+        1,
+        9,
+        null,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/implementation_manager.rb": {
+      "lines": [
+        1,
+        1,
+        1,
+        null,
+        1,
+        null,
+        1,
+        1,
+        null,
+        null,
+        1,
+        9,
+        null,
+        null,
+        1,
+        82,
+        null,
+        null,
+        1,
+        null,
+        1,
+        9,
+        null,
+        null,
+        1,
+        73,
+        null,
+        null,
+        null,
+        null,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/wrap.rb": {
+      "lines": [
+        1,
+        null,
+        1,
+        17,
+        20,
+        16,
+        16,
+        12,
+        null,
+        null
+      ]
+    },
+    "development/mygem/lib/mygem/type_check.rb": {
+      "lines": [
+        1,
+        null,
+        1,
+        7,
+        7,
+        7,
+        null,
+        null,
+        null
+      ]
+    }
+  },
+  "groups": {}
+}

formatters/simplecov/simplecov_test.go

@@ -248,3 +248,30 @@ func Test_Format_Merged(t *testing.T) {
 	assert.Equal(lc.Missed, 2)
 	assert.Equal(lc.Total, 8)
 }
+
+func Test_ParseWithGroups(t *testing.T) {
+	ogb := env.GitBlob
+	defer func() {
+		env.GitBlob = ogb
+	}()
+	env.GitBlob = func(s string, c *object.Commit) (string, error) {
+		return s, nil
+	}
+
+	assert := require.New(t)
+
+	formatter := Formatter{
+		Path: "./simplecov-with-groups.json",
+	}
+	rep, err := formatter.Format()
+	assert.NoError(err)
+
+	assert.Len(rep.SourceFiles, 7)
+
+	cf := rep.SourceFiles["development/mygem/lib/mygem/wrap.rb"]
+	assert.Len(cf.Coverage, 10)
+	for i, x := range []interface{}{1, nil, 1, 17, 20, 16, 16, 12, nil, nil} {
+		l := cf.Coverage[i]
+		assert.Equal(x, l.Interface())
+	}
+}