Write unit test with mocked golang file used for parsing methods

Author: bokimilinkovic

test-crawler/go.mod

@@ -2,6 +2,13 @@ module testsuites
 
 go 1.17
 
-require github.com/smacker/go-tree-sitter v0.0.0-20211116060328-db7fde9b5e82
+require (
+	github.com/smacker/go-tree-sitter v0.0.0-20211116060328-db7fde9b5e82
+	github.com/stretchr/testify v1.4.0
+)
 
-require gopkg.in/yaml.v2 v2.4.0 // indirect
+require (
+	github.com/davecgh/go-spew v1.1.0 // indirect
+	github.com/pmezard/go-difflib v1.0.0 // indirect
+	gopkg.in/yaml.v2 v2.4.0
+)

test-crawler/go.sum

@@ -7,8 +7,8 @@ github.com/smacker/go-tree-sitter v0.0.0-20211116060328-db7fde9b5e82/go.mod h1:E
 github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
 github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
 github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
+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.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
 gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
 gopkg.in/yaml.v2 v2.4.0 h1:D8xgwECY7CYvx+Y2n4sBz93Jn9JRvxdiyyo8CTfuKaY=
 gopkg.in/yaml.v2 v2.4.0/go.mod h1:RDklbk79AGWmwhnvt/jBztapEOGDOx6ZbXqjP6csGnQ=

test-crawler/main.go

@@ -27,7 +27,6 @@ func main() {
 	config := NewConfig()
 
 	crawlRepoBehaviorsAndSaveToJSON(config)
-	crawlSingleFileForMethods("../repo-to-crawl/system/subsystem/file.go") // // ex: ../repo-to-crawl/venus-gateway/proofevent/proof_event.go
 }
 
 func crawlRepoBehaviorsAndSaveToJSON(config Config) {

test-crawler/main_test.go

@@ -0,0 +1,27 @@
+package main
+
+import (
+	"context"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestExtractPublicMethodsFromFile(t *testing.T) {
+	fnsAnn, err := extractPublicMethodsFromFile(context.Background(), "./mocks/event.go")
+	if err != nil {
+		t.Errorf("got error: %v", err.Error())
+	}
+
+	if len(fnsAnn) != 2 {
+		t.Errorf("got %q, expected %q methods", len(fnsAnn), 2)
+	}
+
+	assert.Equal(t, "HelloEvent", fnsAnn[0].Name)
+	assert.Equal(t, "()", fnsAnn[0].InputParams)      // input param
+	assert.Equal(t, "string", fnsAnn[0].ReturnValues) // return param
+
+	assert.Equal(t, "HelloEventWithParameter", fnsAnn[1].Name)
+	assert.Equal(t, "(param string)", fnsAnn[1].InputParams)
+	assert.Equal(t, "(string, error)", fnsAnn[1].ReturnValues)
+}

test-crawler/mocks/event.go

@@ -0,0 +1,31 @@
+package mocks
+
+import (
+	"errors"
+	"fmt"
+	"time"
+)
+
+type Event struct {
+	ID string `json:"id"`
+}
+
+func NewEvent() *Event {
+	return &Event{
+		ID: time.Now().String(),
+	}
+}
+
+// HelloEvent simple method that just formats message.
+func (e *Event) HelloEvent() string {
+	return fmt.Sprintf("Simple HelloEvent")
+}
+
+// HelloEventWithParameter accepts one param that got formated in message.
+func (e *Event) HelloEventWithParameter(param string) (string, error) {
+	if param == "" {
+		return "", errors.New("no param provided")
+	}
+
+	return fmt.Sprintf("HelloEventWithParameter: %v", param), nil
+}