blob: 42a10bee1d53da807cdaf8953e212e9f501c8798 [file] [log] [blame]
Facundo Batista16ed5b42007-07-24 21:20:42 +00001import asyncore
Facundo Batista1bc8d632007-08-21 16:57:18 +00002import email.utils
Facundo Batista366d6262007-03-28 18:25:54 +00003import socket
Facundo Batista16ed5b42007-07-24 21:20:42 +00004import smtpd
Facundo Batista366d6262007-03-28 18:25:54 +00005import smtplib
Facundo Batista16ed5b42007-07-24 21:20:42 +00006import StringIO
7import sys
Facundo Batista366d6262007-03-28 18:25:54 +00008import time
Facundo Batista16ed5b42007-07-24 21:20:42 +00009import select
Facundo Batista366d6262007-03-28 18:25:54 +000010
Victor Stinner6a102812010-04-27 23:55:59 +000011import unittest
Facundo Batista366d6262007-03-28 18:25:54 +000012from test import test_support
13
Victor Stinner6a102812010-04-27 23:55:59 +000014try:
15 import threading
16except ImportError:
17 threading = None
18
Trent Nelsone41b0062008-04-08 23:47:30 +000019HOST = test_support.HOST
Facundo Batista366d6262007-03-28 18:25:54 +000020
Trent Nelsone41b0062008-04-08 23:47:30 +000021def server(evt, buf, serv):
Neal Norwitz75992ed2008-02-26 08:04:59 +000022 serv.listen(5)
23 evt.set()
Facundo Batista366d6262007-03-28 18:25:54 +000024 try:
25 conn, addr = serv.accept()
26 except socket.timeout:
27 pass
28 else:
Facundo Batista412b8b62007-08-01 23:18:36 +000029 n = 500
Facundo Batista16ed5b42007-07-24 21:20:42 +000030 while buf and n > 0:
31 r, w, e = select.select([], [conn], [])
32 if w:
33 sent = conn.send(buf)
34 buf = buf[sent:]
35
36 n -= 1
Facundo Batista16ed5b42007-07-24 21:20:42 +000037
Facundo Batista366d6262007-03-28 18:25:54 +000038 conn.close()
39 finally:
40 serv.close()
41 evt.set()
42
Victor Stinner6a102812010-04-27 23:55:59 +000043@unittest.skipUnless(threading, 'Threading required for this test.')
44class GeneralTests(unittest.TestCase):
Neal Norwitz0d4c06e2007-04-25 06:30:05 +000045
Facundo Batista366d6262007-03-28 18:25:54 +000046 def setUp(self):
Antoine Pitroua763c062009-10-27 19:47:30 +000047 self._threads = test_support.threading_setup()
Facundo Batista366d6262007-03-28 18:25:54 +000048 self.evt = threading.Event()
Trent Nelsone41b0062008-04-08 23:47:30 +000049 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
50 self.sock.settimeout(15)
51 self.port = test_support.bind_port(self.sock)
52 servargs = (self.evt, "220 Hola mundo\n", self.sock)
Antoine Pitroua763c062009-10-27 19:47:30 +000053 self.thread = threading.Thread(target=server, args=servargs)
54 self.thread.start()
Neal Norwitz75992ed2008-02-26 08:04:59 +000055 self.evt.wait()
56 self.evt.clear()
Facundo Batista366d6262007-03-28 18:25:54 +000057
58 def tearDown(self):
59 self.evt.wait()
Antoine Pitroua763c062009-10-27 19:47:30 +000060 self.thread.join()
61 test_support.threading_cleanup(*self._threads)
Facundo Batista366d6262007-03-28 18:25:54 +000062
Facundo Batista16ed5b42007-07-24 21:20:42 +000063 def testBasic1(self):
Facundo Batista366d6262007-03-28 18:25:54 +000064 # connects
Trent Nelsone41b0062008-04-08 23:47:30 +000065 smtp = smtplib.SMTP(HOST, self.port)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000066 smtp.close()
Neal Norwitz0d4c06e2007-04-25 06:30:05 +000067
Facundo Batista16ed5b42007-07-24 21:20:42 +000068 def testBasic2(self):
69 # connects, include port in host name
Trent Nelsone41b0062008-04-08 23:47:30 +000070 smtp = smtplib.SMTP("%s:%s" % (HOST, self.port))
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000071 smtp.close()
Facundo Batista16ed5b42007-07-24 21:20:42 +000072
73 def testLocalHostName(self):
74 # check that supplied local_hostname is used
Trent Nelsone41b0062008-04-08 23:47:30 +000075 smtp = smtplib.SMTP(HOST, self.port, local_hostname="testhost")
Facundo Batista16ed5b42007-07-24 21:20:42 +000076 self.assertEqual(smtp.local_hostname, "testhost")
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000077 smtp.close()
Facundo Batista16ed5b42007-07-24 21:20:42 +000078
Facundo Batista366d6262007-03-28 18:25:54 +000079 def testTimeoutDefault(self):
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000080 self.assertTrue(socket.getdefaulttimeout() is None)
81 socket.setdefaulttimeout(30)
82 try:
83 smtp = smtplib.SMTP(HOST, self.port)
84 finally:
85 socket.setdefaulttimeout(None)
Facundo Batista366d6262007-03-28 18:25:54 +000086 self.assertEqual(smtp.sock.gettimeout(), 30)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000087 smtp.close()
Facundo Batista366d6262007-03-28 18:25:54 +000088
89 def testTimeoutNone(self):
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000090 self.assertTrue(socket.getdefaulttimeout() is None)
Facundo Batista366d6262007-03-28 18:25:54 +000091 socket.setdefaulttimeout(30)
92 try:
Trent Nelsone41b0062008-04-08 23:47:30 +000093 smtp = smtplib.SMTP(HOST, self.port, timeout=None)
Facundo Batista366d6262007-03-28 18:25:54 +000094 finally:
Facundo Batista4f1b1ed2008-05-29 16:39:26 +000095 socket.setdefaulttimeout(None)
96 self.assertTrue(smtp.sock.gettimeout() is None)
97 smtp.close()
98
99 def testTimeoutValue(self):
100 smtp = smtplib.SMTP(HOST, self.port, timeout=30)
Facundo Batista366d6262007-03-28 18:25:54 +0000101 self.assertEqual(smtp.sock.gettimeout(), 30)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000102 smtp.close()
Facundo Batista366d6262007-03-28 18:25:54 +0000103
104
Facundo Batista1bc8d632007-08-21 16:57:18 +0000105# Test server thread using the specified SMTP server class
Trent Nelsone41b0062008-04-08 23:47:30 +0000106def debugging_server(serv, serv_evt, client_evt):
Neal Norwitz75992ed2008-02-26 08:04:59 +0000107 serv_evt.set()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000108
109 try:
Facundo Batista412b8b62007-08-01 23:18:36 +0000110 if hasattr(select, 'poll'):
111 poll_fun = asyncore.poll2
112 else:
113 poll_fun = asyncore.poll
114
115 n = 1000
116 while asyncore.socket_map and n > 0:
117 poll_fun(0.01, asyncore.socket_map)
118
119 # when the client conversation is finished, it will
120 # set client_evt, and it's then ok to kill the server
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000121 if client_evt.is_set():
Facundo Batista412b8b62007-08-01 23:18:36 +0000122 serv.close()
123 break
124
125 n -= 1
126
Facundo Batista16ed5b42007-07-24 21:20:42 +0000127 except socket.timeout:
128 pass
129 finally:
Benjamin Peterson0fbcf692008-06-11 17:27:50 +0000130 if not client_evt.is_set():
Neal Norwitz75992ed2008-02-26 08:04:59 +0000131 # allow some time for the client to read the result
132 time.sleep(0.5)
133 serv.close()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000134 asyncore.close_all()
Facundo Batista412b8b62007-08-01 23:18:36 +0000135 serv_evt.set()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000136
137MSG_BEGIN = '---------- MESSAGE FOLLOWS ----------\n'
138MSG_END = '------------ END MESSAGE ------------\n'
139
Facundo Batista1bc8d632007-08-21 16:57:18 +0000140# NOTE: Some SMTP objects in the tests below are created with a non-default
141# local_hostname argument to the constructor, since (on some systems) the FQDN
142# lookup caused by the default local_hostname sometimes takes so long that the
Facundo Batista412b8b62007-08-01 23:18:36 +0000143# test server times out, causing the test to fail.
Facundo Batista1bc8d632007-08-21 16:57:18 +0000144
145# Test behavior of smtpd.DebuggingServer
Victor Stinner6a102812010-04-27 23:55:59 +0000146@unittest.skipUnless(threading, 'Threading required for this test.')
147class DebuggingServerTests(unittest.TestCase):
Facundo Batista16ed5b42007-07-24 21:20:42 +0000148
149 def setUp(self):
Facundo Batista412b8b62007-08-01 23:18:36 +0000150 # temporarily replace sys.stdout to capture DebuggingServer output
Facundo Batista16ed5b42007-07-24 21:20:42 +0000151 self.old_stdout = sys.stdout
152 self.output = StringIO.StringIO()
153 sys.stdout = self.output
154
Antoine Pitroua763c062009-10-27 19:47:30 +0000155 self._threads = test_support.threading_setup()
Facundo Batista412b8b62007-08-01 23:18:36 +0000156 self.serv_evt = threading.Event()
157 self.client_evt = threading.Event()
Antoine Pitrou54f9f832010-04-30 23:08:48 +0000158 # Pick a random unused port by passing 0 for the port number
159 self.serv = smtpd.DebuggingServer((HOST, 0), ('nowhere', -1))
160 # Keep a note of what port was assigned
161 self.port = self.serv.socket.getsockname()[1]
Trent Nelsone41b0062008-04-08 23:47:30 +0000162 serv_args = (self.serv, self.serv_evt, self.client_evt)
Antoine Pitroua763c062009-10-27 19:47:30 +0000163 self.thread = threading.Thread(target=debugging_server, args=serv_args)
164 self.thread.start()
Facundo Batista412b8b62007-08-01 23:18:36 +0000165
166 # wait until server thread has assigned a port number
Neal Norwitz75992ed2008-02-26 08:04:59 +0000167 self.serv_evt.wait()
168 self.serv_evt.clear()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000169
170 def tearDown(self):
Facundo Batista412b8b62007-08-01 23:18:36 +0000171 # indicate that the client is finished
172 self.client_evt.set()
173 # wait for the server thread to terminate
174 self.serv_evt.wait()
Antoine Pitroua763c062009-10-27 19:47:30 +0000175 self.thread.join()
176 test_support.threading_cleanup(*self._threads)
Facundo Batista412b8b62007-08-01 23:18:36 +0000177 # restore sys.stdout
Facundo Batista16ed5b42007-07-24 21:20:42 +0000178 sys.stdout = self.old_stdout
179
180 def testBasic(self):
181 # connect
Trent Nelsone41b0062008-04-08 23:47:30 +0000182 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista412b8b62007-08-01 23:18:36 +0000183 smtp.quit()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000184
Facundo Batista1bc8d632007-08-21 16:57:18 +0000185 def testNOOP(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000186 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000187 expected = (250, 'Ok')
188 self.assertEqual(smtp.noop(), expected)
189 smtp.quit()
190
191 def testRSET(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000192 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000193 expected = (250, 'Ok')
194 self.assertEqual(smtp.rset(), expected)
195 smtp.quit()
196
197 def testNotImplemented(self):
198 # EHLO isn't implemented in DebuggingServer
Trent Nelsone41b0062008-04-08 23:47:30 +0000199 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista412b8b62007-08-01 23:18:36 +0000200 expected = (502, 'Error: command "EHLO" not implemented')
201 self.assertEqual(smtp.ehlo(), expected)
202 smtp.quit()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000203
Facundo Batista1bc8d632007-08-21 16:57:18 +0000204 def testVRFY(self):
205 # VRFY isn't implemented in DebuggingServer
Trent Nelsone41b0062008-04-08 23:47:30 +0000206 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000207 expected = (502, 'Error: command "VRFY" not implemented')
208 self.assertEqual(smtp.vrfy('nobody@nowhere.com'), expected)
209 self.assertEqual(smtp.verify('nobody@nowhere.com'), expected)
210 smtp.quit()
211
212 def testSecondHELO(self):
213 # check that a second HELO returns a message that it's a duplicate
214 # (this behavior is specific to smtpd.SMTPChannel)
Trent Nelsone41b0062008-04-08 23:47:30 +0000215 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000216 smtp.helo()
217 expected = (503, 'Duplicate HELO/EHLO')
218 self.assertEqual(smtp.helo(), expected)
219 smtp.quit()
220
Facundo Batista16ed5b42007-07-24 21:20:42 +0000221 def testHELP(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000222 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista16ed5b42007-07-24 21:20:42 +0000223 self.assertEqual(smtp.help(), 'Error: command "HELP" not implemented')
Facundo Batista412b8b62007-08-01 23:18:36 +0000224 smtp.quit()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000225
226 def testSend(self):
227 # connect and send mail
228 m = 'A test message'
Trent Nelsone41b0062008-04-08 23:47:30 +0000229 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=3)
Facundo Batista16ed5b42007-07-24 21:20:42 +0000230 smtp.sendmail('John', 'Sally', m)
Neal Norwitze39be532008-08-25 03:52:40 +0000231 # XXX(nnorwitz): this test is flaky and dies with a bad file descriptor
232 # in asyncore. This sleep might help, but should really be fixed
233 # properly by using an Event variable.
234 time.sleep(0.01)
Facundo Batista412b8b62007-08-01 23:18:36 +0000235 smtp.quit()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000236
Facundo Batista412b8b62007-08-01 23:18:36 +0000237 self.client_evt.set()
238 self.serv_evt.wait()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000239 self.output.flush()
240 mexpect = '%s%s\n%s' % (MSG_BEGIN, m, MSG_END)
241 self.assertEqual(self.output.getvalue(), mexpect)
242
243
Victor Stinner6a102812010-04-27 23:55:59 +0000244class NonConnectingTests(unittest.TestCase):
Neal Norwitz75992ed2008-02-26 08:04:59 +0000245
246 def testNotConnected(self):
247 # Test various operations on an unconnected SMTP object that
248 # should raise exceptions (at present the attempt in SMTP.send
249 # to reference the nonexistent 'sock' attribute of the SMTP object
250 # causes an AttributeError)
251 smtp = smtplib.SMTP()
252 self.assertRaises(smtplib.SMTPServerDisconnected, smtp.ehlo)
253 self.assertRaises(smtplib.SMTPServerDisconnected,
254 smtp.send, 'test msg')
255
256 def testNonnumericPort(self):
257 # check that non-numeric port raises socket.error
258 self.assertRaises(socket.error, smtplib.SMTP,
259 "localhost", "bogus")
260 self.assertRaises(socket.error, smtplib.SMTP,
261 "localhost:bogus")
262
263
Facundo Batista1bc8d632007-08-21 16:57:18 +0000264# test response of client to a non-successful HELO message
Victor Stinner6a102812010-04-27 23:55:59 +0000265@unittest.skipUnless(threading, 'Threading required for this test.')
266class BadHELOServerTests(unittest.TestCase):
Facundo Batista16ed5b42007-07-24 21:20:42 +0000267
268 def setUp(self):
269 self.old_stdout = sys.stdout
270 self.output = StringIO.StringIO()
271 sys.stdout = self.output
272
Antoine Pitroua763c062009-10-27 19:47:30 +0000273 self._threads = test_support.threading_setup()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000274 self.evt = threading.Event()
Trent Nelsone41b0062008-04-08 23:47:30 +0000275 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
276 self.sock.settimeout(15)
277 self.port = test_support.bind_port(self.sock)
278 servargs = (self.evt, "199 no hello for you!\n", self.sock)
Antoine Pitroua763c062009-10-27 19:47:30 +0000279 self.thread = threading.Thread(target=server, args=servargs)
280 self.thread.start()
Neal Norwitz75992ed2008-02-26 08:04:59 +0000281 self.evt.wait()
282 self.evt.clear()
Facundo Batista16ed5b42007-07-24 21:20:42 +0000283
284 def tearDown(self):
285 self.evt.wait()
Antoine Pitroua763c062009-10-27 19:47:30 +0000286 self.thread.join()
287 test_support.threading_cleanup(*self._threads)
Facundo Batista16ed5b42007-07-24 21:20:42 +0000288 sys.stdout = self.old_stdout
289
290 def testFailingHELO(self):
Facundo Batista412b8b62007-08-01 23:18:36 +0000291 self.assertRaises(smtplib.SMTPConnectError, smtplib.SMTP,
Trent Nelsone41b0062008-04-08 23:47:30 +0000292 HOST, self.port, 'localhost', 3)
Facundo Batista366d6262007-03-28 18:25:54 +0000293
Facundo Batista1bc8d632007-08-21 16:57:18 +0000294
295sim_users = {'Mr.A@somewhere.com':'John A',
296 'Ms.B@somewhere.com':'Sally B',
297 'Mrs.C@somewhereesle.com':'Ruth C',
298 }
299
R. David Murray3724d6c2009-05-23 21:48:06 +0000300sim_auth = ('Mr.A@somewhere.com', 'somepassword')
R. David Murray8de212b2009-05-28 18:49:23 +0000301sim_cram_md5_challenge = ('PENCeUxFREJoU0NnbmhNWitOMjNGNn'
302 'dAZWx3b29kLmlubm9zb2Z0LmNvbT4=')
303sim_auth_credentials = {
304 'login': 'TXIuQUBzb21ld2hlcmUuY29t',
305 'plain': 'AE1yLkFAc29tZXdoZXJlLmNvbQBzb21lcGFzc3dvcmQ=',
306 'cram-md5': ('TXIUQUBZB21LD2HLCMUUY29TIDG4OWQ0MJ'
307 'KWZGQ4ODNMNDA4NTGXMDRLZWMYZJDMODG1'),
308 }
309sim_auth_login_password = 'C29TZXBHC3N3B3JK'
R. David Murray3724d6c2009-05-23 21:48:06 +0000310
Facundo Batista1bc8d632007-08-21 16:57:18 +0000311sim_lists = {'list-1':['Mr.A@somewhere.com','Mrs.C@somewhereesle.com'],
312 'list-2':['Ms.B@somewhere.com',],
313 }
314
315# Simulated SMTP channel & server
316class SimSMTPChannel(smtpd.SMTPChannel):
R. David Murray8de212b2009-05-28 18:49:23 +0000317
R. David Murray6b985442009-05-29 17:31:05 +0000318 def __init__(self, extra_features, *args, **kw):
319 self._extrafeatures = ''.join(
320 [ "250-{0}\r\n".format(x) for x in extra_features ])
R. David Murray8de212b2009-05-28 18:49:23 +0000321 smtpd.SMTPChannel.__init__(self, *args, **kw)
322
Facundo Batista1bc8d632007-08-21 16:57:18 +0000323 def smtp_EHLO(self, arg):
R. David Murray8de212b2009-05-28 18:49:23 +0000324 resp = ('250-testhost\r\n'
325 '250-EXPN\r\n'
326 '250-SIZE 20000000\r\n'
327 '250-STARTTLS\r\n'
328 '250-DELIVERBY\r\n')
329 resp = resp + self._extrafeatures + '250 HELP'
Facundo Batista1bc8d632007-08-21 16:57:18 +0000330 self.push(resp)
331
332 def smtp_VRFY(self, arg):
Facundo Batista1bc8d632007-08-21 16:57:18 +0000333 raw_addr = email.utils.parseaddr(arg)[1]
334 quoted_addr = smtplib.quoteaddr(arg)
335 if raw_addr in sim_users:
336 self.push('250 %s %s' % (sim_users[raw_addr], quoted_addr))
337 else:
338 self.push('550 No such user: %s' % arg)
339
340 def smtp_EXPN(self, arg):
Facundo Batista1bc8d632007-08-21 16:57:18 +0000341 list_name = email.utils.parseaddr(arg)[1].lower()
342 if list_name in sim_lists:
343 user_list = sim_lists[list_name]
344 for n, user_email in enumerate(user_list):
345 quoted_addr = smtplib.quoteaddr(user_email)
346 if n < len(user_list) - 1:
347 self.push('250-%s %s' % (sim_users[user_email], quoted_addr))
348 else:
349 self.push('250 %s %s' % (sim_users[user_email], quoted_addr))
350 else:
351 self.push('550 No access for you!')
352
R. David Murray3724d6c2009-05-23 21:48:06 +0000353 def smtp_AUTH(self, arg):
R. David Murray8de212b2009-05-28 18:49:23 +0000354 if arg.strip().lower()=='cram-md5':
355 self.push('334 {0}'.format(sim_cram_md5_challenge))
356 return
R. David Murray3724d6c2009-05-23 21:48:06 +0000357 mech, auth = arg.split()
R. David Murray8de212b2009-05-28 18:49:23 +0000358 mech = mech.lower()
359 if mech not in sim_auth_credentials:
R. David Murray3724d6c2009-05-23 21:48:06 +0000360 self.push('504 auth type unimplemented')
R. David Murray8de212b2009-05-28 18:49:23 +0000361 return
362 if mech == 'plain' and auth==sim_auth_credentials['plain']:
363 self.push('235 plain auth ok')
364 elif mech=='login' and auth==sim_auth_credentials['login']:
365 self.push('334 Password:')
366 else:
367 self.push('550 No access for you!')
R. David Murray3724d6c2009-05-23 21:48:06 +0000368
Giampaolo Rodolàe4499a82010-05-06 20:19:32 +0000369 def handle_error(self):
370 raise
371
Facundo Batista1bc8d632007-08-21 16:57:18 +0000372
373class SimSMTPServer(smtpd.SMTPServer):
R. David Murray8de212b2009-05-28 18:49:23 +0000374
R. David Murray6b985442009-05-29 17:31:05 +0000375 def __init__(self, *args, **kw):
376 self._extra_features = []
377 smtpd.SMTPServer.__init__(self, *args, **kw)
378
Facundo Batista1bc8d632007-08-21 16:57:18 +0000379 def handle_accept(self):
380 conn, addr = self.accept()
R. David Murray6b985442009-05-29 17:31:05 +0000381 self._SMTPchannel = SimSMTPChannel(self._extra_features,
382 self, conn, addr)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000383
384 def process_message(self, peer, mailfrom, rcpttos, data):
385 pass
386
R. David Murray8de212b2009-05-28 18:49:23 +0000387 def add_feature(self, feature):
R. David Murray6b985442009-05-29 17:31:05 +0000388 self._extra_features.append(feature)
R. David Murray8de212b2009-05-28 18:49:23 +0000389
Giampaolo Rodolàe4499a82010-05-06 20:19:32 +0000390 def handle_error(self):
391 raise
392
Facundo Batista1bc8d632007-08-21 16:57:18 +0000393
394# Test various SMTP & ESMTP commands/behaviors that require a simulated server
395# (i.e., something with more features than DebuggingServer)
Victor Stinner6a102812010-04-27 23:55:59 +0000396@unittest.skipUnless(threading, 'Threading required for this test.')
397class SMTPSimTests(unittest.TestCase):
Facundo Batista1bc8d632007-08-21 16:57:18 +0000398
399 def setUp(self):
Antoine Pitroua763c062009-10-27 19:47:30 +0000400 self._threads = test_support.threading_setup()
Facundo Batista1bc8d632007-08-21 16:57:18 +0000401 self.serv_evt = threading.Event()
402 self.client_evt = threading.Event()
Antoine Pitrou54f9f832010-04-30 23:08:48 +0000403 # Pick a random unused port by passing 0 for the port number
404 self.serv = SimSMTPServer((HOST, 0), ('nowhere', -1))
405 # Keep a note of what port was assigned
406 self.port = self.serv.socket.getsockname()[1]
Trent Nelsone41b0062008-04-08 23:47:30 +0000407 serv_args = (self.serv, self.serv_evt, self.client_evt)
Antoine Pitroua763c062009-10-27 19:47:30 +0000408 self.thread = threading.Thread(target=debugging_server, args=serv_args)
409 self.thread.start()
Facundo Batista1bc8d632007-08-21 16:57:18 +0000410
411 # wait until server thread has assigned a port number
Neal Norwitz75992ed2008-02-26 08:04:59 +0000412 self.serv_evt.wait()
413 self.serv_evt.clear()
Facundo Batista1bc8d632007-08-21 16:57:18 +0000414
415 def tearDown(self):
416 # indicate that the client is finished
417 self.client_evt.set()
418 # wait for the server thread to terminate
419 self.serv_evt.wait()
Antoine Pitroua763c062009-10-27 19:47:30 +0000420 self.thread.join()
421 test_support.threading_cleanup(*self._threads)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000422
423 def testBasic(self):
424 # smoke test
Trent Nelsone41b0062008-04-08 23:47:30 +0000425 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000426 smtp.quit()
427
428 def testEHLO(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000429 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000430
431 # no features should be present before the EHLO
432 self.assertEqual(smtp.esmtp_features, {})
433
434 # features expected from the test server
435 expected_features = {'expn':'',
436 'size': '20000000',
437 'starttls': '',
438 'deliverby': '',
439 'help': '',
440 }
441
442 smtp.ehlo()
443 self.assertEqual(smtp.esmtp_features, expected_features)
444 for k in expected_features:
445 self.assertTrue(smtp.has_extn(k))
446 self.assertFalse(smtp.has_extn('unsupported-feature'))
447 smtp.quit()
448
449 def testVRFY(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000450 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000451
452 for email, name in sim_users.items():
453 expected_known = (250, '%s %s' % (name, smtplib.quoteaddr(email)))
454 self.assertEqual(smtp.vrfy(email), expected_known)
455
456 u = 'nobody@nowhere.com'
457 expected_unknown = (550, 'No such user: %s' % smtplib.quoteaddr(u))
458 self.assertEqual(smtp.vrfy(u), expected_unknown)
459 smtp.quit()
460
461 def testEXPN(self):
Trent Nelsone41b0062008-04-08 23:47:30 +0000462 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000463
464 for listname, members in sim_lists.items():
465 users = []
466 for m in members:
467 users.append('%s %s' % (sim_users[m], smtplib.quoteaddr(m)))
468 expected_known = (250, '\n'.join(users))
469 self.assertEqual(smtp.expn(listname), expected_known)
470
471 u = 'PSU-Members-List'
472 expected_unknown = (550, 'No access for you!')
473 self.assertEqual(smtp.expn(u), expected_unknown)
474 smtp.quit()
475
R. David Murray8de212b2009-05-28 18:49:23 +0000476 def testAUTH_PLAIN(self):
R. David Murray8de212b2009-05-28 18:49:23 +0000477 self.serv.add_feature("AUTH PLAIN")
R. David Murray6b985442009-05-29 17:31:05 +0000478 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
R. David Murray3724d6c2009-05-23 21:48:06 +0000479
R. David Murray8de212b2009-05-28 18:49:23 +0000480 expected_auth_ok = (235, b'plain auth ok')
R. David Murray3724d6c2009-05-23 21:48:06 +0000481 self.assertEqual(smtp.login(sim_auth[0], sim_auth[1]), expected_auth_ok)
Facundo Batista1bc8d632007-08-21 16:57:18 +0000482
R. David Murray8de212b2009-05-28 18:49:23 +0000483 # SimSMTPChannel doesn't fully support LOGIN or CRAM-MD5 auth because they
484 # require a synchronous read to obtain the credentials...so instead smtpd
485 # sees the credential sent by smtplib's login method as an unknown command,
486 # which results in smtplib raising an auth error. Fortunately the error
487 # message contains the encoded credential, so we can partially check that it
488 # was generated correctly (partially, because the 'word' is uppercased in
489 # the error message).
490
491 def testAUTH_LOGIN(self):
R. David Murray8de212b2009-05-28 18:49:23 +0000492 self.serv.add_feature("AUTH LOGIN")
R. David Murray6b985442009-05-29 17:31:05 +0000493 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
R. David Murray8de212b2009-05-28 18:49:23 +0000494 try: smtp.login(sim_auth[0], sim_auth[1])
495 except smtplib.SMTPAuthenticationError as err:
496 if sim_auth_login_password not in str(err):
497 raise "expected encoded password not found in error message"
498
499 def testAUTH_CRAM_MD5(self):
R. David Murray8de212b2009-05-28 18:49:23 +0000500 self.serv.add_feature("AUTH CRAM-MD5")
R. David Murray6b985442009-05-29 17:31:05 +0000501 smtp = smtplib.SMTP(HOST, self.port, local_hostname='localhost', timeout=15)
R. David Murray8de212b2009-05-28 18:49:23 +0000502
503 try: smtp.login(sim_auth[0], sim_auth[1])
504 except smtplib.SMTPAuthenticationError as err:
505 if sim_auth_credentials['cram-md5'] not in str(err):
506 raise "expected encoded credentials not found in error message"
507
508 #TODO: add tests for correct AUTH method fallback now that the
509 #test infrastructure can support it.
510
Facundo Batista1bc8d632007-08-21 16:57:18 +0000511
Facundo Batista366d6262007-03-28 18:25:54 +0000512def test_main(verbose=None):
Facundo Batista412b8b62007-08-01 23:18:36 +0000513 test_support.run_unittest(GeneralTests, DebuggingServerTests,
Neal Norwitz75992ed2008-02-26 08:04:59 +0000514 NonConnectingTests,
Facundo Batista1bc8d632007-08-21 16:57:18 +0000515 BadHELOServerTests, SMTPSimTests)
Facundo Batista366d6262007-03-28 18:25:54 +0000516
517if __name__ == '__main__':
518 test_main()