Merge pull request #14343 from rtibblesbot/issue-9251-8074cb

Consolidate deprovision to reuse facility deletion utilities

Author: rtibbles

kolibri/core/auth/management/commands/deprovision.py

@@ -1,44 +1,14 @@
 import logging
 import sys
 
-from morango.models import Certificate
-from morango.models import DatabaseIDModel
-from morango.models import DatabaseMaxCounter
-from morango.models import DeletedModels
-from morango.models import HardDeletedModels
-from morango.models import Store
-
 from kolibri.core.auth.management.utils import confirm_or_exit
-from kolibri.core.auth.models import FacilityDataset
-from kolibri.core.auth.models import FacilityUser
 from kolibri.core.auth.utils.deprovision import deprovision
 from kolibri.core.auth.utils.deprovision import get_deprovision_progress_total
-from kolibri.core.device.models import DevicePermissions
-from kolibri.core.device.models import DeviceSettings
-from kolibri.core.logger.models import AttemptLog
-from kolibri.core.logger.models import ContentSessionLog
-from kolibri.core.logger.models import ContentSummaryLog
 from kolibri.core.tasks.management.commands.base import AsyncCommand
 from kolibri.utils.cli import server
 
 logger = logging.getLogger(__name__)
 
-MODELS_TO_DELETE = [
-    AttemptLog,
-    ContentSessionLog,
-    ContentSummaryLog,
-    FacilityUser,
-    FacilityDataset,
-    HardDeletedModels,
-    Certificate,
-    DatabaseIDModel,
-    Store,
-    DevicePermissions,
-    DeletedModels,
-    DeviceSettings,
-    DatabaseMaxCounter,
-]
-
 
 class Command(AsyncCommand):
     help = "Delete all facility user data from the local database, and put it back to a clean state (but leaving content as-is)."

kolibri/core/auth/test/test_deprovisioning.py

@@ -4,20 +4,46 @@
 from django.test import override_settings
 from django.test import TestCase
 from mock import patch
+from morango.models import Certificate
+from morango.models import DatabaseIDModel
+from morango.models import DatabaseMaxCounter
+from morango.models import DeletedModels
+from morango.models import HardDeletedModels
+from morango.models import Store
 from morango.sync.controller import MorangoProfileController
 
 from .. import models as auth_models
-from ..management.commands import deprovision
 from .helpers import setup_device
 from .test_api import ClassroomFactory
 from .test_api import LearnerGroupFactory
 from kolibri.core.auth.constants.morango_sync import PROFILE_FACILITY_DATA
 from kolibri.core.content import models as content_models
+from kolibri.core.device.models import DevicePermissions
+from kolibri.core.device.models import DeviceSettings
+from kolibri.core.logger.models import AttemptLog
+from kolibri.core.logger.models import ContentSessionLog
+from kolibri.core.logger.models import ContentSummaryLog
 from kolibri.core.logger.test.factory_logger import ContentSessionLogFactory
 from kolibri.core.logger.test.factory_logger import ContentSummaryLogFactory
 from kolibri.core.logger.test.factory_logger import FacilityUserFactory
 from kolibri.core.logger.test.factory_logger import UserSessionLogFactory
 
+MODELS_DELETED_BY_DEPROVISION = [
+    AttemptLog,
+    ContentSessionLog,
+    ContentSummaryLog,
+    auth_models.FacilityUser,
+    auth_models.FacilityDataset,
+    HardDeletedModels,
+    Certificate,
+    DatabaseIDModel,
+    Store,
+    DevicePermissions,
+    DeletedModels,
+    DeviceSettings,
+    DatabaseMaxCounter,
+]
+
 
 def count_instances(models):
     return sum([model.objects.count() for model in models])
@@ -54,16 +80,18 @@ def setUp(self):
         MorangoProfileController(PROFILE_FACILITY_DATA).serialize_into_store()
 
     @patch("kolibri.core.auth.management.commands.deprovision.confirm_or_exit")
-    def test_setup_no_headers_bad_user_good_user(self, confirm_or_exit_mock):
+    def test_deprovision_deletes_user_data_preserves_content(
+        self, confirm_or_exit_mock
+    ):
         models_that_should_remain = [
             content_models.LocalFile,
             content_models.ContentNode,
             content_models.File,
             content_models.AssessmentMetaData,
         ]
-        assert count_instances(deprovision.MODELS_TO_DELETE) > 0
+        assert count_instances(MODELS_DELETED_BY_DEPROVISION) > 0
         initial_model_count = count_instances(models_that_should_remain)
         assert initial_model_count > 0
         call_command("deprovision")
-        assert count_instances(deprovision.MODELS_TO_DELETE) == 0
+        assert count_instances(MODELS_DELETED_BY_DEPROVISION) == 0
         assert count_instances(models_that_should_remain) == initial_model_count

kolibri/core/auth/utils/deprovision.py

@@ -1,47 +1,38 @@
-from morango.models import Certificate
 from morango.models import DatabaseIDModel
-from morango.models import DatabaseMaxCounter
-from morango.models import DeletedModels
 from morango.models import HardDeletedModels
-from morango.models import Store
 
-from kolibri.core.auth.models import FacilityDataset
-from kolibri.core.auth.models import FacilityUser
+from kolibri.core.auth.models import dataset_cache
+from kolibri.core.auth.models import Facility
+from kolibri.core.auth.utils.delete import clean_up_legacy_counters
 from kolibri.core.auth.utils.delete import DisablePostDeleteSignal
-from kolibri.core.device.models import DevicePermissions
+from kolibri.core.auth.utils.delete import get_delete_group_for_facility
 from kolibri.core.device.models import DeviceSettings
-from kolibri.core.logger.models import AttemptLog
-from kolibri.core.logger.models import ContentSessionLog
-from kolibri.core.logger.models import ContentSummaryLog
 from kolibri.core.tasks.main import job_storage
 
-MODELS_TO_DELETE = [
-    AttemptLog,
-    ContentSessionLog,
-    ContentSummaryLog,
-    FacilityUser,
-    FacilityDataset,
-    HardDeletedModels,
-    Certificate,
-    DatabaseIDModel,
-    Store,
-    DevicePermissions,
-    DeletedModels,
-    DeviceSettings,
-    DatabaseMaxCounter,
-]
-
 
 def deprovision(progress_update=None):
     with DisablePostDeleteSignal():
-        for Model in MODELS_TO_DELETE:
-            Model.objects.all().delete()
+        facilities = Facility.objects.all()
+        for facility in facilities:
+            delete_group = get_delete_group_for_facility(facility)
+            delete_group.delete()
             if progress_update:
                 progress_update(1)
 
+        clean_up_legacy_counters()
+        dataset_cache.clear()
+
+        # Delete device-level models not covered by facility deletion
+        HardDeletedModels.objects.all().delete()
+        DatabaseIDModel.objects.all().delete()
+        DeviceSettings.objects.all().delete()
+
         # Clear all completed, failed or cancelled jobs
         job_storage.clear()
 
+        if progress_update:
+            progress_update(1)
+
 
 def get_deprovision_progress_total():
-    return len(MODELS_TO_DELETE)
+    return Facility.objects.count() + 1  # +1 for cleanup step