fix: ensure sink names are unique (#1599)

Author: nherment

src/robusta/core/model/runner_config.py

@@ -1,5 +1,5 @@
 import base64
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Optional, Union, cast
 
 from pydantic import BaseModel, SecretStr, root_validator, validator
 
@@ -29,6 +29,7 @@
 from robusta.model.alert_relabel_config import AlertRelabel
 from robusta.model.playbook_definition import PlaybookDefinition
 from robusta.utils.base64_utils import is_base64_encoded
+from robusta.core.sinks.sink_config import SinkConfigBase
 
 
 class PlaybookRepo(BaseModel):
@@ -81,6 +82,19 @@ class RunnerConfig(BaseModel):
     active_playbooks: Optional[List[PlaybookDefinition]] = []
     alert_relabel: Optional[List[AlertRelabel]] = []
 
+    @root_validator()
+    def ensure_unique_sink_name(cls, val: Dict) -> Dict:
+        if val.get('sinks_config'):
+            value_set = set()
+            sinksConfig = cast(List[SinkConfigBase], val.get('sinks_config'))
+            for sink_config in sinksConfig:
+                sink_name = sink_config.get_name()
+                if sink_name in value_set:
+                    raise ValueError(f"Sink name \"{sink_name}\" is already defined. Sink names must be unique.")
+
+                value_set.add(sink_name)
+        return val
+
     @validator("playbook_repos")
     def env_var_repo_keys(cls, playbook_repos: Dict[str, PlaybookRepo]):
         return {k: RunnerConfig._replace_env_var_in_playbook_repo(v) for k, v in playbook_repos.items()}

tests/file_fixtures/config_validation/invalid_dupl_sink_names.yaml

@@ -0,0 +1,22 @@
+playbook_repos:
+  chatgpt_robusta_actions:
+    url: "file:///path/to/kubernetes-chatgpt-bot"
+sinks_config:
+  - slack_sink:
+      name: my_sink1
+      slack_channel: my-alert-channel
+      api_key: "foobar"
+      scope:
+        include:
+          - labels:
+              - "severity=high"
+              - "severity=critical"
+
+  - slack_sink:
+      name: my_sink1
+      slack_channel: my-notification-channel
+      api_key: "foobar"
+      scope:
+        include:
+          - labels:
+              - "severity=warning"

tests/file_fixtures/config_validation/valid_config.yaml

@@ -0,0 +1,22 @@
+playbook_repos:
+  chatgpt_robusta_actions:
+    url: "file:///path/to/kubernetes-chatgpt-bot"
+sinks_config:
+  - slack_sink:
+      name: my_sink1
+      slack_channel: my-alert-channel
+      api_key: "foobar"
+      scope:
+        include:
+          - labels:
+              - "severity=high"
+              - "severity=critical"
+
+  - slack_sink:
+      name: my_sink2
+      slack_channel: my-notification-channel
+      api_key: "foobar"
+      scope:
+        include:
+          - labels:
+              - "severity=warning"

tests/test_config_validation.py

@@ -0,0 +1,23 @@
+import pytest
+import yaml
+import os
+from pydantic import ValidationError
+from robusta.core.model.runner_config import RunnerConfig
+
+FIXTURES = os.path.join(os.path.dirname(__file__), "file_fixtures", "config_validation")
+FIXTURE_VALID_CONFIG_FILE_PATH = os.path.join(FIXTURES, "valid_config.yaml")
+FIXTURE_DUPL_SINKS_NAME_FILE_PATH = os.path.join(FIXTURES, "invalid_dupl_sink_names.yaml")
+
+class TestSinkValidation:
+
+    def test_valid_sink_config(self):
+        with open(FIXTURE_VALID_CONFIG_FILE_PATH) as file:
+            yaml_content = yaml.safe_load(file)
+            config = RunnerConfig(**yaml_content)
+
+    def test_duplicate_sink_names(self):
+        with open(FIXTURE_DUPL_SINKS_NAME_FILE_PATH) as file:
+            yaml_content = yaml.safe_load(file)
+            with pytest.raises(ValidationError) as validation_error:
+                config = RunnerConfig(**yaml_content)
+            assert f'Sink name "my_sink1" is already defined. Sink names must be unique.' in str(validation_error)