← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/tests/test_smtp_connection.py

  • Committer: John Arbash Meinel
  • Date: 2013-05-19 14:29:37 UTC
  • mfrom: (6437.63.9 2.5)
  • mto: (6437.63.10 2.5)
  • mto: This revision was merged to the branch mainline in revision 6575.
  • Revision ID: john@arbash-meinel.com-20130519142937-21ykz2n2y2f22za9
Merge in the actual 2.5 branch. It seems I failed before

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/tests/test_smtp_connection.py
 
1
# Copyright (C) 2007, 2009, 2010, 2011 Canonical Ltd
 
2
#
 
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.
 
7
#
 
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.
 
12
#
 
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
 
16
 
 
17
from email.Message import Message
 
18
import errno
 
19
import smtplib
 
20
import socket
 
21
 
 
22
from bzrlib import (
 
23
    config,
 
24
    email_message,
 
25
    errors,
 
26
    smtp_connection,
 
27
    tests,
 
28
    ui,
 
29
    )
 
30
 
 
31
 
 
32
def connection_refuser():
 
33
    def connect(server):
 
34
        raise socket.error(errno.ECONNREFUSED, 'Connection Refused')
 
35
    smtp = smtplib.SMTP()
 
36
    smtp.connect = connect
 
37
    return smtp
 
38
 
 
39
 
 
40
class StubSMTPFactory(object):
 
41
    """A fake SMTP connection to test the connection setup."""
 
42
    def __init__(self, fail_on=None, smtp_features=None):
 
43
        self._fail_on = fail_on or []
 
44
        self._calls = []
 
45
        self._smtp_features = smtp_features or []
 
46
        self._ehlo_called = False
 
47
 
 
48
    def __call__(self):
 
49
        # The factory pretends to be a connection
 
50
        return self
 
51
 
 
52
    def connect(self, server):
 
53
        self._calls.append(('connect', server))
 
54
 
 
55
    def helo(self):
 
56
        self._calls.append(('helo',))
 
57
        if 'helo' in self._fail_on:
 
58
            return 500, 'helo failure'
 
59
        else:
 
60
            return 200, 'helo success'
 
61
 
 
62
    def ehlo(self):
 
63
        self._calls.append(('ehlo',))
 
64
        if 'ehlo' in self._fail_on:
 
65
            return 500, 'ehlo failure'
 
66
        else:
 
67
            self._ehlo_called = True
 
68
            return 200, 'ehlo success'
 
69
 
 
70
    def has_extn(self, extension):
 
71
        self._calls.append(('has_extn', extension))
 
72
        return self._ehlo_called and extension in self._smtp_features
 
73
 
 
74
    def starttls(self):
 
75
        self._calls.append(('starttls',))
 
76
        if 'starttls' in self._fail_on:
 
77
            return 500, 'starttls failure'
 
78
        else:
 
79
            self._ehlo_called = True
 
80
            return 200, 'starttls success'
 
81
 
 
82
 
 
83
class WideOpenSMTPFactory(StubSMTPFactory):
 
84
    """A fake smtp server that implements login by accepting anybody."""
 
85
 
 
86
    def login(self, user, password):
 
87
        self._calls.append(('login', user, password))
 
88
 
 
89
 
 
90
class TestSMTPConnection(tests.TestCaseInTempDir):
 
91
 
 
92
    def get_connection(self, text, smtp_factory=None):
 
93
        my_config = config.MemoryStack(text)
 
94
        return smtp_connection.SMTPConnection(
 
95
            my_config, _smtp_factory=smtp_factory)
 
96
 
 
97
    def test_defaults(self):
 
98
        conn = self.get_connection('')
 
99
        self.assertEqual('localhost', conn._smtp_server)
 
100
        self.assertEqual(None, conn._smtp_username)
 
101
        self.assertEqual(None, conn._smtp_password)
 
102
 
 
103
    def test_smtp_server(self):
 
104
        conn = self.get_connection('smtp_server=host:10')
 
105
        self.assertEqual('host:10', conn._smtp_server)
 
106
 
 
107
    def test_missing_server(self):
 
108
        conn = self.get_connection('', smtp_factory=connection_refuser)
 
109
        self.assertRaises(errors.DefaultSMTPConnectionRefused, conn._connect)
 
