Improve tests. Update configuration examples

Author: LucaRocco

examples/config/global_config.json

@@ -15,11 +15,35 @@
         "info"
     ],
     "metrics": false,
-    "output": [
-        "json"
-    ],
+    "output": {
+        "destinations": [
+            {
+                "name": "default_destination",
+                "type": "file",
+                "path": "stdout",
+                "url": "",
+                "format": "table"
+            }
+        ],
+        "streams": [
+            {
+                "name": "default_stream",
+                "destinations": [
+                    "default_destination"
+                ],
+                "filters": {
+                    "events": [],
+                    "policies": []
+                },
+                "buffer": {
+                    "mode": "block",
+                    "size": 1024
+                }
+            }
+        ]
+    },
     "perf-buffer-size": 1024,
     "pprof": false,
     "pyroscope": false,
     "signatures-dir": ""
-}
+}

examples/config/global_config.yaml

@@ -112,56 +112,25 @@ scope:
 metrics: false
 
 output:
-    json:
-        files:
-            - stdout
-
-    # table:
-    #     files:
-    #         - /path/to/table1.out
-    #         - /path/to/table2.out
-
-    # table-verbose:
-    #     files:
-    #         - stdout
-
-    # gotemplate:
-    #     template: /path/to/my_template1.tmpl
-    #     files:
-    #         - /path/to/output1.out
-    #         - /path/to/output2.out
-
-    # forward:
-    #     - forward1:
-    #         protocol: tcp
-    #         user: user
-    #         password: pass
-    #         host: 127.0.0.1
-    #         port: 24224
-    #         tag: tracee1
-    #     - forward2:
-    #         protocol: udp
-    #         user: user
-    #         password: pass
-    #         host: 127.0.0.1
-    #         port: 24225
-    #         tag: tracee2
-
-    # webhook:
-    #     - webhook1:
-    #         protocol: http
-    #         host: localhost
-    #         port: 8000
-    #         timeout: 5s
-    #         gotemplate: /path/to/template/test.tmpl
-    #         content-type: application/json
-    #     - webhook2:
-    #         protocol: http
-    #         host: localhost
-    #         port: 9000
-    #         timeout: 3s
-    #         gotemplate: /path/to/template/test.tmpl
-    #         content-type: application/json
+    # destinations:
+    #   - name: destination_name
+    #     type: file | webhook | forward
+    #     path: path in case of type == file
+    #     url: url in case of type == webhook or type == forward
+    #     format: json | gotemplate=/path/to/template.tpl | table | table-verbose
+    
+    # streams:
+    #   - name: stream_name
+    #     destinations: 
+    #       - destination_name
+    #     filters:
+    #       events:
+    #         - event_to_filter
+    #       policies:
+    #         - policy_to_filter
+    #     buffer:
+    #       mode: drop
+    #       size: 1024
 
     # options:
     #     none: false

pkg/cmd/cobra/cobra.go

@@ -285,7 +285,7 @@ func GetTraceeRunner(c *cobra.Command, version string) (cmd.Runner, error) {
 
 		cfg.Output = output.TraceeConfig
 	} else {
-		outputConfig, err := getStructuredOutputConfig()
+		outputConfig, err := GetStructuredOutputConfig()
 		if err != nil {
 			return runner, err
 		}

pkg/cmd/cobra/config.go

@@ -3,6 +3,7 @@ package cobra
 import (
 	"fmt"
 	"os"
+	"strings"
 
 	"github.com/spf13/viper"
 
@@ -354,24 +355,33 @@ func isStructured(key string) bool {
 	return ok
 }
 
-func getStructuredOutputConfig() (*OutputConfig, error) {
+// GetStructuredOutputConfig gets the output from config file
+// and returns an error if the validation goes wrong. Exported for testing
+func GetStructuredOutputConfig() (*OutputConfig, error) {
 	var output OutputConfig
 	err := viper.UnmarshalKey("output", &output)
 	if err != nil {
 		return nil, err
 	}
 
-	// validation
+	if err := output.ValidateOrDefaults(); err != nil {
+		return nil, err
+	}
+
+	return &output, nil
+}
+
+func (output *OutputConfig) ValidateOrDefaults() error {
 	for _, stream := range output.Streams {
 		if stream.Name == "" {
-			return nil, errfmt.Errorf("validaiton error: name is mandatory for streams")
+			return errfmt.Errorf("validation error: name is mandatory for streams")
 		}
 	}
 
 	for dIdx := range output.Destinations {
 		destination := &output.Destinations[dIdx]
 		if destination.Name == "" {
-			return nil, errfmt.Errorf("validaiton error: name is mandatory for destinations")
+			return errfmt.Errorf("validation error: name is mandatory for destinations")
 		}
 
 		if destination.Type == "" {
@@ -384,11 +394,22 @@ func getStructuredOutputConfig() (*OutputConfig, error) {
 
 		if (destination.Type == "webhook" || destination.Type == "forward") &&
 			destination.Url == "" {
-			return nil, errfmt.Errorf("validaiton error: url is mandatory in destination for %s", destination.Type)
+			return errfmt.Errorf("validation error: url is mandatory in destination for %s", destination.Type)
+		}
+
+		if destination.Format != "json" && destination.Format != "table" &&
+			destination.Format != "table-verbose" && !strings.HasPrefix(destination.Format, "gotemplate=") {
+			return errfmt.Errorf("validation error: destination format %s not valid for destination %s",
+				destination.Format, destination.Name)
+		}
+
+		if destination.Type != "file" && destination.Type != "webhook" && destination.Type != "forward" {
+			return errfmt.Errorf("validation error: destination type %s not valid for destination %s",
+				destination.Type, destination.Name)
 		}
 	}
 
-	return &output, nil
+	return nil
 }
 
 // The following structures are very similar to the ones defined in pkg/config/config.go.