feat: reattach event streams when rulebook changes

Perform source swapping at activation editing when event source
mapping is provided, no matter a new rulebook is selected or not.
Clear existing event stream maaping if a new rulebook is selected
but no event source mapping is provided.

AAP-37298: Reattach event streams when rulebook has changed

Author: bzwei

src/aap_eda/api/serializers/activation.py

@@ -585,9 +585,20 @@ def prepare_update(self, activation: models.Activation):
         else:
             vault_data = VaultData()
         if self.validated_data.get("source_mappings", []):
+            if not rulebook_id:
+                # load the original ruleset
+                self.validated_data[
+                    "rulebook_rulesets"
+                ] = activation.rulebook.rulesets
+
+            # update with new event streams
             self.validated_data[
                 "rulebook_rulesets"
             ] = _update_event_stream_source(self.validated_data, vault_data)
+        elif rulebook_id:
+            # user selects a rulebook but no mapping, clear existing mappings
+            self.validated_data["source_mappings"] = ""
+            self.validated_data["event_streams"] = []
 
         if self.validated_data.get("eda_credentials"):
             _update_extra_vars_from_eda_credentials(
@@ -611,8 +622,8 @@ def update(
         self, instance: models.Activation, validated_data: dict
     ) -> None:
         update_fields = []
-        eda_credentials = []
-        event_streams = []
+        eda_credentials = None
+        event_streams = None
         for key, value in validated_data.items():
             if key == "eda_credentials":
                 eda_credentials = value
@@ -624,10 +635,16 @@ def update(
             update_fields.append(key)
 
         instance.save(update_fields=update_fields)
-        if eda_credentials:
-            instance.eda_credentials.set(eda_credentials)
-        if event_streams:
-            instance.event_streams.set(event_streams)
+        if eda_credentials is not None:
+            if eda_credentials:
+                instance.eda_credentials.set(eda_credentials)
+            else:
+                instance.eda_credentials.clear()
+        if event_streams is not None:
+            if event_streams:
+                instance.event_streams.set(event_streams)
+            else:
+                instance.event_streams.clear()
 
     def to_representation(self, activation):
         extra_var = (
@@ -1193,7 +1210,7 @@ def _validate_sources_with_event_streams(data: dict) -> None:
         if source_map["rulebook_hash"] != rulebook_hash:
             msg = (
                 "Rulebook has changed since the sources were mapped. "
-                "Please reattach Event streams again"
+                "Please reattach event streams"
             )
 
             raise serializers.ValidationError(

tests/integration/api/test_activation_with_event_stream.py

@@ -558,7 +558,7 @@ def test_create_activation_with_bad_rulebook_hash(
     assert response.status_code == status.HTTP_400_BAD_REQUEST
     assert str(response.data[SOURCE_MAPPING_ERROR_KEY][0]) == (
         "Rulebook has changed since the sources were mapped."
-        " Please reattach Event streams again"
+        " Please reattach event streams"
     )
 
 
@@ -811,25 +811,20 @@ def test_update_activation_with_everything(
                 "source_name": f"{DEFAULT_SOURCE_NAME_PREFIX}1",
             }
         )
-    # to be enabled in another PR
-    """
     test_activation2["source_mappings"] = yaml.dump(source_mappings2)
-    """
+
     response = admin_client.patch(
         f"{api_url_v1}/activations/{activation_id}/", data=test_activation2
     )
-    assert response.status_code == status.HTTP_200_OK
-    data = response.data
-    activation = models.Activation.objects.filter(id=data["id"]).first()
-    assert activation.rulebook_name == f"{TEST_RULEBOOK['name']}2"
-    """
-    swapped_ruleset = yaml.safe_load(activation.rulebook_rulesets)
-    assert sorted(swapped_ruleset[0]["sources"][0].keys()) == [
-       "ansible.eda.pg_listener",
-       "name",
-    ]
-    assert data["event_streams"][0]["name"] == "demo-2"
-    """
+    assert_updated_event_stream_mapping(
+        response,
+        ["ansible.eda.pg_listener", "name"],
+        test_activation2["source_mappings"],
+        "demo-2",
+    )
+    activation = models.Activation.objects.filter(
+        id=response.data["id"]
+    ).first()
     for key, val in test_activation2.items():
         if key == "extra_var":
             assert activation.extra_var == (
@@ -842,6 +837,63 @@ def test_update_activation_with_everything(
             assert activation.eda_credentials.all()[0].id == val[0]
             continue
         if key == "source_mappings":
-            assert activation.source_mappings.strip() == val.strip()
             continue
         assert getattr(activation, key) == val
+
+    # test unchanged event stream mapping
+    test_activation3 = {"name": "name3"}
+    response = admin_client.patch(
+        f"{api_url_v1}/activations/{activation_id}/", data=test_activation3
+    )
+    assert_updated_event_stream_mapping(
+        response,
+        ["ansible.eda.pg_listener", "name"],
+        test_activation2["source_mappings"],
+        "demo-2",
+    )
+
+    # test only changing event stream mapping
+    source_mappings = []
+    for event_stream in fks["event_streams"]:
+        source_mappings.append(
+            {
+                "event_stream_name": event_stream.name,
+                "event_stream_id": event_stream.id,
+                "rulebook_hash": get_rulebook_hash(LEGACY_TEST_RULESETS),
+                "source_name": f"{DEFAULT_SOURCE_NAME_PREFIX}1",
+            }
+        )
+    test_activation4 = {"source_mappings": yaml.dump(source_mappings)}
+    response = admin_client.patch(
+        f"{api_url_v1}/activations/{activation_id}/", data=test_activation4
+    )
+    assert_updated_event_stream_mapping(
+        response,
+        ["ansible.eda.pg_listener", "name"],
+        test_activation4["source_mappings"],
+        "demo",
+    )
+
+    # test clearing event stream mapping
+    test_activation5 = {"rulebook_id": fks2["rulebook_id"]}
+    response = admin_client.patch(
+        f"{api_url_v1}/activations/{activation_id}/", data=test_activation5
+    )
+    assert_updated_event_stream_mapping(
+        response, ["ansible.eda.range"], "", ""
+    )
+
+
+def assert_updated_event_stream_mapping(
+    response, sources: list, source_mappings: str, event_stream_name: str
+):
+    assert response.status_code == status.HTTP_200_OK
+    data = response.data
+    activation = models.Activation.objects.filter(id=data["id"]).first()
+    swapped_ruleset = yaml.safe_load(activation.rulebook_rulesets)
+    assert sorted(swapped_ruleset[0]["sources"][0].keys()) == sources
+    assert data["source_mappings"].strip() == source_mappings.strip()
+    if event_stream_name:
+        assert data["event_streams"][0]["name"] == "demo-2"
+    else:
+        assert data["event_streams"] == []