blob: a7ea254d950431eeefa63c6b4414bf8b37bfaaa4 [file] [log] [blame]
Benjamin Petersonbe17a112008-09-27 21:49:47 +00001"""Test script for ftplib module."""
2
Antoine Pitrouf988cd02009-11-17 20:21:14 +00003# Modified by Giampaolo Rodola' to test FTP class, IPv6 and TLS
4# environment
Benjamin Petersonbe17a112008-09-27 21:49:47 +00005
Guido van Rossumd8faa362007-04-27 19:54:29 +00006import ftplib
Benjamin Petersonbe17a112008-09-27 21:49:47 +00007import asyncore
8import asynchat
9import socket
10import io
Antoine Pitrouf988cd02009-11-17 20:21:14 +000011import errno
12import os
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +000013import time
Antoine Pitrouf988cd02009-11-17 20:21:14 +000014try:
15 import ssl
16except ImportError:
17 ssl = None
Guido van Rossumd8faa362007-04-27 19:54:29 +000018
19from unittest import TestCase
Benjamin Petersonee8712c2008-05-20 21:35:26 +000020from test import support
Benjamin Petersonbe17a112008-09-27 21:49:47 +000021from test.support import HOST
Victor Stinner45df8202010-04-28 22:31:17 +000022threading = support.import_module('threading')
Guido van Rossumd8faa362007-04-27 19:54:29 +000023
Benjamin Petersonbe17a112008-09-27 21:49:47 +000024# the dummy data returned by server over the data channel when
25# RETR, LIST and NLST commands are issued
26RETR_DATA = 'abcde12345\r\n' * 1000
27LIST_DATA = 'foo\r\nbar\r\n'
28NLST_DATA = 'foo\r\nbar\r\n'
Christian Heimes836baa52008-02-26 08:18:30 +000029
Christian Heimes836baa52008-02-26 08:18:30 +000030
Benjamin Petersonbe17a112008-09-27 21:49:47 +000031class DummyDTPHandler(asynchat.async_chat):
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +000032 dtp_conn_closed = False
Benjamin Petersonbe17a112008-09-27 21:49:47 +000033
34 def __init__(self, conn, baseclass):
35 asynchat.async_chat.__init__(self, conn)
36 self.baseclass = baseclass
37 self.baseclass.last_received_data = ''
38
39 def handle_read(self):
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +000040 self.baseclass.last_received_data += self.recv(1024).decode('ascii')
Benjamin Petersonbe17a112008-09-27 21:49:47 +000041
42 def handle_close(self):
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +000043 # XXX: this method can be called many times in a row for a single
44 # connection, including in clear-text (non-TLS) mode.
45 # (behaviour witnessed with test_data_connection)
46 if not self.dtp_conn_closed:
47 self.baseclass.push('226 transfer complete')
48 self.close()
49 self.dtp_conn_closed = True
Benjamin Petersonbe17a112008-09-27 21:49:47 +000050
51 def push(self, what):
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +000052 super(DummyDTPHandler, self).push(what.encode('ascii'))
Benjamin Petersonbe17a112008-09-27 21:49:47 +000053
Giampaolo Rodolàd930b632010-05-06 20:21:57 +000054 def handle_error(self):
55 raise
56
Benjamin Petersonbe17a112008-09-27 21:49:47 +000057
58class DummyFTPHandler(asynchat.async_chat):
59
Antoine Pitrouf988cd02009-11-17 20:21:14 +000060 dtp_handler = DummyDTPHandler
61
Benjamin Petersonbe17a112008-09-27 21:49:47 +000062 def __init__(self, conn):
63 asynchat.async_chat.__init__(self, conn)
64 self.set_terminator(b"\r\n")
65 self.in_buffer = []
66 self.dtp = None
67 self.last_received_cmd = None
68 self.last_received_data = ''
69 self.next_response = ''
Antoine Pitrou648bcd72009-11-27 13:23:26 +000070 self.rest = None
Benjamin Petersonbe17a112008-09-27 21:49:47 +000071 self.push('220 welcome')
72
73 def collect_incoming_data(self, data):
74 self.in_buffer.append(data)
75
76 def found_terminator(self):
77 line = b''.join(self.in_buffer).decode('ascii')
78 self.in_buffer = []
79 if self.next_response:
80 self.push(self.next_response)
81 self.next_response = ''
82 cmd = line.split(' ')[0].lower()
83 self.last_received_cmd = cmd
84 space = line.find(' ')
85 if space != -1:
86 arg = line[space + 1:]
87 else:
88 arg = ""
89 if hasattr(self, 'cmd_' + cmd):
90 method = getattr(self, 'cmd_' + cmd)
91 method(arg)
92 else:
93 self.push('550 command "%s" not understood.' %cmd)
94
95 def handle_error(self):
96 raise
97
98 def push(self, data):
99 asynchat.async_chat.push(self, data.encode('ascii') + b'\r\n')
100
101 def cmd_port(self, arg):
102 addr = list(map(int, arg.split(',')))
103 ip = '%d.%d.%d.%d' %tuple(addr[:4])
104 port = (addr[4] * 256) + addr[5]
Antoine Pitroud778e562010-10-14 20:35:26 +0000105 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000106 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000107 self.push('200 active data connection established')
108
109 def cmd_pasv(self, arg):
Brett Cannon918e2d42010-10-29 23:26:25 +0000110 with socket.socket() as sock:
111 sock.bind((self.socket.getsockname()[0], 0))
112 sock.listen(5)
113 sock.settimeout(10)
114 ip, port = sock.getsockname()[:2]
115 ip = ip.replace('.', ','); p1 = port / 256; p2 = port % 256
116 self.push('227 entering passive mode (%s,%d,%d)' %(ip, p1, p2))
117 conn, addr = sock.accept()
118 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000119
120 def cmd_eprt(self, arg):
121 af, ip, port = arg.split(arg[0])[1:-1]
122 port = int(port)
Antoine Pitroud778e562010-10-14 20:35:26 +0000123 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000124 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000125 self.push('200 active data connection established')
126
127 def cmd_epsv(self, arg):
Brett Cannon918e2d42010-10-29 23:26:25 +0000128 with socket.socket(socket.AF_INET6) as sock:
129 sock.bind((self.socket.getsockname()[0], 0))
130 sock.listen(5)
131 sock.settimeout(10)
132 port = sock.getsockname()[1]
133 self.push('229 entering extended passive mode (|||%d|)' %port)
134 conn, addr = sock.accept()
135 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000136
137 def cmd_echo(self, arg):
138 # sends back the received string (used by the test suite)
139 self.push(arg)
140
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000141 def cmd_noop(self, arg):
142 self.push('200 noop ok')
143
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000144 def cmd_user(self, arg):
145 self.push('331 username ok')
146
147 def cmd_pass(self, arg):
148 self.push('230 password ok')
149
150 def cmd_acct(self, arg):
151 self.push('230 acct ok')
152
153 def cmd_rnfr(self, arg):
154 self.push('350 rnfr ok')
155
156 def cmd_rnto(self, arg):
157 self.push('250 rnto ok')
158
159 def cmd_dele(self, arg):
160 self.push('250 dele ok')
161
162 def cmd_cwd(self, arg):
163 self.push('250 cwd ok')
164
165 def cmd_size(self, arg):
166 self.push('250 1000')
167
168 def cmd_mkd(self, arg):
169 self.push('257 "%s"' %arg)
170
171 def cmd_rmd(self, arg):
172 self.push('250 rmd ok')
173
174 def cmd_pwd(self, arg):
175 self.push('257 "pwd ok"')
176
177 def cmd_type(self, arg):
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +0000178 self.push('200 type ok')
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000179
180 def cmd_quit(self, arg):
181 self.push('221 quit ok')
182 self.close()
183
184 def cmd_stor(self, arg):
185 self.push('125 stor ok')
186
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000187 def cmd_rest(self, arg):
188 self.rest = arg
189 self.push('350 rest ok')
190
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000191 def cmd_retr(self, arg):
192 self.push('125 retr ok')
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000193 if self.rest is not None:
194 offset = int(self.rest)
195 else:
196 offset = 0
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +0000197 self.dtp.push(RETR_DATA[offset:])
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000198 self.dtp.close_when_done()
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000199 self.rest = None
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000200
201 def cmd_list(self, arg):
202 self.push('125 list ok')
203 self.dtp.push(LIST_DATA)
204 self.dtp.close_when_done()
205
206 def cmd_nlst(self, arg):
207 self.push('125 nlst ok')
208 self.dtp.push(NLST_DATA)
209 self.dtp.close_when_done()
210
211
212class DummyFTPServer(asyncore.dispatcher, threading.Thread):
213
214 handler = DummyFTPHandler
215
216 def __init__(self, address, af=socket.AF_INET):
217 threading.Thread.__init__(self)
218 asyncore.dispatcher.__init__(self)
219 self.create_socket(af, socket.SOCK_STREAM)
220 self.bind(address)
221 self.listen(5)
222 self.active = False
223 self.active_lock = threading.Lock()
224 self.host, self.port = self.socket.getsockname()[:2]
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000225 self.handler_instance = None
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000226
227 def start(self):
228 assert not self.active
229 self.__flag = threading.Event()
230 threading.Thread.start(self)
231 self.__flag.wait()
232
233 def run(self):
234 self.active = True
235 self.__flag.set()
236 while self.active and asyncore.socket_map:
237 self.active_lock.acquire()
238 asyncore.loop(timeout=0.1, count=1)
239 self.active_lock.release()
240 asyncore.close_all(ignore_all=True)
241
242 def stop(self):
243 assert self.active
244 self.active = False
245 self.join()
246
Giampaolo Rodolà977c7072010-10-04 21:08:36 +0000247 def handle_accepted(self, conn, addr):
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000248 self.handler_instance = self.handler(conn)
Benjamin Petersond06e3b02008-09-28 21:00:42 +0000249
250 def handle_connect(self):
251 self.close()
252 handle_read = handle_connect
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000253
254 def writable(self):
255 return 0
256
257 def handle_error(self):
258 raise
259
260
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000261if ssl is not None:
262
263 CERTFILE = os.path.join(os.path.dirname(__file__), "keycert.pem")
264
265 class SSLConnection(asyncore.dispatcher):
266 """An asyncore.dispatcher subclass supporting TLS/SSL."""
267
268 _ssl_accepting = False
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000269 _ssl_closing = False
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000270
271 def secure_connection(self):
272 self.del_channel()
273 socket = ssl.wrap_socket(self.socket, suppress_ragged_eofs=False,
274 certfile=CERTFILE, server_side=True,
275 do_handshake_on_connect=False,
276 ssl_version=ssl.PROTOCOL_SSLv23)
277 self.set_socket(socket)
278 self._ssl_accepting = True
279
280 def _do_ssl_handshake(self):
281 try:
282 self.socket.do_handshake()
283 except ssl.SSLError as err:
284 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
285 ssl.SSL_ERROR_WANT_WRITE):
286 return
287 elif err.args[0] == ssl.SSL_ERROR_EOF:
288 return self.handle_close()
289 raise
290 except socket.error as err:
291 if err.args[0] == errno.ECONNABORTED:
292 return self.handle_close()
293 else:
294 self._ssl_accepting = False
295
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000296 def _do_ssl_shutdown(self):
297 self._ssl_closing = True
298 try:
299 self.socket = self.socket.unwrap()
300 except ssl.SSLError as err:
301 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
302 ssl.SSL_ERROR_WANT_WRITE):
303 return
304 except socket.error as err:
305 # Any "socket error" corresponds to a SSL_ERROR_SYSCALL return
306 # from OpenSSL's SSL_shutdown(), corresponding to a
307 # closed socket condition. See also:
308 # http://www.mail-archive.com/openssl-users@openssl.org/msg60710.html
309 pass
310 self._ssl_closing = False
311 super(SSLConnection, self).close()
312
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000313 def handle_read_event(self):
314 if self._ssl_accepting:
315 self._do_ssl_handshake()
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000316 elif self._ssl_closing:
317 self._do_ssl_shutdown()
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000318 else:
319 super(SSLConnection, self).handle_read_event()
320
321 def handle_write_event(self):
322 if self._ssl_accepting:
323 self._do_ssl_handshake()
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000324 elif self._ssl_closing:
325 self._do_ssl_shutdown()
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000326 else:
327 super(SSLConnection, self).handle_write_event()
328
329 def send(self, data):
330 try:
331 return super(SSLConnection, self).send(data)
332 except ssl.SSLError as err:
Antoine Pitrou5733c082010-03-22 14:49:10 +0000333 if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN,
334 ssl.SSL_ERROR_WANT_READ,
335 ssl.SSL_ERROR_WANT_WRITE):
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000336 return 0
337 raise
338
339 def recv(self, buffer_size):
340 try:
341 return super(SSLConnection, self).recv(buffer_size)
342 except ssl.SSLError as err:
Antoine Pitrou5733c082010-03-22 14:49:10 +0000343 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
344 ssl.SSL_ERROR_WANT_WRITE):
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000345 return b''
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000346 if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN):
347 self.handle_close()
348 return b''
349 raise
350
351 def handle_error(self):
352 raise
353
354 def close(self):
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000355 if (isinstance(self.socket, ssl.SSLSocket) and
356 self.socket._sslobj is not None):
357 self._do_ssl_shutdown()
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000358
359
360 class DummyTLS_DTPHandler(SSLConnection, DummyDTPHandler):
361 """A DummyDTPHandler subclass supporting TLS/SSL."""
362
363 def __init__(self, conn, baseclass):
364 DummyDTPHandler.__init__(self, conn, baseclass)
365 if self.baseclass.secure_data_channel:
366 self.secure_connection()
367
368
369 class DummyTLS_FTPHandler(SSLConnection, DummyFTPHandler):
370 """A DummyFTPHandler subclass supporting TLS/SSL."""
371
372 dtp_handler = DummyTLS_DTPHandler
373
374 def __init__(self, conn):
375 DummyFTPHandler.__init__(self, conn)
376 self.secure_data_channel = False
377
378 def cmd_auth(self, line):
379 """Set up secure control channel."""
380 self.push('234 AUTH TLS successful')
381 self.secure_connection()
382
383 def cmd_pbsz(self, line):
384 """Negotiate size of buffer for secure data transfer.
385 For TLS/SSL the only valid value for the parameter is '0'.
386 Any other value is accepted but ignored.
387 """
388 self.push('200 PBSZ=0 successful.')
389
390 def cmd_prot(self, line):
391 """Setup un/secure data channel."""
392 arg = line.upper()
393 if arg == 'C':
394 self.push('200 Protection set to Clear')
395 self.secure_data_channel = False
396 elif arg == 'P':
397 self.push('200 Protection set to Private')
398 self.secure_data_channel = True
399 else:
400 self.push("502 Unrecognized PROT type (use C or P).")
401
402
403 class DummyTLS_FTPServer(DummyFTPServer):
404 handler = DummyTLS_FTPHandler
405
406
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000407class TestFTPClass(TestCase):
408
409 def setUp(self):
410 self.server = DummyFTPServer((HOST, 0))
411 self.server.start()
Antoine Pitroud778e562010-10-14 20:35:26 +0000412 self.client = ftplib.FTP(timeout=10)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000413 self.client.connect(self.server.host, self.server.port)
414
415 def tearDown(self):
416 self.client.close()
417 self.server.stop()
418
419 def test_getwelcome(self):
420 self.assertEqual(self.client.getwelcome(), '220 welcome')
421
422 def test_sanitize(self):
423 self.assertEqual(self.client.sanitize('foo'), repr('foo'))
424 self.assertEqual(self.client.sanitize('pass 12345'), repr('pass *****'))
425 self.assertEqual(self.client.sanitize('PASS 12345'), repr('PASS *****'))
426
427 def test_exceptions(self):
428 self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 400')
429 self.assertRaises(ftplib.error_temp, self.client.sendcmd, 'echo 499')
430 self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 500')
431 self.assertRaises(ftplib.error_perm, self.client.sendcmd, 'echo 599')
432 self.assertRaises(ftplib.error_proto, self.client.sendcmd, 'echo 999')
433
434 def test_all_errors(self):
435 exceptions = (ftplib.error_reply, ftplib.error_temp, ftplib.error_perm,
436 ftplib.error_proto, ftplib.Error, IOError, EOFError)
437 for x in exceptions:
438 try:
439 raise x('exception not included in all_errors set')
440 except ftplib.all_errors:
441 pass
442
443 def test_set_pasv(self):
444 # passive mode is supposed to be enabled by default
445 self.assertTrue(self.client.passiveserver)
446 self.client.set_pasv(True)
447 self.assertTrue(self.client.passiveserver)
448 self.client.set_pasv(False)
449 self.assertFalse(self.client.passiveserver)
450
451 def test_voidcmd(self):
452 self.client.voidcmd('echo 200')
453 self.client.voidcmd('echo 299')
454 self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 199')
455 self.assertRaises(ftplib.error_reply, self.client.voidcmd, 'echo 300')
456
457 def test_login(self):
458 self.client.login()
459
460 def test_acct(self):
461 self.client.acct('passwd')
462
463 def test_rename(self):
464 self.client.rename('a', 'b')
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000465 self.server.handler_instance.next_response = '200'
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000466 self.assertRaises(ftplib.error_reply, self.client.rename, 'a', 'b')
467
468 def test_delete(self):
469 self.client.delete('foo')
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000470 self.server.handler_instance.next_response = '199'
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000471 self.assertRaises(ftplib.error_reply, self.client.delete, 'foo')
472
473 def test_size(self):
474 self.client.size('foo')
475
476 def test_mkd(self):
477 dir = self.client.mkd('/foo')
478 self.assertEqual(dir, '/foo')
479
480 def test_rmd(self):
481 self.client.rmd('foo')
482
483 def test_pwd(self):
484 dir = self.client.pwd()
485 self.assertEqual(dir, 'pwd ok')
486
487 def test_quit(self):
488 self.assertEqual(self.client.quit(), '221 quit ok')
489 # Ensure the connection gets closed; sock attribute should be None
490 self.assertEqual(self.client.sock, None)
491
492 def test_retrbinary(self):
493 def callback(data):
494 received.append(data.decode('ascii'))
495 received = []
496 self.client.retrbinary('retr', callback)
497 self.assertEqual(''.join(received), RETR_DATA)
498
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000499 def test_retrbinary_rest(self):
500 def callback(data):
501 received.append(data.decode('ascii'))
502 for rest in (0, 10, 20):
503 received = []
504 self.client.retrbinary('retr', callback, rest=rest)
505 self.assertEqual(''.join(received), RETR_DATA[rest:],
506 msg='rest test case %d %d %d' % (rest,
507 len(''.join(received)),
508 len(RETR_DATA[rest:])))
509
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000510 def test_retrlines(self):
511 received = []
512 self.client.retrlines('retr', received.append)
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +0000513 self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', ''))
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000514
515 def test_storbinary(self):
516 f = io.BytesIO(RETR_DATA.encode('ascii'))
517 self.client.storbinary('stor', f)
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000518 self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000519 # test new callback arg
520 flag = []
521 f.seek(0)
522 self.client.storbinary('stor', f, callback=lambda x: flag.append(None))
523 self.assertTrue(flag)
524
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000525 def test_storbinary_rest(self):
526 f = io.BytesIO(RETR_DATA.replace('\r\n', '\n').encode('ascii'))
527 for r in (30, '30'):
528 f.seek(0)
529 self.client.storbinary('stor', f, rest=r)
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000530 self.assertEqual(self.server.handler_instance.rest, str(r))
Antoine Pitrou648bcd72009-11-27 13:23:26 +0000531
Giampaolo Rodolàf96482e2010-08-04 10:36:18 +0000532 def test_storlines(self):
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000533 f = io.BytesIO(RETR_DATA.replace('\r\n', '\n').encode('ascii'))
534 self.client.storlines('stor', f)
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000535 self.assertEqual(self.server.handler_instance.last_received_data, RETR_DATA)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000536 # test new callback arg
537 flag = []
538 f.seek(0)
539 self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
540 self.assertTrue(flag)
541
542 def test_nlst(self):
543 self.client.nlst()
544 self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1])
545
546 def test_dir(self):
547 l = []
548 self.client.dir(lambda x: l.append(x))
549 self.assertEqual(''.join(l), LIST_DATA.replace('\r\n', ''))
550
Benjamin Peterson3a53fbb2008-09-27 22:04:16 +0000551 def test_makeport(self):
Brett Cannon918e2d42010-10-29 23:26:25 +0000552 with self.client.makeport():
553 # IPv4 is in use, just make sure send_eprt has not been used
554 self.assertEqual(self.server.handler_instance.last_received_cmd,
555 'port')
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000556
557 def test_makepasv(self):
558 host, port = self.client.makepasv()
Antoine Pitroud778e562010-10-14 20:35:26 +0000559 conn = socket.create_connection((host, port), 10)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000560 conn.close()
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000561 # IPv4 is in use, just make sure send_epsv has not been used
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000562 self.assertEqual(self.server.handler_instance.last_received_cmd, 'pasv')
563
564 def test_with_statement(self):
565 self.client.quit()
566
567 def is_client_connected():
568 if self.client.sock is None:
569 return False
570 try:
571 self.client.sendcmd('noop')
572 except (socket.error, EOFError):
573 return False
574 return True
575
576 # base test
Antoine Pitroud778e562010-10-14 20:35:26 +0000577 with ftplib.FTP(timeout=10) as self.client:
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000578 self.client.connect(self.server.host, self.server.port)
579 self.client.sendcmd('noop')
580 self.assertTrue(is_client_connected())
581 self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit')
582 self.assertFalse(is_client_connected())
583
584 # QUIT sent inside the with block
Antoine Pitroud778e562010-10-14 20:35:26 +0000585 with ftplib.FTP(timeout=10) as self.client:
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000586 self.client.connect(self.server.host, self.server.port)
587 self.client.sendcmd('noop')
588 self.client.quit()
589 self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit')
590 self.assertFalse(is_client_connected())
591
592 # force a wrong response code to be sent on QUIT: error_perm
593 # is expected and the connection is supposed to be closed
594 try:
Antoine Pitroud778e562010-10-14 20:35:26 +0000595 with ftplib.FTP(timeout=10) as self.client:
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000596 self.client.connect(self.server.host, self.server.port)
597 self.client.sendcmd('noop')
598 self.server.handler_instance.next_response = '550 error on quit'
599 except ftplib.error_perm as err:
600 self.assertEqual(str(err), '550 error on quit')
601 else:
602 self.fail('Exception not raised')
603 # needed to give the threaded server some time to set the attribute
604 # which otherwise would still be == 'noop'
605 time.sleep(0.1)
606 self.assertEqual(self.server.handler_instance.last_received_cmd, 'quit')
607 self.assertFalse(is_client_connected())
Guido van Rossumd8faa362007-04-27 19:54:29 +0000608
Giampaolo Rodolàbbc47822010-08-23 22:10:32 +0000609 def test_parse257(self):
610 self.assertEqual(ftplib.parse257('257 "/foo/bar"'), '/foo/bar')
611 self.assertEqual(ftplib.parse257('257 "/foo/bar" created'), '/foo/bar')
612 self.assertEqual(ftplib.parse257('257 ""'), '')
613 self.assertEqual(ftplib.parse257('257 "" created'), '')
614 self.assertRaises(ftplib.error_reply, ftplib.parse257, '250 "/foo/bar"')
615 # The 257 response is supposed to include the directory
616 # name and in case it contains embedded double-quotes
617 # they must be doubled (see RFC-959, chapter 7, appendix 2).
618 self.assertEqual(ftplib.parse257('257 "/foo/b""ar"'), '/foo/b"ar')
619 self.assertEqual(ftplib.parse257('257 "/foo/b""ar" created'), '/foo/b"ar')
620
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000621
622class TestIPv6Environment(TestCase):
623
624 def setUp(self):
625 self.server = DummyFTPServer((HOST, 0), af=socket.AF_INET6)
626 self.server.start()
627 self.client = ftplib.FTP()
628 self.client.connect(self.server.host, self.server.port)
629
630 def tearDown(self):
631 self.client.close()
632 self.server.stop()
633
634 def test_af(self):
635 self.assertEqual(self.client.af, socket.AF_INET6)
636
637 def test_makeport(self):
Brett Cannon918e2d42010-10-29 23:26:25 +0000638 with self.client.makeport():
639 self.assertEqual(self.server.handler_instance.last_received_cmd,
640 'eprt')
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000641
642 def test_makepasv(self):
643 host, port = self.client.makepasv()
Antoine Pitroud778e562010-10-14 20:35:26 +0000644 conn = socket.create_connection((host, port), 10)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000645 conn.close()
Giampaolo Rodolàbd576b72010-05-10 14:53:29 +0000646 self.assertEqual(self.server.handler_instance.last_received_cmd, 'epsv')
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000647
648 def test_transfer(self):
649 def retr():
650 def callback(data):
651 received.append(data.decode('ascii'))
652 received = []
653 self.client.retrbinary('retr', callback)
654 self.assertEqual(''.join(received), RETR_DATA)
655 self.client.set_pasv(True)
656 retr()
657 self.client.set_pasv(False)
658 retr()
659
660
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000661class TestTLS_FTPClassMixin(TestFTPClass):
662 """Repeat TestFTPClass tests starting the TLS layer for both control
663 and data connections first.
664 """
665
666 def setUp(self):
667 self.server = DummyTLS_FTPServer((HOST, 0))
668 self.server.start()
Antoine Pitroud778e562010-10-14 20:35:26 +0000669 self.client = ftplib.FTP_TLS(timeout=10)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000670 self.client.connect(self.server.host, self.server.port)
671 # enable TLS
672 self.client.auth()
673 self.client.prot_p()
674
675
676class TestTLS_FTPClass(TestCase):
677 """Specific TLS_FTP class tests."""
678
679 def setUp(self):
680 self.server = DummyTLS_FTPServer((HOST, 0))
681 self.server.start()
Antoine Pitroud778e562010-10-14 20:35:26 +0000682 self.client = ftplib.FTP_TLS(timeout=10)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000683 self.client.connect(self.server.host, self.server.port)
684
685 def tearDown(self):
686 self.client.close()
687 self.server.stop()
688
689 def test_control_connection(self):
Ezio Melottie9615932010-01-24 19:26:24 +0000690 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000691 self.client.auth()
Ezio Melottie9615932010-01-24 19:26:24 +0000692 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000693
694 def test_data_connection(self):
695 # clear text
Brett Cannon918e2d42010-10-29 23:26:25 +0000696 with self.client.transfercmd('list') as sock:
697 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000698 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000699
700 # secured, after PROT P
701 self.client.prot_p()
Brett Cannon918e2d42010-10-29 23:26:25 +0000702 with self.client.transfercmd('list') as sock:
703 self.assertIsInstance(sock, ssl.SSLSocket)
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000704 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000705
706 # PROT C is issued, the connection must be in cleartext again
707 self.client.prot_c()
Brett Cannon918e2d42010-10-29 23:26:25 +0000708 with self.client.transfercmd('list') as sock:
709 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrou2c4f98b2010-04-23 00:16:21 +0000710 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000711
712 def test_login(self):
713 # login() is supposed to implicitly secure the control connection
Ezio Melottie9615932010-01-24 19:26:24 +0000714 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000715 self.client.login()
Ezio Melottie9615932010-01-24 19:26:24 +0000716 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000717 # make sure that AUTH TLS doesn't get issued again
718 self.client.login()
719
720 def test_auth_issued_twice(self):
721 self.client.auth()
722 self.assertRaises(ValueError, self.client.auth)
723
724 def test_auth_ssl(self):
725 try:
726 self.client.ssl_version = ssl.PROTOCOL_SSLv3
727 self.client.auth()
728 self.assertRaises(ValueError, self.client.auth)
729 finally:
730 self.client.ssl_version = ssl.PROTOCOL_TLSv1
731
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000732 def test_context(self):
733 self.client.quit()
734 ctx = ssl.SSLContext(ssl.PROTOCOL_TLSv1)
735 self.assertRaises(ValueError, ftplib.FTP_TLS, keyfile=CERTFILE,
736 context=ctx)
737 self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
738 context=ctx)
739 self.assertRaises(ValueError, ftplib.FTP_TLS, certfile=CERTFILE,
740 keyfile=CERTFILE, context=ctx)
741
Antoine Pitroud778e562010-10-14 20:35:26 +0000742 self.client = ftplib.FTP_TLS(context=ctx, timeout=10)
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000743 self.client.connect(self.server.host, self.server.port)
744 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
745 self.client.auth()
746 self.assertIs(self.client.sock.context, ctx)
747 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
748
749 self.client.prot_p()
Brett Cannon918e2d42010-10-29 23:26:25 +0000750 with self.client.transfercmd('list') as sock:
751 self.assertIs(sock.context, ctx)
752 self.assertIsInstance(sock, ssl.SSLSocket)
Giampaolo Rodolàa67299e2010-05-26 18:06:04 +0000753
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000754
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000755class TestTimeouts(TestCase):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000756
757 def setUp(self):
Guido van Rossumd8faa362007-04-27 19:54:29 +0000758 self.evt = threading.Event()
Christian Heimes5e696852008-04-09 08:37:03 +0000759 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
760 self.sock.settimeout(3)
Benjamin Petersonee8712c2008-05-20 21:35:26 +0000761 self.port = support.bind_port(self.sock)
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000762 threading.Thread(target=self.server, args=(self.evt,self.sock)).start()
Christian Heimes836baa52008-02-26 08:18:30 +0000763 # Wait for the server to be ready.
764 self.evt.wait()
765 self.evt.clear()
Christian Heimes5e696852008-04-09 08:37:03 +0000766 ftplib.FTP.port = self.port
Guido van Rossumd8faa362007-04-27 19:54:29 +0000767
768 def tearDown(self):
769 self.evt.wait()
Brett Cannon918e2d42010-10-29 23:26:25 +0000770 self.sock.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000771
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000772 def server(self, evt, serv):
773 # This method sets the evt 3 times:
774 # 1) when the connection is ready to be accepted.
775 # 2) when it is safe for the caller to close the connection
776 # 3) when we have closed the socket
777 serv.listen(5)
778 # (1) Signal the caller that we are ready to accept the connection.
779 evt.set()
780 try:
781 conn, addr = serv.accept()
782 except socket.timeout:
783 pass
784 else:
785 conn.send(b"1 Hola mundo\n")
786 # (2) Signal the caller that it is safe to close the socket.
787 evt.set()
788 conn.close()
789 finally:
790 serv.close()
791 # (3) Signal the caller that we are done.
792 evt.set()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000793
794 def testTimeoutDefault(self):
Georg Brandlf78e02b2008-06-10 17:40:04 +0000795 # default -- use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000796 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000797 socket.setdefaulttimeout(30)
798 try:
799 ftp = ftplib.FTP("localhost")
800 finally:
801 socket.setdefaulttimeout(None)
802 self.assertEqual(ftp.sock.gettimeout(), 30)
803 self.evt.wait()
804 ftp.close()
805
806 def testTimeoutNone(self):
807 # no timeout -- do not use global socket timeout
Benjamin Petersonc9c0f202009-06-30 23:06:06 +0000808 self.assertTrue(socket.getdefaulttimeout() is None)
Georg Brandlf78e02b2008-06-10 17:40:04 +0000809 socket.setdefaulttimeout(30)
810 try:
811 ftp = ftplib.FTP("localhost", timeout=None)
812 finally:
813 socket.setdefaulttimeout(None)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000814 self.assertTrue(ftp.sock.gettimeout() is None)
Christian Heimes836baa52008-02-26 08:18:30 +0000815 self.evt.wait()
Georg Brandlf78e02b2008-06-10 17:40:04 +0000816 ftp.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000817
818 def testTimeoutValue(self):
819 # a value
Christian Heimes5e696852008-04-09 08:37:03 +0000820 ftp = ftplib.FTP(HOST, timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000821 self.assertEqual(ftp.sock.gettimeout(), 30)
Christian Heimes836baa52008-02-26 08:18:30 +0000822 self.evt.wait()
Georg Brandlf78e02b2008-06-10 17:40:04 +0000823 ftp.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000824
825 def testTimeoutConnect(self):
826 ftp = ftplib.FTP()
Christian Heimes5e696852008-04-09 08:37:03 +0000827 ftp.connect(HOST, timeout=30)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000828 self.assertEqual(ftp.sock.gettimeout(), 30)
Christian Heimes836baa52008-02-26 08:18:30 +0000829 self.evt.wait()
Georg Brandlf78e02b2008-06-10 17:40:04 +0000830 ftp.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000831
832 def testTimeoutDifferentOrder(self):
833 ftp = ftplib.FTP(timeout=30)
Christian Heimes5e696852008-04-09 08:37:03 +0000834 ftp.connect(HOST)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000835 self.assertEqual(ftp.sock.gettimeout(), 30)
Christian Heimes836baa52008-02-26 08:18:30 +0000836 self.evt.wait()
Georg Brandlf78e02b2008-06-10 17:40:04 +0000837 ftp.close()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000838
839 def testTimeoutDirectAccess(self):
840 ftp = ftplib.FTP()
841 ftp.timeout = 30
Christian Heimes5e696852008-04-09 08:37:03 +0000842 ftp.connect(HOST)
Guido van Rossumd8faa362007-04-27 19:54:29 +0000843 self.assertEqual(ftp.sock.gettimeout(), 30)
Christian Heimes836baa52008-02-26 08:18:30 +0000844 self.evt.wait()
Guido van Rossumd8faa362007-04-27 19:54:29 +0000845 ftp.close()
846
847
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000848def test_main():
849 tests = [TestFTPClass, TestTimeouts]
850 if socket.has_ipv6:
851 try:
852 DummyFTPServer((HOST, 0), af=socket.AF_INET6)
853 except socket.error:
854 pass
855 else:
856 tests.append(TestIPv6Environment)
Antoine Pitrouf988cd02009-11-17 20:21:14 +0000857
858 if ssl is not None:
859 tests.extend([TestTLS_FTPClassMixin, TestTLS_FTPClass])
860
Benjamin Petersonbe17a112008-09-27 21:49:47 +0000861 thread_info = support.threading_setup()
862 try:
863 support.run_unittest(*tests)
864 finally:
865 support.threading_cleanup(*thread_info)
866
Guido van Rossumd8faa362007-04-27 19:54:29 +0000867
868if __name__ == '__main__':
869 test_main()