From 9fc1d90c7db78d95b9c3b9a8d0329b472b8a4280 Mon Sep 17 00:00:00 2001 From: Marc Tamlyn Date: Fri, 3 Aug 2012 10:42:20 +0100 Subject: Move tests into wkhtmltopdf.tests.* Fixes #11. --- wkhtmltopdf/test_settings.py | 16 ++ wkhtmltopdf/tests.py | 272 -------------------------------- wkhtmltopdf/tests/__init__.py | 0 wkhtmltopdf/tests/models.py | 0 wkhtmltopdf/tests/templates/footer.html | 2 + wkhtmltopdf/tests/templates/sample.html | 7 + wkhtmltopdf/tests/tests.py | 272 ++++++++++++++++++++++++++++++++ 7 files changed, 297 insertions(+), 272 deletions(-) create mode 100644 wkhtmltopdf/test_settings.py delete mode 100644 wkhtmltopdf/tests.py create mode 100644 wkhtmltopdf/tests/__init__.py create mode 100644 wkhtmltopdf/tests/models.py create mode 100644 wkhtmltopdf/tests/templates/footer.html create mode 100644 wkhtmltopdf/tests/templates/sample.html create mode 100644 wkhtmltopdf/tests/tests.py (limited to 'wkhtmltopdf') diff --git a/wkhtmltopdf/test_settings.py b/wkhtmltopdf/test_settings.py new file mode 100644 index 0000000..37d086f --- /dev/null +++ b/wkhtmltopdf/test_settings.py @@ -0,0 +1,16 @@ +DEBUG = True + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': ':memory:', + } +} + +MEDIA_URL = '' +STATIC_URL = '' + +INSTALLED_APPS = ( + 'wkhtmltopdf.tests', + 'wkhtmltopdf', +) diff --git a/wkhtmltopdf/tests.py b/wkhtmltopdf/tests.py deleted file mode 100644 index cd0213d..0000000 --- a/wkhtmltopdf/tests.py +++ /dev/null @@ -1,272 +0,0 @@ -# -*- coding: utf-8 -*- - -from __future__ import absolute_import - -import os -import sys - -from django.test import TestCase -from django.test.client import RequestFactory - -from .subprocess import CalledProcessError -from .utils import override_settings, _options_to_args, wkhtmltopdf -from .views import PDFResponse, PDFTemplateView, PDFTemplateResponse - - -class TestUtils(TestCase): - def setUp(self): - # Clear standard error - self._stderr = sys.stderr - sys.stderr = open(os.devnull, 'w') - self.factory = RequestFactory() - - def tearDown(self): - sys.stderr = self._stderr - - def test_options_to_args(self): - self.assertEqual(_options_to_args(), []) - self.assertEqual(_options_to_args(heart=u'♥', verbose=True, - file_name='file-name'), - ['--file-name', 'file-name', - '--heart', u'♥', - '--verbose']) - - def test_wkhtmltopdf(self): - """Should run wkhtmltopdf to generate a PDF""" - title = 'A test template.' - response = PDFTemplateResponse(self.factory.get('/'), None, context={'title': title}) - temp_file = response.render_to_temporary_file('sample.html') - try: - # Standard call - pdf_output = wkhtmltopdf(pages=[temp_file.name]) - self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) - - # Single page - pdf_output = wkhtmltopdf(pages=temp_file.name) - self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) - - # Unicode - pdf_output = wkhtmltopdf(pages=[temp_file.name], title=u'♥') - self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) - - # Invalid arguments - self.assertRaises(CalledProcessError, - wkhtmltopdf, pages=[]) - finally: - temp_file.close() - - def test_PDFTemplateResponse_render_to_temporary_file(self): - """Should render a template to a temporary file.""" - title = 'A test template.' - response = PDFTemplateResponse(self.factory.get('/'), None, context={'title': title}) - temp_file = response.render_to_temporary_file('sample.html') - temp_file.seek(0) - saved_content = temp_file.read() - self.assertTrue(title in saved_content) - temp_file.close() - - -class TestViews(TestCase): - def test_pdf_response(self): - """Should generate the correct HttpResponse object and mimetype""" - # 404 - response = PDFResponse(content='', status=404) - self.assertEqual(response.status_code, 404) - self.assertEqual(response.content, '') - self.assertEqual(response['Content-Type'], 'application/pdf') - self.assertFalse(response.has_header('Content-Disposition')) - - content = '%PDF-1.4\n%%EOF' - # Without filename - response = PDFResponse(content=content) - self.assertEqual(response.status_code, 200) - self.assertEqual(response.content, content) - self.assertEqual(response['Content-Type'], 'application/pdf') - self.assertFalse(response.has_header('Content-Disposition')) - - # With filename - response = PDFResponse(content=content, filename="nospace.pdf") - self.assertEqual(response['Content-Disposition'], - 'attachment; filename="nospace.pdf"') - response = PDFResponse(content=content, filename="one space.pdf") - self.assertEqual(response['Content-Disposition'], - 'attachment; filename="one space.pdf"') - response = PDFResponse(content=content, filename="4'5\".pdf") - self.assertEqual(response['Content-Disposition'], - 'attachment; filename="4\'5.pdf"') - response = PDFResponse(content=content, filename=u"♥.pdf") - self.assertEqual(response['Content-Disposition'], - 'attachment; filename="?.pdf"') - - # Content-Type - response = PDFResponse(content=content, - content_type='application/x-pdf') - self.assertEqual(response['Content-Type'], 'application/x-pdf') - response = PDFResponse(content=content, - mimetype='application/x-pdf') - self.assertEqual(response['Content-Type'], 'application/x-pdf') - - def test_pdf_template_response(self): - """Test PDFTemplateResponse.""" - from django.conf import settings - - with override_settings( - MEDIA_URL='/media/', - MEDIA_ROOT='/tmp/media', - STATIC_URL='/static/', - STATIC_ROOT='/tmp/static', - TEMPLATE_CONTEXT_PROCESSORS=[ - 'django.core.context_processors.media', - 'django.core.context_processors.static', - ], - TEMPLATE_LOADERS=['django.template.loaders.filesystem.Loader'], - TEMPLATE_DIRS=[os.path.join(os.path.dirname(__file__), - '_testproject', 'templates')], - WKHTMLTOPDF_DEBUG=False, - ): - # Setup sample.html - template = 'sample.html' - context = {'title': 'Heading'} - request = RequestFactory().get('/') - response = PDFTemplateResponse(request=request, - template=template, - context=context) - self.assertEqual(response._request, request) - self.assertEqual(response.template_name, template) - self.assertEqual(response.context_data, context) - self.assertEqual(response.filename, None) - self.assertEqual(response.header_template, None) - self.assertEqual(response.footer_template, None) - self.assertEqual(response.cmd_options, {}) - self.assertFalse(response.has_header('Content-Disposition')) - - # Render to temporary file - tempfile = response.render_to_temporary_file(template) - tempfile.seek(0) - html_content = tempfile.read() - self.assertTrue(html_content.startswith('')) - self.assertTrue('

