Lib/test/test_poplib.py

   1 """Test script for poplib module."""
   2
   3 # Modified by Giampaolo Rodola' to give poplib.POP3 and poplib.POP3_SSL
   4 # a real test suite
   5
   6 import poplib
   7 import threading
   8 import asyncore
   9 import asynchat
  10 import socket
  11 import os
  12 import time
  13
  14 from unittest import TestCase
  15 from test import support as test_support
  16
  17 HOST = test_support.HOST
  18 PORT = 0
  19
  20 # the dummy data returned by server when LIST and RETR commands are issued
  21 LIST_RESP = b'1 1\r\n2 2\r\n3 3\r\n4 4\r\n5 5\r\n.\r\n'
  22 RETR_RESP = b"""From: postmaster@python.org\
  23 \r\nContent-Type: text/plain\r\n\
  24 MIME-Version: 1.0\r\n\
  25 Subject: Dummy\r\n\
  26 \r\n\
  27 line1\r\n\
  28 line2\r\n\
  29 line3\r\n\
  30 .\r\n"""
  31
  32
  33 class DummyPOP3Handler(asynchat.async_chat):
  34
  35     def __init__(self, conn):
  36         asynchat.async_chat.__init__(self, conn)
  37         self.set_terminator(b"\r\n")
  38         self.in_buffer = []
  39         self.push('+OK dummy pop3 server ready.')
  40
  41     def collect_incoming_data(self, data):
  42         self.in_buffer.append(data)
  43
  44     def found_terminator(self):
  45         line = b''.join(self.in_buffer)
  46         line = str(line, 'ISO-8859-1')
  47         self.in_buffer = []
  48         cmd = line.split(' ')[0].lower()
  49         space = line.find(' ')
  50         if space != -1:
  51             arg = line[space + 1:]
  52         else:
  53             arg = ""
  54         if hasattr(self, 'cmd_' + cmd):
  55             method = getattr(self, 'cmd_' + cmd)
  56             method(arg)
  57         else:
  58             self.push('-ERR unrecognized POP3 command "%s".' %cmd)
  59
  60     def handle_error(self):
  61         raise
  62
  63     def push(self, data):
  64         asynchat.async_chat.push(self, data.encode("ISO-8859-1") + b'\r\n')
  65
  66     def cmd_echo(self, arg):
  67         # sends back the received string (used by the test suite)
  68         self.push(arg)
  69
  70     def cmd_user(self, arg):
  71         if arg != "guido":
  72             self.push("-ERR no such user")
  73         self.push('+OK password required')
  74
  75     def cmd_pass(self, arg):
  76         if arg != "python":
  77             self.push("-ERR wrong password")
  78         self.push('+OK 10 messages')
  79
  80     def cmd_stat(self, arg):
  81         self.push('+OK 10 100')
  82
  83     def cmd_list(self, arg):
  84         if arg:
  85             self.push('+OK %s %s' %(arg, arg))
  86         else:
  87             self.push('+OK')
  88             asynchat.async_chat.push(self, LIST_RESP)
  89
  90     cmd_uidl = cmd_list
  91
  92     def cmd_retr(self, arg):
  93         self.push('+OK %s bytes' %len(RETR_RESP))
  94         asynchat.async_chat.push(self, RETR_RESP)
  95
  96     cmd_top = cmd_retr
  97
  98     def cmd_dele(self, arg):
  99         self.push('+OK message marked for deletion.')
 100
 101     def cmd_noop(self, arg):
 102         self.push('+OK done nothing.')
 103
 104     def cmd_rpop(self, arg):
 105         self.push('+OK done nothing.')
 106
 107
 108 class DummyPOP3Server(asyncore.dispatcher, threading.Thread):
 109
 110     handler = DummyPOP3Handler
 111
 112     def __init__(self, address, af=socket.AF_INET):
 113         threading.Thread.__init__(self)
 114         asyncore.dispatcher.__init__(self)
 115         self.create_socket(af, socket.SOCK_STREAM)
 116         self.bind(address)
 117         self.listen(5)
 118         self.active = False
 119         self.active_lock = threading.Lock()
 120         self.host, self.port = self.socket.getsockname()[:2]
 121
 122     def start(self):
 123         assert not self.active
 124         self.__flag = threading.Event()
 125         threading.Thread.start(self)
 126         self.__flag.wait()
 127
 128     def run(self):
 129         self.active = True
 130         self.__flag.set()
 131         while self.active and asyncore.socket_map:
 132             self.active_lock.acquire()
 133             asyncore.loop(timeout=0.1, count=1)
 134             self.active_lock.release()
 135         asyncore.close_all(ignore_all=True)
 136
 137     def stop(self):
 138         assert self.active
 139         self.active = False
 140         self.join()
 141
 142     def handle_accept(self):
 143         conn, addr = self.accept()
 144         self.handler = self.handler(conn)
 145         self.close()
 146
 147     def handle_connect(self):
 148         self.close()
 149     handle_read = handle_connect
 150
 151     def writable(self):
 152         return 0
 153
 154     def handle_error(self):
 155         raise
 156
 157
 158 class TestPOP3Class(TestCase):
 159     def assertOK(self, resp):
 160         self.assertTrue(resp.startswith(b"+OK"))
 161
 162     def setUp(self):
 163         self.server = DummyPOP3Server((HOST, PORT))
 164         self.server.start()
 165         self.client = poplib.POP3(self.server.host, self.server.port)
 166
 167     def tearDown(self):
 168         self.client.quit()
 169         self.server.stop()
 170
 171     def test_getwelcome(self):
 172         self.assertEqual(self.client.getwelcome(), b'+OK dummy pop3 server ready.')
 173
 174     def test_exceptions(self):
 175         self.assertRaises(poplib.error_proto, self.client._shortcmd, 'echo -err')
 176
 177     def test_user(self):
 178         self.assertOK(self.client.user('guido'))
 179         self.assertRaises(poplib.error_proto, self.client.user, 'invalid')
 180
 181     def test_pass_(self):
 182         self.assertOK(self.client.pass_('python'))
 183         self.assertRaises(poplib.error_proto, self.client.user, 'invalid')
 184
 185     def test_stat(self):
 186         self.assertEqual(self.client.stat(), (10, 100))
 187
 188     def test_list(self):
 189         self.assertEqual(self.client.list()[1:],
 190                          ([b'1 1', b'2 2', b'3 3', b'4 4', b'5 5'],
 191                           25))
 192         self.assertTrue(self.client.list('1').endswith(b"OK 1 1"))
 193
 194     def test_retr(self):
 195         expected = (b'+OK 116 bytes',
 196                     [b'From: postmaster@python.org', b'Content-Type: text/plain',
 197                      b'MIME-Version: 1.0', b'Subject: Dummy',
 198                      b'', b'line1', b'line2', b'line3'],
 199                     113)
 200         foo = self.client.retr('foo')
 201         self.assertEqual(foo, expected)
 202
 203     def test_dele(self):
 204         self.assertOK(self.client.dele('foo'))
 205
 206     def test_noop(self):
 207         self.assertOK(self.client.noop())
 208
 209     def test_rpop(self):
 210         self.assertOK(self.client.rpop('foo'))
 211
 212     def test_top(self):
 213         expected =  (b'+OK 116 bytes',
 214                      [b'From: postmaster@python.org', b'Content-Type: text/plain',
 215                       b'MIME-Version: 1.0', b'Subject: Dummy', b'',
 216                       b'line1', b'line2', b'line3'],
 217                      113)
 218         self.assertEqual(self.client.top(1, 1), expected)
 219
 220     def test_uidl(self):
 221         self.client.uidl()
 222         self.client.uidl('foo')
 223
 224
 225 SUPPORTS_SSL = False
 226 if hasattr(poplib, 'POP3_SSL'):
 227     import ssl
 228
 229     SUPPORTS_SSL = True
 230     CERTFILE = os.path.join(os.path.dirname(__file__) or os.curdir, "keycert.pem")
 231
 232     class DummyPOP3_SSLHandler(DummyPOP3Handler):
 233
 234         def __init__(self, conn):
 235             asynchat.async_chat.__init__(self, conn)
 236             ssl_socket = ssl.wrap_socket(self.socket, certfile=CERTFILE,
 237                                           server_side=True)
 238             self.del_channel()
 239             self.set_socket(ssl_socket)
 240             self.set_terminator(b"\r\n")
 241             self.in_buffer = []
 242             self.push('+OK dummy pop3 server ready.')
 243
 244     class TestPOP3_SSLClass(TestPOP3Class):
 245         # repeat previous tests by using poplib.POP3_SSL
 246
 247         def setUp(self):
 248             self.server = DummyPOP3Server((HOST, PORT))
 249             self.server.handler = DummyPOP3_SSLHandler
 250             self.server.start()
 251             self.client = poplib.POP3_SSL(self.server.host, self.server.port)
 252
 253         def test__all__(self):
 254             self.assert_('POP3_SSL' in poplib.__all__)
 255
 256
 257 class TestTimeouts(TestCase):
 258
 259     def setUp(self):
 260         self.evt = threading.Event()
 261         self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
 262         self.sock.settimeout(3)
 263         self.port = test_support.bind_port(self.sock)
 264         threading.Thread(target=self.server, args=(self.evt,self.sock)).start()
 265         time.sleep(.1)
 266
 267     def tearDown(self):
 268         self.evt.wait()
 269
 270     def server(self, evt, serv):
 271         serv.listen(5)
 272         try:
 273             conn, addr = serv.accept()
 274         except socket.timeout:
 275             pass
 276         else:
 277             conn.send(b"+ Hola mundo\n")
 278             conn.close()
 279         finally:
 280             serv.close()
 281             evt.set()
 282
 283     def testTimeoutDefault(self):
 284         self.assertTrue(socket.getdefaulttimeout() is None)
 285         socket.setdefaulttimeout(30)
 286         try:
 287             pop = poplib.POP3("localhost", self.port)
 288         finally:
 289             socket.setdefaulttimeout(None)
 290         self.assertEqual(pop.sock.gettimeout(), 30)
 291         pop.sock.close()
 292
 293     def testTimeoutNone(self):
 294         self.assertTrue(socket.getdefaulttimeout() is None)
 295         socket.setdefaulttimeout(30)
 296         try:
 297             pop = poplib.POP3(HOST, self.port, timeout=None)
 298         finally:
 299             socket.setdefaulttimeout(None)
 300         self.assertTrue(pop.sock.gettimeout() is None)
 301         pop.sock.close()
 302
 303     def testTimeoutValue(self):
 304         pop = poplib.POP3("localhost", self.port, timeout=30)
 305         self.assertEqual(pop.sock.gettimeout(), 30)
 306         pop.sock.close()
 307
 308
 309 def test_main():
 310     tests = [TestPOP3Class, TestTimeouts]
 311     if SUPPORTS_SSL:
 312         tests.append(TestPOP3_SSLClass)
 313     thread_info = test_support.threading_setup()
 314     try:
 315         test_support.run_unittest(*tests)
 316     finally:
 317         test_support.threading_cleanup(*thread_info)
 318
 319
 320 if __name__ == '__main__':
 321     test_main()