1
# Copyright (C) 2007, 2009, 2010, 2011 Canonical Ltd
3
# This program is free software; you can redistribute it and/or modify
4
# it under the terms of the GNU General Public License as published by
5
# the Free Software Foundation; either version 2 of the License, or
6
# (at your option) any later version.
8
# This program is distributed in the hope that it will be useful,
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11
# GNU General Public License for more details.
13
# You should have received a copy of the GNU General Public License
14
# along with this program; if not, write to the Free Software
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
18
from email.message import Message
19
except ImportError: # python < 3
20
from email.Message import Message
34
def connection_refuser():
36
raise socket.error(errno.ECONNREFUSED, 'Connection Refused')
38
smtp.connect = connect
42
class StubSMTPFactory(object):
43
"""A fake SMTP connection to test the connection setup."""
45
def __init__(self, fail_on=None, smtp_features=None):
46
self._fail_on = fail_on or []
48
self._smtp_features = smtp_features or []
49
self._ehlo_called = False
52
# The factory pretends to be a connection
55
def connect(self, server):
56
self._calls.append(('connect', server))
59
self._calls.append(('helo',))
60
if 'helo' in self._fail_on:
61
return 500, 'helo failure'
63
return 200, 'helo success'
66
self._calls.append(('ehlo',))
67
if 'ehlo' in self._fail_on:
68
return 500, 'ehlo failure'
70
self._ehlo_called = True
71
return 200, 'ehlo success'
73
def has_extn(self, extension):
74
self._calls.append(('has_extn', extension))
75
return self._ehlo_called and extension in self._smtp_features
78
self._calls.append(('starttls',))
79
if 'starttls' in self._fail_on:
80
return 500, 'starttls failure'
82
self._ehlo_called = True
83
return 200, 'starttls success'
86
class WideOpenSMTPFactory(StubSMTPFactory):
87
"""A fake smtp server that implements login by accepting anybody."""
89
def login(self, user, password):
90
self._calls.append(('login', user, password))
93
class TestSMTPConnection(tests.TestCaseInTempDir):
95
def get_connection(self, text, smtp_factory=None):
96
my_config = config.MemoryStack(text)
97
return smtp_connection.SMTPConnection(
98
my_config, _smtp_factory=smtp_factory)
100
def test_defaults(self):
101
conn = self.get_connection(b'')
102
self.assertEqual('localhost', conn._smtp_server)
103
self.assertEqual(None, conn._smtp_username)
104
self.assertEqual(None, conn._smtp_password)
106
def test_smtp_server(self):
107
conn = self.get_connection(b'smtp_server=host:10')
108
self.assertEqual('host:10', conn._smtp_server)
110
def test_missing_server(self):
111
conn = self.get_connection(b'', smtp_factory=connection_refuser)
112
self.assertRaises(smtp_connection.DefaultSMTPConnectionRefused,
114
conn = self.get_connection(b'smtp_server=smtp.example.com',
115
smtp_factory=connection_refuser)
116
self.assertRaises(smtp_connection.SMTPConnectionRefused, conn._connect)
118
def test_smtp_username(self):
119
conn = self.get_connection(b'')
120
self.assertIs(None, conn._smtp_username)
122
conn = self.get_connection(b'smtp_username=joebody')
123
self.assertEqual(u'joebody', conn._smtp_username)
125
def test_smtp_password_from_config(self):
126
conn = self.get_connection(b'')
127
self.assertIs(None, conn._smtp_password)
129
conn = self.get_connection(b'smtp_password=mypass')
130
self.assertEqual(u'mypass', conn._smtp_password)
132
def test_smtp_password_from_user(self):
135
factory = WideOpenSMTPFactory()
136
conn = self.get_connection(
137
b'[DEFAULT]\nsmtp_username=%s\n' % user.encode('ascii'),
138
smtp_factory=factory)
139
self.assertIs(None, conn._smtp_password)
141
ui.ui_factory = ui.CannedInputUIFactory([password])
143
self.assertEqual(password, conn._smtp_password)
145
def test_smtp_password_from_auth_config(self):
148
factory = WideOpenSMTPFactory()
149
conn = self.get_connection(
150
b'[DEFAULT]\nsmtp_username=%s\n' % user.encode('ascii'),
151
smtp_factory=factory)
152
self.assertEqual(user, conn._smtp_username)
153
self.assertIs(None, conn._smtp_password)
154
# Create a config file with the right password
155
conf = config.AuthenticationConfig()
156
conf._get_config().update({'smtptest':
157
{'scheme': 'smtp', 'user': user,
158
'password': password}})
162
self.assertEqual(password, conn._smtp_password)
164
def test_authenticate_with_byte_strings(self):
166
unicode_pass = u'h\xECspass'
167
utf8_pass = unicode_pass.encode('utf-8')
168
factory = WideOpenSMTPFactory()
169
conn = self.get_connection(
170
b'[DEFAULT]\nsmtp_username=%s\nsmtp_password=%s\n'
171
% (user, utf8_pass), smtp_factory=factory)
172
self.assertEqual(unicode_pass, conn._smtp_password)
174
self.assertEqual([('connect', 'localhost'),
176
('has_extn', 'starttls'),
177
('login', user, utf8_pass)], factory._calls)
178
smtp_username, smtp_password = factory._calls[-1][1:]
179
self.assertIsInstance(smtp_username, bytes)
180
self.assertIsInstance(smtp_password, bytes)
182
def test_create_connection(self):
183
factory = StubSMTPFactory()
184
conn = self.get_connection(b'', smtp_factory=factory)
185
conn._create_connection()
186
self.assertEqual([('connect', 'localhost'),
188
('has_extn', 'starttls')], factory._calls)
190
def test_create_connection_ehlo_fails(self):
191
# Check that we call HELO if EHLO failed.
192
factory = StubSMTPFactory(fail_on=['ehlo'])
193
conn = self.get_connection(b'', smtp_factory=factory)
194
conn._create_connection()
195
self.assertEqual([('connect', 'localhost'),
198
('has_extn', 'starttls')], factory._calls)
200
def test_create_connection_ehlo_helo_fails(self):
201
# Check that we raise an exception if both EHLO and HELO fail.
202
factory = StubSMTPFactory(fail_on=['ehlo', 'helo'])
203
conn = self.get_connection(b'', smtp_factory=factory)
204
self.assertRaises(smtp_connection.SMTPError, conn._create_connection)
205
self.assertEqual([('connect', 'localhost'),
207
('helo',)], factory._calls)
209
def test_create_connection_starttls(self):
210
# Check that STARTTLS plus a second EHLO are called if the
211
# server says it supports the feature.
212
factory = StubSMTPFactory(smtp_features=['starttls'])
213
conn = self.get_connection(b'', smtp_factory=factory)
214
conn._create_connection()
215
self.assertEqual([('connect', 'localhost'),
217
('has_extn', 'starttls'),
219
('ehlo',)], factory._calls)
221
def test_create_connection_starttls_fails(self):
222
# Check that we raise an exception if the server claims to
223
# support STARTTLS, but then fails when we try to activate it.
224
factory = StubSMTPFactory(fail_on=['starttls'],
225
smtp_features=['starttls'])
226
conn = self.get_connection(b'', smtp_factory=factory)
227
self.assertRaises(smtp_connection.SMTPError, conn._create_connection)
228
self.assertEqual([('connect', 'localhost'),
230
('has_extn', 'starttls'),
231
('starttls',)], factory._calls)
233
def test_get_message_addresses(self):
236
from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
237
self.assertEqual('', from_)
238
self.assertEqual([], to)
240
msg['From'] = '"J. Random Developer" <jrandom@example.com>'
241
msg['To'] = 'John Doe <john@doe.com>, Jane Doe <jane@doe.com>'
242
msg['CC'] = u'Pepe P\xe9rez <pperez@ejemplo.com>'
243
msg['Bcc'] = 'user@localhost'
245
from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
246
self.assertEqual('jrandom@example.com', from_)
247
self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
248
'pperez@ejemplo.com', 'user@localhost']), sorted(to))
250
# now with breezy's EmailMessage
251
msg = email_message.EmailMessage(
252
'"J. Random Developer" <jrandom@example.com>',
253
['John Doe <john@doe.com>', 'Jane Doe <jane@doe.com>',
254
u'Pepe P\xe9rez <pperez@ejemplo.com>', 'user@localhost'],
257
from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
258
self.assertEqual('jrandom@example.com', from_)
259
self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
260
'pperez@ejemplo.com', 'user@localhost']), sorted(to))
262
def test_destination_address_required(self):
264
msg['From'] = '"J. Random Developer" <jrandom@example.com>'
266
smtp_connection.NoDestinationAddress,
267
smtp_connection.SMTPConnection(config.MemoryStack(b"")
270
msg = email_message.EmailMessage('from@from.com', '', 'subject')
272
smtp_connection.NoDestinationAddress,
273
smtp_connection.SMTPConnection(config.MemoryStack(b"")
276
msg = email_message.EmailMessage('from@from.com', [], 'subject')
278
smtp_connection.NoDestinationAddress,
279
smtp_connection.SMTPConnection(config.MemoryStack(b"")