/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/tests/test_smtp_connection.py

  • Committer: Jelmer Vernooij
  • Date: 2020-05-24 00:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 7504.
  • Revision ID: jelmer@jelmer.uk-20200524003950-bbc545r76vc5yajg
Add github action.

Show diffs side-by-side

added added

removed removed

Lines of Context:
breezy/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 breezy import (
 
23
    config,
 
24
    email_message,
 
25
    smtp_connection,
 
26
    tests,
 
27
    ui,
 
28
    )
 
29
 
 
30
 
 
31
def connection_refuser():
 
32
    def connect(server):
 
33
        raise socket.error(errno.ECONNREFUSED, 'Connection Refused')
 
34
    smtp = smtplib.SMTP()
 
35
    smtp.connect = connect
 
36
    return smtp
 
37
 
 
38
 
 
39
class StubSMTPFactory(object):
 
40
    """A fake SMTP connection to test the connection setup."""
 
41
 
 
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(b'')
 
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(b'smtp_server=host:10')
 
105
        self.assertEqual('host:10', conn._smtp_server)
 
106
 
 
107
    def test_missing_server(self):
 
108
        conn = self.get_connection(b'', smtp_factory=connection_refuser)
 
109
        self.assertRaises(smtp_connection.DefaultSMTPConnectionRefused,
 
110
                          conn._connect)
 
111
        conn = self.get_connection(b'smtp_server=smtp.example.com',
 
112
                                   smtp_factory=connection_refuser)
 
113
        self.assertRaises(smtp_connection.SMTPConnectionRefused, conn._connect)
 
114
 
 
115
    def test_smtp_username(self):
 
116
        conn = self.get_connection(b'')
 
117
        self.assertIs(None, conn._smtp_username)
 
118
 
 
119
        conn = self.get_connection(b'smtp_username=joebody')
 
120
        self.assertEqual(u'joebody', conn._smtp_username)
 
121
 
 
122
    def test_smtp_password_from_config(self):
 
123
        conn = self.get_connection(b'')
 
124
        self.assertIs(None, conn._smtp_password)
 
125
 
 
126
        conn = self.get_connection(b'smtp_password=mypass')
 
127
        self.assertEqual(u'mypass', conn._smtp_password)
 
128
 
 
129
    def test_smtp_password_from_user(self):
 
130
        user = 'joe'
 
131
        password = 'hispass'
 
132
        factory = WideOpenSMTPFactory()
 
133
        conn = self.get_connection(
 
134
            b'[DEFAULT]\nsmtp_username=%s\n' % user.encode('ascii'),
 
135
            smtp_factory=factory)
 
136
        self.assertIs(None, conn._smtp_password)
 
137
 
 
138
        ui.ui_factory = ui.CannedInputUIFactory([password])
 
139
        conn._connect()
 
140
        self.assertEqual(password, conn._smtp_password)
 
141
 
 
142
    def test_smtp_password_from_auth_config(self):
 
143
        user = 'joe'
 
144
        password = 'hispass'
 
145
        factory = WideOpenSMTPFactory()
 
146
        conn = self.get_connection(
 
147
            b'[DEFAULT]\nsmtp_username=%s\n' % user.encode('ascii'),
 
148
            smtp_factory=factory)
 
149
        self.assertEqual(user, conn._smtp_username)
 
150
        self.assertIs(None, conn._smtp_password)
 
151
        # Create a config file with the right password
 
152
        conf = config.AuthenticationConfig()
 
153
        conf._get_config().update({'smtptest':
 
154
                                   {'scheme': 'smtp', 'user': user,
 
155
                                    'password': password}})
 
156
        conf._save()
 
157
 
 
158
        conn._connect()
 
159
        self.assertEqual(password, conn._smtp_password)
 
160
 
 
161
    def test_authenticate_with_byte_strings(self):
 
162
        user = b'joe'
 
163
        unicode_pass = u'h\xECspass'
 
164
        utf8_pass = unicode_pass.encode('utf-8')
 
165
        factory = WideOpenSMTPFactory()
 
166
        conn = self.get_connection(
 
167
            b'[DEFAULT]\nsmtp_username=%s\nsmtp_password=%s\n'
 
168
            % (user, utf8_pass), smtp_factory=factory)
 
169
        self.assertEqual(unicode_pass, conn._smtp_password)
 
170
        conn._connect()
 
171
        self.assertEqual([('connect', 'localhost'),
 
172
                          ('ehlo',),
 
173
                          ('has_extn', 'starttls'),
 
174
                          ('login', user, utf8_pass)], factory._calls)
 
175
        smtp_username, smtp_password = factory._calls[-1][1:]
 
176
        self.assertIsInstance(smtp_username, bytes)
 
177
        self.assertIsInstance(smtp_password, bytes)
 
178
 
 
179
    def test_create_connection(self):
 
180
        factory = StubSMTPFactory()
 
181
        conn = self.get_connection(b'', smtp_factory=factory)
 
182
        conn._create_connection()
 