{title}

'.format(**context) - in html_content) - - pdf_content = response.rendered_content - self.assertTrue(pdf_content.startswith('%PDF-')) - self.assertTrue(pdf_content.endswith('%%EOF\n')) - - # Footer - filename = 'output.pdf' - footer_template = 'footer.html' - cmd_options = {'title': 'Test PDF'} - response = PDFTemplateResponse(request=request, - template=template, - context=context, - filename=filename, - footer_template=footer_template, - cmd_options=cmd_options) - self.assertEqual(response.filename, filename) - self.assertEqual(response.header_template, None) - self.assertEqual(response.footer_template, footer_template) - self.assertEqual(response.cmd_options, cmd_options) - self.assertTrue(response.has_header('Content-Disposition')) - - tempfile = response.render_to_temporary_file(footer_template) - tempfile.seek(0) - footer_content = tempfile.read() - - media_url = 'MEDIA_URL = file://{0}/'.format(settings.MEDIA_ROOT) - self.assertTrue( - media_url in footer_content, - "{0!r} not in {1!r}".format(media_url, footer_content) - ) - - static_url = 'STATIC_URL = file://{0}/'.format(settings.STATIC_ROOT) - self.assertTrue( - static_url in footer_content, - "{0!r} not in {1!r}".format(static_url, footer_content) - ) - - pdf_content = response.rendered_content - self.assertTrue('\0'.join('{title}'.format(**cmd_options)) - in pdf_content) - - # Override settings - response = PDFTemplateResponse(request=request, - template=template, - context=context, - filename=filename, - footer_template=footer_template, - cmd_options=cmd_options, - override_settings={ - 'STATIC_URL': 'file:///tmp/s/' - }) - tempfile = response.render_to_temporary_file(footer_template) - tempfile.seek(0) - footer_content = tempfile.read() - - static_url = 'STATIC_URL = {0}'.format('file:///tmp/s/') - self.assertTrue( - static_url in footer_content, - "{0!r} not in {1!r}".format(static_url, footer_content) - ) - self.assertEqual(settings.STATIC_URL, '/static/') - - def test_pdf_template_view(self): - """Test PDFTemplateView.""" - with override_settings( - MEDIA_URL='/media/', - STATIC_URL='/static/', - TEMPLATE_CONTEXT_PROCESSORS=[ - 'django.core.context_processors.media', - 'django.core.context_processors.static', - ], - TEMPLATE_LOADERS=['django.template.loaders.filesystem.Loader'], - TEMPLATE_DIRS=[os.path.join(os.path.dirname(__file__), - '_testproject', 'templates')], - WKHTMLTOPDF_DEBUG=False, - ): - # Setup sample.html - template = 'sample.html' - filename = 'output.pdf' - view = PDFTemplateView.as_view(filename=filename, - template_name=template, - footer_template='footer.html') - - # As PDF - request = RequestFactory().get('/') - response = view(request) - self.assertEqual(response.status_code, 200) - response.render() - self.assertEqual(response['Content-Disposition'], - 'attachment; filename="{0}"'.format(filename)) - self.assertTrue(response.content.startswith('%PDF-')) - self.assertTrue(response.content.endswith('%%EOF\n')) - - # As HTML - request = RequestFactory().get('/?as=html') - response = view(request) - self.assertEqual(response.status_code, 200) - response.render() - self.assertFalse(response.has_header('Content-Disposition')) - self.assertTrue(response.content.startswith('')) - - # POST - request = RequestFactory().post('/') - response = view(request) - self.assertEqual(response.status_code, 405) - - def test_get_cmd_options(self): - # Default cmd_options - view = PDFTemplateView() - self.assertEqual(view.cmd_options, PDFTemplateView.cmd_options) - self.assertEqual(PDFTemplateView.cmd_options, {}) - - # Instantiate with new cmd_options - cmd_options = {'orientation': 'landscape'} - view = PDFTemplateView(cmd_options=cmd_options) - self.assertEqual(view.cmd_options, cmd_options) - self.assertEqual(PDFTemplateView.cmd_options, {}) - - # Update local instance of cmd_options - view = PDFTemplateView() - view.cmd_options.update(cmd_options) - self.assertEqual(view.cmd_options, cmd_options) - self.assertEqual(PDFTemplateView.cmd_options, {}) diff --git a/wkhtmltopdf/tests/__init__.py b/wkhtmltopdf/tests/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/wkhtmltopdf/tests/models.py b/wkhtmltopdf/tests/models.py new file mode 100644 index 0000000..e69de29 diff --git a/wkhtmltopdf/tests/templates/footer.html b/wkhtmltopdf/tests/templates/footer.html new file mode 100644 index 0000000..3ae09cb --- /dev/null +++ b/wkhtmltopdf/tests/templates/footer.html @@ -0,0 +1,2 @@ +MEDIA_URL = {{ MEDIA_URL }} +STATIC_URL = {{ STATIC_URL }} diff --git a/wkhtmltopdf/tests/templates/sample.html b/wkhtmltopdf/tests/templates/sample.html new file mode 100644 index 0000000..3dfbdbb --- /dev/null +++ b/wkhtmltopdf/tests/templates/sample.html @@ -0,0 +1,7 @@ + + + + +

