mirror of
https://github.com/django-helpdesk/django-helpdesk.git
synced 2025-08-26 23:04:48 +02:00
Refactor project folders.
Move helpdesk to src folder. Move tests to project base folder.
This commit is contained in:
Christopher Broderick
409
tests/test_email_notifications.py
Normal file
409
tests/test_email_notifications.py
Normal file
@@ -0,0 +1,409 @@
|
||||
import logging
|
||||
from django.contrib.auth import get_user_model
|
||||
from django.core import mail
|
||||
from django.test import TestCase
|
||||
from helpdesk import settings as helpdesk_settings
|
||||
from helpdesk.models import Queue, Ticket
|
||||
from helpdesk.forms import TicketForm
|
||||
from helpdesk.views.staff import get_user_queues
|
||||
from helpdesk.update_ticket import update_ticket
|
||||
|
||||
User = get_user_model()
|
||||
|
||||
|
||||
class TicketEmailNotificationTests(TestCase):
|
||||
@classmethod
|
||||
def setUpClass(cls):
|
||||
super().setUpClass()
|
||||
|
||||
@classmethod
|
||||
def tearDownClass(cls):
|
||||
super().tearDownClass()
|
||||
|
||||
def setUp(self):
|
||||
# Need at least 2 public queues so that the queue_choices list contains a blank 1st entry
|
||||
self.queue_public_1 = Queue.objects.create(
|
||||
title="Public Queue 1",
|
||||
slug="public_queue_1",
|
||||
allow_public_submission=True,
|
||||
)
|
||||
self.queue_public_2 = Queue.objects.create(
|
||||
title="Public Queue 2",
|
||||
slug="public_queue_2",
|
||||
allow_public_submission=True,
|
||||
)
|
||||
self.queue_not_public_1 = Queue.objects.create(
|
||||
title="Not Public Queue",
|
||||
slug="not_public_queue",
|
||||
allow_public_submission=False,
|
||||
)
|
||||
self.logger = logging.getLogger("helpdesk")
|
||||
self.assigned_user = User.objects.create(
|
||||
username="asgnd_user",
|
||||
email="asgnd@djangohelpdesk.com",
|
||||
)
|
||||
self.creator_user = User.objects.create(
|
||||
username="create_user",
|
||||
email="create@djangohelpdesk.com",
|
||||
)
|
||||
self.new_ticket_cc_user = User.objects.create(
|
||||
username="new_ticket_cc_user",
|
||||
email="new_cc@djangohelpdesk.com",
|
||||
)
|
||||
self.update_ticket_cc_user = User.objects.create(
|
||||
username="update_ticket_cc_user",
|
||||
email="update_cc@djangohelpdesk.com",
|
||||
)
|
||||
self.update_user = User.objects.create(
|
||||
username="update_user",
|
||||
email="update@djangohelpdesk.com",
|
||||
)
|
||||
self.non_user_submitter_email = "submit@random.email"
|
||||
self.queue_choices = get_user_queues(self.creator_user)
|
||||
form = TicketForm(
|
||||
queue_choices=self.queue_choices,
|
||||
data={
|
||||
"title": "Existing Test Ticket",
|
||||
"body": "Test ticket update email notifications",
|
||||
"queue": self.queue_public_2.id,
|
||||
"submitter_email": self.non_user_submitter_email,
|
||||
},
|
||||
)
|
||||
form.full_clean()
|
||||
self.existing_ticket: Ticket = form.save(user=self.creator_user)
|
||||
self.outbox = mail.outbox # @UndefinedVariable
|
||||
self.outbox.clear() # Make sure the outbox is cleared for each test
|
||||
|
||||
def test_create_ticket_assigned(self):
|
||||
"""
|
||||
Ensure the appropriate roles are notified by email when new tickets are created
|
||||
"""
|
||||
form = TicketForm(
|
||||
queue_choices=self.queue_choices,
|
||||
data={
|
||||
"title": "Test Ticket",
|
||||
"body": "Test email notifications",
|
||||
"queue": self.queue_public_2.id,
|
||||
"assigned_to": self.assigned_user.id,
|
||||
"submitter_email": self.non_user_submitter_email,
|
||||
},
|
||||
)
|
||||
form.full_clean()
|
||||
ticket: Ticket = form.save(user=self.creator_user)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
2,
|
||||
f"Expected to send 2 email notifications. {email_cnt} were sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
def test_create_ticket_not_assigned(self):
|
||||
"""
|
||||
No explicit assignment of the ticket - system should assign ticket creator
|
||||
Use an actual user for submitter
|
||||
"""
|
||||
form = TicketForm(
|
||||
queue_choices=self.queue_choices,
|
||||
data={
|
||||
"title": "Test Ticket",
|
||||
"body": "Test email notifications",
|
||||
"queue": self.queue_public_2.id,
|
||||
"submitter_email": self.creator_user.email,
|
||||
},
|
||||
)
|
||||
form.full_clean()
|
||||
ticket: Ticket = form.save(user=self.creator_user)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
1,
|
||||
f"Expected to send 1 email notification. {email_cnt} were sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
def test_update_ticket_default_behaviour(self):
|
||||
"""
|
||||
Ticket is initially unassigned so should not get assigned email until assigned.
|
||||
Change various data points checking where submitter should get emailed.
|
||||
"""
|
||||
# Ensure the attribute is correct since it is not reset on each test
|
||||
setattr(
|
||||
helpdesk_settings, "HELPDESK_NOTIFY_SUBMITTER_FOR_ALL_TICKET_CHANGES", False
|
||||
)
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
comment="Should get a submitter email with this in update.",
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
1,
|
||||
f"1. Expected to send 1 email notification. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Assign a user but no other change so submitter should be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
owner=self.assigned_user.id,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
1,
|
||||
f"2. Expected to send 1 email notification. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Update the ticket status to REOPENED so submitter should not be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
new_status=Ticket.REOPENED_STATUS,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
1,
|
||||
f"3. Expected to send 1 email notification. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Update the ticket status to CLOSED so submitter should be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
new_status=Ticket.CLOSED_STATUS,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
2,
|
||||
f"4. Expected to send 2 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
def test_update_ticket_always_notify_submitter(self):
|
||||
"""
|
||||
Ticket is initially unassigned so should not get assigned email until assigned.
|
||||
Check submitter should always get emailed.
|
||||
"""
|
||||
# Ensure the attribute is correct since it is not reset on each test
|
||||
setattr(
|
||||
helpdesk_settings, "HELPDESK_NOTIFY_SUBMITTER_FOR_ALL_TICKET_CHANGES", True
|
||||
)
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
comment="Should get a submitter email with this in update.",
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
1,
|
||||
f"1. Expected to send 1 email notification. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Assign a user but no other change so submitter should not be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
owner=self.assigned_user.id,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
2,
|
||||
f"2. Expected to send 2 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Update the ticket status to REOPENED - submitter should be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
new_status=Ticket.REOPENED_STATUS,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
2,
|
||||
f"3. Expected to send 2 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Update the ticket status to CLOSED - submitter should be emailed.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
self.existing_ticket,
|
||||
new_status=Ticket.CLOSED_STATUS,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
2,
|
||||
f"4. Expected to send 2 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.existing_ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
def test_ticket_notifiy_cc(self):
|
||||
"""
|
||||
Add CC user(s) to the queue for new tickets and updates.
|
||||
|
||||
NOTE: Oddly the CC user for updates is also sent an email on create
|
||||
"""
|
||||
# Ensure the attribute is correct since it is not reset on each test
|
||||
setattr(
|
||||
helpdesk_settings, "HELPDESK_NOTIFY_SUBMITTER_FOR_ALL_TICKET_CHANGES", False
|
||||
)
|
||||
queue_id = self.queue_public_2.id
|
||||
queue = Queue.objects.get(id=queue_id)
|
||||
queue.enable_notifications_on_email_events = True
|
||||
queue.new_ticket_cc = self.new_ticket_cc_user.email
|
||||
queue.updated_ticket_cc = self.update_ticket_cc_user.email
|
||||
queue.save()
|
||||
form = TicketForm(
|
||||
queue_choices=self.queue_choices,
|
||||
data={
|
||||
"title": "Test Ticket",
|
||||
"body": "Test email notifications",
|
||||
"queue": self.queue_public_2.id,
|
||||
"assigned_to": self.assigned_user.id,
|
||||
"submitter_email": self.non_user_submitter_email,
|
||||
},
|
||||
)
|
||||
form.full_clean()
|
||||
ticket: Ticket = form.save(user=self.creator_user)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
4,
|
||||
f"New ticket CC Notifications test expected to send 4 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.new_ticket_cc_user.email in recipient_list,
|
||||
"New ticket CC user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.update_ticket_cc_user.email in recipient_list,
|
||||
"Update ticket CC user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"New ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
|
||||
# Update the ticket status to CLOSED.
|
||||
self.outbox.clear() # Remove the prior emails
|
||||
update_ticket(
|
||||
self.update_user,
|
||||
ticket,
|
||||
new_status=Ticket.CLOSED_STATUS,
|
||||
public=True,
|
||||
)
|
||||
email_cnt = len(self.outbox)
|
||||
recipient_list = [email.to[0] for email in self.outbox]
|
||||
self.assertTrue(
|
||||
self.update_ticket_cc_user.email in recipient_list,
|
||||
"Updated ticket CC user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertEqual(
|
||||
email_cnt,
|
||||
3,
|
||||
f"Updated CC Ticket test expected to send 3 email notifications. {email_cnt} were sent: {recipient_list}",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.update_ticket_cc_user.email in recipient_list,
|
||||
"Update ticket CC user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
self.assigned_user.email in recipient_list,
|
||||
"Ticket assigned user email not found in email notifications sent.",
|
||||
)
|
||||
self.assertTrue(
|
||||
ticket.submitter_email in recipient_list,
|
||||
"Submitter email not found in email notifications sent.",
|
||||
)
|
||||
Reference in New Issue
Block a user