183
        self.assertEqual([('connect', 'localhost'),
 
184
                          ('ehlo',),
 
185
                          ('has_extn', 'starttls')], factory._calls)
 
186
 
 
187
    def test_create_connection_ehlo_fails(self):
 
188
        # Check that we call HELO if EHLO failed.
 
189
        factory = StubSMTPFactory(fail_on=['ehlo'])
 
190
        conn = self.get_connection(b'', smtp_factory=factory)
 
191
        conn._create_connection()
 
192
        self.assertEqual([('connect', 'localhost'),
 
193
                          ('ehlo',),
 
194
                          ('helo',),
 
195
                          ('has_extn', 'starttls')], factory._calls)
 
196
 
 
197
    def test_create_connection_ehlo_helo_fails(self):
 
198
        # Check that we raise an exception if both EHLO and HELO fail.
 
199
        factory = StubSMTPFactory(fail_on=['ehlo', 'helo'])
 
200
        conn = self.get_connection(b'', smtp_factory=factory)
 
201
        self.assertRaises(smtp_connection.SMTPError, conn._create_connection)
 
202
        self.assertEqual([('connect', 'localhost'),
 
203
                          ('ehlo',),
 
204
                          ('helo',)], factory._calls)
 
205
 
 
206
    def test_create_connection_starttls(self):
 
207
        # Check that STARTTLS plus a second EHLO are called if the
 
208
        # server says it supports the feature.
 
209
        factory = StubSMTPFactory(smtp_features=['starttls'])
 
210
        conn = self.get_connection(b'', smtp_factory=factory)
 
211
        conn._create_connection()
 
212
        self.assertEqual([('connect', 'localhost'),
 
213
                          ('ehlo',),
 
214
                          ('has_extn', 'starttls'),
 
215
                          ('starttls',),
 
216
                          ('ehlo',)], factory._calls)
 
217
 
 
218
    def test_create_connection_starttls_fails(self):
 
219
        # Check that we raise an exception if the server claims to
 
220
        # support STARTTLS, but then fails when we try to activate it.
 
221
        factory = StubSMTPFactory(fail_on=['starttls'],
 
222
                                  smtp_features=['starttls'])
 
223
        conn = self.get_connection(b'', smtp_factory=factory)
 
224
        self.assertRaises(smtp_connection.SMTPError, conn._create_connection)
 
225
        self.assertEqual([('connect', 'localhost'),
 
226
                          ('ehlo',),
 
227
                          ('has_extn', 'starttls'),
 
228
                          ('starttls',)], factory._calls)
 
229
 
 
230
    def test_get_message_addresses(self):
 
231
        msg = Message()
 
232
 
 
233
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
234
        self.assertEqual('', from_)
 
235
        self.assertEqual([], to)
 
236
 
 
237
        msg['From'] = '"J. Random Developer" <jrandom@example.com>'
 
238
        msg['To'] = 'John Doe <john@doe.com>, Jane Doe <jane@doe.com>'
 
239
        msg['CC'] = u'Pepe P\xe9rez <pperez@ejemplo.com>'
 
240
        msg['Bcc'] = 'user@localhost'
 
241
 
 
242
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
243
        self.assertEqual('jrandom@example.com', from_)
 
244
        self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
 
245
                                 'pperez@ejemplo.com', 'user@localhost']), sorted(to))
 
246
 
 
247
        # now with breezy's EmailMessage
 
248
        msg = email_message.EmailMessage(
 
249
            '"J. Random Developer" <jrandom@example.com>',
 
250
            ['John Doe <john@doe.com>', 'Jane Doe <jane@doe.com>',
 
251
             u'Pepe P\xe9rez <pperez@ejemplo.com>', 'user@localhost'],
 
252
            'subject')
 
253
 
 
254
        from_, to = smtp_connection.SMTPConnection.get_message_addresses(msg)
 
255
        self.assertEqual('jrandom@example.com', from_)
 
256
        self.assertEqual(sorted(['john@doe.com', 'jane@doe.com',
 
257
                                 'pperez@ejemplo.com', 'user@localhost']), sorted(to))
 
258
 
 
259
    def test_destination_address_required(self):
 
260
        msg = Message()
 
261
        msg['From'] = '"J. Random Developer" <jrandom@example.com>'
 
262
        self.assertRaises(
 
263
            smtp_connection.NoDestinationAddress,
 
264
            smtp_connection.SMTPConnection(config.MemoryStack(b"")
 
265
                                           ).send_email, msg)
 
266
 
 
267
        msg = email_message.EmailMessage('from@from.com', '', 'subject')
 
268
        self.assertRaises(
 
269
            smtp_connection.NoDestinationAddress,
 
270
            smtp_connection.SMTPConnection(config.MemoryStack(b"")
 
271
                                           ).send_email, msg)
 
272
 
 
273
        msg = email_message.EmailMessage('from@from.com', [], 'subject')
 
274
        self.assertRaises(
 
275
            smtp_connection.NoDestinationAddress,
 
276
            smtp_connection.SMTPConnection(config.MemoryStack(b"")
 
277
                                           ).send_email, msg)