From 72a99cc99a3d57a241e6a94db1d0f3f1272cc3bf Mon Sep 17 00:00:00 2001 From: Alex Seeholzer Date: Tue, 1 Nov 2016 13:44:24 +0100 Subject: [PATCH] Moved existing test for local mailbox into generation of tests for matrix of email configurations; --- helpdesk/tests/test_get_email.py | 98 ++++++++++++++++++++++++-------- 1 file changed, 73 insertions(+), 25 deletions(-) diff --git a/helpdesk/tests/test_get_email.py b/helpdesk/tests/test_get_email.py index ca803716..f6df2d7f 100644 --- a/helpdesk/tests/test_get_email.py +++ b/helpdesk/tests/test_get_email.py @@ -1,12 +1,10 @@ from helpdesk.models import Queue, Ticket -from helpdesk.management.commands.get_email import process_email from django.test import TestCase -from django.core import mail from django.core.management import call_command -from django.test.client import Client from django.utils import six -from django.core.urlresolvers import reverse from django.shortcuts import get_object_or_404 +import itertools +import sys try: # python 3 from urllib.parse import urlparse @@ -21,39 +19,89 @@ except ImportError: import mock -class GetEmailTestCase(TestCase): - ''' Test reading emails from a local directory ''' - - def setUp(self): - self.queue_public = Queue.objects.create(title='Queue 1', slug='QQ', allow_public_submission=True, allow_email_submission=True, email_box_type='local', email_box_local_dir='/var/lib/mail/helpdesk/') +class GetEmailCommonTests(TestCase): # tests correct syntax for command line option def test_get_email_quiet_option(self): + """Test quiet option is properly propagated""" with mock.patch('helpdesk.management.commands.get_email.process_email') as mocked_processemail: call_command('get_email', quiet=True) mocked_processemail.assert_called_with(quiet=True) call_command('get_email') mocked_processemail.assert_called_with(quiet=False) - # tests reading emails from a queue and creating tickets + +class GetEmailParametricTemplate(object): + """TestCase that checks email functionality accross methods and socks configs.""" + + def setUp(self): + + kwargs = { + "title": 'Queue 1', + "slug": 'QQ', + "allow_public_submission": True, + "allow_email_submission": True, + "email_box_type": self.method} + + if self.method == 'local': + kwargs["email_box_local_dir"] = '/var/lib/mail/helpdesk/' + + if self.socks: + kwargs["socks_proxy_type"] = self.socks + kwargs["socks_proxy_host"] = "127.0.0.1" + kwargs["socks_proxy_host"] = "9150" # default for tor + + self.queue_public = Queue.objects.create(**kwargs) + def test_read_email(self): + """Tests reading emails from a queue and creating tickets.""" test_email = "To: update.public@example.com\nFrom: comment@example.com\nSubject: Some Comment\n\nThis is the helpdesk comment via email." - with mock.patch('helpdesk.management.commands.get_email.listdir') as mocked_listdir, \ - mock.patch('helpdesk.management.commands.get_email.isfile') as mocked_isfile, \ - mock.patch('builtins.open' if six.PY3 else '__builtin__.open', mock.mock_open(read_data=test_email)): - mocked_isfile.return_value = True - mocked_listdir.return_value = ['filename1', 'filename2'] - call_command('get_email') + # Test local email reading + if self.method == 'local': + with mock.patch('helpdesk.management.commands.get_email.listdir') as mocked_listdir, \ + mock.patch('helpdesk.management.commands.get_email.isfile') as mocked_isfile, \ + mock.patch('builtins.open' if six.PY3 else '__builtin__.open', mock.mock_open(read_data=test_email)): + mocked_isfile.return_value = True + mocked_listdir.return_value = ['filename1', 'filename2'] - mocked_listdir.assert_called_with('/var/lib/mail/helpdesk/') - mocked_isfile.assert_any_call('/var/lib/mail/helpdesk/filename1') - mocked_isfile.assert_any_call('/var/lib/mail/helpdesk/filename2') + call_command('get_email') - ticket1 = get_object_or_404(Ticket, pk=1) - self.assertEqual(ticket1.ticket_for_url, "QQ-%s" % ticket1.id) - self.assertEqual(ticket1.description, "This is the helpdesk comment via email.") + mocked_listdir.assert_called_with('/var/lib/mail/helpdesk/') + mocked_isfile.assert_any_call('/var/lib/mail/helpdesk/filename1') + mocked_isfile.assert_any_call('/var/lib/mail/helpdesk/filename2') - ticket2 = get_object_or_404(Ticket, pk=2) - self.assertEqual(ticket2.ticket_for_url, "QQ-%s" % ticket2.id) - self.assertEqual(ticket2.description, "This is the helpdesk comment via email.") + # Other methods go here, not implemented yet. + else: + return True + + ticket1 = get_object_or_404(Ticket, pk=1) + self.assertEqual(ticket1.ticket_for_url, "QQ-%s" % ticket1.id) + self.assertEqual(ticket1.description, "This is the helpdesk comment via email.") + + ticket2 = get_object_or_404(Ticket, pk=2) + self.assertEqual(ticket2.ticket_for_url, "QQ-%s" % ticket2.id) + self.assertEqual(ticket2.description, "This is the helpdesk comment via email.") + +# build matrix of test cases +case_methods = [c[0] for c in Queue._meta.get_field('email_box_type').choices] +case_socks = ("SOCKS4", "SOCKS5", False) +case_matrix = list(itertools.product(case_methods, case_socks)) + +# Populate TestCases from the matrix of parameters +thismodule = sys.modules[__name__] +for method, socks in case_matrix: + + if method == "local" and socks: + continue + + socks_str = "Nosocks" + if socks: + socks_str = socks.capitalize() + test_name = str( + "TestGetEmail%s%s" % (method.capitalize(), socks_str)) + + cl = type(test_name, (GetEmailParametricTemplate, TestCase,), { + "method": method, + "socks": socks}) + setattr(thismodule, test_name, cl)