blob: 15cb336d633e7ba047995cbc44c662dcf4b1d4dc [file] [log] [blame]
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00001"""Test script for ftplib module."""
2
Antoine Pitrouccd5e022009-11-15 17:22:09 +00003# Modified by Giampaolo Rodola' to test FTP class, IPv6 and TLS
4# environment
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00005
Facundo Batista3f100992007-03-26 20:56:09 +00006import ftplib
Benjamin Peterson3c0c4832008-09-27 02:49:54 +00007import asyncore
8import asynchat
9import socket
10import StringIO
Antoine Pitrouccd5e022009-11-15 17:22:09 +000011import errno
12import os
13try:
14 import ssl
15except ImportError:
16 ssl = None
Facundo Batista3f100992007-03-26 20:56:09 +000017
Serhiy Storchaka32e23e72013-11-03 23:15:46 +020018from unittest import TestCase, SkipTest, skipUnless
Facundo Batista3f100992007-03-26 20:56:09 +000019from test import test_support
Antoine Pitrou78254dc2013-08-22 00:39:46 +020020from test.test_support import HOST, HOSTv6
Victor Stinner6a102812010-04-27 23:55:59 +000021threading = test_support.import_module('threading')
Facundo Batista3f100992007-03-26 20:56:09 +000022
Neal Norwitzb0917c12008-02-26 04:50:37 +000023
Benjamin Peterson3c0c4832008-09-27 02:49:54 +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'
29
30
31class DummyDTPHandler(asynchat.async_chat):
Antoine Pitroua5c4b552010-04-22 23:33:02 +000032 dtp_conn_closed = False
Benjamin Peterson3c0c4832008-09-27 02:49:54 +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):
40 self.baseclass.last_received_data += self.recv(1024)
41
42 def handle_close(self):
Antoine Pitroua5c4b552010-04-22 23:33:02 +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 Peterson3c0c4832008-09-27 02:49:54 +000050
Giampaolo RodolĂ e4499a82010-05-06 20:19:32 +000051 def handle_error(self):
52 raise
53
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000054
55class DummyFTPHandler(asynchat.async_chat):
56
Antoine Pitrouccd5e022009-11-15 17:22:09 +000057 dtp_handler = DummyDTPHandler
58
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000059 def __init__(self, conn):
60 asynchat.async_chat.__init__(self, conn)
61 self.set_terminator("\r\n")
62 self.in_buffer = []
63 self.dtp = None
64 self.last_received_cmd = None
65 self.last_received_data = ''
66 self.next_response = ''
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +000067 self.rest = None
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +030068 self.next_retr_data = RETR_DATA
Benjamin Peterson3c0c4832008-09-27 02:49:54 +000069 self.push('220 welcome')
70
71 def collect_incoming_data(self, data):
72 self.in_buffer.append(data)
73
74 def found_terminator(self):
75 line = ''.join(self.in_buffer)
76 self.in_buffer = []
77 if self.next_response:
78 self.push(self.next_response)
79 self.next_response = ''
80 cmd = line.split(' ')[0].lower()
81 self.last_received_cmd = cmd
82 space = line.find(' ')
83 if space != -1:
84 arg = line[space + 1:]
85 else:
86 arg = ""
87 if hasattr(self, 'cmd_' + cmd):
88 method = getattr(self, 'cmd_' + cmd)
89 method(arg)
90 else:
91 self.push('550 command "%s" not understood.' %cmd)
92
93 def handle_error(self):
94 raise
95
96 def push(self, data):
97 asynchat.async_chat.push(self, data + '\r\n')
98
99 def cmd_port(self, arg):
100 addr = map(int, arg.split(','))
101 ip = '%d.%d.%d.%d' %tuple(addr[:4])
102 port = (addr[4] * 256) + addr[5]
Antoine Pitrou82993932010-10-14 20:46:25 +0000103 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000104 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000105 self.push('200 active data connection established')
106
107 def cmd_pasv(self, arg):
108 sock = socket.socket()
109 sock.bind((self.socket.getsockname()[0], 0))
110 sock.listen(5)
Antoine Pitrou82993932010-10-14 20:46:25 +0000111 sock.settimeout(10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000112 ip, port = sock.getsockname()[:2]
Ezio Melottidde5b942010-02-03 05:37:26 +0000113 ip = ip.replace('.', ',')
114 p1, p2 = divmod(port, 256)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000115 self.push('227 entering passive mode (%s,%d,%d)' %(ip, p1, p2))
116 conn, addr = sock.accept()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000117 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000118
119 def cmd_eprt(self, arg):
120 af, ip, port = arg.split(arg[0])[1:-1]
121 port = int(port)
Antoine Pitrou82993932010-10-14 20:46:25 +0000122 s = socket.create_connection((ip, port), timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000123 self.dtp = self.dtp_handler(s, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000124 self.push('200 active data connection established')
125
126 def cmd_epsv(self, arg):
127 sock = socket.socket(socket.AF_INET6)
128 sock.bind((self.socket.getsockname()[0], 0))
129 sock.listen(5)
Antoine Pitrou82993932010-10-14 20:46:25 +0000130 sock.settimeout(10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000131 port = sock.getsockname()[1]
132 self.push('229 entering extended passive mode (|||%d|)' %port)
133 conn, addr = sock.accept()
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000134 self.dtp = self.dtp_handler(conn, baseclass=self)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000135
136 def cmd_echo(self, arg):
137 # sends back the received string (used by the test suite)
138 self.push(arg)
139
140 def cmd_user(self, arg):
141 self.push('331 username ok')
142
143 def cmd_pass(self, arg):
144 self.push('230 password ok')
145
146 def cmd_acct(self, arg):
147 self.push('230 acct ok')
148
149 def cmd_rnfr(self, arg):
150 self.push('350 rnfr ok')
151
152 def cmd_rnto(self, arg):
153 self.push('250 rnto ok')
154
155 def cmd_dele(self, arg):
156 self.push('250 dele ok')
157
158 def cmd_cwd(self, arg):
159 self.push('250 cwd ok')
160
161 def cmd_size(self, arg):
162 self.push('250 1000')
163
164 def cmd_mkd(self, arg):
165 self.push('257 "%s"' %arg)
166
167 def cmd_rmd(self, arg):
168 self.push('250 rmd ok')
169
170 def cmd_pwd(self, arg):
171 self.push('257 "pwd ok"')
172
173 def cmd_type(self, arg):
174 self.push('200 type ok')
175
176 def cmd_quit(self, arg):
177 self.push('221 quit ok')
178 self.close()
179
180 def cmd_stor(self, arg):
181 self.push('125 stor ok')
182
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000183 def cmd_rest(self, arg):
184 self.rest = arg
185 self.push('350 rest ok')
186
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000187 def cmd_retr(self, arg):
188 self.push('125 retr ok')
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000189 if self.rest is not None:
190 offset = int(self.rest)
191 else:
192 offset = 0
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300193 self.dtp.push(self.next_retr_data[offset:])
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000194 self.dtp.close_when_done()
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000195 self.rest = None
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000196
197 def cmd_list(self, arg):
198 self.push('125 list ok')
199 self.dtp.push(LIST_DATA)
200 self.dtp.close_when_done()
201
202 def cmd_nlst(self, arg):
203 self.push('125 nlst ok')
204 self.dtp.push(NLST_DATA)
205 self.dtp.close_when_done()
206
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300207 def cmd_setlongretr(self, arg):
208 # For testing. Next RETR will return long line.
209 self.next_retr_data = 'x' * int(arg)
210 self.push('125 setlongretr ok')
211
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000212
213class DummyFTPServer(asyncore.dispatcher, threading.Thread):
214
215 handler = DummyFTPHandler
216
217 def __init__(self, address, af=socket.AF_INET):
218 threading.Thread.__init__(self)
219 asyncore.dispatcher.__init__(self)
220 self.create_socket(af, socket.SOCK_STREAM)
221 self.bind(address)
222 self.listen(5)
223 self.active = False
224 self.active_lock = threading.Lock()
225 self.host, self.port = self.socket.getsockname()[:2]
226
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
247 def handle_accept(self):
248 conn, addr = self.accept()
249 self.handler = self.handler(conn)
Benjamin Petersone14267b2008-09-28 20:57:21 +0000250 self.close()
251
252 def handle_connect(self):
253 self.close()
254 handle_read = handle_connect
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000255
256 def writable(self):
257 return 0
258
259 def handle_error(self):
260 raise
261
262
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000263if ssl is not None:
264
265 CERTFILE = os.path.join(os.path.dirname(__file__), "keycert.pem")
266
267 class SSLConnection(object, asyncore.dispatcher):
268 """An asyncore.dispatcher subclass supporting TLS/SSL."""
269
270 _ssl_accepting = False
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000271 _ssl_closing = False
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000272
273 def secure_connection(self):
274 self.socket = ssl.wrap_socket(self.socket, suppress_ragged_eofs=False,
275 certfile=CERTFILE, server_side=True,
276 do_handshake_on_connect=False,
277 ssl_version=ssl.PROTOCOL_SSLv23)
278 self._ssl_accepting = True
279
280 def _do_ssl_handshake(self):
281 try:
282 self.socket.do_handshake()
283 except ssl.SSLError, 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, err:
291 if err.args[0] == errno.ECONNABORTED:
292 return self.handle_close()
293 else:
294 self._ssl_accepting = False
295
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000296 def _do_ssl_shutdown(self):
297 self._ssl_closing = True
298 try:
299 self.socket = self.socket.unwrap()
300 except ssl.SSLError, err:
301 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
302 ssl.SSL_ERROR_WANT_WRITE):
303 return
304 except socket.error, 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 Pitrouccd5e022009-11-15 17:22:09 +0000313 def handle_read_event(self):
314 if self._ssl_accepting:
315 self._do_ssl_handshake()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000316 elif self._ssl_closing:
317 self._do_ssl_shutdown()
Antoine Pitrouccd5e022009-11-15 17:22:09 +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 Pitroua5c4b552010-04-22 23:33:02 +0000324 elif self._ssl_closing:
325 self._do_ssl_shutdown()
Antoine Pitrouccd5e022009-11-15 17:22:09 +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, err:
Antoine Pitrou52093b82010-03-22 14:41:48 +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 Pitrouccd5e022009-11-15 17:22:09 +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, err:
Antoine Pitrou52093b82010-03-22 14:41:48 +0000343 if err.args[0] in (ssl.SSL_ERROR_WANT_READ,
344 ssl.SSL_ERROR_WANT_WRITE):
345 return ''
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000346 if err.args[0] in (ssl.SSL_ERROR_EOF, ssl.SSL_ERROR_ZERO_RETURN):
347 self.handle_close()
348 return ''
349 raise
350
351 def handle_error(self):
352 raise
353
354 def close(self):
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000355 if (isinstance(self.socket, ssl.SSLSocket) and
356 self.socket._sslobj is not None):
357 self._do_ssl_shutdown()
Antoine Pitrouccd5e022009-11-15 17:22:09 +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 Peterson3c0c4832008-09-27 02:49:54 +0000407class TestFTPClass(TestCase):
408
409 def setUp(self):
410 self.server = DummyFTPServer((HOST, 0))
411 self.server.start()
Antoine Pitrou82993932010-10-14 20:46:25 +0000412 self.client = ftplib.FTP(timeout=10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +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')
465 self.server.handler.next_response = '200'
466 self.assertRaises(ftplib.error_reply, self.client.rename, 'a', 'b')
467
468 def test_delete(self):
469 self.client.delete('foo')
470 self.server.handler.next_response = '199'
471 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
Senthil Kumaran1eeba832013-08-12 22:24:43 -0700483 def test_cwd(self):
484 dir = self.client.cwd('/foo')
485 self.assertEqual(dir, '250 cwd ok')
486
487 def test_mkd(self):
488 dir = self.client.mkd('/foo')
489 self.assertEqual(dir, '/foo')
490
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000491 def test_pwd(self):
492 dir = self.client.pwd()
493 self.assertEqual(dir, 'pwd ok')
494
495 def test_quit(self):
496 self.assertEqual(self.client.quit(), '221 quit ok')
497 # Ensure the connection gets closed; sock attribute should be None
498 self.assertEqual(self.client.sock, None)
499
500 def test_retrbinary(self):
501 received = []
502 self.client.retrbinary('retr', received.append)
503 self.assertEqual(''.join(received), RETR_DATA)
504
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000505 def test_retrbinary_rest(self):
506 for rest in (0, 10, 20):
507 received = []
508 self.client.retrbinary('retr', received.append, rest=rest)
509 self.assertEqual(''.join(received), RETR_DATA[rest:],
510 msg='rest test case %d %d %d' % (rest,
511 len(''.join(received)),
512 len(RETR_DATA[rest:])))
513
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000514 def test_retrlines(self):
515 received = []
516 self.client.retrlines('retr', received.append)
517 self.assertEqual(''.join(received), RETR_DATA.replace('\r\n', ''))
518
519 def test_storbinary(self):
520 f = StringIO.StringIO(RETR_DATA)
521 self.client.storbinary('stor', f)
522 self.assertEqual(self.server.handler.last_received_data, RETR_DATA)
523 # test new callback arg
524 flag = []
525 f.seek(0)
526 self.client.storbinary('stor', f, callback=lambda x: flag.append(None))
527 self.assertTrue(flag)
528
Antoine Pitrouacbe3bd2009-11-27 13:18:34 +0000529 def test_storbinary_rest(self):
530 f = StringIO.StringIO(RETR_DATA)
531 for r in (30, '30'):
532 f.seek(0)
533 self.client.storbinary('stor', f, rest=r)
534 self.assertEqual(self.server.handler.rest, str(r))
535
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000536 def test_storlines(self):
537 f = StringIO.StringIO(RETR_DATA.replace('\r\n', '\n'))
538 self.client.storlines('stor', f)
539 self.assertEqual(self.server.handler.last_received_data, RETR_DATA)
540 # test new callback arg
541 flag = []
542 f.seek(0)
543 self.client.storlines('stor foo', f, callback=lambda x: flag.append(None))
544 self.assertTrue(flag)
545
546 def test_nlst(self):
547 self.client.nlst()
548 self.assertEqual(self.client.nlst(), NLST_DATA.split('\r\n')[:-1])
549
550 def test_dir(self):
551 l = []
552 self.client.dir(lambda x: l.append(x))
553 self.assertEqual(''.join(l), LIST_DATA.replace('\r\n', ''))
554
555 def test_makeport(self):
556 self.client.makeport()
557 # IPv4 is in use, just make sure send_eprt has not been used
558 self.assertEqual(self.server.handler.last_received_cmd, 'port')
559
560 def test_makepasv(self):
561 host, port = self.client.makepasv()
Antoine Pitrou82993932010-10-14 20:46:25 +0000562 conn = socket.create_connection((host, port), 10)
Facundo Batista93c33682007-03-30 13:00:35 +0000563 conn.close()
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000564 # IPv4 is in use, just make sure send_epsv has not been used
565 self.assertEqual(self.server.handler.last_received_cmd, 'pasv')
Facundo Batista3f100992007-03-26 20:56:09 +0000566
Serhiy Storchaka2585e1e2013-10-20 16:57:07 +0300567 def test_line_too_long(self):
568 self.assertRaises(ftplib.Error, self.client.sendcmd,
569 'x' * self.client.maxline * 2)
570
571 def test_retrlines_too_long(self):
572 self.client.sendcmd('SETLONGRETR %d' % (self.client.maxline * 2))
573 received = []
574 self.assertRaises(ftplib.Error,
575 self.client.retrlines, 'retr', received.append)
576
577 def test_storlines_too_long(self):
578 f = StringIO.StringIO('x' * self.client.maxline * 2)
579 self.assertRaises(ftplib.Error, self.client.storlines, 'stor', f)
580
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000581
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200582@skipUnless(socket.has_ipv6, "IPv6 not enabled")
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000583class TestIPv6Environment(TestCase):
584
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200585 @classmethod
586 def setUpClass(cls):
587 try:
588 DummyFTPServer((HOST, 0), af=socket.AF_INET6)
589 except socket.error:
590 raise SkipTest("IPv6 not enabled")
591
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000592 def setUp(self):
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200593 self.server = DummyFTPServer((HOSTv6, 0), af=socket.AF_INET6)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000594 self.server.start()
595 self.client = ftplib.FTP()
596 self.client.connect(self.server.host, self.server.port)
597
598 def tearDown(self):
599 self.client.close()
600 self.server.stop()
601
602 def test_af(self):
603 self.assertEqual(self.client.af, socket.AF_INET6)
604
605 def test_makeport(self):
606 self.client.makeport()
607 self.assertEqual(self.server.handler.last_received_cmd, 'eprt')
608
609 def test_makepasv(self):
610 host, port = self.client.makepasv()
Antoine Pitrou82993932010-10-14 20:46:25 +0000611 conn = socket.create_connection((host, port), 10)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000612 conn.close()
613 self.assertEqual(self.server.handler.last_received_cmd, 'epsv')
614
615 def test_transfer(self):
616 def retr():
617 received = []
618 self.client.retrbinary('retr', received.append)
619 self.assertEqual(''.join(received), RETR_DATA)
620 self.client.set_pasv(True)
621 retr()
622 self.client.set_pasv(False)
623 retr()
624
625
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200626@skipUnless(ssl, "SSL not available")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000627class TestTLS_FTPClassMixin(TestFTPClass):
628 """Repeat TestFTPClass tests starting the TLS layer for both control
629 and data connections first.
630 """
631
632 def setUp(self):
633 self.server = DummyTLS_FTPServer((HOST, 0))
634 self.server.start()
Antoine Pitrou82993932010-10-14 20:46:25 +0000635 self.client = ftplib.FTP_TLS(timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000636 self.client.connect(self.server.host, self.server.port)
637 # enable TLS
638 self.client.auth()
639 self.client.prot_p()
640
641
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200642@skipUnless(ssl, "SSL not available")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000643class TestTLS_FTPClass(TestCase):
644 """Specific TLS_FTP class tests."""
645
646 def setUp(self):
647 self.server = DummyTLS_FTPServer((HOST, 0))
648 self.server.start()
Antoine Pitrou82993932010-10-14 20:46:25 +0000649 self.client = ftplib.FTP_TLS(timeout=10)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000650 self.client.connect(self.server.host, self.server.port)
651
652 def tearDown(self):
653 self.client.close()
654 self.server.stop()
655
656 def test_control_connection(self):
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000657 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000658 self.client.auth()
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000659 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000660
661 def test_data_connection(self):
662 # clear text
663 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000664 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000665 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000666 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000667
668 # secured, after PROT P
669 self.client.prot_p()
670 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000671 self.assertIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000672 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000673 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000674
675 # PROT C is issued, the connection must be in cleartext again
676 self.client.prot_c()
677 sock = self.client.transfercmd('list')
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000678 self.assertNotIsInstance(sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000679 sock.close()
Antoine Pitroua5c4b552010-04-22 23:33:02 +0000680 self.assertEqual(self.client.voidresp(), "226 transfer complete")
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000681
682 def test_login(self):
683 # login() is supposed to implicitly secure the control connection
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000684 self.assertNotIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000685 self.client.login()
Ezio Melottib0f5adc2010-01-24 16:58:36 +0000686 self.assertIsInstance(self.client.sock, ssl.SSLSocket)
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000687 # make sure that AUTH TLS doesn't get issued again
688 self.client.login()
689
690 def test_auth_issued_twice(self):
691 self.client.auth()
692 self.assertRaises(ValueError, self.client.auth)
693
694 def test_auth_ssl(self):
695 try:
696 self.client.ssl_version = ssl.PROTOCOL_SSLv3
697 self.client.auth()
698 self.assertRaises(ValueError, self.client.auth)
699 finally:
700 self.client.ssl_version = ssl.PROTOCOL_TLSv1
701
702
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000703class TestTimeouts(TestCase):
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000704
Facundo Batista3f100992007-03-26 20:56:09 +0000705 def setUp(self):
Facundo Batista3f100992007-03-26 20:56:09 +0000706 self.evt = threading.Event()
Trent Nelsone41b0062008-04-08 23:47:30 +0000707 self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
Charles-François Natali3b818072011-12-19 16:11:04 +0100708 self.sock.settimeout(10)
Trent Nelsone41b0062008-04-08 23:47:30 +0000709 self.port = test_support.bind_port(self.sock)
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000710 threading.Thread(target=self.server, args=(self.evt,self.sock)).start()
Neal Norwitzb0917c12008-02-26 04:50:37 +0000711 # Wait for the server to be ready.
712 self.evt.wait()
713 self.evt.clear()
Trent Nelsone41b0062008-04-08 23:47:30 +0000714 ftplib.FTP.port = self.port
Facundo Batista3f100992007-03-26 20:56:09 +0000715
716 def tearDown(self):
717 self.evt.wait()
718
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000719 def server(self, evt, serv):
720 # This method sets the evt 3 times:
721 # 1) when the connection is ready to be accepted.
722 # 2) when it is safe for the caller to close the connection
723 # 3) when we have closed the socket
724 serv.listen(5)
725 # (1) Signal the caller that we are ready to accept the connection.
726 evt.set()
727 try:
728 conn, addr = serv.accept()
729 except socket.timeout:
730 pass
731 else:
732 conn.send("1 Hola mundo\n")
733 # (2) Signal the caller that it is safe to close the socket.
734 evt.set()
735 conn.close()
736 finally:
737 serv.close()
738 # (3) Signal the caller that we are done.
739 evt.set()
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000740
Facundo Batista3f100992007-03-26 20:56:09 +0000741 def testTimeoutDefault(self):
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000742 # default -- use global socket timeout
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000743 self.assertTrue(socket.getdefaulttimeout() is None)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000744 socket.setdefaulttimeout(30)
745 try:
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200746 ftp = ftplib.FTP(HOST)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000747 finally:
748 socket.setdefaulttimeout(None)
749 self.assertEqual(ftp.sock.gettimeout(), 30)
750 self.evt.wait()
751 ftp.close()
752
753 def testTimeoutNone(self):
754 # no timeout -- do not use global socket timeout
Benjamin Peterson5c8da862009-06-30 22:57:08 +0000755 self.assertTrue(socket.getdefaulttimeout() is None)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000756 socket.setdefaulttimeout(30)
757 try:
Antoine Pitrou78254dc2013-08-22 00:39:46 +0200758 ftp = ftplib.FTP(HOST, timeout=None)
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000759 finally:
760 socket.setdefaulttimeout(None)
Facundo Batista3f100992007-03-26 20:56:09 +0000761 self.assertTrue(ftp.sock.gettimeout() is None)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000762 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000763 ftp.close()
Neal Norwitz0d4c06e2007-04-25 06:30:05 +0000764
Facundo Batista3f100992007-03-26 20:56:09 +0000765 def testTimeoutValue(self):
766 # a value
Trent Nelsone41b0062008-04-08 23:47:30 +0000767 ftp = ftplib.FTP(HOST, timeout=30)
Facundo Batista3f100992007-03-26 20:56:09 +0000768 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000769 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000770 ftp.close()
Facundo Batista3f100992007-03-26 20:56:09 +0000771
Facundo Batista93c33682007-03-30 13:00:35 +0000772 def testTimeoutConnect(self):
773 ftp = ftplib.FTP()
Trent Nelsone41b0062008-04-08 23:47:30 +0000774 ftp.connect(HOST, timeout=30)
Facundo Batista93c33682007-03-30 13:00:35 +0000775 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000776 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000777 ftp.close()
Facundo Batista93c33682007-03-30 13:00:35 +0000778
779 def testTimeoutDifferentOrder(self):
780 ftp = ftplib.FTP(timeout=30)
Trent Nelsone41b0062008-04-08 23:47:30 +0000781 ftp.connect(HOST)
Facundo Batista93c33682007-03-30 13:00:35 +0000782 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000783 self.evt.wait()
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000784 ftp.close()
Facundo Batista93c33682007-03-30 13:00:35 +0000785
786 def testTimeoutDirectAccess(self):
787 ftp = ftplib.FTP()
788 ftp.timeout = 30
Trent Nelsone41b0062008-04-08 23:47:30 +0000789 ftp.connect(HOST)
Facundo Batista93c33682007-03-30 13:00:35 +0000790 self.assertEqual(ftp.sock.gettimeout(), 30)
Neal Norwitzb0917c12008-02-26 04:50:37 +0000791 self.evt.wait()
Facundo Batista3f100992007-03-26 20:56:09 +0000792 ftp.close()
793
794
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000795def test_main():
Serhiy Storchaka32e23e72013-11-03 23:15:46 +0200796 tests = [TestFTPClass, TestTimeouts,
797 TestIPv6Environment,
798 TestTLS_FTPClassMixin, TestTLS_FTPClass]
Antoine Pitrouccd5e022009-11-15 17:22:09 +0000799
Benjamin Peterson3c0c4832008-09-27 02:49:54 +0000800 thread_info = test_support.threading_setup()
801 try:
802 test_support.run_unittest(*tests)
803 finally:
804 test_support.threading_cleanup(*thread_info)
805
Facundo Batista3f100992007-03-26 20:56:09 +0000806
807if __name__ == '__main__':
808 test_main()