110
        conn = self.get_connection('smtp_server=smtp.example.com',
 
111
                                   smtp_factory=connection_refuser)
 
112
        self.assertRaises(errors.SMTPConnectionRefused, conn._connect)
 
113
 
 
114
    def test_smtp_username(self):
 
115
        conn = self.get_connection('')
 
116
        self.assertIs(None, conn._smtp_username)
 
117
 
 
118
        conn = self.get_connection('smtp_username=joebody')
 
119
        self.assertEqual(u'joebody', conn._smtp_username)
 
120
 
 
121
    def test_smtp_password_from_config(self):
 
122
        conn = self.get_connection('')
 
123
        self.assertIs(None, conn._smtp_password)
 
124
 
 
125
        conn = self.get_connection('smtp_password=mypass')
 
126
        self.assertEqual(u'mypass', conn._smtp_password)
 
127
 
 
128
    def test_smtp_password_from_user(self):
 
129
        user = 'joe'
 
130
        password = 'hispass'
 
131
        factory = WideOpenSMTPFactory()
 
132
        conn = self.get_connection('[DEFAULT]\nsmtp_username=%s\n' % user,
 
133
                                   smtp_factory=factory)
 
134
        self.assertIs(None, conn._smtp_password)
 
135
 
 
136
        ui.ui_factory = ui.CannedInputUIFactory([password])
 
137
        conn._connect()
 
138
        self.assertEqual(password, conn._smtp_password)
 
139
 
 
140
    def test_smtp_password_from_auth_config(self):
 
141
        user = 'joe'
 
142
        password = 'hispass'
 
143
        factory = WideOpenSMTPFactory()
 
144
        conn = self.get_connection('[DEFAULT]\nsmtp_username=%s\n' % user,
 
145
                                   smtp_factory=factory)
 
146
        self.assertEqual(user, conn._smtp_username)
 
147
        self.assertIs(None, conn._smtp_password)
 
148
        # Create a config file with the right password
 
149
        conf = config.AuthenticationConfig()
 
150
        conf._get_config().update({'smtptest':
 
151
                                       {'scheme': 'smtp', 'user':user,
 
152
                                        'password': password}})
 
153
        conf._save()
 
154
 
 
155
        conn._connect()
 
156
        self.assertEqual(password, conn._smtp_password)
 
157
 
 
158
    def test_authenticate_with_byte_strings(self):
 
159
        user = 'joe'
 
160
        unicode_pass = u'h\xECspass'
 
161
        utf8_pass = unicode_pass.encode('utf-8')
 
162
        factory = WideOpenSMTPFactory()
 
163
        conn = self.get_connection(
 
164
            '[DEFAULT]\nsmtp_username=%s\nsmtp_password=%s\n'
 
165
            % (user, utf8_pass), smtp_factory=factory)
 
166
        self.assertEqual(unicode_pass, conn._smtp_password)
 
167
        conn._connect()
 
168
        self.assertEqual([('connect', 'localhost'),
 
169
                          ('ehlo',),
 
170
                          ('has_extn', 'starttls'),
 
171
                          ('login', user, utf8_pass)], factory._calls)
 
172
        smtp_username, smtp_password = factory._calls[-1][1:]
 
173
        self.assertIsInstance(smtp_username, str)
 
174
        self.assertIsInstance(smtp_password, str)
 
175
 
 
176
    def test_create_connection(self):
 
177
        factory = StubSMTPFactory()
 
178
        conn = self.get_connection('', smtp_factory=factory)
 
179
        conn._create_connection()
 
180
        self.assertEqual([('connect', 'localhost'),
 
181
                          ('ehlo',),
 
182
                          ('has_extn', 'starttls')], factory._calls)
 
183
 
 
184
    def test_create_connection_ehlo_fails(self):
 
185
        # Check that we call HELO if EHLO failed.
 
186
        factory = StubSMTPFactory(fail_on=['ehlo'])
 
187
        conn = self.get_connection('', smtp_factory=factory)
 
188
        conn._create_connection()
 
189
        self.assertEqual([('connect', 'localhost'),
 
190
                          ('ehlo',),
 
191
                          ('helo',),
 
192
                          ('has_extn', 'starttls')], factory._calls)
 
