opendev/storyboard
Code Issues Proposed changes

Factory subject is now a template file.

Browse Source 
Previously, the email factory expected a string as the subject
template. Now it uses a template file instead. This is to somewhat
simplify and externalize the various email templates.

This work was originally done by Michael Krotscheck <krotscheck@gmail.com>.

Change-Id: I1dbcbae1a033da68cf720e90be58b4238d068b05
This commit is contained in:
Adam Coldrick
2015-10-29 22:30:12 +00:00
parent 1ecdcb2074
commit 0a776f24fe
5 changed files with 15 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
storyboard/plugin/email/factory.py
View File

@@ -23,7 +23,6 @@ from email.utils import formatdate
from jinja2 import Environment from jinja2 import Environment
from jinja2 import PackageLoader from jinja2 import PackageLoader
from jinja2 import Template
class EmailFactory(object): class EmailFactory(object):
@@ -52,7 +51,7 @@ class EmailFactory(object):
# Store internal values. # Store internal values.
self.sender = sender self.sender = sender
self.subject = Template(subject) self.subject = self.env.get_template(subject)
self.headers = dict() self.headers = dict()
# Add the default text template. # Add the default text template.

1
storyboard/tests/plugin/email/templates/test_long_subject.txt Normal file
View File

@@ -0,0 +1 @@
aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa

1
storyboard/tests/plugin/email/templates/test_subject.txt Normal file
View File

@@ -0,0 +1 @@
{{test_parameter}}

2
storyboard/tests/plugin/email/templates/test_subject_newline.txt Normal file
View File

@@ -0,0 +1,2 @@
with
newline

30
storyboard/tests/plugin/email/test_factory.py
View File

@@ -26,7 +26,7 @@ class TestEmailFactory(base.TestCase):
"""Assert that a simple build provides an email. """Assert that a simple build provides an email.
""" """
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'test_subject', 'test_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
@@ -40,7 +40,7 @@ class TestEmailFactory(base.TestCase):
# Test message headers # Test message headers
self.assertEqual('test@example.org', msg.get('From')) self.assertEqual('test@example.org', msg.get('From'))
self.assertEqual('test_recipient@example.org', msg.get('To')) self.assertEqual('test_recipient@example.org', msg.get('To'))
self.assertEqual('test_subject', msg.get('Subject')) self.assertEqual('value', msg.get('Subject'))
self.assertEqual('auto-generated', msg.get('Auto-Submitted')) self.assertEqual('auto-generated', msg.get('Auto-Submitted'))
self.assertEqual('multipart/alternative', msg.get('Content-Type')) self.assertEqual('multipart/alternative', msg.get('Content-Type'))
self.assertIsNotNone(msg.get('Date')) # This will vary self.assertIsNotNone(msg.get('Date')) # This will vary
@@ -58,7 +58,7 @@ class TestEmailFactory(base.TestCase):
"""Assert that we can set custom headers.""" """Assert that we can set custom headers."""
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'test_subject', 'test_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
custom_headers = { custom_headers = {
@@ -83,7 +83,7 @@ class TestEmailFactory(base.TestCase):
"""Assert that the subject is templateable.""" """Assert that the subject is templateable."""
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'{{test_parameter}}', 'test_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
msg = factory.build('test_recipient@example.org', msg = factory.build('test_recipient@example.org',
@@ -91,9 +91,8 @@ class TestEmailFactory(base.TestCase):
self.assertEqual('value', msg.get('Subject')) self.assertEqual('value', msg.get('Subject'))
# Assert that the subject is trimmed. and appended with an ellipsis. # Assert that the subject is trimmed. and appended with an ellipsis.
test_subject = ('a' * 100)
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
test_subject, 'test_long_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
msg = factory.build('test_recipient@example.org', msg = factory.build('test_recipient@example.org',
@@ -101,18 +100,9 @@ class TestEmailFactory(base.TestCase):
self.assertEqual(78, len(msg.get('Subject'))) self.assertEqual(78, len(msg.get('Subject')))
self.assertEqual('...', msg.get('Subject')[-3:]) self.assertEqual('...', msg.get('Subject')[-3:])
# Assert that the subject has unix newlines trimmed # Assert that the subject has newlines trimmed
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'with\nnewline', 'test_subject_newline.txt',
'test.txt',
'plugin.email')
msg = factory.build('test_recipient@example.org',
test_parameter='value')
self.assertEqual('with newline', msg.get('Subject'))
# Assert that the subject has windows returns trimmed
factory = EmailFactory('test@example.org',
'with\r\nnewline',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
msg = factory.build('test_recipient@example.org', msg = factory.build('test_recipient@example.org',
@@ -125,7 +115,7 @@ class TestEmailFactory(base.TestCase):
''' '''
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'test_subject', 'test_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
factory.add_text_template('test.html', 'html') factory.add_text_template('test.html', 'html')
@@ -155,7 +145,7 @@ class TestEmailFactory(base.TestCase):
""" """
try: try:
EmailFactory('test@example.org', EmailFactory('test@example.org',
'test_subject', 'invalid_subject.txt',
'invalid.txt', 'invalid.txt',
'plugin.email') 'plugin.email')
self.assertFalse(True) self.assertFalse(True)
@@ -164,7 +154,7 @@ class TestEmailFactory(base.TestCase):
try: try:
factory = EmailFactory('test@example.org', factory = EmailFactory('test@example.org',
'test_subject', 'test_subject.txt',
'test.txt', 'test.txt',
'plugin.email') 'plugin.email')
factory.add_text_template('invalid.html', 'html') factory.add_text_template('invalid.html', 'html')