Log changes to project sharing (#5199)

Author: rgraber

kobo/apps/audit_log/audit_actions.py

@@ -15,3 +15,6 @@ class AuditAction(models.TextChoices):
     REDEPLOY = 'redeploy'
     UPDATE_NAME = 'update-name'
     UPDATE_SETTINGS = 'update-settings'
+    ENABLE_SHARING = 'enable-sharing'
+    DISABLE_SHARING = 'disable-sharing'
+    MODIFY_SHARING = 'modify_sharing'

kobo/apps/audit_log/models.py

@@ -21,6 +21,11 @@
 from kpi.models import Asset
 from kpi.utils.log import logging
 
+NEW = 'new'
+OLD = 'old'
+ADDED = 'added'
+REMOVED = 'removed'
+
 
 class AuditType(models.TextChoices):
     ACCESS = 'access'
@@ -384,6 +389,7 @@ def create_from_detail_request(cls, request):
         changed_field_to_action_map = {
             'name': cls.name_change,
             'settings': cls.settings_change,
+            'data_sharing': cls.sharing_change,
         }
 
         for field, method in changed_field_to_action_map.items():
@@ -405,7 +411,7 @@ def create_from_detail_request(cls, request):
 
     @staticmethod
     def name_change(old_field, new_field):
-        metadata = {'name': {'old': old_field, 'new': new_field}}
+        metadata = {'name': {OLD: old_field, NEW: new_field}}
         return AuditAction.UPDATE_NAME, metadata
 
     @staticmethod
@@ -420,10 +426,39 @@ def settings_change(old_field, new_field):
                 if isinstance(old, list) and isinstance(new, list):
                     removed_values = [val for val in old if val not in new]
                     added_values = [val for val in new if val not in old]
-                    metadata_field_subdict['added'] = added_values
-                    metadata_field_subdict['removed'] = removed_values
+                    metadata_field_subdict[ADDED] = added_values
+                    metadata_field_subdict[REMOVED] = removed_values
                 else:
-                    metadata_field_subdict['old'] = old
-                    metadata_field_subdict['new'] = new
+                    metadata_field_subdict[OLD] = old
+                    metadata_field_subdict[NEW] = new
                 settings[setting_name] = metadata_field_subdict
         return AuditAction.UPDATE_SETTINGS, {'settings': settings}
+
+    @staticmethod
+    def sharing_change(old_fields, new_fields):
+        old_enabled = old_fields.get('enabled', False)
+        old_shared_fields = old_fields.get('fields', [])
+        new_enabled = new_fields.get('enabled', False)
+        new_shared_fields = new_fields.get('fields', [])
+        shared_fields_dict = {}
+        # anything falsy means it was disabled, anything truthy means enabled
+        if old_enabled and not new_enabled:
+            # sharing went from enabled to disabled
+            action = AuditAction.DISABLE_SHARING
+            return action, {}
+        elif not old_enabled and new_enabled:
+            # sharing went from disabled to enabled
+            action = AuditAction.ENABLE_SHARING
+            shared_fields_dict[ADDED] = new_shared_fields
+        else:
+            # the specific fields shared changed
+            removed_fields = [
+                field for field in old_shared_fields if field not in new_shared_fields
+            ]
+            added_fields = [
+                field for field in new_shared_fields if field not in old_shared_fields
+            ]
+            action = AuditAction.MODIFY_SHARING
+            shared_fields_dict[ADDED] = added_fields
+            shared_fields_dict[REMOVED] = removed_fields
+        return action, {'shared_fields': shared_fields_dict}

kobo/apps/audit_log/tests/test_project_history_logs.py

@@ -4,7 +4,7 @@
 from django.urls import reverse
 
 from kobo.apps.audit_log.audit_actions import AuditAction
-from kobo.apps.audit_log.models import ProjectHistoryLog
+from kobo.apps.audit_log.models import ADDED, NEW, OLD, REMOVED, ProjectHistoryLog
 from kobo.apps.audit_log.tests.test_models import BaseAuditLogTestCase
 from kobo.apps.kobo_auth.shortcuts import User
 from kpi.models import Asset
@@ -173,8 +173,8 @@ def test_change_project_name_creates_log(self):
             expected_action=AuditAction.UPDATE_NAME,
         )
 
-        self.assertEqual(log_metadata['name']['new'], 'new_name')
-        self.assertEqual(log_metadata['name']['old'], old_name)
+        self.assertEqual(log_metadata['name'][NEW], 'new_name')
+        self.assertEqual(log_metadata['name'][OLD], old_name)
 
     def test_change_standard_project_settings_creates_log(self):
         old_settings = copy.deepcopy(self.asset.settings)
@@ -195,17 +195,15 @@ def test_change_standard_project_settings_creates_log(self):
 
         # check non-list settings just store old and new information
         settings_dict = log_metadata['settings']
