Generate function name, and description based on input and return values (#957)

* Generate function name, and description based on input and return values

Author: bokimilinkovic

test-crawler/collector/collector.go

@@ -1,9 +1,12 @@
 package collector
 
 import (
+	"bytes"
+	"fmt"
 	"os"
 	"path/filepath"
 	"strings"
+	"unicode"
 
 	a "testsuites/annotations"
 )
@@ -33,7 +36,7 @@ type FunctionAnnotation struct {
 	Name         string `yaml:"name"`
 	InputParams  string `yaml:"inputParams"`
 	ReturnValues string `yaml:"returnValues"`
-	Description  string
+	Description  string `yaml:"description"`
 	Public       bool
 }
 
@@ -126,3 +129,33 @@ func ListGoFilesInFolder(root string, ignore []string) (system string, files []s
 
 	return "", nil, nil
 }
+
+// GenerateMethodName generates name adding underscore and usecase index
+// ex: name: ListenProofRequest -> LISTEN_PROOF_REQUEST_001
+func GenerateMethodName(funcName string) string {
+	usecase := "001" // in the future it will be autoincremented depending how many return cases we have.
+	buf := &bytes.Buffer{}
+	for i, rune := range funcName {
+		if unicode.IsUpper(rune) && i > 0 {
+			buf.WriteRune('_')
+		}
+		buf.WriteRune(rune)
+	}
+
+	return fmt.Sprintf("%s_%s", strings.ToUpper(buf.String()), usecase)
+}
+
+// GenerateMethodDescription generates description based on inputParams, returnParams
+func GenerateMethodDescription(f FunctionAnnotation) string {
+	var dsc string
+	if f.Description == "" {
+		dsc = "Function description not set."
+		if (f.InputParams != "" && f.InputParams != "()") && f.ReturnValues != "" {
+			dsc = fmt.Sprintf(`Given a %s, returns %s`, f.InputParams, f.ReturnValues)
+		} else if (f.InputParams == "" || f.InputParams == "()") && f.ReturnValues != "" {
+			dsc = fmt.Sprintf(`Returns %s`, f.ReturnValues)
+		}
+	}
+
+	return dsc
+}

test-crawler/crawler_test.go

@@ -21,19 +21,19 @@ func TestCrawlSingleFileForFunctions(t *testing.T) {
 		t.Errorf("got %q, expected %q methods", len(fnsAnn), 2)
 	}
 
-	assert.Equal(t, "HelloEvent", fnsAnn[0].Name)
+	assert.Equal(t, "HELLO_EVENT_001", 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, "HELLO_EVENT_WITH_PARAMETER_001", fnsAnn[1].Name)
 	assert.Equal(t, "(param string)", fnsAnn[1].InputParams)
 	assert.Equal(t, "(string, error)", fnsAnn[1].ReturnValues)
 
-	assert.Equal(t, "FunctionWithoutParameters", fnsAnn[2].Name)
+	assert.Equal(t, "FUNCTION_WITHOUT_PARAMETERS_001", fnsAnn[2].Name)
 	assert.Equal(t, "()", fnsAnn[2].InputParams)
 	assert.Equal(t, "", fnsAnn[2].ReturnValues)
 
-	assert.Equal(t, "FunctionWithPointerReturnValue", fnsAnn[3].Name)
+	assert.Equal(t, "FUNCTION_WITH_POINTER_RETURN_VALUE_001", fnsAnn[3].Name)
 	assert.Equal(t, "()", fnsAnn[3].InputParams)
 	assert.Equal(t, "*Event", fnsAnn[3].ReturnValues)
 }

test-crawler/extractor/extractor.go

@@ -279,14 +279,18 @@ func getFunctionNodes(content string, treeCursor *sitter.TreeCursor, parser *a.P
 					returnValueType == string(TYPE_IDENTIFIER) {
 					returnValues = content[child.Child(4).StartByte():child.Child(4).EndByte()]
 				}
+				funcAnn := c.FunctionAnnotation{
+					Name:         funcName,
+					Public:       isPublic(funcName),
+					InputParams:  params,
+					ReturnValues: returnValues,
+				}
+				funcAnn.Name = c.GenerateMethodName(funcAnn.Name)
+				funcAnn.Description = c.GenerateMethodDescription(funcAnn)
+
 				funcAnnoPair = append(funcAnnoPair, FunctionAnnotationNode{
-					Node: child,
-					Function: c.FunctionAnnotation{
-						Name:         funcName,
-						Public:       isPublic(funcName),
-						InputParams:  params,
-						ReturnValues: returnValues,
-					},
+					Node:     child,
+					Function: funcAnn,
 				})
 			}
 			prevNode = child