Add function without comment in mock and test and add description for it

Author: StefanGajic

test-crawler/collector/collector.go

@@ -145,19 +145,10 @@ func GenerateMethodName(funcName string) string {
 	return fmt.Sprintf("%s_%s", strings.ToUpper(buf.String()), usecase)
 }
 
-// GenerateMethodDescription generates description based on inputParams, returnParams
+// GenerateMethodDescription generates description based on comment.
 func GenerateMethodDescription(f FunctionAnnotation) 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
-	} else {
-		return f.Description
+		return "Function description not set."
 	}
-
-	return "Function description not set."
+	return f.Description
 }

test-crawler/crawler_test.go

@@ -17,7 +17,7 @@ func TestCrawlSingleFileForFunctions(t *testing.T) {
 		t.Errorf("got error: %v", err.Error())
 	}
 
-	if len(fnsAnn) != 4 {
+	if len(fnsAnn) != 5 {
 		t.Errorf("got %q, expected %q methods", len(fnsAnn), 2)
 	}
 
@@ -38,9 +38,13 @@ func TestCrawlSingleFileForFunctions(t *testing.T) {
 
 	assert.Equal(t, "// FunctionWithPointerReturnValue returns a simple pointer value.", fnsAnn[3].Description)
 	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)
+
+	assert.Equal(t, "Function description not set.", fnsAnn[4].Description)
+	assert.Equal(t, "FUNCTION_WITHOUT_COMMENT_001", fnsAnn[4].Name)
+	assert.Equal(t, "()", fnsAnn[4].InputParams)
+	assert.Equal(t, "*Event", fnsAnn[4].ReturnValues)
 }
 
 func TestMakeYAML(t *testing.T) {

test-crawler/mocks/event.go

@@ -39,3 +39,7 @@ func (e *Event) FunctionWithoutParameters() {
 func (e *Event) FunctionWithPointerReturnValue() *Event {
 	return &Event{}
 }
+
+func (e *Event) FunctionWithoutComment() *Event {
+	return &Event{}
+}