VEN-7 | Refactor and improve config file (#958)

* VEN-7 | Refactor and improve config file

Author: bokimilinkovic

test-crawler/config.go

@@ -15,12 +15,16 @@ const (
 )
 
 type Config struct {
-	Paths      []string   `yaml:"paths"`
-	OutputMode OutputMode `yaml:"output"`
-	OutputDir  string     `yaml:"output_dir"`
-	Language   string     `yaml:"lang_mode"`
-	IndentJSON bool       `yaml:"indent_json"`
-	Ignore     []string   `yaml:"ignore"`
+	TestCrawlerPaths      []string   `yaml:"test_crawler_paths"`
+	TestCrawlerOutputMode OutputMode `yaml:"test_crawler_output"`
+	TestCrawlerOutputDir  string     `yaml:"test_crawler_output_dir"`
+	TestCrawlerLanguage   string     `yaml:"test_crawler_lang_mode"`
+	TestCrawlerIndentJSON bool       `yaml:"test_crawler_indent_json"`
+	TestCrawlerIgnore     []string   `yaml:"test_crawler_ignore"`
+
+	BehaviorGenPaths     []string `yaml:"behavior_gen_paths"`
+	BehaviorGenIgnore    []string `yaml:"behavior_gen_ignore"`
+	BehaviorGenOutputDir string   `yaml:"behavior_gen_output_dir"`
 }
 
 const filename string = "config.yaml"
@@ -50,9 +54,9 @@ func NewConfig() Config {
 
 func Default() Config {
 	return Config{
-		Paths:      []string{"_modules/lotus"},
-		OutputMode: "stdout",
-		Language:   "auto",
-		IndentJSON: false,
+		TestCrawlerPaths:      []string{"_modules/lotus"},
+		TestCrawlerOutputMode: "stdout",
+		TestCrawlerLanguage:   "auto",
+		TestCrawlerIndentJSON: false,
 	}
 }

test-crawler/config.yaml

@@ -1,12 +1,17 @@
 # list of paths to directories that should be crawled
-paths: ["../repo-to-crawl"]
+test_crawler_paths: ["../repo-to-crawl"]
 # stdout or file(json)
-output: stdout
+test_crawler_output: stdout
 # if output is file, choose directory
-output_dir: outputs
+test_crawler_output_dir: outputs
 # auto or one of the supported languages for specific repo
-lang_mode: go
+test_crawler_lang_mode: go
 # should the output JSON be indented
-indent_json: true
+test_crawler_indent_json: true
 # ignore paths
-ignore: ["extern"]
+test_crawler_ignore: ["extern"]
+
+### Behavior catalogue related vars
+behavior_gen_paths: ["../repo-to-crawl"]
+behavior_gen_ignore: [".github","cmds","config","docker","docs","extern","integrate_test"]
+behavior_gen_output_dir: outputs/catalogue

test-crawler/config_test.go

@@ -0,0 +1,45 @@
+package main
+
+import (
+	"io/ioutil"
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v2"
+)
+
+func TestNewConfig(t *testing.T) {
+	cfg := Config{
+		TestCrawlerPaths:      []string{"a", "b"},
+		TestCrawlerOutputMode: "stdout",
+		TestCrawlerOutputDir:  "output",
+		TestCrawlerLanguage:   "go",
+		TestCrawlerIndentJSON: true,
+		TestCrawlerIgnore:     []string{"extern"},
+
+		BehaviorGenPaths:     []string{"c", "d"},
+		BehaviorGenIgnore:    []string{".git"},
+		BehaviorGenOutputDir: "output/catalogue",
+	}
+
+	f, err := os.CreateTemp("", "config-test.yml")
+	require.Nil(t, err)
+	defer f.Close()
+	defer os.Remove(f.Name())
+
+	configBytes, err := yaml.Marshal(&cfg)
+	assert.NoError(t, err)
+
+	assert.NoError(t, ioutil.WriteFile(f.Name(), configBytes, 0644))
+
+	var configFromFile Config
+	fileContent, err := ioutil.ReadFile(f.Name())
+	assert.NoError(t, err)
+
+	err = yaml.Unmarshal(fileContent, &configFromFile)
+	assert.NoError(t, err)
+
+	assert.Equal(t, cfg, configFromFile)
+}

test-crawler/main.go

@@ -37,8 +37,8 @@ func crawlRepoBehaviorsAndSaveToJSON(config Config) {
 	allFiles := make(map[c.FileID]*c.TestFile)
 	var fileFunctions []c.Function
 
-	for _, path := range config.Paths {
-		files, err := c.GetTestFiles(path, config.Ignore)
+	for _, path := range config.TestCrawlerPaths {
+		files, err := c.GetTestFiles(path, config.TestCrawlerIgnore)
 		if err != nil {
 			fmt.Println(err)
 			return
@@ -78,7 +78,7 @@ func crawlRepoBehaviorsAndSaveToJSON(config Config) {
 
 	result := filterFilesWhereChildIsRoot(allFiles)
 
-	Save(result, config.OutputMode, config.OutputDir, config.IndentJSON)
+	Save(result, config.TestCrawlerOutputMode, config.TestCrawlerOutputDir, config.TestCrawlerIndentJSON)
 }
 
 // crawlSingleFileForMethods accepts path of single go file,