import unittest from django.conf import settings from django.contrib.sites.models import Site from django.contrib.admindocs import utils from django.contrib.auth.models import User from django.core.apps import app_cache from django.core.urlresolvers import reverse from django.test import TestCase from django.test.utils import override_settings class MiscTests(TestCase): urls = 'admin_docs.urls' def setUp(self): User.objects.create_superuser('super', None, 'secret') self.client.login(username='super', password='secret') def test_no_sites_framework(self): """ Without the sites framework, should not access SITE_ID or Site objects. Deleting settings is fine here as UserSettingsHolder is used. """ with self.settings(SITE_ID=None), app_cache._without_app('django.contrib.sites'): Site.objects.all().delete() del settings.SITE_ID self.client.get('/admindocs/views/') # should not raise @override_settings(PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',)) @unittest.skipUnless(utils.docutils_is_available, "no docutils installed.") class AdminDocViewTests(TestCase): fixtures = ['data.xml'] urls = 'admin_docs.urls' def setUp(self): self.client.login(username='super', password='secret') def test_index(self): self.client.logout() response = self.client.get(reverse('django-admindocs-docroot')) # Should display the login screen self.assertContains(response, '', html=True) self.client.login(username='super', password='secret') response = self.client.get(reverse('django-admindocs-docroot')) self.assertContains(response, '

Documentation

', html=True) self.assertContains(response, '

Django ' 'administration

') def test_bookmarklets(self): response = self.client.get(reverse('django-admindocs-bookmarklets')) self.assertContains(response, 'http://testserver/admin/doc/views/') def test_templatetag_index(self): response = self.client.get(reverse('django-admindocs-tags')) self.assertContains(response, '

extends

', html=True) def test_templatefilter_index(self): response = self.client.get(reverse('django-admindocs-filters')) self.assertContains(response, '

first

', html=True) def test_view_index(self): response = self.client.get(reverse('django-admindocs-views-index')) self.assertContains(response, '

/admindocs/

', html=True) self.assertContains(response, 'Views by namespace test') self.assertContains(response, 'Name: test:func.') def test_view_detail(self): response = self.client.get( reverse('django-admindocs-views-detail', args=['django.contrib.admindocs.views.BaseAdminDocsView'])) # View docstring self.assertContains(response, 'Base view for admindocs views.') def test_model_index(self): response = self.client.get(reverse('django-admindocs-models-index')) self.assertContains(response, '

Auth

', 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, 'emailEmail addressemail address', html=True) self.assertContains(response, 'user_permissions.allList' '

all related ' 'auth.Permission objects

', html=True) def test_template_detail(self): response = self.client.get(reverse('django-admindocs-templates', args=['admin_doc/template_detail.html'])) self.assertContains(response, '

Template: "admin_doc/template_detail.html"

', html=True) def test_missing_docutils(self): utils.docutils_is_available = False try: response = self.client.get(reverse('django-admindocs-docroot')) self.assertContains(response, '

The admin documentation system requires Python\'s ' 'docutils library.

', html=True) self.assertContains(response, '

Django ' 'administration

') finally: utils.docutils_is_available = True @override_settings(PASSWORD_HASHERS=('django.contrib.auth.hashers.SHA1PasswordHasher',)) class XViewMiddlewareTest(TestCase): fixtures = ['data.xml'] urls = 'admin_docs.urls' def test_xview_func(self): user = User.objects.get(username='super') response = self.client.head('/xview/func/') self.assertFalse('X-View' in response) self.client.login(username='super', password='secret') response = self.client.head('/xview/func/') self.assertTrue('X-View' in response) self.assertEqual(response['X-View'], 'admin_docs.views.xview') user.is_staff = False user.save() response = self.client.head('/xview/func/') self.assertFalse('X-View' in response) user.is_staff = True user.is_active = False user.save() response = self.client.head('/xview/func/') self.assertFalse('X-View' in response) def test_xview_class(self): user = User.objects.get(username='super') response = self.client.head('/xview/class/') self.assertFalse('X-View' in response) self.client.login(username='super', password='secret') response = self.client.head('/xview/class/') self.assertTrue('X-View' in response) self.assertEqual(response['X-View'], 'admin_docs.views.XViewClass') user.is_staff = False user.save() response = self.client.head('/xview/class/') self.assertFalse('X-View' in response) user.is_staff = True user.is_active = False user.save() response = self.client.head('/xview/class/') self.assertFalse('X-View' in response) @unittest.skipUnless(utils.docutils_is_available, "no docutils installed.") class DefaultRoleTest(TestCase): urls = 'admin_docs.urls' def test_parse_rst(self): """ Tests that ``django.contrib.admindocs.utils.parse_rst`` uses ``cmsreference`` as the default role. """ markup = ('

' 'title

\n') self.assertEqual(utils.parse_rst('`title`', 'model'), markup % 'models/title/') self.assertEqual(utils.parse_rst('`title`', 'view'), markup % 'views/title/') self.assertEqual(utils.parse_rst('`title`', 'template'), markup % 'templates/title/') self.assertEqual(utils.parse_rst('`title`', 'filter'), markup % 'filters/#title') self.assertEqual(utils.parse_rst('`title`', 'tag'), markup % 'tags/#title') def test_publish_parts(self): """ Tests that Django hasn't broken the default role for interpreted text when ``publish_parts`` is used directly, by setting it to ``cmsreference``. See #6681. """ import docutils self.assertNotEqual(docutils.parsers.rst.roles.DEFAULT_INTERPRETED_ROLE, 'cmsreference') source = 'reST, `interpreted text`, default role.' markup = '

reST, interpreted text, default role.

\n' parts = docutils.core.publish_parts(source=source, writer_name="html4css1") self.assertEqual(parts['fragment'], markup)