Files
mayan-edms/mayan/apps/mailer/tests/test_views.py
Roberto Rosario 29b41a7638 Mailing: Add support for a from field
Add support to the mailing profiles for specifying a "from"
address. Closes GitLab issue #522.

This commit adds a new backend class property "class_fields"
which differs from the normal "fields" property. The "class_fields"
property specifies which of the backend fields will be used to
initialize a backend's driver class. This is to avoid passing
fields that the driver doesn't expect and getting an error.

When sending emails, the "send" method will attempt to get
a "from" key from the backend data and use that when sending
emails. If no "from" key is found a None is passes. Django's
behavior in this situation dictates that the "from" value will
then be taken from the DEFAULT_FROM_EMAIL setting.

Signed-off-by: Roberto Rosario <roberto.rosario.gonzalez@gmail.com>
2019-04-15 15:22:54 -04:00

343 lines
12 KiB
Python

from __future__ import unicode_literals
from django.core import mail
from mayan.apps.documents.tests import GenericDocumentViewTestCase
from ..models import UserMailer
from ..permissions import (
permission_mailing_link, permission_mailing_send_document,
permission_user_mailer_create, permission_user_mailer_delete,
permission_user_mailer_use, permission_user_mailer_view
)
from .literals import (
TEST_EMAIL_ADDRESS, TEST_EMAIL_FROM_ADDRESS, TEST_USER_MAILER_BACKEND_PATH,
TEST_USER_MAILER_LABEL, TEST_RECIPIENTS_MULTIPLE_COMMA,
TEST_RECIPIENTS_MULTIPLE_COMMA_RESULT, TEST_RECIPIENTS_MULTIPLE_MIXED,
TEST_RECIPIENTS_MULTIPLE_MIXED_RESULT, TEST_RECIPIENTS_MULTIPLE_SEMICOLON,
TEST_RECIPIENTS_MULTIPLE_SEMICOLON_RESULT
)
from .mailers import TestBackend
from .mixins import MailerTestMixin
class MailerViewsTestCase(MailerTestMixin, GenericDocumentViewTestCase):
def setUp(self):
super(MailerViewsTestCase, self).setUp()
self.login_user()
def _request_document_link_send(self):
return self.post(
'mailer:send_document_link', args=(self.document.pk,),
data={
'email': getattr(
self, 'test_email_address', TEST_EMAIL_ADDRESS
),
'user_mailer': self.user_mailer.pk
},
)
def _request_document_send(self):
return self.post(
'mailer:send_document', args=(self.document.pk,),
data={
'email': getattr(
self, 'test_email_address', TEST_EMAIL_ADDRESS
),
'user_mailer': self.user_mailer.pk
},
)
def _request_user_mailer_create(self):
return self.post(
'mailer:user_mailer_create', args=(
TEST_USER_MAILER_BACKEND_PATH,
), data={
'default': True,
'enabled': True,
'label': TEST_USER_MAILER_LABEL,
}, follow=True
)
def _request_user_mailer_delete(self):
return self.post(
'mailer:user_mailer_delete', args=(self.user_mailer.pk,)
)
def _request_user_mailer_test(self):
return self.post(
'mailer:user_mailer_test', args=(self.user_mailer.pk,), data={
'email': getattr(
self, 'test_email_address', TEST_EMAIL_ADDRESS
)
}, follow=True
)
def test_mail_link_view_no_permissions(self):
self._create_user_mailer()
response = self._request_document_link_send()
self.assertContains(
response, 'Select a valid choice', status_code=200
)
def test_mail_link_view_with_permission(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_link)
self.grant_permission(permission=permission_user_mailer_use)
self._request_document_link_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(mail.outbox[0].to, [TEST_EMAIL_ADDRESS])
def test_mail_document_view_no_permissions(self):
self._create_user_mailer()
response = self._request_document_send()
self.assertContains(
response, 'Select a valid choice', status_code=200
)
def test_mail_document_view_with_permission(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_send_document)
self.grant_permission(permission=permission_user_mailer_use)
self._request_document_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(mail.outbox[0].to, [TEST_EMAIL_ADDRESS])
def test_user_mailer_create_view_no_permissions(self):
self.grant_permission(permission=permission_user_mailer_view)
response = self._request_user_mailer_create()
self.assertNotContains(
response, text=TestBackend.label, status_code=403
)
self.assertEqual(UserMailer.objects.count(), 0)
def test_user_mailer_create_view_with_permissions(self):
self.grant_permission(permission=permission_user_mailer_create)
self.grant_permission(permission=permission_user_mailer_view)
response = self._request_user_mailer_create()
self.assertContains(
response, text=TestBackend.label, status_code=200
)
self.assertEqual(UserMailer.objects.count(), 1)
def test_user_mailer_delete_view_no_permissions(self):
self._create_user_mailer()
self._request_user_mailer_delete()
self.assertQuerysetEqual(
UserMailer.objects.all(), (repr(self.user_mailer),)
)
def test_user_mailer_delete_view_with_access(self):
self._create_user_mailer()
self.grant_access(
obj=self.user_mailer, permission=permission_user_mailer_delete
)
self._request_user_mailer_delete()
self.assertEqual(UserMailer.objects.count(), 0)
def test_user_mailer_list_view_no_permissions(self):
self._create_user_mailer()
response = self.get(
'mailer:user_mailer_list',
)
self.assertNotContains(
response, text=self.user_mailer.label, status_code=200
)
def test_user_mailer_list_view_with_permissions(self):
self._create_user_mailer()
self.grant_permission(permission=permission_user_mailer_view)
response = self.get(
'mailer:user_mailer_list',
)
self.assertContains(
response, text=self.user_mailer.label, status_code=200
)
def test_user_mailer_test_view_no_permissions(self):
self._create_user_mailer()
response = self._request_user_mailer_test()
self.assertEqual(response.status_code, 403)
self.assertEqual(len(mail.outbox), 0)
def test_user_mailer_test_view_with_access(self):
self._create_user_mailer()
self.grant_access(
obj=self.user_mailer, permission=permission_user_mailer_use
)
response = self._request_user_mailer_test()
self.assertEqual(response.status_code, 200)
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(mail.outbox[0].to, [TEST_EMAIL_ADDRESS])
def test_send_multiple_recipients_comma(self):
self._create_user_mailer()
self.grant_access(
obj=self.user_mailer, permission=permission_user_mailer_use
)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_COMMA
response = self._request_user_mailer_test()
self.assertEqual(response.status_code, 200)
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_COMMA_RESULT
)
def test_send_multiple_recipients_mixed(self):
self._create_user_mailer()
self.grant_access(
obj=self.user_mailer, permission=permission_user_mailer_use
)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_MIXED
response = self._request_user_mailer_test()
self.assertEqual(response.status_code, 200)
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_MIXED_RESULT
)
def test_send_multiple_recipients_semicolon(self):
self._create_user_mailer()
self.grant_access(
obj=self.user_mailer, permission=permission_user_mailer_use
)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_SEMICOLON
response = self._request_user_mailer_test()
self.assertEqual(response.status_code, 200)
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_SEMICOLON_RESULT
)
def test_mail_link_view_recipients_comma(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_link)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_COMMA
self._request_document_link_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_COMMA_RESULT
)
def test_mail_link_view_recipients_mixed(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_link)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_MIXED
self._request_document_link_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_MIXED_RESULT
)
def test_mail_link_view_recipients_semicolon(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_link)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_SEMICOLON
self._request_document_link_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_SEMICOLON_RESULT
)
def test_mail_document_view_recipients_comma(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_send_document)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_COMMA
self._request_document_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_COMMA_RESULT
)
def test_mail_document_view_recipients_mixed(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_send_document)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_MIXED
self._request_document_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_MIXED_RESULT
)
def test_mail_document_view_recipients_semicolon(self):
self._create_user_mailer()
self.grant_permission(permission=permission_mailing_send_document)
self.grant_permission(permission=permission_user_mailer_use)
self.test_email_address = TEST_RECIPIENTS_MULTIPLE_SEMICOLON
self._request_document_send()
self.assertEqual(len(mail.outbox), 1)
self.assertEqual(mail.outbox[0].from_email, TEST_EMAIL_FROM_ADDRESS)
self.assertEqual(
mail.outbox[0].to, TEST_RECIPIENTS_MULTIPLE_SEMICOLON_RESULT
)