193
 
 
194
    def test_create_connection_ehlo_helo_fails(self):
 
195
        # Check that we raise an exception if both EHLO and HELO fail.
 
196
        factory = StubSMTPFactory(fail_on=['ehlo', 'helo'])
 
197
        conn = self.get_connection('', smtp_factory=factory)
 
198
        self.assertRaises(errors.SMTPError, conn._create_connection)
 
199
        self.assertEqual([('connect', 'localhost'),
 
200
                          ('ehlo',),
 
201
                          ('helo',)], factory._calls)
 
202
 
 
203
    def test_create_connection_starttls(self):
 
204
        # Check that STARTTLS plus a second EHLO are called if the
 
205
        # server says it supports the feature.
 
206
        factory = StubSMTPFactory(smtp_features=['starttls'])
 
207
        conn = self.get_connection('', smtp_factory=factory)
 
208
        conn._create_connection()
 
209
        self.assertEqual([('connect', 'localhost'),
 
210
                          ('ehlo',),
 
211
                          ('has_extn', 'starttls'),
 
212
                          ('starttls',),
 
213
                          ('ehlo',)], factory._calls)
 
214
 
 
215
    def test_create_connection_starttls_fails(self):
 
216
        # Check that we raise an exception if the server claims to
 
217
        # support STARTTLS, but then fails when we try to activate it.
 
218
        factory = StubSMTPFactory(fail_on=['starttls'],
 
219
                                  smtp_features=['starttls'])
 
220
        conn = self.get_connection('', smtp_factory=factory)
 
221
        self.assertRaises(errors.SMTPError, conn._create_connection)
 
222
        self.assertEqual([('connect', 'localhost'),
 
223
                          ('ehlo',),
 
224
                          ('has_extn', 'starttls'),
 
225
                          ('starttls',)], factory._calls)
 
226
 
 
227
    def test_get_message_addresses(self):
 
228
        msg = Message()
 
229
 
 
230
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
231
        self.assertEqual('', from_)
 
232
        self.assertEqual([], to)
 
233
 
 
234
        msg['From'] = '"J. Random Developer" <jrandom@example.com>'
 
235
        msg['To'] = 'John Doe <john@doe.com>, Jane Doe <jane@doe.com>'
 
236
        msg['CC'] = u'Pepe P\xe9rez <pperez@ejemplo.com>'
 
237
        msg['Bcc'] = 'user@localhost'
 
238
 
 
239
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
240
        self.assertEqual('jrandom@example.com', from_)
 
241
        self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
 
242
            'pperez@ejemplo.com', 'user@localhost']), sorted(to))
 
243
 
 
244
        # now with bzrlib's EmailMessage
 
245
        msg = email_message.EmailMessage(
 
246
            '"J. Random Developer" <jrandom@example.com>',
 
247
            ['John Doe <john@doe.com>', 'Jane Doe <jane@doe.com>',
 
248
             u'Pepe P\xe9rez <pperez@ejemplo.com>', 'user@localhost' ],
 
249
            'subject')
 
250
 
 
251
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
252
        self.assertEqual('jrandom@example.com', from_)
 
253
        self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
 
254
            'pperez@ejemplo.com', 'user@localhost']), sorted(to))
 
255
 
 
256
    def test_destination_address_required(self):
 
257
        msg = Message()
 
258
        msg['From'] = '"J. Random Developer" <jrandom@example.com>'
 
259
        self.assertRaises(
 
260
            errors.NoDestinationAddress,
 
261
            smtp_connection.SMTPConnection(config.MemoryStack("")
 
262
                                           ).send_email, msg)
 
263
 
 
264
        msg = email_message.EmailMessage('from@from.com', '', 'subject')
 
265
        self.assertRaises(
 
266
            errors.NoDestinationAddress,
 
267
            smtp_connection.SMTPConnection(config.MemoryStack("")
 
268
                                           ).send_email, msg)
 
269
 
 
270
        msg = email_message.EmailMessage('from@from.com', [], 'subject')
 
271
        self.assertRaises(
 
272
            errors.NoDestinationAddress,
 
273
            smtp_connection.SMTPConnection(config.MemoryStack("")
 
274
                                           ).send_email, msg)