Missed instruction part of PR comments (#18)

* detailed info on pr comments

* missed instructions part of pr

* formatting issues

* linting fixes

* vela compatible

* plugin source dir

* debugging

* dummy commit

* dummy commit

* skipping if thats a missed instructions

* moved common to utils

Author: Vishal Vaibhav

.vela.yml

@@ -18,13 +18,13 @@ build: &build
 check-pr-code-coverage: &check-pr-code-coverage
   image: alpine:latest
   environment:
-    - PLUGIN_COVERAGE_FILE=./coverage.xml
-    - PLUGIN_COVERAGE_TYPE=cobertura
-    - PLUGIN_SOURCE_DIRS=git.target.com/searchoss/pull-request-code-coverage
+    - PARAMETER_COVERAGE_FILE=./coverage.xml
+    - PARAMETER_COVERAGE_TYPE=cobertura
+    - PARAMETER_SOURCE_DIRS=/vela/src/git.target.com/TargetOSS/pull-request-code-coverage
     - PLUGIN_RUN_DIR=bin
-    - PLUGIN_GH_API_BASE_URL=https://git.target.com
+    - PARAMETER_GH_API_BASE_URL=https://git.target.com
   secrets:
-    - source: pull_request_api_key
+    - source: github_pr_token
       target: plugin_gh_api_key
   commands:
     - apk --no-cache add ca-certificates git bash openssh-client
@@ -75,8 +75,6 @@ steps:
         - master
       event:
         - pull_request
-    when:
-      event: [pull_request]
 
   - name: docker-pull-request
     image: docker.target.com/vela-plugins/docker:v0.2.3-1
@@ -119,4 +117,7 @@ secrets:
     key: tap/vela-secrets/ARTIFACTORY_SVCPEJKN001_BINREPO
     engine: native
     type: shared
+  - name: github_pr_token
+    engine: native
+    type: repo
 

go.mod

@@ -3,10 +3,8 @@ module git.target.com/searchoss/pull-request-code-coverage
 go 1.13
 
 require (
-	github.com/konsorten/go-windows-terminal-sequences v1.0.1
-	github.com/nicksnyder/go-i18n v1.10.1
 	github.com/pkg/errors v0.9.1
 	github.com/sirupsen/logrus v1.2.0
-	github.com/stretchr/testify v1.2.2
+	github.com/stretchr/testify v1.4.0
 
 )

go.sum

@@ -1,27 +1,61 @@
-git.target.com/searchoss/pull-request-code-coverage v0.0.0-20200404215431-8064a445bf4c h1:Z0rjclOT23umt1IOd9wvwBxzNYEmRhAz9ElEj1UmHrM=
-git.target.com/searchoss/pull-request-code-coverage v0.0.0-20200404215431-8064a445bf4c/go.mod h1:1KzCU08X6A2gF4AQDeA1jXUhWfbjr3SdqK+skf5jRFU=
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
 github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/gin-contrib/sse v0.1.0 h1:Y/yl/+YNO8GZSjAhjMsSuLt29uWRFHdHYUb5lYOV9qE=
+github.com/gin-contrib/sse v0.1.0/go.mod h1:RHrZQHXnP2xjPF+u1gW/2HnVO7nvIa9PG3Gm+fLHvGI=
+github.com/gin-gonic/gin v1.6.3 h1:ahKqKTFpO5KTPHxWZjEdPScmYaGtLo8Y4DMHoEsnp14=
+github.com/gin-gonic/gin v1.6.3/go.mod h1:75u5sXoLsGZoRN5Sgbi1eraJ4GU3++wFwWzhwvtwp4M=
+github.com/go-playground/assert/v2 v2.0.1 h1:MsBgLAaY856+nPRTKrp3/OZK38U/wa0CcBYNjji3q3A=
+github.com/go-playground/assert/v2 v2.0.1/go.mod h1:VDjEfimB/XKnb+ZQfWdccd7VUvScMdVu0Titje2rxJ4=
+github.com/go-playground/locales v0.13.0 h1:HyWk6mgj5qFqCT5fjGBuRArbVDfE4hi8+e8ceBS/t7Q=
+github.com/go-playground/locales v0.13.0/go.mod h1:taPMhCMXrRLJO55olJkUXHZBHCxTMfnGwq/HNwmWNS8=
+github.com/go-playground/universal-translator v0.17.0 h1:icxd5fm+REJzpZx7ZfpaD876Lmtgy7VtROAbHHXk8no=
+github.com/go-playground/universal-translator v0.17.0/go.mod h1:UkSxE5sNxxRwHyU+Scu5vgOQjsIJAF8j9muTVoKLVtA=
+github.com/go-playground/validator/v10 v10.2.0 h1:KgJ0snyC2R9VXYN2rneOtQcw5aHQB1Vv0sFl1UcHBOY=
+github.com/go-playground/validator/v10 v10.2.0/go.mod h1:uOYAAleCW8F/7oMFd6aG0GOhaH6EGOAJShg8Id5JGkI=
+github.com/golang/protobuf v1.3.3 h1:gyjaxf+svBWX08ZjK86iN9geUJF0H6gp2IRKX6Nf6/I=
+github.com/golang/protobuf v1.3.3/go.mod h1:vzj43D7+SQXF/4pzW/hwtAqwc6iTitCiVSaWz5lYuqw=
+github.com/google/gofuzz v1.0.0/go.mod h1:dBl0BpW6vV/+mYPU4Po3pmUjxk6FQPldtuIdl/M65Eg=
+github.com/json-iterator/go v1.1.9 h1:9yzud/Ht36ygwatGx56VwCZtlI/2AD15T1X2sjSuGns=
+github.com/json-iterator/go v1.1.9/go.mod h1:KdQUCv79m/52Kvf8AW2vK1V8akMuk1QjK/uOdHXbAo4=
+github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
 github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
-github.com/nicksnyder/go-i18n v1.10.1/go.mod h1:e4Di5xjP9oTVrC6y3C7C0HoSYXjSbhh/dU0eUV32nB4=
-github.com/pelletier/go-toml v1.2.0/go.mod h1:5z9KED0ma1S8pY6P1sdut58dfprrGBbd/94hg7ilaic=
+github.com/leodido/go-urn v1.2.0 h1:hpXL4XnriNwQ/ABnpepYM/1vCLWNDfUNts8dX3xTG6Y=
+github.com/leodido/go-urn v1.2.0/go.mod h1:+8+nEpDfqqsY+g338gtMEUOtuK+4dEMhiQEgxpxOKII=
+github.com/mattn/go-isatty v0.0.12 h1:wuysRhFDzyxgEmMf5xjvJ2M9dZoWAXNNr5LSBS7uHXY=
+github.com/mattn/go-isatty v0.0.12/go.mod h1:cbi8OIDigv2wuxKPP5vlRcQ1OAZbq2CE4Kysco4FUpU=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421 h1:ZqeYNhU3OHLH3mGKHDcjJRFFRrJa6eAM5H+CtDdOsPc=
+github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
+github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742 h1:Esafd1046DLDQ0W1YjYsBW+p8U2u7vzgW2SQVmlNazg=
+github.com/modern-go/reflect2 v0.0.0-20180701023420-4b7aa43c6742/go.mod h1:bx2lNnkwVCuqBIxFjflWJWanXIb3RllmbCylyMrvgv0=
 github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4=
 github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0=
 github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
 github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
 github.com/sirupsen/logrus v1.2.0 h1:juTguoYk5qI21pwyTXY3B3Y5cOTH3ZUyZCg1v/mihuo=
 github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/objx v0.1.1 h1:2vfRuCMp5sSVIDSqO8oNnWJq7mPa6KVP3iPIwFBuy8A=
 github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.2.2 h1:bSDNvY7ZPG5RlJ8otE/7V6gMiyenm9RtJ7IUVIAoJ1w=
 github.com/stretchr/testify v1.2.2/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
+github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI=
+github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
+github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo=
+github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
+github.com/ugorji/go/codec v1.1.7 h1:2SvQaVZ1ouYrrKKwoSk2pzd4A9evlKJb9oTL+OaLUSs=
+github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793 h1:u+LnwYTOOW7Ukr/fppxEb1Nwz0AtPflrblfvUudpo+I=
 golang.org/x/crypto v0.0.0-20180904163835-0709b304e793/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
-golang.org/x/crypto v0.0.0-20181106171534-e4dc69e5b2fd h1:VtIkGDhk0ph3t+THbvXHfMZ8QHgsBO39Nh52+74pq7w=
-golang.org/x/crypto v0.0.0-20181106171534-e4dc69e5b2fd/go.mod h1:6SG95UA2DQfeDnfUPMdvaQW0Q7yPrPDi9nlGo2tz2b4=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33 h1:I6FyU15t786LL7oL/hn43zqTuEGr4PN7F4XJ1p4E3Y8=
 golang.org/x/sys v0.0.0-20180905080454-ebe1bf3edb33/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
-golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8 h1:YoY1wS6JYVRpIfFngRf2HHo9R9dAne3xbkGOQ5rJXjU=
-golang.org/x/sys v0.0.0-20181107165924-66b7b1311ac8/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42 h1:vEOn+mP2zCOVzKckCZy6YsCtDblrpj/w7B9nxGNELpg=
+golang.org/x/sys v0.0.0-20200116001909-b77594299b42/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
+golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk=
+golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/yaml.v2 v2.2.1/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
+gopkg.in/yaml.v2 v2.2.8 h1:obN1ZagJSUGI0Ek/LBmuj4SNLPfIny3KsKFopxRdj10=
+gopkg.in/yaml.v2 v2.2.8/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=

internal/plugin/reporter/github_pr.go

@@ -90,6 +90,14 @@ func (s *GithubPullRequest) createCommentBody(changedLinesWithCoverage domain.So
 	if len(modules) > 0 {
 		summaryLines = append(summaryLines, fmt.Sprintf("*Modules: %v*\n\n", strings.Join(modules, ", ")))
 	}
+	var missedInstructions string
+
+	for _, r := range changedLinesWithCoverage {
+		if r.MissedInstructionCount > 0 {
+			missedInstructions += fmt.Sprintf("--- %v\n", lineDescription(r.SourceLine))
+			missedInstructions += fmt.Sprintf("%v\n", r.LineValue)
+		}
+	}
 
 	summaryLines = append(summaryLines, generateSummaryLines(changedLinesWithCoverage, func(linesWithDataCount int, linesWithoutDataCount int, covered int, missed int) []string {
 		totalLines := linesWithDataCount + linesWithoutDataCount
@@ -105,7 +113,16 @@ func (s *GithubPullRequest) createCommentBody(changedLinesWithCoverage domain.So
 
 		return result
 	})...)
-	summary := strings.Join(summaryLines, "")
+
+	var summary string
+	if missedInstructions == "" {
+		summary = strings.Join(summaryLines, "")
+	} else {
+
+		summaryWithoutInstructions := strings.Join(summaryLines, "")
+		summary = summaryWithoutInstructions + "\n<details><summary>Missed Instructions summary</summary>\n\n" + "```\n" + missedInstructions + "```" +
+			"\n</details>"
+	}
 
 	data := map[string]string{
 		"body": summary,

internal/plugin/reporter/simple.go

@@ -2,9 +2,9 @@ package reporter
 
 import (
 	"fmt"
+
 	"io"
 	"log"
-	"strings"
 
 	"git.target.com/searchoss/pull-request-code-coverage/internal/plugin/domain"
 )
@@ -27,7 +27,7 @@ func (s *Simple) Write(changedLinesWithCoverage domain.SourceLineCoverageReport)
 	s.printf("Missed Instructions:\n")
 	for _, r := range changedLinesWithCoverage {
 		if r.MissedInstructionCount > 0 {
-			s.printf("--- %v\n", s.lineDescription(r.SourceLine))
+			s.printf("--- %v\n", lineDescription(r.SourceLine))
 			s.printf("%v\n", r.LineValue)
 		}
 	}
@@ -92,18 +92,3 @@ func (s *Simple) print(str string) {
 		log.Panic(err)
 	}
 }
-
-func (s *Simple) lineDescription(l domain.SourceLine) string {
-	rawFileNameParts := []string{
-		l.Module, l.SrcDir, l.Pkg, l.FileName,
-	}
-
-	fileNameParts := []string{}
-	for _, part := range rawFileNameParts {
-		if len(part) > 0 {
-			fileNameParts = append(fileNameParts, part)
-		}
-	}
-
-	return fmt.Sprintf("%v:%v", strings.Join(fileNameParts, "/"), l.LineNumber)
-}

internal/plugin/reporter/utils.go

@@ -0,0 +1,23 @@
+package reporter
+
+import (
+	"fmt"
+	"strings"
+
+	"git.target.com/searchoss/pull-request-code-coverage/internal/plugin/domain"
+)
+
+func lineDescription(l domain.SourceLine) string {
+	rawFileNameParts := []string{
+		l.Module, l.SrcDir, l.Pkg, l.FileName,
+	}
+
+	var fileNameParts []string
+	for _, part := range rawFileNameParts {
+		if len(part) > 0 {
+			fileNameParts = append(fileNameParts, part)
+		}
+	}
+
+	return fmt.Sprintf("%v:%v", strings.Join(fileNameParts, "/"), l.LineNumber)
+}

internal/plugin/runner_test.go

@@ -117,7 +117,22 @@ Lines Without Coverage Data -> 92% (2216)
 Lines With Coverage Data    -> 8% (182)
 Covered Instructions        -> **97%** (177)
 Missed Instructions         -> 3% (5)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- internal/plugin/runner.go:72
+func GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {
+--- main.go:10
+	err := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)
+--- main.go:12
+	if err != nil {
+--- main.go:13
+		log.WithFields(log.Fields{
+--- main.go:17
+		os.Exit(1)
+` +
+				"```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)
@@ -172,7 +187,22 @@ Lines Without Coverage Data -> 92% (2216)
 Lines With Coverage Data    -> 8% (182)
 Covered Instructions        -> **97%** (177)
 Missed Instructions         -> 3% (5)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- internal/plugin/runner.go:72
+func GetCoverageReportLoader(coverageType string, sourceDir string) coverage.Loader {
+--- main.go:10
+	err := plugin.NewRunner().Run(os.LookupEnv, os.Stdin, os.Stdout)
+--- main.go:12
+	if err != nil {
+--- main.go:13
+		log.WithFields(log.Fields{
+--- main.go:17
+		os.Exit(1)
+` +
+				"```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)
@@ -220,7 +250,14 @@ Lines Without Coverage Data -> 78% (7)
 Lines With Coverage Data    -> 22% (2)
 Covered Instructions        -> **73%** (8)
 Missed Instructions         -> 27% (3)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
+    System.out.print("Something");
+` +
+				"```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)
@@ -279,7 +316,14 @@ Lines Without Coverage Data -> 78% (7)
 Lines With Coverage Data    -> 22% (2)
 Covered Instructions        -> **73%** (8)
 Missed Instructions         -> 27% (3)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
+    System.out.print("Something");
+` +
+				"```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)
@@ -330,7 +374,15 @@ Lines Without Coverage Data -> 47% (7)
 Lines With Coverage Data    -> 53% (8)
 Covered Instructions        -> **88%** (42)
 Missed Instructions         -> 12% (6)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
+    System.out.print("Something");
+--- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12
+    System.out.print("Something2");
+` + "```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)
@@ -393,7 +445,16 @@ Lines Without Coverage Data -> 47% (7)
 Lines With Coverage Data    -> 53% (8)
 Covered Instructions        -> **88%** (42)
 Missed Instructions         -> 12% (6)
-`,
+
+<details><summary>Missed Instructions summary</summary>
+
+` + "```" + `
+--- category-search/src/main/java/com/tgt/CategorySearchApplication.java:52
+    System.out.print("Something");
+--- category-search/src/main/kotlin/com/tgt/SomeOtherClass.kt:12
+    System.out.print("Something2");
+` +
+				"```\n</details>",
 		})
 
 		propGetter.AssertExpectations(t)