pkg/csplugin: constructors for PluginConfig, PluginConfigList (#3640)

Author: mmetc

cmd/crowdsec-cli/clinotifications/notifications.go

@@ -93,13 +93,17 @@ func (cli *cliNotifications) getPluginConfigs() (map[string]csplugin.PluginConfi
 
 		name := filepath.Join(cfg.ConfigPaths.NotificationDir, info.Name()) // Avoid calling info.Name() twice
 		if (strings.HasSuffix(name, "yaml") || strings.HasSuffix(name, "yml")) && !(info.IsDir()) {
-			ts, err := csplugin.ParsePluginConfigFile(name)
+			fin, err := os.Open(name)
 			if err != nil {
-				return fmt.Errorf("loading notifification plugin configuration with %s: %w", name, err)
+				return fmt.Errorf("opening %s: %w", name, err)
+			}
+
+			ts, err := csplugin.NewPluginConfigList(fin)
+			if err != nil {
+				return fmt.Errorf("loading notification plugin configuration with %s: %w", name, err)
 			}
 
 			for _, t := range ts {
-				csplugin.SetRequiredFields(&t)
 				pcfgs[t.Name] = t
 			}
 		}

pkg/csplugin/broker.go

@@ -68,6 +68,34 @@ type PluginConfig struct {
 	Config map[string]any `yaml:",inline"` // to keep the plugin-specific config
 }
 
+// UnmarshalYAML implements yaml.Unmarshaler.
+func (pc *PluginConfig) UnmarshalYAML(unmarshal func(any) error) error {
+	type raw PluginConfig
+	aux := raw{}
+
+	if err := unmarshal(&aux); err != nil {
+		return err
+	}
+
+	if aux.Type == "" {
+		return errors.New("missing required field 'type'")
+	}
+
+	if aux.MaxRetry == 0 {
+		aux.MaxRetry = 1
+	}
+
+	if aux.TimeOut == 0 {
+		aux.TimeOut = time.Second * 5
+	}
+
+	*pc = PluginConfig(aux)
+	return nil
+}
+
+type PluginConfigList []PluginConfig
+
+
 func (pb *PluginBroker) Init(ctx context.Context, pluginCfg *csconfig.PluginCfg, profileConfigs []*csconfig.ProfileCfg, configPaths *csconfig.ConfigurationPaths) error {
 	pb.PluginChannel = make(chan models.ProfileAlert)
 	pb.notificationConfigsByPluginType = make(map[string][][]byte)
@@ -195,14 +223,17 @@ func (pb *PluginBroker) loadConfig(path string) error {
 			continue
 		}
 
-		pluginConfigs, err := ParsePluginConfigFile(configFilePath)
+		fin, err := os.Open(configFilePath)
 		if err != nil {
-			return err
+			return fmt.Errorf("while opening %s: %w", configFilePath, err)
 		}
 
-		for _, pluginConfig := range pluginConfigs {
-			SetRequiredFields(&pluginConfig)
+		pluginConfigs, err := NewPluginConfigList(fin)
+		if err != nil {
+			return fmt.Errorf("error in %s: %w", configFilePath, err)
+		}
 
+		for _, pluginConfig := range pluginConfigs {
 			if _, ok := pb.pluginConfigByName[pluginConfig.Name]; ok {
 				log.Warningf("notification '%s' is defined multiple times", pluginConfig.Name)
 			}
@@ -392,15 +423,10 @@ func (pb *PluginBroker) pushNotificationsToPlugin(ctx context.Context, pluginNam
 	return err
 }
 
-func ParsePluginConfigFile(path string) ([]PluginConfig, error) {
-	parsedConfigs := make([]PluginConfig, 0)
-
-	yamlFile, err := os.Open(path)
-	if err != nil {
-		return nil, fmt.Errorf("while opening %s: %w", path, err)
-	}
+func NewPluginConfigList(fin io.Reader) (PluginConfigList, error) {
+	parsedConfigs := make(PluginConfigList, 0)
 
-	dec := yaml.NewDecoder(yamlFile)
+	dec := yaml.NewDecoder(fin)
 	dec.SetStrict(true)
 
 	idx := -1
@@ -410,40 +436,26 @@ func ParsePluginConfigFile(path string) ([]PluginConfig, error) {
 
 		idx += 1
 
-		err = dec.Decode(&pc)
+		err := dec.Decode(&pc)
 		if err != nil {
 			if errors.Is(err, io.EOF) {
 				break
 			}
 
-			return nil, fmt.Errorf("while decoding %s got error %s", path, err)
+			return nil, fmt.Errorf("document %d: %w", idx, err)
 		}
 
 		// if the yaml document is empty, skip
 		if reflect.DeepEqual(pc, PluginConfig{}) {
 			continue
 		}
 
-		if pc.Type == "" {
-			return nil, fmt.Errorf("field 'type' missing in %s (position %d)", path, idx)
-		}
-
 		parsedConfigs = append(parsedConfigs, pc)
 	}
 
 	return parsedConfigs, nil
 }
 
-func SetRequiredFields(pluginCfg *PluginConfig) {
-	if pluginCfg.MaxRetry == 0 {
-		pluginCfg.MaxRetry++
-	}
-
-	if pluginCfg.TimeOut == time.Second*0 {
-		pluginCfg.TimeOut = time.Second * 5
-	}
-}
-
 func getUUID() (string, error) {
 	uuidv4, err := uuid.NewRandom()
 	if err != nil {

test/bats/72_plugin_badconfig.bats

@@ -139,7 +139,7 @@ teardown() {
     # the slack plugin may fail or not, but we just need the logs
     config_set '.common.log_media="stdout"'
     rune wait-for \
-        --err "api server init: plugin broker: loading plugin config" \
+        --err "api server init: plugin broker: loading config" \
         "$CROWDSEC"
-    assert_stderr --partial "field 'type' missing in $CONFIG_DIR/notifications/http.yaml (position 0)"
+    assert_stderr --partial "error in $CONFIG_DIR/notifications/http.yaml: document 0: missing required field 'type'"
 }