From 61b1ce55db2dd62996336a91cd2ffa4f8d361b9e Mon Sep 17 00:00:00 2001 From: aranega Date: Mon, 16 Nov 2026 08:03:06 -0600 Subject: [PATCH] Fix user deletion synchronization --- .../cloudharness_django/services/events.py | 7 +- .../cloudharness_django/services/user.py | 12 ++++ .../cloudharness_django/test_settings.py | 14 ++++ .../cloudharness_django/tests.py | 72 ++++++++++++++++++- 4 files changed, 103 insertions(+), 2 deletions(-) create mode 100644 infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/test_settings.py diff --git a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/events.py b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/events.py index 23970a94c..244749db9 100644 --- a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/events.py +++ b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/events.py @@ -39,10 +39,15 @@ def event_handler(app, event_client, message): user_service.sync_kc_group(kc_group) return if resource == "USER": + if operation == "DELETE": + # the user no longer exists in Keycloak, so it can't be fetched: work from the id + user_service.deactivate_kc_user(resource_path[1]) + invalidate_user_cache(resource_path[1]) + return kc_user = auth_client.get_user(resource_path[1]) # invalidate the user cache to force the user to be reloaded invalidate_user_cache(kc_user.id) - user_service.sync_kc_user(kc_user, delete=operation == "DELETE") + user_service.sync_kc_user(kc_user) return if resource == "CLIENT_ROLE_MAPPING": # adding/deleting user client roles diff --git a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/user.py b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/user.py index 715c53b2c..436b11037 100644 --- a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/user.py +++ b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/services/user.py @@ -100,6 +100,18 @@ def sync_kc_groups(self, kc_groups=None): for kc_group in kc_groups: self.sync_kc_group(kc_group) + def deactivate_kc_user(self, kc_id: str): + """ + Deactivate the django user of a Keycloak user that was deleted. + Works from the Keycloak id alone, as the user can no longer be fetched from Keycloak. + The django user is kept, as other models may reference it. + """ + user = get_user_by_kc_id(kc_id) + if user is None: + return + user.is_active = False + user.save(update_fields=["is_active"]) + @transaction.atomic def sync_kc_user(self, kc_user: ch_models.User, is_superuser=False, delete=False): """ diff --git a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/test_settings.py b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/test_settings.py new file mode 100644 index 000000000..42316a737 --- /dev/null +++ b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/test_settings.py @@ -0,0 +1,14 @@ +# Minimal settings to run the library tests (no Keycloak, no Kafka): +# python -m django test cloudharness_django --settings=cloudharness_django.test_settings +SECRET_KEY = "test" +INSTALLED_APPS = ["django.contrib.auth", "django.contrib.contenttypes", "cloudharness_django"] +DATABASES = {"default": {"ENGINE": "django.db.backends.sqlite3", "NAME": ":memory:"}} +DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField" +USE_TZ = True + +# read at import time by cloudharness_django.services +KC_CLIENT_NAME = "test-client" +KC_ALL_ROLES = ["administrator", "standard"] +KC_PRIVILEGED_ROLES = ["administrator"] +KC_ADMIN_ROLE = "administrator" +KC_DEFAULT_USER_ROLE = "standard" diff --git a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/tests.py b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/tests.py index 7ce503c2d..53787d666 100644 --- a/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/tests.py +++ b/infrastructure/common-images/cloudharness-django/libraries/cloudharness-django/cloudharness_django/tests.py @@ -1,3 +1,73 @@ +from unittest.mock import MagicMock, patch + +from django.contrib.auth.models import User from django.test import TestCase -# Create your tests here. +from cloudharness.auth.exceptions import UserNotFound +from cloudharness_django.models import Member +from cloudharness_django.services.events import KeycloakMessageService +from cloudharness_django.services.user import UserService + +EVENTS = "cloudharness_django.services.events" +KC_ID = "aa9fa0bb-572e-4467-8b13-746606981626" + + +class UserEventHandlerTest(TestCase): + def setUp(self): + self.user = User.objects.create(username="kc-user@example.com", email="kc-user@example.com", is_active=True) + Member.objects.create(user=self.user, kc_id=KC_ID) + + self.auth_client = MagicMock() + auth_service = MagicMock() + auth_service.get_auth_client.return_value = self.auth_client + self.user_service = UserService(auth_service) + + self.invalidate_user_cache = self._patch(f"{EVENTS}.invalidate_user_cache") + self._patch(f"{EVENTS}.time.sleep") + self._patch(f"{EVENTS}.init_services") + self._patch(f"{EVENTS}.get_user_service", return_value=self.user_service) + self._patch(f"{EVENTS}.get_auth_service", return_value=auth_service) + + def _patch(self, target, **kwargs): + patcher = patch(target, **kwargs) + self.addCleanup(patcher.stop) + return patcher.start() + + def _send_user_event(self, operation): + message = { + "resource-type": "USER", + "operation-type": operation, + "resource-path": f"users/{KC_ID}", + } + KeycloakMessageService.event_handler(app={}, event_client=None, message=message) + + def test_delete_deactivates_django_user_without_fetching_keycloak_user(self): + # Keycloak has already removed the user when its DELETE admin event arrives + self.auth_client.get_user.side_effect = UserNotFound(KC_ID) + + self._send_user_event("DELETE") + + self.user.refresh_from_db() + self.assertFalse(self.user.is_active) + self.auth_client.get_user.assert_not_called() + self.invalidate_user_cache.assert_called_once_with(KC_ID) + + def test_delete_of_user_unknown_to_django_is_ignored(self): + Member.objects.all().delete() + self.auth_client.get_user.side_effect = UserNotFound(KC_ID) + + self._send_user_event("DELETE") + + self.auth_client.get_user.assert_not_called() + + def test_update_still_syncs_the_keycloak_user(self): + kc_user = MagicMock(id=KC_ID) + self.auth_client.get_user.return_value = kc_user + + with patch.object(self.user_service, "sync_kc_user") as sync_kc_user: + self._send_user_event("UPDATE") + + self.auth_client.get_user.assert_called_once_with(KC_ID) + sync_kc_user.assert_called_once() + self.assertIs(sync_kc_user.call_args.args[0], kc_user) + self.invalidate_user_cache.assert_called_once_with(KC_ID)