Merge pull request #945 from filecoin-project/feature/STM2

VEN-2 | Generate a basic YAML file

Author: StefanGajic

test-crawler/collector/collector.go

@@ -29,6 +29,7 @@ type Function struct {
 }
 
 type FunctionAnnotation struct {
+	ID           int    `yaml:"id"`
 	Name         string `yaml:"name"`
 	InputParams  string `yaml:"inputParams"`
 	ReturnValues string `yaml:"returnValues"`

test-crawler/main.go

@@ -5,6 +5,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"io/ioutil"
 	"os"
 	"os/exec"
 	"strings"
@@ -13,6 +14,8 @@ import (
 	a "testsuites/annotations"
 	c "testsuites/collector"
 	ex "testsuites/extractor"
+
+	y "gopkg.in/yaml.v2"
 )
 
 type FnLink struct {
@@ -27,6 +30,7 @@ func main() {
 	config := NewConfig()
 
 	crawlRepoBehaviorsAndSaveToJSON(config)
+
 }
 
 func crawlRepoBehaviorsAndSaveToJSON(config Config) {
@@ -87,7 +91,8 @@ func crawlSingleFileForMethods(path string) {
 	}
 	for _, fn := range fns {
 		fmt.Printf(
-			"name %s : public %v : params: %s : return values : %s\n",
+			"ID %d : name %s : public %v : params: %s : return values : %s\n",
+			fn.ID,
 			fn.Name,
 			fn.Public,
 			fn.InputParams,
@@ -100,6 +105,32 @@ func extractPublicMethodsFromFile(ctx context.Context, filePath string) ([]c.Fun
 	return ex.GetExportedFunctions(ctx, filePath)
 }
 
+// makeYAML will make yaml file from public methods.
+func makeYAML(ctx context.Context, filePath string) error {
+
+	publicMethods, err := extractPublicMethodsFromFile(ctx, filePath)
+	if err != nil {
+		fmt.Print(err)
+		os.Exit(1)
+	}
+
+	for i := 0; i < len(publicMethods); i++ {
+		publicMethods[i].ID = i
+	}
+
+	yamlData, err := y.Marshal(&publicMethods)
+	if err != nil {
+		fmt.Printf("Error while Marshaling. %v", err)
+	}
+
+	fileName := "test.yaml"
+	err = ioutil.WriteFile(fileName, yamlData, 0644)
+	if err != nil {
+		panic("Unable to write data into the file")
+	}
+	return nil
+}
+
 func linkFiles(flist []c.Function) (links [][]FnLink) {
 
 	functions := make(map[string]c.Function)

test-crawler/make_yaml_test.go

@@ -0,0 +1,52 @@
+package main
+
+import (
+	"testing"
+	c "testsuites/collector"
+
+	y "gopkg.in/yaml.v2"
+
+	"github.com/stretchr/testify/assert"
+
+	"io/ioutil"
+)
+
+func TestMakeYAML(t *testing.T) {
+
+	yaml := []c.FunctionAnnotation{
+		{
+			ID:           1,
+			Name:         "SomeName",
+			InputParams:  "(ctx context.Context, param Parameters)",
+			ReturnValues: "error",
+			Description:  "",
+			Public:       true,
+		},
+		{
+			ID:           2,
+			Name:         "SomeName2",
+			InputParams:  "(ctx context.Context, param2 Parameters2)",
+			ReturnValues: "error",
+			Description:  "",
+			Public:       true,
+		},
+	}
+
+	yamlData, err := y.Marshal(&yaml)
+	if err != nil {
+		t.Errorf("got error: %v", err.Error())
+	}
+	fileName := "test.yaml"
+	err = ioutil.WriteFile(fileName, yamlData, 0644)
+	if err != nil {
+		panic("Unable to write data into the file")
+	}
+
+	bytes, err := ioutil.ReadFile(fileName)
+	if err != nil {
+		t.Errorf("got error: %v", err.Error())
+	}
+
+	assert.Equal(t, yamlData, bytes)
+
+}