Do not let enabling plugins affect the global plugin cache (#3944)

Co-authored-by: Jan Klopper <[email protected]>

boefjes/boefjes/dependencies/plugins.py

@@ -43,13 +43,13 @@ def __exit__(self, exc_type, exc_val, exc_tb):
 
     def get_all(self, organisation_id: str) -> list[PluginType]:
         all_plugins = self._get_all_without_enabled()
-        plugin_states = self.config_storage.get_state_by_id(organisation_id)
+        plugin_states = self.config_storage.get_states_for_organisation(organisation_id)
 
         for plugin in all_plugins.values():
             if plugin.id not in plugin_states:
                 continue
 
-            plugin.enabled = plugin_states[plugin.id]
+            all_plugins[plugin.id] = plugin.model_copy(update={"enabled": plugin_states[plugin.id]})
 
         return list(all_plugins.values())
 

boefjes/boefjes/sql/config_storage.py

@@ -111,7 +111,7 @@ def get_enabled_normalizers(self, organisation_id: str) -> list[str]:
 
         return [plugin[0] for plugin in enabled_normalizers.all()]
 
-    def get_state_by_id(self, organisation_id: str) -> dict[str, bool]:
+    def get_states_for_organisation(self, organisation_id: str) -> dict[str, bool]:
         enabled_boefjes = (
             self.session.query(BoefjeInDB.plugin_id, BoefjeConfigInDB.enabled)
             .join(BoefjeConfigInDB)

boefjes/boefjes/storage/interfaces.py

@@ -157,5 +157,5 @@ def get_enabled_boefjes(self, organisation_id: str) -> list[str]:
     def get_enabled_normalizers(self, organisation_id: str) -> list[str]:
         raise NotImplementedError
 
-    def get_state_by_id(self, organisation_id: str) -> dict[str, bool]:
+    def get_states_for_organisation(self, organisation_id: str) -> dict[str, bool]:
         raise NotImplementedError

boefjes/boefjes/storage/memory.py

@@ -131,5 +131,5 @@ def get_enabled_normalizers(self, organisation_id: str) -> list[str]:
             if enabled and "norm" in plugin_id
         ]
 
-    def get_state_by_id(self, organisation_id: str) -> dict[str, bool]:
+    def get_states_for_organisation(self, organisation_id: str) -> dict[str, bool]:
         return self._enabled.get(organisation_id, {})

boefjes/tests/conftest.py

@@ -238,6 +238,11 @@ def test_organisation():
     return Organisation(id="test", name="Test org")
 
 
+@pytest.fixture
+def second_test_organisation():
+    return Organisation(id="test2", name="Test org2")
+
+
 @pytest.fixture
 def mock_plugin_service(mock_local_repository, test_organisation) -> PluginService:
     storage = ConfigStorageMemory()
@@ -254,6 +259,14 @@ def organisation(organisation_storage, test_organisation) -> Organisation:
     return test_organisation
 
 
+@pytest.fixture
+def second_organisation(organisation_storage, second_test_organisation) -> Organisation:
+    with organisation_storage as repo:
+        repo.create(second_test_organisation)
+
+    return second_test_organisation
+
+
 @pytest.fixture
 def unit_test_client(mock_plugin_service) -> TestClient:
     client = TestClient(app)

boefjes/tests/integration/test_api.py

@@ -73,6 +73,16 @@ def test_add_boefje(test_client, organisation):
     assert response.json() == boefje_dict
 
 
+def test_enable_boefje(test_client, organisation, second_organisation):
+    test_client.patch(f"/v1/organisations/{organisation.id}/plugins/dns-records", json={"enabled": True})
+
+    response = test_client.get(f"/v1/organisations/{organisation.id}/plugins/dns-records")
+    assert response.json()["enabled"] is True
+
+    response = test_client.get(f"/v1/organisations/{second_organisation.id}/plugins/dns-records")
+    assert response.json()["enabled"] is False
+
+
 def test_cannot_add_static_plugin_with_duplicate_name(test_client, organisation):
     boefje = Boefje(id="test_plugin", name="DNS records", static=False)
     response = test_client.post(f"/v1/organisations/{organisation.id}/plugins", content=boefje.model_dump_json())
@@ -137,7 +147,7 @@ def test_delete_normalizer(test_client, organisation):
     assert response.status_code == 404
 
 
-def test_update_plugins(test_client, organisation):
+def test_update_plugins(test_client, organisation, second_organisation):
     normalizer = Normalizer(id="norm_id", name="My test normalizer")
     boefje = Boefje(id="test_plugin", name="My test boefje", description="123", interval=20)