1. import json
    
  2. from datetime import datetime
    
  3. 
    
  4. from django.contrib.admin.models import ADDITION, CHANGE, DELETION, LogEntry
    
  5. from django.contrib.admin.utils import quote
    
  6. from django.contrib.auth.models import User
    
  7. from django.contrib.contenttypes.models import ContentType
    
  8. from django.test import TestCase, override_settings
    
  9. from django.urls import reverse
    
  10. from django.utils import translation
    
  11. from django.utils.html import escape
    
  12. 
    
  13. from .models import Article, ArticleProxy, Site
    
  14. 
    
  15. 
    
  16. @override_settings(ROOT_URLCONF="admin_utils.urls")
    
  17. class LogEntryTests(TestCase):
    
  18.     @classmethod
    
  19.     def setUpTestData(cls):
    
  20.         cls.user = User.objects.create_superuser(
    
  21.             username="super", password="secret", email="[email protected]"
    
  22.         )
    
  23.         cls.site = Site.objects.create(domain="example.org")
    
  24.         cls.a1 = Article.objects.create(
    
  25.             site=cls.site,
    
  26.             title="Title",
    
  27.             created=datetime(2008, 3, 12, 11, 54),
    
  28.         )
    
  29.         content_type_pk = ContentType.objects.get_for_model(Article).pk
    
  30.         LogEntry.objects.log_action(
    
  31.             cls.user.pk,
    
  32.             content_type_pk,
    
  33.             cls.a1.pk,
    
  34.             repr(cls.a1),
    
  35.             CHANGE,
    
  36.             change_message="Changed something",
    
  37.         )
    
  38. 
    
  39.     def setUp(self):
    
  40.         self.client.force_login(self.user)
    
  41. 
    
  42.     def test_logentry_save(self):
    
  43.         """
    
  44.         LogEntry.action_time is a timestamp of the date when the entry was
    
  45.         created. It shouldn't be updated on a subsequent save().
    
  46.         """
    
  47.         logentry = LogEntry.objects.get(content_type__model__iexact="article")
    
  48.         action_time = logentry.action_time
    
  49.         logentry.save()
    
  50.         self.assertEqual(logentry.action_time, action_time)
    
  51. 
    
  52.     def test_logentry_change_message(self):
    
  53.         """
    
  54.         LogEntry.change_message is stored as a dumped JSON structure to be able
    
  55.         to get the message dynamically translated at display time.
    
  56.         """
    
  57.         post_data = {
    
  58.             "site": self.site.pk,
    
  59.             "title": "Changed",
    
  60.             "hist": "Some content",
    
  61.             "created_0": "2008-03-12",
    
  62.             "created_1": "11:54",
    
  63.         }
    
  64.         change_url = reverse(
    
  65.             "admin:admin_utils_article_change", args=[quote(self.a1.pk)]
    
  66.         )
    
  67.         response = self.client.post(change_url, post_data)
    
  68.         self.assertRedirects(response, reverse("admin:admin_utils_article_changelist"))
    
  69.         logentry = LogEntry.objects.filter(
    
  70.             content_type__model__iexact="article"
    
  71.         ).latest("id")
    
  72.         self.assertEqual(logentry.get_change_message(), "Changed Title and History.")
    
  73.         with translation.override("fr"):
    
  74.             self.assertEqual(
    
  75.                 logentry.get_change_message(), "Modification de Title et Historique."
    
  76.             )
    
  77. 
    
  78.         add_url = reverse("admin:admin_utils_article_add")
    
  79.         post_data["title"] = "New"
    
  80.         response = self.client.post(add_url, post_data)
    
  81.         self.assertRedirects(response, reverse("admin:admin_utils_article_changelist"))
    
  82.         logentry = LogEntry.objects.filter(
    
  83.             content_type__model__iexact="article"
    
  84.         ).latest("id")
    
  85.         self.assertEqual(logentry.get_change_message(), "Added.")
    
  86.         with translation.override("fr"):
    
  87.             self.assertEqual(logentry.get_change_message(), "Ajout.")
    
  88. 
    
  89.     def test_logentry_change_message_not_json(self):
    
  90.         """LogEntry.change_message was a string before Django 1.10."""
    
  91.         logentry = LogEntry(change_message="non-JSON string")
    
  92.         self.assertEqual(logentry.get_change_message(), logentry.change_message)
    
  93. 
    
  94.     def test_logentry_change_message_localized_datetime_input(self):
    
  95.         """
    
  96.         Localized date/time inputs shouldn't affect changed form data detection.
    
  97.         """
    
  98.         post_data = {
    
  99.             "site": self.site.pk,
    
  100.             "title": "Changed",
    
  101.             "hist": "Some content",
    
  102.             "created_0": "12/03/2008",
    
  103.             "created_1": "11:54",
    
  104.         }
    
  105.         with translation.override("fr"):
    
  106.             change_url = reverse(
    
  107.                 "admin:admin_utils_article_change", args=[quote(self.a1.pk)]
    
  108.             )
    
  109.             response = self.client.post(change_url, post_data)
    
  110.             self.assertRedirects(
    
  111.                 response, reverse("admin:admin_utils_article_changelist")
    
  112.             )
    
  113.         logentry = LogEntry.objects.filter(
    
  114.             content_type__model__iexact="article"
    
  115.         ).latest("id")
    
  116.         self.assertEqual(logentry.get_change_message(), "Changed Title and History.")
    
  117. 
    
  118.     def test_logentry_change_message_formsets(self):
    
  119.         """
    
  120.         All messages for changed formsets are logged in a change message.
    
  121.         """
    
  122.         a2 = Article.objects.create(
    
  123.             site=self.site,
    
  124.             title="Title second article",
    
  125.             created=datetime(2012, 3, 18, 11, 54),
    
  126.         )
    
  127.         post_data = {
    
  128.             "domain": "example.com",  # domain changed
    
  129.             "admin_articles-TOTAL_FORMS": "5",
    
  130.             "admin_articles-INITIAL_FORMS": "2",
    
  131.             "admin_articles-MIN_NUM_FORMS": "0",
    
  132.             "admin_articles-MAX_NUM_FORMS": "1000",
    
  133.             # Changed title for 1st article
    
  134.             "admin_articles-0-id": str(self.a1.pk),
    
  135.             "admin_articles-0-site": str(self.site.pk),
    
  136.             "admin_articles-0-title": "Changed Title",
    
  137.             # Second article is deleted
    
  138.             "admin_articles-1-id": str(a2.pk),
    
  139.             "admin_articles-1-site": str(self.site.pk),
    
  140.             "admin_articles-1-title": "Title second article",
    
  141.             "admin_articles-1-DELETE": "on",
    
  142.             # A new article is added
    
  143.             "admin_articles-2-site": str(self.site.pk),
    
  144.             "admin_articles-2-title": "Added article",
    
  145.         }
    
  146.         change_url = reverse(
    
  147.             "admin:admin_utils_site_change", args=[quote(self.site.pk)]
    
  148.         )
    
  149.         response = self.client.post(change_url, post_data)
    
  150.         self.assertRedirects(response, reverse("admin:admin_utils_site_changelist"))
    
  151.         self.assertQuerysetEqual(Article.objects.filter(pk=a2.pk), [])
    
  152.         logentry = LogEntry.objects.filter(content_type__model__iexact="site").latest(
    
  153.             "action_time"
    
  154.         )
    
  155.         self.assertEqual(
    
  156.             json.loads(logentry.change_message),
    
  157.             [
    
  158.                 {"changed": {"fields": ["Domain"]}},
    
  159.                 {"added": {"object": "Added article", "name": "article"}},
    
  160.                 {
    
  161.                     "changed": {
    
  162.                         "fields": ["Title", "not_a_form_field"],
    
  163.                         "object": "Changed Title",
    
  164.                         "name": "article",
    
  165.                     }
    
  166.                 },
    
  167.                 {"deleted": {"object": "Title second article", "name": "article"}},
    
  168.             ],
    
  169.         )
    
  170.         self.assertEqual(
    
  171.             logentry.get_change_message(),
    
  172.             "Changed Domain. Added article “Added article”. "
    
  173.             "Changed Title and not_a_form_field for article “Changed Title”. "
    
  174.             "Deleted article “Title second article”.",
    
  175.         )
    
  176. 
    
  177.         with translation.override("fr"):
    
  178.             self.assertEqual(
    
  179.                 logentry.get_change_message(),
    
  180.                 "Modification de Domain. Ajout de article « Added article ». "
    
  181.                 "Modification de Title et not_a_form_field pour l'objet "
    
  182.                 "article « Changed Title ». "
    
  183.                 "Suppression de article « Title second article ».",
    
  184.             )
    
  185. 
    
  186.     def test_logentry_get_edited_object(self):
    
  187.         """
    
  188.         LogEntry.get_edited_object() returns the edited object of a LogEntry
    
  189.         object.
    
  190.         """
    
  191.         logentry = LogEntry.objects.get(content_type__model__iexact="article")
    
  192.         edited_obj = logentry.get_edited_object()
    
  193.         self.assertEqual(logentry.object_id, str(edited_obj.pk))
    
  194. 
    
  195.     def test_logentry_get_admin_url(self):
    
  196.         """
    
  197.         LogEntry.get_admin_url returns a URL to edit the entry's object or
    
  198.         None for nonexistent (possibly deleted) models.
    
  199.         """
    
  200.         logentry = LogEntry.objects.get(content_type__model__iexact="article")
    
  201.         expected_url = reverse(
    
  202.             "admin:admin_utils_article_change", args=(quote(self.a1.pk),)
    
  203.         )
    
  204.         self.assertEqual(logentry.get_admin_url(), expected_url)
    
  205.         self.assertIn("article/%d/change/" % self.a1.pk, logentry.get_admin_url())
    
  206. 
    
  207.         logentry.content_type.model = "nonexistent"
    
  208.         self.assertIsNone(logentry.get_admin_url())
    
  209. 
    
  210.     def test_logentry_unicode(self):
    
  211.         log_entry = LogEntry()
    
  212. 
    
  213.         log_entry.action_flag = ADDITION
    
  214.         self.assertTrue(str(log_entry).startswith("Added "))
    
  215. 
    
  216.         log_entry.action_flag = CHANGE
    
  217.         self.assertTrue(str(log_entry).startswith("Changed "))
    
  218. 
    
  219.         log_entry.action_flag = DELETION
    
  220.         self.assertTrue(str(log_entry).startswith("Deleted "))
    
  221. 
    
  222.         # Make sure custom action_flags works
    
  223.         log_entry.action_flag = 4
    
  224.         self.assertEqual(str(log_entry), "LogEntry Object")
    
  225. 
    
  226.     def test_logentry_repr(self):
    
  227.         logentry = LogEntry.objects.first()
    
  228.         self.assertEqual(repr(logentry), str(logentry.action_time))
    
  229. 
    
  230.     def test_log_action(self):
    
  231.         content_type_pk = ContentType.objects.get_for_model(Article).pk
    
  232.         log_entry = LogEntry.objects.log_action(
    
  233.             self.user.pk,
    
  234.             content_type_pk,
    
  235.             self.a1.pk,
    
  236.             repr(self.a1),
    
  237.             CHANGE,
    
  238.             change_message="Changed something else",
    
  239.         )
    
  240.         self.assertEqual(log_entry, LogEntry.objects.latest("id"))
    
  241. 
    
  242.     def test_recentactions_without_content_type(self):
    
  243.         """
    
  244.         If a LogEntry is missing content_type it will not display it in span
    
  245.         tag under the hyperlink.
    
  246.         """
    
  247.         response = self.client.get(reverse("admin:index"))
    
  248.         link = reverse("admin:admin_utils_article_change", args=(quote(self.a1.pk),))
    
  249.         should_contain = """<a href="%s">%s</a>""" % (
    
  250.             escape(link),
    
  251.             escape(repr(self.a1)),
    
  252.         )
    
  253.         self.assertContains(response, should_contain)
    
  254.         should_contain = "Article"
    
  255.         self.assertContains(response, should_contain)
    
  256.         logentry = LogEntry.objects.get(content_type__model__iexact="article")
    
  257.         # If the log entry doesn't have a content type it should still be
    
  258.         # possible to view the Recent Actions part (#10275).
    
  259.         logentry.content_type = None
    
  260.         logentry.save()
    
  261. 
    
  262.         should_contain = should_contain.encode()
    
  263.         counted_presence_before = response.content.count(should_contain)
    
  264.         response = self.client.get(reverse("admin:index"))
    
  265.         counted_presence_after = response.content.count(should_contain)
    
  266.         self.assertEqual(counted_presence_before - 1, counted_presence_after)
    
  267. 
    
  268.     def test_proxy_model_content_type_is_used_for_log_entries(self):
    
  269.         """
    
  270.         Log entries for proxy models should have the proxy model's contenttype
    
  271.         (#21084).
    
  272.         """
    
  273.         proxy_content_type = ContentType.objects.get_for_model(
    
  274.             ArticleProxy, for_concrete_model=False
    
  275.         )
    
  276.         post_data = {
    
  277.             "site": self.site.pk,
    
  278.             "title": "Foo",
    
  279.             "hist": "Bar",
    
  280.             "created_0": "2015-12-25",
    
  281.             "created_1": "00:00",
    
  282.         }
    
  283.         changelist_url = reverse("admin:admin_utils_articleproxy_changelist")
    
  284. 
    
  285.         # add
    
  286.         proxy_add_url = reverse("admin:admin_utils_articleproxy_add")
    
  287.         response = self.client.post(proxy_add_url, post_data)
    
  288.         self.assertRedirects(response, changelist_url)
    
  289.         proxy_addition_log = LogEntry.objects.latest("id")
    
  290.         self.assertEqual(proxy_addition_log.action_flag, ADDITION)
    
  291.         self.assertEqual(proxy_addition_log.content_type, proxy_content_type)
    
  292. 
    
  293.         # change
    
  294.         article_id = proxy_addition_log.object_id
    
  295.         proxy_change_url = reverse(
    
  296.             "admin:admin_utils_articleproxy_change", args=(article_id,)
    
  297.         )
    
  298.         post_data["title"] = "New"
    
  299.         response = self.client.post(proxy_change_url, post_data)
    
  300.         self.assertRedirects(response, changelist_url)
    
  301.         proxy_change_log = LogEntry.objects.latest("id")
    
  302.         self.assertEqual(proxy_change_log.action_flag, CHANGE)
    
  303.         self.assertEqual(proxy_change_log.content_type, proxy_content_type)
    
  304. 
    
  305.         # delete
    
  306.         proxy_delete_url = reverse(
    
  307.             "admin:admin_utils_articleproxy_delete", args=(article_id,)
    
  308.         )
    
  309.         response = self.client.post(proxy_delete_url, {"post": "yes"})
    
  310.         self.assertRedirects(response, changelist_url)
    
  311.         proxy_delete_log = LogEntry.objects.latest("id")
    
  312.         self.assertEqual(proxy_delete_log.action_flag, DELETION)
    
  313.         self.assertEqual(proxy_delete_log.content_type, proxy_content_type)
    
  314. 
    
  315.     def test_action_flag_choices(self):
    
  316.         tests = ((1, "Addition"), (2, "Change"), (3, "Deletion"))
    
  317.         for action_flag, display_name in tests:
    
  318.             with self.subTest(action_flag=action_flag):
    
  319.                 log = LogEntry(action_flag=action_flag)
    
  320.                 self.assertEqual(log.get_action_flag_display(), display_name)