Added tests for django.contrib.admindocs

Refs #22015

tests/admin_docs/models.py

@@ -0,0 +1,52 @@
+"""
+Models for testing various aspects of the djang.contrib.admindocs app
+"""
+
+from django.db import models
+
+
+class Company(models.Model):
+    name = models.CharField(max_length=200)
+
+
+class Group(models.Model):
+    name = models.CharField(max_length=200)
+
+
+class Family(models.Model):
+    last_name = models.CharField(max_length=200)
+
+
+class Person(models.Model):
+    first_name = models.CharField(max_length=200, help_text="The person's first name")
+    last_name = models.CharField(max_length=200, help_text="The person's last name")
+    company = models.ForeignKey(Company, help_text="place of work")
+    family = models.ForeignKey(Family, related_name='+', null=True)
+    groups = models.ManyToManyField(Group, help_text="has membership")
+
+    def _get_full_name(self):
+        return "%s %s" % (self.first_name, self.last_name)
+
+    def add_image(self):
+        pass
+
+    def delete_image(self):
+        pass
+
+    def save_changes(self):
+        pass
+
+    def set_status(self):
+        pass
+
+    def get_full_name(self):
+        """
+        Get the full name of the person
+        """
+        return self._get_full_name()
+
+    def get_status_count(self):
+        return 0
+
+    def get_groups_list(self):
+        return []

tests/admin_docs/tests.py

@@ -3,10 +3,13 @@ import unittest
 from django.conf import settings
 from django.contrib.sites.models import Site
 from django.contrib.admindocs import utils
+from django.contrib.admindocs.views import get_return_data_type
 from django.contrib.auth.models import User
 from django.core.urlresolvers import reverse
 from django.test import TestCase, modify_settings, override_settings
 
+from .models import Person, Company
+
 
 class MiscTests(TestCase):
     urls = 'admin_docs.urls'
@@ -80,17 +83,6 @@ class AdminDocViewTests(TestCase):
         response = self.client.get(reverse('django-admindocs-models-index'))
         self.assertContains(response, '<h2 id="app-auth">Auth</h2>', html=True)
 
-    def test_model_detail(self):
-        response = self.client.get(reverse('django-admindocs-models-detail',
-            args=['auth', 'user']))
-        # Check for attribute, many-to-many field
-        self.assertContains(response,
-            '<tr><td>email</td><td>Email address</td><td>email address</td></tr>', html=True)
-        self.assertContains(response,
-            '<tr><td>user_permissions.all</td><td>List</td><td>'
-            '<p>all related <a class="reference external" href="/admindocs/models/auth.permission/">'
-            'auth.Permission</a> objects</p></td></tr>', html=True)
-
     def test_template_detail(self):
         response = self.client.get(reverse('django-admindocs-templates',
             args=['admin_doc/template_detail.html']))
@@ -189,3 +181,98 @@ class DefaultRoleTest(TestCase):
         markup = '<p>reST, <cite>interpreted text</cite>, default role.</p>\n'
         parts = docutils.core.publish_parts(source=source, writer_name="html4css1")
         self.assertEqual(parts['fragment'], markup)
+
+
+@override_settings(PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',))
+@unittest.skipUnless(utils.docutils_is_available, "no docutils installed.")
+class TestModelDetailView(TestCase):
+    """
+    Tests that various details render correctly
+    """
+
+    fixtures = ['data.xml']
+    urls = 'admin_docs.urls'
+
+    def setUp(self):
+        self.client.login(username='super', password='secret')
+        self.response = self.client.get(
+            reverse('django-admindocs-models-detail',
+                    args=['admin_docs', 'person']))
+
+    def test_method_excludes(self):
+        """
+        Test that methods that begin with strings defined in
+        ``django.contrib.admindocs.views.MODEL_METHODS_EXCLUDE``
+        do not get displayed in the admin docs
+        """
+        self.assertContains(self.response, "<td>get_full_name</td>")
+        self.assertNotContains(self.response, "<td>_get_full_name</td>")
+        self.assertNotContains(self.response, "<td>add_image</td>")
+        self.assertNotContains(self.response, "<td>delete_image</td>")
+        self.assertNotContains(self.response, "<td>set_status</td>")
+        self.assertNotContains(self.response, "<td>save_changes</td>")
+
+    def test_method_data_types(self):
+        """
+        We should be able to get a basic idea of the type returned
+        by a method
+        """
+        company = Company.objects.create(name="Django")
+        person = Person.objects.create(
+            first_name="Human",
+            last_name="User",
+            company=company
+        )
+
+        self.assertEqual(
+            get_return_data_type(person.get_status_count.__name__),
+            'Integer'
+        )
+
+        self.assertEqual(
+            get_return_data_type(person.get_groups_list.__name__),
+            'List'
+        )
+
+    def test_descriptions_render_correctly(self):
+        """
+        The ``description`` field should render correctly for each type of field
+        """
+        # help text in fields
+        self.assertContains(self.response, "<td>first name - The person's first name</td>")
+        self.assertContains(self.response, "<td>last name - The person's last name</td>")
+
+        # method docstrings
+        self.assertContains(self.response, "<p>Get the full name of the person</p>")
+
+        link = '<a class="reference external" href="/admindocs/models/%s/">%s</a>'
+        markup = '<p>the related %s object</p>'
+        company_markup = markup % (link % ("admin_docs.company", "admin_docs.Company"))
+
+        # foreign keys
+        self.assertContains(self.response, company_markup)
+
+        # foreign keys with help text
+        self.assertContains(self.response, "%s\n - place of work" % company_markup)
+
+        # many to many fields
+        self.assertContains(
+            self.response,
+            "number of related %s objects" % (link % ("admin_docs.group", "admin_docs.Group"))
+        )
+        self.assertContains(
+            self.response,
+            "all related %s objects" % (link % ("admin_docs.group", "admin_docs.Group"))
+        )
+
+    def test_model_with_no_backward_relations_render_only_relevant_fields(self):
+        """
+        A model with ``related_name`` of `+` should not show backward relationship
+        links in admin docs
+        """
+        response = self.client.get(
+            reverse('django-admindocs-models-detail',
+                    args=['admin_docs', 'family']))
+
+        fields = response.context_data.get('fields')
+        self.assertEqual(len(fields), 2)