Adds Go check support (#240)

* gocheck test

* test

* fix golinkname

* go check first instrumentation

* initial scope support for go-checks

* enabling coverage for go-checks

* remove branch fail checks

* go fmt

* fix test

* changes

* removes results from the parent TestingT from scope

* add support to ignore retries for a single testing.T, remove retries for gocheck

* refactoring and func to check if a test needs a retry

* start implementation of runner test execution handler

* adds support of cached test and retries in go-check

* fail retries workflow configuration

* adds support for expected failures type of errors

* comments

* adds log support

* logger fix

* change messages

* adds go-check to the autoinstrument package

* change the source root info with the code

* fixes logs

* fix windows path

Author: tonyredondo

.github/workflows/go.yml

@@ -32,6 +32,8 @@ jobs:
           SCOPE_DEBUG: true
           SCOPE_RUNNER_ENABLED: true
           SCOPE_RUNNER_EXCLUDE_BRANCHES: master
+          SCOPE_TESTING_FAIL_RETRIES: 3
+          SCOPE_TESTING_PANIC_AS_FAIL: true
 
       - name: Upload Scope logs
         if: always()

ast/sources.go

@@ -1,6 +1,7 @@
 package ast
 
 import (
+	"fmt"
 	"go/ast"
 	"go/parser"
 	"go/token"
@@ -84,9 +85,26 @@ func getCodesForFile(file string) (map[string]*MethodCodeBoundaries, error) {
 					if bPos.IsValid() && bEnd.IsValid() {
 						pos := fSet.PositionFor(bPos, true)
 						end := fSet.PositionFor(bEnd, true)
+						var instTypes []string
+						if fDecl.Recv != nil && fDecl.Recv.List != nil {
+							for _, recv := range fDecl.Recv.List {
+								if recVStarExpr, ok := recv.Type.(*ast.StarExpr); ok {
+									if recVStarExprIdent, ok := recVStarExpr.X.(*ast.Ident); ok {
+										instTypes = append(instTypes, fmt.Sprintf("*%s", recVStarExprIdent.Name))
+									}
+								} else if recVIdent, ok := recv.Type.(*ast.Ident); ok {
+									instTypes = append(instTypes, recVIdent.Name)
+								}
+							}
+						}
+						name := ""
+						if instTypes != nil {
+							name = fmt.Sprintf("(%s).", strings.Join(instTypes, ", "))
+						}
+						name = name + fDecl.Name.String()
 						methodCode := MethodCodeBoundaries{
 							Package: packageName,
-							Name:    fDecl.Name.String(),
+							Name:    name,
 							File:    file,
 							Start: CodePos{
 								Line:   pos.Line,

autoinstrument/init.go

@@ -10,6 +10,7 @@ import (
 	"go.undefinedlabs.com/scopeagent"
 	"go.undefinedlabs.com/scopeagent/agent"
 	"go.undefinedlabs.com/scopeagent/instrumentation"
+	scopegocheck "go.undefinedlabs.com/scopeagent/instrumentation/gocheck"
 	scopetesting "go.undefinedlabs.com/scopeagent/instrumentation/testing"
 )
 
@@ -39,6 +40,8 @@ func init() {
 			return scopeagent.Run(m, agent.WithGlobalPanicHandler())
 		})
 		logOnError(err)
+
+		scopegocheck.Init()
 	})
 }
 

go.mod

@@ -9,18 +9,18 @@ require (
 	github.com/gogo/protobuf v1.3.1
 	github.com/golang/protobuf v1.4.2 // indirect
 	github.com/google/uuid v1.1.1
-	github.com/kr/pretty v0.2.0 // indirect
 	github.com/mitchellh/go-homedir v1.1.0
+	github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e // indirect
 	github.com/opentracing/basictracer-go v1.1.0
 	github.com/opentracing/opentracing-go v1.1.0
 	github.com/sirupsen/logrus v1.6.0
 	github.com/stretchr/testify v1.5.1
 	github.com/undefinedlabs/go-mpatch v1.0.3
 	github.com/vmihailenco/msgpack v4.0.4+incompatible
-	golang.org/x/net v0.0.0-20200519113804-d87ec0cfa476
+	golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7
 	golang.org/x/sys v0.0.0-20200519105757-fe76b779f299 // indirect
 	google.golang.org/appengine v1.6.6 // indirect
 	google.golang.org/grpc v1.29.1
-	gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
+	gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f
 	gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637
 )

go.sum

@@ -43,13 +43,13 @@ github.com/kisielk/errcheck v1.2.0/go.mod h1:/BMXB+zMLi60iA8Vv6Ksmxu/1UDYcXs4uQL
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
 github.com/konsorten/go-windows-terminal-sequences v1.0.3 h1:CE8S1cTafDpPvMhIxNJKvHsGVBgn1xWYf1NbHQhywc8=
 github.com/konsorten/go-windows-terminal-sequences v1.0.3/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
-github.com/kr/pretty v0.2.0 h1:s5hAObm+yFO5uHYt5dYjxi2rXrsnmRpJx4OYvIWUaQs=
-github.com/kr/pretty v0.2.0/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
 github.com/mitchellh/go-homedir v1.1.0 h1:lukF9ziXFxDFPkA1vsr5zpc1XuPDn/wFntq5mG+4E0Y=
 github.com/mitchellh/go-homedir v1.1.0/go.mod h1:SfyaCUpYCn1Vlf4IUYiD9fPX4A5wJrkLzIz1N1q0pr0=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e h1:fD57ERR4JtEqsWbfPhv4DMiApHyliiK5xCTNVSPiaAs=
+github.com/niemeyer/pretty v0.0.0-20200227124842-a10e7caefd8e/go.mod h1:zD1mROLANZcx1PVRCS0qkT7pwLkGfwJo4zjcN/Tysno=
 github.com/opentracing/basictracer-go v1.1.0 h1:Oa1fTSBvAl8pa3U+IJYqrKm0NALwH9OsgwOqDv4xJW0=
 github.com/opentracing/basictracer-go v1.1.0/go.mod h1:V2HZueSJEp879yv285Aap1BS69fQMD+MNP1mRs6mBQc=
 github.com/opentracing/opentracing-go v1.1.0 h1:pWlfV3Bxv7k65HYwkikxat0+s3pV4bsqf19k25Ur8rU=
@@ -83,8 +83,8 @@ golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn
 golang.org/x/net v0.0.0-20190603091049-60506f45cf65/go.mod h1:HSz+uSET+XFnRR8LxR5pz3Of3rY3CfYBVs4xY44aLks=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
 golang.org/x/net v0.0.0-20200421231249-e086a090c8fd/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
-golang.org/x/net v0.0.0-20200519113804-d87ec0cfa476 h1:E7ct1C6/33eOdrGZKMoyntcEvs2dwZnDe30crG5vpYU=
-golang.org/x/net v0.0.0-20200519113804-d87ec0cfa476/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
+golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7 h1:AeiKBIuRw3UomYXSbLy0Mc2dDLfdtbT/IVn4keq83P0=
+golang.org/x/net v0.0.0-20200520004742-59133d7f0dd7/go.mod h1:qpuaurCH72eLCgpAm/N6yyVIVM9cpaDIP3A8BGJEC5A=
 golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U=
 golang.org/x/sync v0.0.0-20180314180146-1d60e4601c6f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
 golang.org/x/sync v0.0.0-20181108010431-42b317875d0f/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -125,13 +125,12 @@ google.golang.org/protobuf v0.0.0-20200109180630-ec00e32a8dfd/go.mod h1:DFci5gLY
 google.golang.org/protobuf v0.0.0-20200221191635-4d8936d0db64/go.mod h1:kwYJMbMJ01Woi6D6+Kah6886xMZcty6N08ah7+eCXa0=
 google.golang.org/protobuf v0.0.0-20200228230310-ab0ca4ff8a60/go.mod h1:cfTl7dwQJ+fmap5saPgwCLgHXTUD7jkjRqWcaiX5VyM=
 google.golang.org/protobuf v1.20.1-0.20200309200217-e05f789c0967/go.mod h1:A+miEFZTKqfCUM6K7xSMQL9OKL/b6hQv+e19PK+JZNE=
-google.golang.org/protobuf v1.21.0 h1:qdOKuR/EIArgaWNjetjgTzgVTAZ+S/WXVrq9HW9zimw=
 google.golang.org/protobuf v1.21.0/go.mod h1:47Nbq4nVaFHyn7ilMalzfO3qCViNmqZ2kzikPIcrTAo=
 google.golang.org/protobuf v1.23.0 h1:4MY060fB1DLGMB/7MBTLnwQUY6+F09GEiz6SsrNqyzM=
 google.golang.org/protobuf v1.23.0/go.mod h1:EGpADcykh3NcUnDUJcl1+ZksZNG86OlYog2l/sGQquU=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
-gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 h1:YR8cESwS4TdDjEe65xsg0ogRM/Nc3DYOhEAlW+xobZo=
-gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f h1:BLraFXnmrev5lT+xlilqcH8XK9/i0At2xKjWk4p6zsU=
+gopkg.in/check.v1 v1.0.0-20200227125254-8fa46927fb4f/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637 h1:yiW+nvdHb9LVqSHQBXfZCieqV4fzYhNBql77zY0ykqs=
 gopkg.in/tomb.v2 v2.0.0-20161208151619-d5d1b5820637/go.mod h1:BHsqpu/nsuzkT5BpiH1EMZPLyqSMM8JbIavyFACoFNk=
 gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=

instrumentation/testing/coverage.go renamed to instrumentation/coverage/coverage.go

@@ -1,4 +1,4 @@
-package testing
+package coverage
 
 import (
 	"bytes"
@@ -80,7 +80,7 @@ func initCoverage() {
 }
 
 // Clean the counters for a new coverage session
-func startCoverage() {
+func StartCoverage() {
 	countersMutex.Lock()
 	defer countersMutex.Unlock()
 	if cover.Mode == "" {
@@ -97,7 +97,7 @@ func startCoverage() {
 }
 
 // Restore counters
-func restoreCoverageCounters() {
+func RestoreCoverageCounters() {
 	countersMutex.Lock()
 	defer countersMutex.Unlock()
 	if cover.Mode == "" {
@@ -111,7 +111,7 @@ func restoreCoverageCounters() {
 }
 
 // Get the counters values and extract the coverage info
-func endCoverage() *coverage {
+func EndCoverage() *coverage {
 	countersMutex.Lock()
 	defer countersMutex.Unlock()
 	if cover.Mode == "" {

instrumentation/gocheck/gocheck_test.go

@@ -0,0 +1,75 @@
+package gocheck
+
+import (
+	"os"
+	"testing"
+
+	. "gopkg.in/check.v1"
+
+	"go.undefinedlabs.com/scopeagent"
+	"go.undefinedlabs.com/scopeagent/agent"
+	scopetesting "go.undefinedlabs.com/scopeagent/instrumentation/testing"
+)
+
+var (
+	failCount     = 0
+	fatalCount    = 0
+	panicCount    = 0
+	expectedCount = 0
+	errorCount    = 0
+)
+
+func TestMain(m *testing.M) {
+	scopetesting.PatchTestingLogger()
+	defer scopetesting.UnpatchTestingLogger()
+	Init()
+	os.Exit(scopeagent.Run(m, agent.WithGlobalPanicHandler()))
+}
+
+// Hook up gocheck into the "go test" runner.
+func TestM(t *testing.T) {
+	TestingT(t)
+}
+
+type MySuite struct{}
+
+var _ = Suite(&MySuite{})
+
+func (s *MySuite) TestPass(c *C) {
+	c.Log("Hello", "World")
+	c.Logf("Hello: %v", "World 2")
+}
+func (s *MySuite) TestSkip(c *C) {
+	c.Skip("My skip reason")
+}
+func (s *MySuite) TestFail(c *C) {
+	if failCount < 2 {
+		failCount++
+		c.Fail()
+	}
+}
+func (s *MySuite) TestFatal(c *C) {
+	if fatalCount < 2 {
+		fatalCount++
+		c.Fatal("fatal error")
+	}
+}
+func (s *MySuite) TestPanic(c *C) {
+	if panicCount < 2 {
+		panicCount++
+		panic("Custom panic")
+	}
+}
+func (s *MySuite) TestExpected(c *C) {
+	c.ExpectFailure("expected failure")
+	expectedCount++
+	if expectedCount > 2 {
+		c.Fail()
+	}
+}
+func (s *MySuite) TestError(c *C) {
+	if errorCount < 2 {
+		errorCount++
+		c.Error("This is an error")
+	}
+}