-        self.assertEqual(
-            settings_dict['description']['old'], old_settings['description']
-        )
-        self.assertEqual(settings_dict['description']['new'], 'New description')
+        self.assertEqual(settings_dict['description'][OLD], old_settings['description'])
+        self.assertEqual(settings_dict['description'][NEW], 'New description')
         # check list settings store added and removed fields
         self.assertListEqual(
-            settings_dict['country']['added'],
+            settings_dict['country'][ADDED],
             [{'label': 'Albania', 'value': 'ALB'}],
         )
         self.assertListEqual(
-            settings_dict['country']['removed'],
+            settings_dict['country'][REMOVED],
             [{'label': 'United States', 'value': 'USA'}],
         )
         # check default settings not recorded if not included in request
@@ -265,7 +263,6 @@ def test_nullify_settings_creates_log(self):
             request_data={'settings': {}},
             expected_action=AuditAction.UPDATE_SETTINGS,
         )
-
         for setting, old_value in old_settings.items():
             if setting in Asset.STANDARDIZED_SETTINGS:
                 # if the setting is one of the standard ones, the new value after
@@ -283,14 +280,14 @@ def test_nullify_settings_creates_log(self):
                 removed_values = [val for val in old_value if val not in new_value]
                 added_values = [val for val in new_value if val not in old_value]
                 self.assertListEqual(
-                    log_metadata['settings'][setting]['added'], added_values
+                    log_metadata['settings'][setting][ADDED], added_values
                 )
                 self.assertListEqual(
-                    log_metadata['settings'][setting]['removed'], removed_values
+                    log_metadata['settings'][setting][REMOVED], removed_values
                 )
             else:
-                self.assertEqual(log_metadata['settings'][setting]['new'], new_value)
-                self.assertEqual(log_metadata['settings'][setting]['old'], old_value)
+                self.assertEqual(log_metadata['settings'][setting][NEW], new_value)
+                self.assertEqual(log_metadata['settings'][setting][OLD], old_value)
 
     def test_add_new_settings_creates_log(self):
         log_metadata = self._base_endpoint_test(
@@ -301,5 +298,80 @@ def test_add_new_settings_creates_log(self):
             expected_action=AuditAction.UPDATE_SETTINGS,
         )
 
-        self.assertEqual(log_metadata['settings']['new_setting']['new'], 'new_value')
-        self.assertEqual(log_metadata['settings']['new_setting']['old'], None)
+        self.assertEqual(log_metadata['settings']['new_setting'][NEW], 'new_value')
+        self.assertEqual(log_metadata['settings']['new_setting'][OLD], None)
+
+    def test_enable_sharing_creates_log(self):
+        log_metadata = self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {'enabled': True, 'fields': []}},
+            expected_action=AuditAction.ENABLE_SHARING,
+        )
+        self.assertEqual(log_metadata['shared_fields'][ADDED], [])
+
+    def test_truthy_field_creates_sharing_enabled_log(self):
+        log_metadata = self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {'enabled': 'truthy'}},
+            expected_action=AuditAction.ENABLE_SHARING,
+        )
+        self.assertEqual(log_metadata['shared_fields'][ADDED], [])
+
+    def test_disable_sharing_creates_log(self):
+        self.asset.data_sharing = {
+            'enabled': True,
+            'fields': [],
+        }
+        self.asset.save()
+
+        self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {'enabled': False}},
+            expected_action=AuditAction.DISABLE_SHARING,
+        )
+
+    def test_nullify_sharing_creates_sharing_disabled_log(self):
+        self.asset.data_sharing = {
+            'enabled': True,
+            'fields': [],
+        }
+        self.asset.save()
+
+        self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {}},
+            expected_action=AuditAction.DISABLE_SHARING,
+        )
+
+    def test_falsy_field_creates_sharing_disabled_log(self):
+        self.asset.data_sharing = {
+            'enabled': True,
+            'fields': [],
+        }
+        self.asset.save()
+
+        self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {'enabled': 0}},
+            expected_action=AuditAction.DISABLE_SHARING,
+        )
+
+    def test_modify_sharing_creates_log(self):
+        self.asset.data_sharing = {
+            'enabled': True,
+            'fields': ['q1'],
+        }
+        self.asset.save()
+        log_metadata = self._base_endpoint_test(
+            patch=True,
+            url_name=self.detail_url,
+            request_data={'data_sharing': {'enabled': True, 'fields': ['q2']}},
+            expected_action=AuditAction.MODIFY_SHARING,
+        )
+        self.assertEqual(log_metadata['shared_fields'][ADDED], ['q2'])
+        self.assertEqual(log_metadata['shared_fields'][REMOVED], ['q1'])

kpi/fixtures/asset_with_settings_and_qa.json

@@ -37,9 +37,7 @@
                 "organization" : "An organization"
             },
             "data_sharing":{
-                "fields":[
-
-                ],
+                "fields":[],
                 "enabled":false
             },
             "advanced_features":{

kpi/views/v2/asset.py

@@ -380,8 +380,14 @@ class AssetViewSet(
         'uid__icontains',
     ]
 
-    logged_fields = ['has_deployment', 'id', 'name', 'settings', 'latest_version.uid']
-
+    logged_fields = [
+        'has_deployment',
+        'id',
+        'name',
+        'settings',
+        'latest_version.uid',
+        'data_sharing',
+    ]
     log_type = AuditType.PROJECT_HISTORY
 
     def get_object_override(self):