{{ title }}

+ + diff --git a/wkhtmltopdf/tests/tests.py b/wkhtmltopdf/tests/tests.py new file mode 100644 index 0000000..6d8f3ac --- /dev/null +++ b/wkhtmltopdf/tests/tests.py @@ -0,0 +1,272 @@ +# -*- coding: utf-8 -*- + +from __future__ import absolute_import + +import os +import sys + +from django.test import TestCase +from django.test.client import RequestFactory + +from wkhtmltopdf.subprocess import CalledProcessError +from wkhtmltopdf.utils import override_settings, _options_to_args, wkhtmltopdf +from wkhtmltopdf.views import PDFResponse, PDFTemplateView, PDFTemplateResponse + + +class TestUtils(TestCase): + def setUp(self): + # Clear standard error + self._stderr = sys.stderr + sys.stderr = open(os.devnull, 'w') + self.factory = RequestFactory() + + def tearDown(self): + sys.stderr = self._stderr + + def test_options_to_args(self): + self.assertEqual(_options_to_args(), []) + self.assertEqual(_options_to_args(heart=u'♥', verbose=True, + file_name='file-name'), + ['--file-name', 'file-name', + '--heart', u'♥', + '--verbose']) + + def test_wkhtmltopdf(self): + """Should run wkhtmltopdf to generate a PDF""" + title = 'A test template.' + response = PDFTemplateResponse(self.factory.get('/'), None, context={'title': title}) + temp_file = response.render_to_temporary_file('sample.html') + try: + # Standard call + pdf_output = wkhtmltopdf(pages=[temp_file.name]) + self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) + + # Single page + pdf_output = wkhtmltopdf(pages=temp_file.name) + self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) + + # Unicode + pdf_output = wkhtmltopdf(pages=[temp_file.name], title=u'♥') + self.assertTrue(pdf_output.startswith('%PDF'), pdf_output) + + # Invalid arguments + self.assertRaises(CalledProcessError, + wkhtmltopdf, pages=[]) + finally: + temp_file.close() + + def test_PDFTemplateResponse_render_to_temporary_file(self): + """Should render a template to a temporary file.""" + title = 'A test template.' + response = PDFTemplateResponse(self.factory.get('/'), None, context={'title': title}) + temp_file = response.render_to_temporary_file('sample.html') + temp_file.seek(0) + saved_content = temp_file.read() + self.assertTrue(title in saved_content) + temp_file.close() + + +class TestViews(TestCase): + def test_pdf_response(self): + """Should generate the correct HttpResponse object and mimetype""" + # 404 + response = PDFResponse(content='', status=404) + self.assertEqual(response.status_code, 404) + self.assertEqual(response.content, '') + self.assertEqual(response['Content-Type'], 'application/pdf') + self.assertFalse(response.has_header('Content-Disposition')) + + content = '%PDF-1.4\n%%EOF' + # Without filename + response = PDFResponse(content=content) + self.assertEqual(response.status_code, 200) + self.assertEqual(response.content, content) + self.assertEqual(response['Content-Type'], 'application/pdf') + self.assertFalse(response.has_header('Content-Disposition')) + + # With filename + response = PDFResponse(content=content, filename="nospace.pdf") + self.assertEqual(response['Content-Disposition'], + 'attachment; filename="nospace.pdf"') + response = PDFResponse(content=content, filename="one space.pdf") + self.assertEqual(response['Content-Disposition'], + 'attachment; filename="one space.pdf"') + response = PDFResponse(content=content, filename="4'5\".pdf") + self.assertEqual(response['Content-Disposition'], + 'attachment; filename="4\'5.pdf"') + response = PDFResponse(content=content, filename=u"♥.pdf") + self.assertEqual(response['Content-Disposition'], + 'attachment; filename="?.pdf"') + + # Content-Type + response = PDFResponse(content=content, + content_type='application/x-pdf') + self.assertEqual(response['Content-Type'], 'application/x-pdf') + response = PDFResponse(content=content, + mimetype='application/x-pdf') + self.assertEqual(response['Content-Type'], 'application/x-pdf') + + def test_pdf_template_response(self): + """Test PDFTemplateResponse.""" + from django.conf import settings + + with override_settings( + MEDIA_URL='/media/', + MEDIA_ROOT='/tmp/media', + STATIC_URL='/static/', + STATIC_ROOT='/tmp/static', + TEMPLATE_CONTEXT_PROCESSORS=[ + 'django.core.context_processors.media', + 'django.core.context_processors.static', + ], + TEMPLATE_LOADERS=['django.template.loaders.filesystem.Loader'], + TEMPLATE_DIRS=[os.path.join(os.path.dirname(__file__), + '_testproject', 'templates')], + WKHTMLTOPDF_DEBUG=False, + ): + # Setup sample.html + template = 'sample.html' + context = {'title': 'Heading'} + request = RequestFactory().get('/') + response = PDFTemplateResponse(request=request, + template=template, + context=context) + self.assertEqual(response._request, request) + self.assertEqual(response.template_name, template) + self.assertEqual(response.context_data, context) + self.assertEqual(response.filename, None) + self.assertEqual(response.header_template, None) + self.assertEqual(response.footer_template, None) + self.assertEqual(response.cmd_options, {}) + self.assertFalse(response.has_header('Content-Disposition')) + + # Render to temporary file + tempfile = response.render_to_temporary_file(template) + tempfile.seek(0) + html_content = tempfile.read() + self.assertTrue(html_content.startswith('')) + self.assertTrue('

