Add tests and changelog for auditlog sortkey columns

Author: Simrayz

changelog.d/3757.changed.md

@@ -0,0 +1,3 @@
+Auditlog entries now store sortable display names for actor, object, and target, enabling sorting and searching on these columns. Links to detail pages are shown when the referenced object still exists.
+
+**Note:** The database migration includes backfill operations to populate sortkey columns for existing log entries. On deployments with millions of log entries, this migration may take some time to complete.

tests/integration/auditlog_test.py

@@ -1,6 +1,7 @@
 from django.test import TestCase
 
 from nav.models.arnold import Justification
+from nav.models.profiles import Account
 
 from nav.auditlog import find_modelname
 from nav.auditlog.models import LogEntry
@@ -86,6 +87,51 @@ def test_find_name(self):
         name = find_modelname(self.justification)
         self.assertEqual(name, 'blocked_reason')
 
+    def test_when_log_entry_created_then_actor_sortkey_is_set(self):
+        LogEntry.add_log_entry(
+            self.justification, 'sortkey test', '{actor} did something'
+        )
+        log_entry = LogEntry.objects.filter(verb='sortkey test').get()
+        self.assertEqual(log_entry.actor_sortkey, str(self.justification))
+
+    def test_when_log_entry_has_object_then_object_sortkey_is_set(self):
+        other = Justification.objects.create(name='object_test')
+        LogEntry.add_log_entry(
+            self.justification,
+            'object sortkey test',
+            '{actor} edited {object}',
+            object=other,
+        )
+        log_entry = LogEntry.objects.filter(verb='object sortkey test').get()
+        self.assertEqual(log_entry.object_sortkey, str(other))
+
+    def test_when_log_entry_has_no_object_then_object_sortkey_is_null(self):
+        LogEntry.add_log_entry(
+            self.justification, 'no object test', '{actor} did something'
+        )
+        log_entry = LogEntry.objects.filter(verb='no object test').get()
+        self.assertIsNone(log_entry.object_sortkey)
+
+    def test_when_log_entry_has_target_then_target_sortkey_is_set(self):
+        obj = Justification.objects.create(name='target_obj')
+        target = Justification.objects.create(name='target_test')
+        LogEntry.add_log_entry(
+            self.justification,
+            'target sortkey test',
+            '{actor} sent {object} to {target}',
+            object=obj,
+            target=target,
+        )
+        log_entry = LogEntry.objects.filter(verb='target sortkey test').get()
+        self.assertEqual(log_entry.target_sortkey, str(target))
+
+    def test_when_log_entry_has_no_target_then_target_sortkey_is_null(self):
+        LogEntry.add_log_entry(
+            self.justification, 'no target test', '{actor} did something'
+        )
+        log_entry = LogEntry.objects.filter(verb='no target test').get()
+        self.assertIsNone(log_entry.target_sortkey)
+
 
 class AuditlogUtilsTestCase(TestCase):
     def setUp(self):
@@ -118,3 +164,112 @@ def test_get_auditlog_entries(self):
         self.assertEqual(entries.count(), 1)
         entries = get_auditlog_entries(modelname=modelname, pks=[justification_1.pk])
         self.assertEqual(entries.count(), 2)
+
+
+def test_v1_api_returns_plain_strings_for_backward_compatibility(db, token, api_client):
+    """Test that v1 API returns plain strings (backward compatibility)"""
+    # Configure token to allow access to v1 auditlog endpoint
+    token.endpoints = {'auditlog': '/auditlog/'}
+    token.save()
+
+    # Create an account that will be the actor
+    account = Account.objects.create(
+        login='testuser', name='Test User', password='unused'
+    )
+    # Create a justification as the object
+    justification = Justification.objects.create(name='test_object')
+
+    # Create a log entry
+    entry = LogEntry.add_log_entry(
+        account,
+        'test-action',
+        '{actor} performed action on {object}',
+        object=justification,
+    )
+
+    # Fetch the entry via v1 API
+    response = api_client.get(f'/api/1/auditlog/{entry.id}/')
+
+    assert response.status_code == 200
+    data = response.json()
+
+    # Verify v1 returns plain strings
+    assert isinstance(data['actor'], str)
+    assert data['actor'] == 'testuser'
+    assert isinstance(data['object'], str)
+    assert data['object'] == 'test_object'
+
+
+def test_v2_api_retrieve_returns_entity_objects_with_urls(db, token, api_client):
+    """Test that v2 retrieve endpoint returns objects with {name, url}"""
+    # Configure token to allow access to v2 auditlog endpoint
+    # Note: TokenPermission.version=1 strips /api/1, so v2 paths become /2/auditlog/
+    token.endpoints = {'auditlog': '/2/auditlog/'}
+    token.save()
+
+    # Create an account that will be the actor (accounts have get_absolute_url)
+    account = Account.objects.create(
+        login='testuser', name='Test User', password='unused'
+    )
+    # Create a justification as the object
+    justification = Justification.objects.create(name='test_object')
+
+    # Create a log entry
+    entry = LogEntry.add_log_entry(
+        account,
+        'test-action',
+        '{actor} performed action on {object}',
+        object=justification,
+    )
+
+    # Fetch the entry via v2 API retrieve endpoint
+    response = api_client.get(f'/api/2/auditlog/{entry.id}/')
+
+    assert response.status_code == 200
+    data = response.json()
+
+    # Verify actor has both name and url
+    assert isinstance(data['actor'], dict)
+    assert data['actor']['name'] == 'testuser'
+    assert data['actor']['url'] is not None
+    assert '/useradmin/account/' in data['actor']['url']
+
+    # Verify object has name (url may be None if Justification lacks get_absolute_url)
+    assert isinstance(data['object'], dict)
+    assert data['object']['name'] == 'test_object'
+
+
+def test_v2_api_list_returns_entity_objects_with_urls(db, token, api_client):
+    """Test that v2 list endpoint returns objects with {name, url}"""
+    # Configure token to allow access to v2 auditlog endpoint
+    # Note: TokenPermission.version=1 strips /api/1, so v2 paths become /2/auditlog/
+    token.endpoints = {'auditlog': '/2/auditlog/'}
+    token.save()
+
+    # Create an account that will be the actor
+    account = Account.objects.create(
+        login='testuser', name='Test User', password='unused'
+    )
+    # Create a justification as the object
+    justification = Justification.objects.create(name='test_object')
+
+    # Create a log entry
+    LogEntry.add_log_entry(
+        account,
+        'test-action',
+        '{actor} performed action on {object}',
+        object=justification,
+    )
+
+    # Fetch entries via v2 API list endpoint
+    response = api_client.get('/api/2/auditlog/')
+
+    assert response.status_code == 200
+    data = response.json()
+    assert len(data['results']) > 0
+
+    # Check the first entry
+    first_entry = data['results'][0]
+    assert isinstance(first_entry['actor'], dict)
+    assert 'name' in first_entry['actor']
+    assert 'url' in first_entry['actor']