From: Scott Kitterman Date: Fri, 18 Jan 2019 18:33:42 -0500 Subject: Add tests from upstream Git --- maintenancemode/test_templates/503.html | 3 + maintenancemode/tests.py | 134 ++++++++++++++++++++++++++++++++ runtests.py | 54 +++++++++++++ 3 files changed, 191 insertions(+) create mode 100644 maintenancemode/test_templates/503.html create mode 100644 maintenancemode/tests.py create mode 100644 runtests.py diff --git a/maintenancemode/test_templates/503.html b/maintenancemode/test_templates/503.html new file mode 100644 index 0000000..3d5febd --- /dev/null +++ b/maintenancemode/test_templates/503.html @@ -0,0 +1,3 @@ +Temporary unavailable + +You requested: {{ request_path }} diff --git a/maintenancemode/tests.py b/maintenancemode/tests.py new file mode 100644 index 0000000..d6ec9d0 --- /dev/null +++ b/maintenancemode/tests.py @@ -0,0 +1,134 @@ +import re +import os.path + +from django.core import management +from django.http import HttpResponse +from django.utils.six import StringIO +from django.contrib.auth.models import User +from django.template import TemplateDoesNotExist + +from django.test import TestCase +from django.test.client import Client +from django.test.utils import override_settings + +from django.conf.urls import url + +from maintenancemode import utils + +PROJECT_ROOT = os.path.abspath(os.path.dirname(__file__)) + +TEMPLATE_DIRS = [ + os.path.join(PROJECT_ROOT, 'test_templates'), +] + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [ + os.path.join(PROJECT_ROOT, 'test_templates'), + ], + 'APP_DIRS': True, + } +] + +urlpatterns = [ + url('^$', lambda r: HttpResponse('Rendered response page'), name='test'), + url('^ignored/$', lambda r: HttpResponse('Rendered response page'), name='test'), +] + + +@override_settings(INTERNAL_IPS=[]) +@override_settings(MAINTENANCE_MODE=False) +@override_settings(TEMPLATE_DIRS=[], TEMPLATES=[]) +@override_settings(ROOT_URLCONF='maintenancemode.tests') +class MaintenanceModeMiddlewareTestCase(TestCase): + + def setUp(self): + utils.deactivate() # make sure maintenance mode is off + + self.user = User.objects.create_user( + username='maintenance', email='maintenance@example.org', password='password') + + def tearDown(self): + self.user.delete() + + def test_default_middleware(self): + # Middleware should default to being disabled + response = self.client.get('/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_disabled_middleware(self): + # Explicitly disabling the ``MAINTENANCE_MODE`` should work + with self.settings(MAINTENANCE_MODE=False): + response = self.client.get('/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_enabled_middleware_without_template(self): + # Enabling the middleware without a proper 503 template should + # raise a template error + with self.settings(MAINTENANCE_MODE=True, TEMPLATE_DIRS=[], TEMPLATES=[]): + self.assertRaises(TemplateDoesNotExist, self.client.get, '/') + + def test_enabled_middleware_with_template(self): + # Enabling the middleware having a ``503.html`` in any of the + # template locations should return the rendered template" + with self.settings(MAINTENANCE_MODE=True, TEMPLATE_DIRS=TEMPLATE_DIRS, TEMPLATES=TEMPLATES): + response = self.client.get('/') + self.assertContains(response, text='Temporary unavailable', count=1, status_code=503) + self.assertContains(response, text='You requested: /', count=1, status_code=503) + + def test_middleware_with_non_staff_user(self): + # A logged in user that is not a staff user should see the 503 message + self.client.login(username='maintenance', password='password') + + with self.settings(MAINTENANCE_MODE=True, TEMPLATE_DIRS=TEMPLATE_DIRS, TEMPLATES=TEMPLATES): + response = self.client.get('/') + self.assertContains(response, text='Temporary unavailable', count=1, status_code=503) + + def test_middleware_with_staff_user(self): + # A logged in user that _is_ a staff user should be able to + # use the site normally + User.objects.filter(pk=self.user.pk).update(is_staff=True) + + self.client.login(username='maintenance', password='password') + + with self.settings(MAINTENANCE_MODE=True, TEMPLATE_DIRS=TEMPLATE_DIRS, TEMPLATES=TEMPLATES): + response = self.client.get('/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_middleware_with_internal_ips(self): + # A user that visits the site from an IP in ``INTERNAL_IPS`` + # should be able to use the site normally + + # Use a new Client instance to be able to set the REMOTE_ADDR used by INTERNAL_IPS + client = Client(REMOTE_ADDR='127.0.0.1') + + with self.settings(MAINTENANCE_MODE=True, INTERNAL_IPS=('127.0.0.1', )): + response = client.get('/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_middleware_with_internal_ips_range(self): + client = Client(REMOTE_ADDR='10.10.10.1') + + with self.settings(MAINTENANCE_MODE=True, INTERNAL_IPS=('10.10.10.0/24', )): + response = client.get('/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_ignored_path(self): + # A path is ignored when applying the maintanance mode and + # should be reachable normally + with self.settings(MAINTENANCE_MODE=True, TEMPLATE_DIRS=TEMPLATE_DIRS, TEMPLATES=TEMPLATES): + with self.settings(IGNORE_URLS=(re.compile(r'^/ignored.*'),)): + response = self.client.get('/ignored/') + self.assertContains(response, text='Rendered response page', count=1, status_code=200) + + def test_management_command(self): + out = StringIO() + # Explicitly disabling the ``MAINTENANCE_MODE`` + with self.settings(MAINTENANCE_MODE=False, TEMPLATE_DIRS=TEMPLATE_DIRS, TEMPLATES=TEMPLATES): + management.call_command('maintenance', 'on', stdout=out) + self.assertContains(self.client.get('/'), text='Temporary unavailable', count=1, status_code=503) + + management.call_command('maintenance', 'off', stdout=out) + self.assertContains(self.client.get('/'), text='Rendered response page', count=1, status_code=200) + diff --git a/runtests.py b/runtests.py new file mode 100644 index 0000000..83bfafe --- /dev/null +++ b/runtests.py @@ -0,0 +1,54 @@ +#!/usr/bin/env python + +import re +import sys +from os import path + +import django +from django.conf import settings, global_settings +from django.core.management import execute_from_command_line + + +if not settings.configured: + BASE_DIR = path.dirname(path.realpath(__file__)) + + settings.configure( + DEBUG = False, + TEMPLATE_DEBUG = True, + DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': ':memory:' + } + }, + INSTALLED_APPS = ( + 'django.contrib.auth', + 'django.contrib.admin', + 'django.contrib.sessions', + 'django.contrib.contenttypes', + 'django.contrib.sites', + + 'maintenancemode', + ), + MIDDLEWARE_CLASSES = ( + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + + 'maintenancemode.middleware.MaintenanceModeMiddleware', + ), + TEST_RUNNER = 'django.test.simple.DjangoTestSuiteRunner' if django.VERSION < (1,6) else 'django.test.runner.DiscoverRunner', + SITE_ID = 1, + ROOT_URLCONF = 'maintenancemode.tests', + MAINTENANCE_MODE = True, # or ``False`` and use ``maintenance`` command + MAINTENANCE_IGNORE_URLS = ( + re.compile(r'^/ignored.*'), + ), + ) + +def runtests(): + argv = sys.argv[:1] + ['test', 'maintenancemode'] + sys.argv[1:] + execute_from_command_line(argv) + +if __name__ == '__main__': + runtests() +