{title}

'.format(**context) + in html_content) + + pdf_content = response.rendered_content + self.assertTrue(pdf_content.startswith('%PDF-')) + self.assertTrue(pdf_content.endswith('%%EOF\n')) + + # Footer + filename = 'output.pdf' + footer_template = 'footer.html' + cmd_options = {'title': 'Test PDF'} + response = PDFTemplateResponse(request=request, + template=template, + context=context, + filename=filename, + footer_template=footer_template, + cmd_options=cmd_options) + self.assertEqual(response.filename, filename) + self.assertEqual(response.header_template, None) + self.assertEqual(response.footer_template, footer_template) + self.assertEqual(response.cmd_options, cmd_options) + self.assertTrue(response.has_header('Content-Disposition')) + + tempfile = response.render_to_temporary_file(footer_template) + tempfile.seek(0) + footer_content = tempfile.read() + + media_url = 'MEDIA_URL = file://{0}/'.format(settings.MEDIA_ROOT) + self.assertTrue( + media_url in footer_content, + "{0!r} not in {1!r}".format(media_url, footer_content) + ) + + static_url = 'STATIC_URL = file://{0}/'.format(settings.STATIC_ROOT) + self.assertTrue( + static_url in footer_content, + "{0!r} not in {1!r}".format(static_url, footer_content) + ) + + pdf_content = response.rendered_content + self.assertTrue('\0'.join('{title}'.format(**cmd_options)) + in pdf_content) + + # Override settings + response = PDFTemplateResponse(request=request, + template=template, + context=context, + filename=filename, + footer_template=footer_template, + cmd_options=cmd_options, + override_settings={ + 'STATIC_URL': 'file:///tmp/s/' + }) + tempfile = response.render_to_temporary_file(footer_template) + tempfile.seek(0) + footer_content = tempfile.read() + + static_url = 'STATIC_URL = {0}'.format('file:///tmp/s/') + self.assertTrue( + static_url in footer_content, + "{0!r} not in {1!r}".format(static_url, footer_content) + ) + self.assertEqual(settings.STATIC_URL, '/static/') + + def test_pdf_template_view(self): + """Test PDFTemplateView.""" + with override_settings( + MEDIA_URL='/media/', + STATIC_URL='/static/', + TEMPLATE_CONTEXT_PROCESSORS=[ + 'django.core.context_processors.media', + 'django.core.context_processors.static', + ], + TEMPLATE_LOADERS=['django.template.loaders.filesystem.Loader'], + TEMPLATE_DIRS=[os.path.join(os.path.dirname(__file__), + '_testproject', 'templates')], + WKHTMLTOPDF_DEBUG=False, + ): + # Setup sample.html + template = 'sample.html' + filename = 'output.pdf' + view = PDFTemplateView.as_view(filename=filename, + template_name=template, + footer_template='footer.html') + + # As PDF + request = RequestFactory().get('/') + response = view(request) + self.assertEqual(response.status_code, 200) + response.render() + self.assertEqual(response['Content-Disposition'], + 'attachment; filename="{0}"'.format(filename)) + self.assertTrue(response.content.startswith('%PDF-')) + self.assertTrue(response.content.endswith('%%EOF\n')) + + # As HTML + request = RequestFactory().get('/?as=html') + response = view(request) + self.assertEqual(response.status_code, 200) + response.render() + self.assertFalse(response.has_header('Content-Disposition')) + self.assertTrue(response.content.startswith('')) + + # POST + request = RequestFactory().post('/') + response = view(request) + self.assertEqual(response.status_code, 405) + + def test_get_cmd_options(self): + # Default cmd_options + view = PDFTemplateView() + self.assertEqual(view.cmd_options, PDFTemplateView.cmd_options) + self.assertEqual(PDFTemplateView.cmd_options, {}) + + # Instantiate with new cmd_options + cmd_options = {'orientation': 'landscape'} + view = PDFTemplateView(cmd_options=cmd_options) + self.assertEqual(view.cmd_options, cmd_options) + self.assertEqual(PDFTemplateView.cmd_options, {}) + + # Update local instance of cmd_options + view = PDFTemplateView() + view.cmd_options.update(cmd_options) + self.assertEqual(view.cmd_options, cmd_options) + self.assertEqual(PDFTemplateView.cmd_options, {}) -- cgit v1.2.3