import unittest
|
|
from pyramid.compat import (
|
bytes_,
|
string_types,
|
text_,
|
)
|
|
class Test_exception_response(unittest.TestCase):
|
def _callFUT(self, *arg, **kw):
|
from pyramid.httpexceptions import exception_response
|
return exception_response(*arg, **kw)
|
|
def test_status_400(self):
|
from pyramid.httpexceptions import HTTPBadRequest
|
self.assertTrue(isinstance(self._callFUT(400), HTTPBadRequest))
|
|
def test_status_404(self):
|
from pyramid.httpexceptions import HTTPNotFound
|
self.assertTrue(isinstance(self._callFUT(404), HTTPNotFound))
|
|
def test_status_500(self):
|
from pyramid.httpexceptions import HTTPInternalServerError
|
self.assertTrue(isinstance(self._callFUT(500),
|
HTTPInternalServerError))
|
|
def test_status_201(self):
|
from pyramid.httpexceptions import HTTPCreated
|
self.assertTrue(isinstance(self._callFUT(201), HTTPCreated))
|
|
def test_extra_kw(self):
|
resp = self._callFUT(404, headers=[('abc', 'def')])
|
self.assertEqual(resp.headers['abc'], 'def')
|
|
class Test_default_exceptionresponse_view(unittest.TestCase):
|
def _callFUT(self, context, request):
|
from pyramid.httpexceptions import default_exceptionresponse_view
|
return default_exceptionresponse_view(context, request)
|
|
def test_call_with_exception(self):
|
context = Exception()
|
result = self._callFUT(context, None)
|
self.assertEqual(result, context)
|
|
def test_call_with_nonexception(self):
|
request = DummyRequest()
|
context = Exception()
|
request.exception = context
|
result = self._callFUT(None, request)
|
self.assertEqual(result, context)
|
|
class Test__no_escape(unittest.TestCase):
|
def _callFUT(self, val):
|
from pyramid.httpexceptions import _no_escape
|
return _no_escape(val)
|
|
def test_null(self):
|
self.assertEqual(self._callFUT(None), '')
|
|
def test_not_basestring(self):
|
self.assertEqual(self._callFUT(42), '42')
|
|
def test_unicode(self):
|
class DummyUnicodeObject(object):
|
def __unicode__(self):
|
return text_('42')
|
duo = DummyUnicodeObject()
|
self.assertEqual(self._callFUT(duo), text_('42'))
|
|
class TestHTTPException(unittest.TestCase):
|
def _getTargetClass(self):
|
from pyramid.httpexceptions import HTTPException
|
return HTTPException
|
|
def _getTargetSubclass(self, code='200', title='OK',
|
explanation='explanation', empty_body=False):
|
cls = self._getTargetClass()
|
class Subclass(cls):
|
pass
|
Subclass.empty_body = empty_body
|
Subclass.code = code
|
Subclass.title = title
|
Subclass.explanation = explanation
|
return Subclass
|
|
def _makeOne(self, *arg, **kw):
|
cls = self._getTargetClass()
|
return cls(*arg, **kw)
|
|
def test_implements_IResponse(self):
|
from pyramid.interfaces import IResponse
|
cls = self._getTargetClass()
|
self.assertTrue(IResponse.implementedBy(cls))
|
|
def test_provides_IResponse(self):
|
from pyramid.interfaces import IResponse
|
inst = self._getTargetClass()()
|
self.assertTrue(IResponse.providedBy(inst))
|
|
def test_implements_IExceptionResponse(self):
|
from pyramid.interfaces import IExceptionResponse
|
cls = self._getTargetClass()
|
self.assertTrue(IExceptionResponse.implementedBy(cls))
|
|
def test_provides_IExceptionResponse(self):
|
from pyramid.interfaces import IExceptionResponse
|
inst = self._getTargetClass()()
|
self.assertTrue(IExceptionResponse.providedBy(inst))
|
|
def test_ctor_sets_detail(self):
|
exc = self._makeOne('message')
|
self.assertEqual(exc.detail, 'message')
|
|
def test_ctor_sets_comment(self):
|
exc = self._makeOne(comment='comment')
|
self.assertEqual(exc.comment, 'comment')
|
|
def test_ctor_calls_Exception_ctor(self):
|
exc = self._makeOne('message')
|
self.assertEqual(exc.message, 'message')
|
|
def test_ctor_calls_Response_ctor(self):
|
exc = self._makeOne('message')
|
self.assertEqual(exc.status, '520 Unknown Error')
|
|
def test_ctor_extends_headers(self):
|
exc = self._makeOne(headers=[('X-Foo', 'foo')])
|
self.assertEqual(exc.headers.get('X-Foo'), 'foo')
|
|
def test_ctor_sets_body_template_obj(self):
|
exc = self._makeOne(body_template='${foo}')
|
self.assertEqual(
|
exc.body_template_obj.substitute({'foo': 'foo'}), 'foo')
|
|
def test_ctor_with_empty_body(self):
|
cls = self._getTargetSubclass(empty_body=True)
|
exc = cls()
|
self.assertEqual(exc.content_type, None)
|
self.assertEqual(exc.content_length, None)
|
|
def test_ctor_with_body_doesnt_set_default_app_iter(self):
|
exc = self._makeOne(body=b'123')
|
self.assertEqual(exc.app_iter, [b'123'])
|
|
def test_ctor_with_unicode_body_doesnt_set_default_app_iter(self):
|
exc = self._makeOne(unicode_body=text_('123'))
|
self.assertEqual(exc.app_iter, [b'123'])
|
|
def test_ctor_with_app_iter_doesnt_set_default_app_iter(self):
|
exc = self._makeOne(app_iter=[b'123'])
|
self.assertEqual(exc.app_iter, [b'123'])
|
|
def test_ctor_with_body_sets_default_app_iter_html(self):
|
cls = self._getTargetSubclass()
|
exc = cls('detail')
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'text/html'
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertTrue(body.startswith(b'<html'))
|
self.assertTrue(b'200 OK' in body)
|
self.assertTrue(b'explanation' in body)
|
self.assertTrue(b'detail' in body)
|
|
def test_ctor_with_body_sets_default_app_iter_text(self):
|
cls = self._getTargetSubclass()
|
exc = cls('detail')
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertEqual(body, b'200 OK\n\nexplanation\n\n\ndetail\n\n')
|
|
def test__str__detail(self):
|
exc = self._makeOne()
|
exc.detail = 'abc'
|
self.assertEqual(str(exc), 'abc')
|
|
def test__str__explanation(self):
|
exc = self._makeOne()
|
exc.explanation = 'def'
|
self.assertEqual(str(exc), 'def')
|
|
def test_wsgi_response(self):
|
exc = self._makeOne()
|
self.assertTrue(exc is exc.wsgi_response)
|
|
def test_exception(self):
|
exc = self._makeOne()
|
self.assertTrue(exc is exc.exception)
|
|
def test__calls_start_response(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
self.assertTrue(start_response.headerlist)
|
self.assertEqual(start_response.status, '200 OK')
|
|
def test_call_returns_same_body_called_twice(self):
|
# optimization
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = '*/*'
|
start_response = DummyStartResponse()
|
app_iter = exc(environ, start_response)
|
self.assertEqual(app_iter[0], exc.body)
|
|
def test__default_app_iter_no_comment_plain(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/plain; charset=UTF-8')
|
self.assertEqual(body, b'200 OK\n\nexplanation\n\n\n\n\n')
|
|
def test__default_app_iter_with_comment_plain(self):
|
cls = self._getTargetSubclass()
|
exc = cls(comment='comment')
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/plain; charset=UTF-8')
|
self.assertEqual(body, b'200 OK\n\nexplanation\n\n\n\ncomment\n')
|
|
def test__default_app_iter_no_comment_html(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/plain; charset=UTF-8')
|
self.assertFalse(b'<!-- ' in body)
|
|
def test__content_type(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/plain; charset=UTF-8')
|
|
def test__content_type_default_is_html(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = '*/*'
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/html; charset=UTF-8')
|
|
def test__content_type_text_html(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'text/html'
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/html; charset=UTF-8')
|
|
def test__content_type_application_json(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'application/json'
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'application/json')
|
|
def test__content_type_invalid(self):
|
cls = self._getTargetSubclass()
|
exc = cls()
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'invalid'
|
start_response = DummyStartResponse()
|
exc(environ, start_response)
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/html; charset=UTF-8')
|
|
def test__default_app_iter_with_comment_ampersand(self):
|
cls = self._getTargetSubclass()
|
exc = cls(comment='comment & comment')
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'text/html'
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
for header in start_response.headerlist:
|
if header[0] == 'Content-Type':
|
self.assertEqual(header[1], 'text/html; charset=UTF-8')
|
self.assertTrue(b'<!-- comment & comment -->' in body)
|
|
def test__default_app_iter_with_comment_html(self):
|
cls = self._getTargetSubclass()
|
exc = cls(comment='comment & comment')
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'text/html'
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertTrue(b'<!-- comment & comment -->' in body)
|
|
def test__default_app_iter_with_comment_json(self):
|
cls = self._getTargetSubclass()
|
exc = cls(comment='comment & comment')
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'application/json'
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
import json
|
retval = json.loads(body.decode('UTF-8'))
|
self.assertEqual(retval['code'], '200 OK')
|
self.assertEqual(retval['title'], 'OK')
|
|
def test__default_app_iter_with_custom_json(self):
|
def json_formatter(status, body, title, environ):
|
return {'message': body,
|
'code': status,
|
'title': title,
|
'custom': environ['CUSTOM_VARIABLE']
|
}
|
cls = self._getTargetSubclass()
|
exc = cls(comment='comment', json_formatter=json_formatter)
|
environ = _makeEnviron()
|
environ['HTTP_ACCEPT'] = 'application/json'
|
environ['CUSTOM_VARIABLE'] = 'custom!'
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
import json
|
retval = json.loads(body.decode('UTF-8'))
|
self.assertEqual(retval['code'], '200 OK')
|
self.assertEqual(retval['title'], 'OK')
|
self.assertEqual(retval['custom'], 'custom!')
|
|
def test_custom_body_template(self):
|
cls = self._getTargetSubclass()
|
exc = cls(body_template='${REQUEST_METHOD}')
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertEqual(body, b'200 OK\n\nGET')
|
|
def test_custom_body_template_with_custom_variable_doesnt_choke(self):
|
cls = self._getTargetSubclass()
|
exc = cls(body_template='${REQUEST_METHOD}')
|
environ = _makeEnviron()
|
class Choke(object):
|
def __str__(self): # pragma no cover
|
raise ValueError
|
environ['gardentheory.user'] = Choke()
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertEqual(body, b'200 OK\n\nGET')
|
|
def test_body_template_unicode(self):
|
cls = self._getTargetSubclass()
|
la = text_(b'/La Pe\xc3\xb1a', 'utf-8')
|
environ = _makeEnviron(unicodeval=la)
|
exc = cls(body_template='${unicodeval}')
|
start_response = DummyStartResponse()
|
body = list(exc(environ, start_response))[0]
|
self.assertEqual(body, b'200 OK\n\n/La Pe\xc3\xb1a')
|
|
def test_allow_detail_non_str(self):
|
exc = self._makeOne(detail={'error': 'This is a test'})
|
self.assertIsInstance(exc.__str__(), string_types)
|
|
|
class TestRenderAllExceptionsWithoutArguments(unittest.TestCase):
|
def _doit(self, content_type):
|
from pyramid.httpexceptions import status_map
|
L = []
|
self.assertTrue(status_map)
|
for v in status_map.values():
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
exc = v()
|
exc.content_type = content_type
|
result = list(exc(environ, start_response))[0]
|
if exc.empty_body:
|
self.assertEqual(result, b'')
|
else:
|
self.assertTrue(bytes_(exc.status) in result)
|
L.append(result)
|
self.assertEqual(len(L), len(status_map))
|
|
def test_it_plain(self):
|
self._doit('text/plain')
|
|
def test_it_html(self):
|
self._doit('text/html')
|
|
class Test_HTTPMove(unittest.TestCase):
|
def _makeOne(self, *arg, **kw):
|
from pyramid.httpexceptions import _HTTPMove
|
return _HTTPMove(*arg, **kw)
|
|
def test_it_location_none_valueerrors(self):
|
# Constructing a HTTPMove instance with location=None should
|
# throw a ValueError from __init__ so that a more-confusing
|
# exception won't be thrown later from .prepare(environ)
|
self.assertRaises(ValueError, self._makeOne, location=None)
|
|
def test_it_location_not_passed(self):
|
exc = self._makeOne()
|
self.assertEqual(exc.location, '')
|
|
def test_it_location_passed(self):
|
exc = self._makeOne(location='foo')
|
self.assertEqual(exc.location, 'foo')
|
|
def test_it_location_firstarg(self):
|
exc = self._makeOne('foo')
|
self.assertEqual(exc.location, 'foo')
|
|
def test_it_call_with_default_body_tmpl(self):
|
exc = self._makeOne(location='foo')
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
app_iter = exc(environ, start_response)
|
self.assertEqual(app_iter[0],
|
(b'520 Unknown Error\n\nThe resource has been moved to foo; '
|
b'you should be redirected automatically.\n\n'))
|
|
class TestHTTPForbidden(unittest.TestCase):
|
def _makeOne(self, *arg, **kw):
|
from pyramid.httpexceptions import HTTPForbidden
|
return HTTPForbidden(*arg, **kw)
|
|
def test_it_result_not_passed(self):
|
exc = self._makeOne()
|
self.assertEqual(exc.result, None)
|
|
def test_it_result_passed(self):
|
exc = self._makeOne(result='foo')
|
self.assertEqual(exc.result, 'foo')
|
|
class TestHTTPMethodNotAllowed(unittest.TestCase):
|
def _makeOne(self, *arg, **kw):
|
from pyramid.httpexceptions import HTTPMethodNotAllowed
|
return HTTPMethodNotAllowed(*arg, **kw)
|
|
def test_it_with_default_body_tmpl(self):
|
exc = self._makeOne()
|
environ = _makeEnviron()
|
start_response = DummyStartResponse()
|
app_iter = exc(environ, start_response)
|
self.assertEqual(app_iter[0],
|
(b'405 Method Not Allowed\n\nThe method GET is not '
|
b'allowed for this resource. \n\n\n'))
|
|
|
class DummyRequest(object):
|
exception = None
|
|
class DummyStartResponse(object):
|
def __call__(self, status, headerlist):
|
self.status = status
|
self.headerlist = headerlist
|
|
def _makeEnviron(**kw):
|
environ = {'REQUEST_METHOD': 'GET',
|
'wsgi.url_scheme': 'http',
|
'SERVER_NAME': 'localhost',
|
'SERVER_PORT': '80'}
|
environ.update(kw)
|
return environ
|
