class MiddlewareTests(TestCase):
def setUp(self):
self.factory = RequestFactory()
self.middleware = ProxitoMiddleware()
self.url = '/'
self.owner = create_user(username='******', password='******')
self.pip = get(Project,
slug='pip',
users=[self.owner],
privacy_level='public')
def run_middleware(self, request):
return self.middleware.process_request(request)
def test_proper_cname(self):
domain = 'docs.random.com'
get(Domain, project=self.pip, domain=domain)
request = self.factory.get(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_proper_cname_uppercase(self):
get(Domain, project=self.pip, domain='docs.random.com')
request = self.factory.get(self.url, HTTP_HOST='docs.RANDOM.COM')
self.run_middleware(request)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_invalid_cname(self):
self.assertFalse(Domain.objects.filter(domain='my.host.com').exists())
request = self.factory.get(self.url, HTTP_HOST='my.host.com')
r = self.run_middleware(request)
# We show the 404 error page
self.assertContains(r, 'my.host.com', status_code=404)
def test_proper_subdomain(self):
request = self.factory.get(self.url,
HTTP_HOST='pip.dev.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
@override_settings(PUBLIC_DOMAIN='foo.bar.readthedocs.io')
def test_subdomain_different_length(self):
request = self.factory.get(self.url,
HTTP_HOST='pip.foo.bar.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header(self):
request = self.factory.get(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='pip')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header_uppercase(self):
request = self.factory.get(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='PIP')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_long_bad_subdomain(self):
domain = 'www.pip.dev.readthedocs.io'
request = self.factory.get(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertEqual(res.status_code, 400)
class MiddlewareTests(RequestFactoryTestMixin, TestCase):
def setUp(self):
self.middleware = ProxitoMiddleware()
self.url = '/'
self.owner = create_user(username='******', password='******')
self.pip = get(Project,
slug='pip',
users=[self.owner],
privacy_level='public')
def run_middleware(self, request):
return self.middleware.process_request(request)
def test_proper_cname(self):
domain = 'docs.random.com'
get(Domain, project=self.pip, domain=domain)
request = self.request(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_proper_cname_https_upgrade(self):
cname = 'docs.random.com'
get(Domain, project=self.pip, domain=cname, canonical=True, https=True)
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'https')
def test_canonical_cname_redirect(self):
"""Requests to the public domain URL should redirect to the custom domain if the domain is canonical/https."""
cname = 'docs.random.com'
domain = get(Domain,
project=self.pip,
domain=cname,
canonical=False,
https=False)
request = self.request(self.url, HTTP_HOST='pip.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertFalse(hasattr(request, 'canonicalize'))
# Make the domain canonical/https and make sure we redirect
domain.canonical = True
domain.https = True
domain.save()
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST='pip.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'canonical-cname')
# We are not canonicalizing custom domains -> public domain for now
@pytest.mark.xfail(strict=True)
def test_canonical_cname_redirect_public_domain(self):
"""Requests to a custom domain should redirect to the public domain or canonical domain if not canonical."""
cname = 'docs.random.com'
domain = get(Domain,
project=self.pip,
domain=cname,
canonical=False,
https=False)
request = self.request(self.url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'noncanonical-cname')
# Make the domain canonical and make sure we don't redirect
domain.canonical = True
domain.save()
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertFalse(hasattr(request, 'canonicalize'))
def test_proper_cname_uppercase(self):
get(Domain, project=self.pip, domain='docs.random.com')
request = self.request(self.url, HTTP_HOST='docs.RANDOM.COM')
self.run_middleware(request)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_invalid_cname(self):
self.assertFalse(Domain.objects.filter(domain='my.host.com').exists())
request = self.request(self.url, HTTP_HOST='my.host.com')
r = self.run_middleware(request)
# We show the 404 error page
self.assertContains(r, 'my.host.com', status_code=404)
def test_proper_subdomain(self):
request = self.request(self.url, HTTP_HOST='pip.dev.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
@override_settings(PUBLIC_DOMAIN='foo.bar.readthedocs.io')
def test_subdomain_different_length(self):
request = self.request(self.url,
HTTP_HOST='pip.foo.bar.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header(self):
request = self.request(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='pip')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header_uppercase(self):
request = self.request(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='PIP')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_long_bad_subdomain(self):
domain = 'www.pip.dev.readthedocs.io'
request = self.request(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertEqual(res.status_code, 400)
class MiddlewareTests(RequestFactoryTestMixin, TestCase):
def setUp(self):
self.middleware = ProxitoMiddleware()
self.url = '/'
self.owner = create_user(username='******', password='******')
self.pip = get(Project,
slug='pip',
users=[self.owner],
privacy_level='public')
def run_middleware(self, request):
return self.middleware.process_request(request)
def test_proper_cname(self):
domain = 'docs.random.com'
get(Domain, project=self.pip, domain=domain)
request = self.request(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_proper_cname_https_upgrade(self):
cname = 'docs.random.com'
get(Domain, project=self.pip, domain=cname, canonical=True, https=True)
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'https')
def test_canonical_cname_redirect(self):
"""Requests to the public domain URL should redirect to the custom domain if the domain is canonical/https."""
cname = 'docs.random.com'
domain = get(Domain,
project=self.pip,
domain=cname,
canonical=False,
https=False)
request = self.request(self.url, HTTP_HOST='pip.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertFalse(hasattr(request, 'canonicalize'))
# Make the domain canonical/https and make sure we redirect
domain.canonical = True
domain.https = True
domain.save()
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST='pip.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'canonical-cname')
def test_subproject_redirect(self):
"""Requests to a subproject should redirect to the domain of the main project."""
subproject = get(
Project,
name='subproject',
slug='subproject',
users=[self.owner],
privacy_level=PUBLIC,
)
subproject.versions.update(privacy_level=PUBLIC)
get(
ProjectRelationship,
parent=self.pip,
child=subproject,
)
for url in (self.url, '/subdir/', '/en/latest/'):
request = self.request(url,
HTTP_HOST='subproject.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertEqual(getattr(request, 'canonicalize', None),
'subproject-main-domain')
# Using a custom domain in a subproject isn't supported (or shouldn't be!).
cname = 'docs.random.com'
domain = get(
Domain,
project=subproject,
domain=cname,
canonical=True,
https=True,
)
request = self.request(self.url,
HTTP_HOST='subproject.dev.readthedocs.io')
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertEqual(getattr(request, 'canonicalize', None),
'canonical-cname')
# We are not canonicalizing custom domains -> public domain for now
@pytest.mark.xfail(strict=True)
def test_canonical_cname_redirect_public_domain(self):
"""Requests to a custom domain should redirect to the public domain or canonical domain if not canonical."""
cname = 'docs.random.com'
domain = get(Domain,
project=self.pip,
domain=cname,
canonical=False,
https=False)
request = self.request(self.url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertTrue(hasattr(request, 'canonicalize'))
self.assertEqual(request.canonicalize, 'noncanonical-cname')
# Make the domain canonical and make sure we don't redirect
domain.canonical = True
domain.save()
for url in (self.url, '/subdir/'):
request = self.request(url, HTTP_HOST=cname)
res = self.run_middleware(request)
self.assertIsNone(res)
self.assertFalse(hasattr(request, 'canonicalize'))
def test_proper_cname_uppercase(self):
get(Domain, project=self.pip, domain='docs.random.com')
request = self.request(self.url, HTTP_HOST='docs.RANDOM.COM')
self.run_middleware(request)
self.assertEqual(request.cname, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_invalid_cname(self):
self.assertFalse(Domain.objects.filter(domain='my.host.com').exists())
request = self.request(self.url, HTTP_HOST='my.host.com')
r = self.run_middleware(request)
# We show the 404 error page
self.assertContains(r, 'my.host.com', status_code=404)
def test_proper_subdomain(self):
request = self.request(self.url, HTTP_HOST='pip.dev.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
@override_settings(PUBLIC_DOMAIN='foo.bar.readthedocs.io')
def test_subdomain_different_length(self):
request = self.request(self.url,
HTTP_HOST='pip.foo.bar.readthedocs.io')
self.run_middleware(request)
self.assertEqual(request.subdomain, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header(self):
request = self.request(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='pip')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_request_header_uppercase(self):
request = self.request(self.url,
HTTP_HOST='some.random.com',
HTTP_X_RTD_SLUG='PIP')
self.run_middleware(request)
self.assertEqual(request.rtdheader, True)
self.assertEqual(request.host_project_slug, 'pip')
def test_long_bad_subdomain(self):
domain = 'www.pip.dev.readthedocs.io'
request = self.request(self.url, HTTP_HOST=domain)
res = self.run_middleware(request)
self.assertEqual(res.status_code, 400)
def test_front_slash(self):
domain = 'pip.dev.readthedocs.io'
# The HttpRequest needs to be created manually,
# because the RequestFactory strips leading /'s
request = HttpRequest()
request.path = '//'
request.META = {'HTTP_HOST': domain}
res = self.run_middleware(request)
self.assertEqual(res.status_code, 302)
self.assertEqual(
res['Location'],
'/',
)
request.path = '///'
res = self.run_middleware(request)
self.assertEqual(res.status_code, 302)
self.assertEqual(
res['Location'],
'/',
)
request.path = '////'
res = self.run_middleware(request)
self.assertEqual(res.status_code, 302)
self.assertEqual(
res['Location'],
'/',
)
request.path = '////?foo'
res = self.run_middleware(request)
self.assertEqual(res.status_code, 302)
self.assertEqual(
res['Location'],
'/%3Ffoo', # Encoded because it's in the middleware
)
def test_front_slash_url(self):
domain = 'pip.dev.readthedocs.io'
# The HttpRequest needs to be created manually,
# because the RequestFactory strips leading /'s
request = HttpRequest()
request.path = '//google.com'
request.META = {'HTTP_HOST': domain}
res = self.run_middleware(request)
self.assertEqual(res.status_code, 302)
self.assertEqual(
res['Location'],
'/google.com',
)