extern/django-helpdesk
1
0
Fork 1
mirror of https://github.com/django-helpdesk/django-helpdesk.git synced 2025-06-06 09:46:51 +02:00
Code Issues Packages Projects Releases Wiki Activity

Enhance tests for multiple parts in emails.

Browse Source
This commit is contained in:
Christopher Broderick 2023-07-23 06:43:08 +01:00
parent 9bbe1945b0
commit 0b9bfbcddd
1 changed files with 116 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

174
helpdesk/tests/test_get_email.py
View File

@ -7,11 +7,13 @@ from django.core.files.uploadedfile import SimpleUploadedFile
from django.core.management import call_command from django.core.management import call_command
from django.shortcuts import get_object_or_404 from django.shortcuts import get_object_or_404
from django.test import override_settings, TestCase from django.test import override_settings, TestCase
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
import helpdesk.email import helpdesk.email
from helpdesk.email import extract_part_data, object_from_message from helpdesk.email import extract_email_metadata, process_as_attachment
from helpdesk.exceptions import DeleteIgnoredTicketException, IgnoreTicketException from helpdesk.exceptions import DeleteIgnoredTicketException, IgnoreTicketException
from helpdesk.management.commands.get_email import Command from helpdesk.management.commands.get_email import Command
from helpdesk.models import Attachment, FollowUp, FollowUpAttachment, IgnoreEmail, Queue, Ticket, TicketCC from helpdesk.models import FollowUp, FollowUpAttachment, IgnoreEmail, Queue, Ticket, TicketCC
from helpdesk.tests import utils from helpdesk.tests import utils
import itertools import itertools
import logging import logging
@ -59,7 +61,7 @@ class GetEmailCommonTests(TestCase):
""" """
with open(os.path.join(THIS_DIR, "test_files/blank-body-with-attachment.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/blank-body-with-attachment.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
ticket = helpdesk.email.object_from_message( ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger) test_email, self.queue_public, self.logger)
# title got truncated because of max_lengh of the model.title field # title got truncated because of max_lengh of the model.title field
assert ticket.title == ( assert ticket.title == (
@ -67,7 +69,7 @@ class GetEmailCommonTests(TestCase):
"ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo" "ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo"
"ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo..." "ooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooooo..."
) )
self.assertEqual(ticket.description, "") self.assertEqual(ticket.description, "", msg=ticket.description)
def test_email_with_quoted_printable_body(self): def test_email_with_quoted_printable_body(self):
""" """
@ -75,7 +77,7 @@ class GetEmailCommonTests(TestCase):
""" """
with open(os.path.join(THIS_DIR, "test_files/quoted_printable.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/quoted_printable.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
ticket = helpdesk.email.object_from_message( ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger) test_email, self.queue_public, self.logger)
self.assertEqual(ticket.title, "Český test") self.assertEqual(ticket.title, "Český test")
self.assertEqual(ticket.description, self.assertEqual(ticket.description,
@ -96,24 +98,29 @@ class GetEmailCommonTests(TestCase):
""" """
with open(os.path.join(THIS_DIR, "test_files/all-special-chars.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/all-special-chars.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
ticket = helpdesk.email.object_from_message( ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger) test_email, self.queue_public, self.logger)
self.assertEqual(ticket.title, "Testovácí email") self.assertEqual(ticket.title, "Testovácí email")
self.assertEqual(ticket.description, "íářčšáíéřášč") self.assertEqual(ticket.description, "íářčšáíéřášč")
@override_settings(HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL=True) @override_settings(HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL=False)
def test_email_with_utf_8_non_decodable_sequences(self): def test_email_with_utf_8_non_decodable_sequences(self):
""" """
Tests that emails with utf-8 non-decodable sequences are parsed correctly Tests that emails with utf-8 non-decodable sequences are parsed correctly
The message is fowarded as well The forwarded part of the message must still be in the ticket description if
HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL is set to True.
Otherwise it should only be in the Followup records Comment field
NOTE: This test weirdly tests having completely different content in the HTML part
than the PLAIN part so not sure about the validity of this as a test but
the code does support this oddity anyway for backwards compatibility
""" """
with open(os.path.join(THIS_DIR, "test_files/utf-nondecodable.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/utf-nondecodable.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
ticket = helpdesk.email.object_from_message( ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger) test_email, self.queue_public, self.logger)
self.assertEqual( self.assertEqual(
ticket.title, "Fwd: Cyklozaměstnavatel - změna vyhodnocení") ticket.title, "Fwd: Cyklozaměstnavatel - změna vyhodnocení")
self.assertIn("prosazuje lepší", ticket.description) self.assertIn("prosazuje lepší", ticket.description, "Missing text \"prosazuje lepší\" in description: %s" % ticket.description)
followups = FollowUp.objects.filter(ticket=ticket) followups = FollowUp.objects.filter(ticket=ticket)
followup = followups[0] followup = followups[0]
attachments = FollowUpAttachment.objects.filter(followup=followup) attachments = FollowUpAttachment.objects.filter(followup=followup)
@ -122,21 +129,40 @@ class GetEmailCommonTests(TestCase):
attachment.file.read().decode("utf-8")) attachment.file.read().decode("utf-8"))
@override_settings(HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL=True) @override_settings(HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL=True)
def test_email_with_forwarded_message(self): def test_email_with_forwarded_message_just_message_stored(self):
""" """
Forwarded message of that format must be still attached correctly The forwarded part of the message must still be in the ticket description if
HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL is set to True.
Otherwise it should only be in the Followup records Comment field
""" """
with open(os.path.join(THIS_DIR, "test_files/forwarded-message.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/forwarded-message.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
ticket = helpdesk.email.object_from_message( ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger) test_email, self.queue_public, self.logger)
self.assertEqual( self.assertEqual(
ticket.title, "Test with original message from GitHub") ticket.title, "Test with original message from GitHub")
self.assertIn("This is email body", ticket.description) self.assertIn("This is email body", ticket.description)
assert "Hello there!" not in ticket.description, ticket.description self.assertTrue("Hello there!" in ticket.description, ticket.description)
assert FollowUp.objects.filter(ticket=ticket).count() == 1 self.assertTrue(FollowUp.objects.filter(ticket=ticket).count() == 1)
assert "Hello there!" in FollowUp.objects.filter(
ticket=ticket).first().comment @override_settings(HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL=False)
def test_email_with_forwarded_message_chained_messages_stored(self):
"""
The forwarded part of the message must still be in the ticket description if
HELPDESK_FULL_FIRST_MESSAGE_FROM_EMAIL is set to True.
Otherwise it should only be in the Followup records Comment field
"""
with open(os.path.join(THIS_DIR, "test_files/forwarded-message.eml"), encoding="utf-8") as fd:
test_email = fd.read()
ticket = helpdesk.email.extract_email_metadata(
test_email, self.queue_public, self.logger)
self.assertEqual(
ticket.title, "Test with original message from GitHub")
self.assertIn("This is email body", ticket.description)
self.assertTrue("Hello there!" not in ticket.description, ticket.description)
followups = FollowUp.objects.filter(ticket=ticket).values("comment")
self.assertTrue(followups.count() == 1)
self.assertTrue("Hello there!" in followups[0]["comment"], followups[0]["comment"])
def test_will_delete_ignored_email(self): def test_will_delete_ignored_email(self):
""" """
@ -147,7 +173,7 @@ class GetEmailCommonTests(TestCase):
ignore = IgnoreEmail(name="Test Ignore", email_address=from_meta[1], keep_in_mailbox=False) ignore = IgnoreEmail(name="Test Ignore", email_address=from_meta[1], keep_in_mailbox=False)
ignore.save() ignore.save()
with self.assertRaises(DeleteIgnoredTicketException): with self.assertRaises(DeleteIgnoredTicketException):
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
def test_will_not_delete_ignored_email(self): def test_will_not_delete_ignored_email(self):
""" """
@ -158,7 +184,7 @@ class GetEmailCommonTests(TestCase):
ignore = IgnoreEmail(name="Test Ignore", email_address=from_meta[1], keep_in_mailbox=True) ignore = IgnoreEmail(name="Test Ignore", email_address=from_meta[1], keep_in_mailbox=True)
ignore.save() ignore.save()
with self.assertRaises(IgnoreTicketException): with self.assertRaises(IgnoreTicketException):
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
def test_utf8_filename_attachment(self): def test_utf8_filename_attachment(self):
""" """
@ -167,7 +193,7 @@ class GetEmailCommonTests(TestCase):
filename = "TeléfonoMañana.txt" filename = "TeléfonoMañana.txt"
part = utils.generate_file_mime_part(locale="es_ES", filename=filename) part = utils.generate_file_mime_part(locale="es_ES", filename=filename)
files: typing.List[SimpleUploadedFile] = [] files: typing.List[SimpleUploadedFile] = []
extract_part_data(part, counter=1, ticket_id="tst1", files=files, logger=self.logger) process_as_attachment(part, counter=1, files=files, logger=self.logger)
sent_file: SimpleUploadedFile = files[0] sent_file: SimpleUploadedFile = files[0]
# The extractor prepends a part identifier so compare the ending # The extractor prepends a part identifier so compare the ending
self.assertTrue(sent_file.name.endswith(filename), f"Filename extracted does not match: {sent_file.name}") self.assertTrue(sent_file.name.endswith(filename), f"Filename extracted does not match: {sent_file.name}")
@ -179,17 +205,17 @@ class GetEmailCommonTests(TestCase):
""" """
message, _, _ = utils.generate_multipart_email(type_list=['plain', 'image']) message, _, _ = utils.generate_multipart_email(type_list=['plain', 'image'])
self.assertEqual(len(mail.outbox), 0) self.assertEqual(len(mail.outbox), 0) # @UndefinedVariable
with self.assertLogs(logger='helpdesk', level='ERROR') as cm: with self.assertLogs(logger='helpdesk', level='ERROR') as cm:
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
self.assertIn( self.assertIn(
"ERROR:helpdesk:['Unsupported file extension: .jpg']", "ERROR:helpdesk:['Unsupported file extension: .jpg']",
cm.output cm.output
) )
self.assertEqual(len(mail.outbox), 1) self.assertEqual(len(mail.outbox), 1) # @UndefinedVariable
self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject) self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject)
def test_multiple_attachments(self): def test_multiple_attachments(self):
@ -198,11 +224,11 @@ class GetEmailCommonTests(TestCase):
""" """
message, _, _ = utils.generate_multipart_email(type_list=['plain', 'file', 'image']) message, _, _ = utils.generate_multipart_email(type_list=['plain', 'file', 'image'])
self.assertEqual(len(mail.outbox), 0) self.assertEqual(len(mail.outbox), 0) # @UndefinedVariable
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
self.assertEqual(len(mail.outbox), 1) self.assertEqual(len(mail.outbox), 1) # @UndefinedVariable
self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject) self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject)
ticket = Ticket.objects.get() ticket = Ticket.objects.get()
@ -216,10 +242,10 @@ class GetEmailCommonTests(TestCase):
""" """
message, _, _ = utils.generate_multipart_email(type_list=['plain', 'image', 'file', 'image']) message, _, _ = utils.generate_multipart_email(type_list=['plain', 'image', 'file', 'image'])
self.assertEqual(len(mail.outbox), 0) self.assertEqual(len(mail.outbox), 0) # @UndefinedVariable
with self.assertLogs(logger='helpdesk', level='ERROR') as cm: with self.assertLogs(logger='helpdesk', level='ERROR') as cm:
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
self.assertIn( self.assertIn(
"ERROR:helpdesk:['Unsupported file extension: .jpg']", "ERROR:helpdesk:['Unsupported file extension: .jpg']",
@ -240,18 +266,72 @@ class GetEmailCommonTests(TestCase):
att_content = email_attachment.as_string() att_content = email_attachment.as_string()
message.attach(utils.generate_file_mime_part(filename=att_filename, content=att_content)) message.attach(utils.generate_file_mime_part(filename=att_filename, content=att_content))
object_from_message(message.as_string(), self.queue_public, self.logger) extract_email_metadata(message.as_string(), self.queue_public, self.logger)
self.assertEqual(len(mail.outbox), 1) # @UndefinedVariable
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject) self.assertEqual(f'[test-1] {message.get("subject")} (Opened)', mail.outbox[0].subject)
ticket = Ticket.objects.get() ticket = Ticket.objects.get()
followup = ticket.followup_set.get() followup = ticket.followup_set.get()
att_retrieved: Attachment = followup.followupattachment_set.get()
self.assertTrue(att_retrieved.filename.endswith(att_filename), "Filename of attached multipart not detected: %s" % (att_retrieved.filename)) for att_retrieved in followup.followupattachment_set.all():
with att_retrieved.file.open('r') as f: if (helpdesk.email.HTML_EMAIL_ATTACHMENT_FILENAME == att_retrieved.filename):
retrieved_content = f.read() # Ignore the HTML formatted conntent of the email that is attached
self.assertEquals(att_content, retrieved_content, "Retrieved attachment content different to original :\n\n%s\n\n%s" % (att_content, retrieved_content)) continue
self.assertTrue(att_retrieved.filename.endswith(att_filename), "Filename of attached multipart not detected: %s" % (att_retrieved.filename))
with att_retrieved.file.open('r') as f:
retrieved_content = f.read()
self.assertEquals(att_content, retrieved_content, "Retrieved attachment content different to original :\n\n%s\n\n%s" % (att_content, retrieved_content))
def test_email_with_inline_and_multipart_as_attachments(self):
"""
Test a multipart email with an inline attachment and a multipart email attachment to the email
"""
inline_att_filename = 'inline_attachment.jpg'
email_att_filename = 'email_attachment2.eml'
# Create the inline attachment for the email using an ID so we can reference it in the email body
inline_image_id = "liTE5er6Dbnd"
inline_attachment = utils.generate_image_mime_part(locale="en_US", imagename=inline_att_filename, disposition_primary_type="inline")
inline_attachment.add_header('X-Attachment-Id', inline_image_id)
inline_attachment.add_header('Content-ID', '<' + inline_image_id + '>')
# Create the actual email with its plain and HTML parts
email_message = MIMEMultipart(_subtype="alternative")
# Create the plain and HTML that will reference the inline attachment
plain_body = "Test with inline image: \n[image: " + inline_att_filename + "]\n\n"
plain_msg = MIMEText(plain_body)
email_message.attach(plain_msg)
html_body = '<div><div>Test with inline image: <img src=3D"cid:' + inline_image_id + '" alt=3D="' + inline_att_filename + '"><br></div>'
html_msg = MIMEText(html_body, "html")
email_message.attach(html_msg)
# Create the email attachment and attach that as well
email_attachment, _, _ = utils.generate_multipart_email(type_list=['plain', 'html'])
email_att_content = email_attachment.as_string()
email_message.attach(utils.generate_file_mime_part(filename=email_att_filename, content=email_att_content))
# Now create the base multipart and attach all the other parts to it
base_message,_ ,_ = utils.generate_multipart_email(type_list=[], sub_type="related")
base_message.attach(email_message)
base_message.attach(inline_attachment)
extract_email_metadata(base_message.as_string(), self.queue_public, self.logger)
self.assertEqual(len(mail.outbox), 1) # @UndefinedVariable
self.assertEqual(f'[test-1] {base_message.get("subject")} (Opened)', mail.outbox[0].subject)
ticket = Ticket.objects.get()
followup = ticket.followup_set.get()
# Check both the inline and attachment are stored as attached files
inline_found = False
email_attachment_found = False
for att_retrieved in followup.followupattachment_set.all():
if (helpdesk.email.HTML_EMAIL_ATTACHMENT_FILENAME == att_retrieved.filename):
# Ignore the HTML formatted conntent of the email that is attached
continue
if att_retrieved.filename.endswith(inline_att_filename):
inline_found = True
elif att_retrieved.filename.endswith(email_att_filename):
email_attachment_found = True
else:
self.assertTrue(False, "Unexpected file in ticket attachments: " % att_retrieved.filename)
self.assertTrue(email_attachment_found, "Email attachment file not found ticket attachments: %s" % (email_att_filename))
self.assertTrue(inline_found, "Inline file not found in email: %s" % (inline_att_filename))
class GetEmailParametricTemplate(object): class GetEmailParametricTemplate(object):
@ -424,7 +504,6 @@ class GetEmailParametricTemplate(object):
def test_commas_in_mail_headers(self): def test_commas_in_mail_headers(self):
"""Tests correctly decoding mail headers when a comma is encoded into """Tests correctly decoding mail headers when a comma is encoded into
UTF-8. See bug report #832.""" UTF-8. See bug report #832."""
# Create the from using standard RFC required formats # Create the from using standard RFC required formats
# Override the last_name to ensure we get a non-ascii character in it # Override the last_name to ensure we get a non-ascii character in it
test_email_from_meta = utils.generate_email_address("fr_FR", last_name_override="Bouissières") test_email_from_meta = utils.generate_email_address("fr_FR", last_name_override="Bouissières")
@ -488,7 +567,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -510,7 +588,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -553,7 +630,6 @@ class GetEmailParametricTemplate(object):
except this time the email body contains a Django template tag. except this time the email body contains a Django template tag.
For each email source supported, we mock the backend to provide For each email source supported, we mock the backend to provide
authentically formatted responses containing our test data.""" authentically formatted responses containing our test data."""
# example email text from Django docs: # example email text from Django docs:
# https://docs.djangoproject.com/en/1.10/ref/unicode/ # https://docs.djangoproject.com/en/1.10/ref/unicode/
test_email_from = "Arnbjörg Ráðormsdóttir <arnbjorg@example.com>" test_email_from = "Arnbjörg Ráðormsdóttir <arnbjorg@example.com>"
@ -617,7 +693,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -639,7 +714,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -680,12 +754,8 @@ class GetEmailParametricTemplate(object):
emails from a queue and creating tickets. emails from a queue and creating tickets.
For each email source supported, we mock the backend to provide For each email source supported, we mock the backend to provide
authentically formatted responses containing our test data.""" authentically formatted responses containing our test data."""
# example email text from Python docs: # example email text from Python docs:
# https://docs.python.org/3/library/email-examples.html # https://docs.python.org/3/library/email-examples.html
from email.mime.multipart import MIMEMultipart
from email.mime.text import MIMEText
me = "my@example.com" me = "my@example.com"
you = "your@example.com" you = "your@example.com"
# NOTE: CC'd emails need to be alphabetical and tested as such! # NOTE: CC'd emails need to be alphabetical and tested as such!
@ -695,7 +765,6 @@ class GetEmailParametricTemplate(object):
cc_two = "other@example.com" cc_two = "other@example.com"
cc = cc_one + ", " + cc_two cc = cc_one + ", " + cc_two
subject = "Link" subject = "Link"
# Create message container - the correct MIME type is # Create message container - the correct MIME type is
# multipart/alternative. # multipart/alternative.
msg = MIMEMultipart('alternative') msg = MIMEMultipart('alternative')
@ -703,7 +772,6 @@ class GetEmailParametricTemplate(object):
msg['From'] = me msg['From'] = me
msg['To'] = you msg['To'] = you
msg['Cc'] = cc msg['Cc'] = cc
# Create the body of the message (a plain-text and an HTML version). # Create the body of the message (a plain-text and an HTML version).
text = "Hi!\nHow are you?\nHere is the link you wanted:\nhttps://www.python.org" text = "Hi!\nHow are you?\nHere is the link you wanted:\nhttps://www.python.org"
html = """\ html = """\
@ -717,11 +785,9 @@ class GetEmailParametricTemplate(object):
</body> </body>
</html> </html>
""" """
# Record the MIME types of both parts - text/plain and text/html. # Record the MIME types of both parts - text/plain and text/html.
part1 = MIMEText(text, 'plain') part1 = MIMEText(text, 'plain')
part2 = MIMEText(html, 'html') part2 = MIMEText(html, 'html')
# Attach parts into message container. # Attach parts into message container.
# According to RFC 2046, the last part of a multipart message, in this case # According to RFC 2046, the last part of a multipart message, in this case
# the HTML message, is best and preferred. # the HTML message, is best and preferred.
@ -785,7 +851,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -807,7 +872,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -867,7 +931,6 @@ class GetEmailParametricTemplate(object):
def test_read_pgp_signed_email(self): def test_read_pgp_signed_email(self):
"""Tests reading a PGP signed email to ensure we handle base64 """Tests reading a PGP signed email to ensure we handle base64
and PGP signatures appropriately.""" and PGP signatures appropriately."""
# example email text from #567 on GitHub # example email text from #567 on GitHub
with open(os.path.join(THIS_DIR, "test_files/pgp.eml"), encoding="utf-8") as fd: with open(os.path.join(THIS_DIR, "test_files/pgp.eml"), encoding="utf-8") as fd:
test_email = fd.read() test_email = fd.read()
@ -923,7 +986,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -944,7 +1006,6 @@ class GetEmailParametricTemplate(object):
mocked_imaplib_server = mock.Mock() mocked_imaplib_server = mock.Mock()
mocked_imaplib_server.search = mock.Mock( mocked_imaplib_server.search = mock.Mock(
return_value=imap_mail_list) return_value=imap_mail_list)
# we ignore the second arg as the data item/mime-part is # we ignore the second arg as the data item/mime-part is
# constant (RFC822) # constant (RFC822)
mocked_imaplib_server.fetch = mock.Mock( mocked_imaplib_server.fetch = mock.Mock(
@ -1001,8 +1062,6 @@ a9eiiQ+3V1v+7wWHXCzq
""") """)
# should this be 'application/pgp-signature'? # should this be 'application/pgp-signature'?
# self.assertEqual(attach1.mime_type, 'text/plain') # self.assertEqual(attach1.mime_type, 'text/plain')
class GetEmailCCHandling(TestCase): class GetEmailCCHandling(TestCase):
"""TestCase that checks CC handling in email. Needs its own test harness.""" """TestCase that checks CC handling in email. Needs its own test harness."""
@ -1102,7 +1161,6 @@ class GetEmailCCHandling(TestCase):
", " + test_email_cc_three + ", " + test_email_cc_four + ", " + ticket_user_emails + \ ", " + test_email_cc_three + ", " + test_email_cc_four + ", " + ticket_user_emails + \
"\nFrom: " + test_email_from + "\nSubject: " + \ "\nFrom: " + test_email_from + "\nSubject: " + \
test_email_subject + "\n\n" + test_email_body test_email_subject + "\n\n" + test_email_body
test_mail_len = len(test_email)
with mock.patch('os.listdir') as mocked_listdir, \ with mock.patch('os.listdir') as mocked_listdir, \
mock.patch('helpdesk.email.isfile') as mocked_isfile, \ mock.patch('helpdesk.email.isfile') as mocked_isfile, \