| from test import support |
| # If we end up with a significant number of tests that don't require |
| # threading, this test module should be split. Right now we skip |
| # them all if we don't have threading. |
| threading = support.import_module('threading') |
| |
| from contextlib import contextmanager |
| import imaplib |
| import os.path |
| import socketserver |
| import time |
| import calendar |
| |
| from test.support import reap_threads, verbose, transient_internet, run_with_tz, run_with_locale |
| import unittest |
| from datetime import datetime, timezone, timedelta |
| try: |
| import ssl |
| except ImportError: |
| ssl = None |
| |
| CERTFILE = None |
| |
| |
| class TestImaplib(unittest.TestCase): |
| |
| def test_Internaldate2tuple(self): |
| t0 = calendar.timegm((2000, 1, 1, 0, 0, 0, -1, -1, -1)) |
| tt = imaplib.Internaldate2tuple( |
| b'25 (INTERNALDATE "01-Jan-2000 00:00:00 +0000")') |
| self.assertEqual(time.mktime(tt), t0) |
| tt = imaplib.Internaldate2tuple( |
| b'25 (INTERNALDATE "01-Jan-2000 11:30:00 +1130")') |
| self.assertEqual(time.mktime(tt), t0) |
| tt = imaplib.Internaldate2tuple( |
| b'25 (INTERNALDATE "31-Dec-1999 12:30:00 -1130")') |
| self.assertEqual(time.mktime(tt), t0) |
| |
| @run_with_tz('MST+07MDT,M4.1.0,M10.5.0') |
| def test_Internaldate2tuple_issue10941(self): |
| self.assertNotEqual(imaplib.Internaldate2tuple( |
| b'25 (INTERNALDATE "02-Apr-2000 02:30:00 +0000")'), |
| imaplib.Internaldate2tuple( |
| b'25 (INTERNALDATE "02-Apr-2000 03:30:00 +0000")')) |
| |
| |
| |
| def timevalues(self): |
| return [2000000000, 2000000000.0, time.localtime(2000000000), |
| (2033, 5, 18, 5, 33, 20, -1, -1, -1), |
| (2033, 5, 18, 5, 33, 20, -1, -1, 1), |
| datetime.fromtimestamp(2000000000, |
| timezone(timedelta(0, 2*60*60))), |
| '"18-May-2033 05:33:20 +0200"'] |
| |
| @run_with_locale('LC_ALL', 'de_DE', 'fr_FR') |
| @run_with_tz('STD-1DST') |
| def test_Time2Internaldate(self): |
| expected = '"18-May-2033 05:33:20 +0200"' |
| |
| for t in self.timevalues(): |
| internal = imaplib.Time2Internaldate(t) |
| self.assertEqual(internal, expected) |
| |
| def test_that_Time2Internaldate_returns_a_result(self): |
| # Without tzset, we can check only that it successfully |
| # produces a result, not the correctness of the result itself, |
| # since the result depends on the timezone the machine is in. |
| for t in self.timevalues(): |
| imaplib.Time2Internaldate(t) |
| |
| |
| if ssl: |
| |
| class SecureTCPServer(socketserver.TCPServer): |
| |
| def get_request(self): |
| newsocket, fromaddr = self.socket.accept() |
| connstream = ssl.wrap_socket(newsocket, |
| server_side=True, |
| certfile=CERTFILE) |
| return connstream, fromaddr |
| |
| IMAP4_SSL = imaplib.IMAP4_SSL |
| |
| else: |
| |
| class SecureTCPServer: |
| pass |
| |
| IMAP4_SSL = None |
| |
| |
| class SimpleIMAPHandler(socketserver.StreamRequestHandler): |
| |
| timeout = 1 |
| continuation = None |
| capabilities = '' |
| |
| def _send(self, message): |
| if verbose: print("SENT: %r" % message.strip()) |
| self.wfile.write(message) |
| |
| def _send_line(self, message): |
| self._send(message + b'\r\n') |
| |
| def _send_textline(self, message): |
| self._send_line(message.encode('ASCII')) |
| |
| def _send_tagged(self, tag, code, message): |
| self._send_textline(' '.join((tag, code, message))) |
| |
| def handle(self): |
| # Send a welcome message. |
| self._send_textline('* OK IMAP4rev1') |
| while 1: |
| # Gather up input until we receive a line terminator or we timeout. |
| # Accumulate read(1) because it's simpler to handle the differences |
| # between naked sockets and SSL sockets. |
| line = b'' |
| while 1: |
| try: |
| part = self.rfile.read(1) |
| if part == b'': |
| # Naked sockets return empty strings.. |
| return |
| line += part |
| except OSError: |
| # ..but SSLSockets raise exceptions. |
| return |
| if line.endswith(b'\r\n'): |
| break |
| |
| if verbose: print('GOT: %r' % line.strip()) |
| if self.continuation: |
| try: |
| self.continuation.send(line) |
| except StopIteration: |
| self.continuation = None |
| continue |
| splitline = line.decode('ASCII').split() |
| tag = splitline[0] |
| cmd = splitline[1] |
| args = splitline[2:] |
| |
| if hasattr(self, 'cmd_'+cmd): |
| continuation = getattr(self, 'cmd_'+cmd)(tag, args) |
| if continuation: |
| self.continuation = continuation |
| next(continuation) |
| else: |
| self._send_tagged(tag, 'BAD', cmd + ' unknown') |
| |
| def cmd_CAPABILITY(self, tag, args): |
| caps = 'IMAP4rev1 ' + self.capabilities if self.capabilities else 'IMAP4rev1' |
| self._send_textline('* CAPABILITY ' + caps) |
| self._send_tagged(tag, 'OK', 'CAPABILITY completed') |
| |
| def cmd_LOGOUT(self, tag, args): |
| self._send_textline('* BYE IMAP4ref1 Server logging out') |
| self._send_tagged(tag, 'OK', 'LOGOUT completed') |
| |
| |
| class BaseThreadedNetworkedTests(unittest.TestCase): |
| |
| def make_server(self, addr, hdlr): |
| |
| class MyServer(self.server_class): |
| def handle_error(self, request, client_address): |
| self.close_request(request) |
| self.server_close() |
| raise |
| |
| if verbose: print("creating server") |
| server = MyServer(addr, hdlr) |
| self.assertEqual(server.server_address, server.socket.getsockname()) |
| |
| if verbose: |
| print("server created") |
| print("ADDR =", addr) |
| print("CLASS =", self.server_class) |
| print("HDLR =", server.RequestHandlerClass) |
| |
| t = threading.Thread( |
| name='%s serving' % self.server_class, |
| target=server.serve_forever, |
| # Short poll interval to make the test finish quickly. |
| # Time between requests is short enough that we won't wake |
| # up spuriously too many times. |
| kwargs={'poll_interval':0.01}) |
| t.daemon = True # In case this function raises. |
| t.start() |
| if verbose: print("server running") |
| return server, t |
| |
| def reap_server(self, server, thread): |
| if verbose: print("waiting for server") |
| server.shutdown() |
| server.server_close() |
| thread.join() |
| if verbose: print("done") |
| |
| @contextmanager |
| def reaped_server(self, hdlr): |
| server, thread = self.make_server((support.HOST, 0), hdlr) |
| try: |
| yield server |
| finally: |
| self.reap_server(server, thread) |
| |
| @contextmanager |
| def reaped_pair(self, hdlr): |
| server, thread = self.make_server((support.HOST, 0), hdlr) |
| client = self.imap_class(*server.server_address) |
| try: |
| yield server, client |
| finally: |
| client.logout() |
| self.reap_server(server, thread) |
| |
| @reap_threads |
| def test_connect(self): |
| with self.reaped_server(SimpleIMAPHandler) as server: |
| client = self.imap_class(*server.server_address) |
| client.shutdown() |
| |
| @reap_threads |
| def test_issue5949(self): |
| |
| class EOFHandler(socketserver.StreamRequestHandler): |
| def handle(self): |
| # EOF without sending a complete welcome message. |
| self.wfile.write(b'* OK') |
| |
| with self.reaped_server(EOFHandler) as server: |
| self.assertRaises(imaplib.IMAP4.abort, |
| self.imap_class, *server.server_address) |
| |
| @reap_threads |
| def test_line_termination(self): |
| |
| class BadNewlineHandler(SimpleIMAPHandler): |
| |
| def cmd_CAPABILITY(self, tag, args): |
| self._send(b'* CAPABILITY IMAP4rev1 AUTH\n') |
| self._send_tagged(tag, 'OK', 'CAPABILITY completed') |
| |
| with self.reaped_server(BadNewlineHandler) as server: |
| self.assertRaises(imaplib.IMAP4.abort, |
| self.imap_class, *server.server_address) |
| |
| @reap_threads |
| def test_bad_auth_name(self): |
| |
| class MyServer(SimpleIMAPHandler): |
| |
| def cmd_AUTHENTICATE(self, tag, args): |
| self._send_tagged(tag, 'NO', 'unrecognized authentication ' |
| 'type {}'.format(args[0])) |
| |
| with self.reaped_pair(MyServer) as (server, client): |
| with self.assertRaises(imaplib.IMAP4.error): |
| client.authenticate('METHOD', lambda: 1) |
| |
| @reap_threads |
| def test_invalid_authentication(self): |
| |
| class MyServer(SimpleIMAPHandler): |
| |
| def cmd_AUTHENTICATE(self, tag, args): |
| self._send_textline('+') |
| self.response = yield |
| self._send_tagged(tag, 'NO', '[AUTHENTICATIONFAILED] invalid') |
| |
| with self.reaped_pair(MyServer) as (server, client): |
| with self.assertRaises(imaplib.IMAP4.error): |
| code, data = client.authenticate('MYAUTH', lambda x: b'fake') |
| |
| @reap_threads |
| def test_valid_authentication(self): |
| |
| class MyServer(SimpleIMAPHandler): |
| |
| def cmd_AUTHENTICATE(self, tag, args): |
| self._send_textline('+') |
| self.server.response = yield |
| self._send_tagged(tag, 'OK', 'FAKEAUTH successful') |
| |
| with self.reaped_pair(MyServer) as (server, client): |
| code, data = client.authenticate('MYAUTH', lambda x: b'fake') |
| self.assertEqual(code, 'OK') |
| self.assertEqual(server.response, |
| b'ZmFrZQ==\r\n') #b64 encoded 'fake' |
| |
| with self.reaped_pair(MyServer) as (server, client): |
| code, data = client.authenticate('MYAUTH', lambda x: 'fake') |
| self.assertEqual(code, 'OK') |
| self.assertEqual(server.response, |
| b'ZmFrZQ==\r\n') #b64 encoded 'fake' |
| |
| @reap_threads |
| def test_login_cram_md5(self): |
| |
| class AuthHandler(SimpleIMAPHandler): |
| |
| capabilities = 'LOGINDISABLED AUTH=CRAM-MD5' |
| |
| def cmd_AUTHENTICATE(self, tag, args): |
| self._send_textline('+ PDE4OTYuNjk3MTcwOTUyQHBvc3RvZmZpY2Uucm' |
| 'VzdG9uLm1jaS5uZXQ=') |
| r = yield |
| if r == b'dGltIGYxY2E2YmU0NjRiOWVmYTFjY2E2ZmZkNmNmMmQ5ZjMy\r\n': |
| self._send_tagged(tag, 'OK', 'CRAM-MD5 successful') |
| else: |
| self._send_tagged(tag, 'NO', 'No access') |
| |
| with self.reaped_pair(AuthHandler) as (server, client): |
| self.assertTrue('AUTH=CRAM-MD5' in client.capabilities) |
| ret, data = client.login_cram_md5("tim", "tanstaaftanstaaf") |
| self.assertEqual(ret, "OK") |
| |
| with self.reaped_pair(AuthHandler) as (server, client): |
| self.assertTrue('AUTH=CRAM-MD5' in client.capabilities) |
| ret, data = client.login_cram_md5("tim", b"tanstaaftanstaaf") |
| self.assertEqual(ret, "OK") |
| |
| |
| class ThreadedNetworkedTests(BaseThreadedNetworkedTests): |
| |
| server_class = socketserver.TCPServer |
| imap_class = imaplib.IMAP4 |
| |
| |
| @unittest.skipUnless(ssl, "SSL not available") |
| class ThreadedNetworkedTestsSSL(BaseThreadedNetworkedTests): |
| |
| server_class = SecureTCPServer |
| imap_class = IMAP4_SSL |
| |
| |
| class RemoteIMAPTest(unittest.TestCase): |
| host = 'cyrus.andrew.cmu.edu' |
| port = 143 |
| username = 'anonymous' |
| password = 'pass' |
| imap_class = imaplib.IMAP4 |
| |
| def setUp(self): |
| with transient_internet(self.host): |
| self.server = self.imap_class(self.host, self.port) |
| |
| def tearDown(self): |
| if self.server is not None: |
| with transient_internet(self.host): |
| self.server.logout() |
| |
| def test_logincapa(self): |
| with transient_internet(self.host): |
| for cap in self.server.capabilities: |
| self.assertIsInstance(cap, str) |
| self.assertIn('LOGINDISABLED', self.server.capabilities) |
| self.assertIn('AUTH=ANONYMOUS', self.server.capabilities) |
| rs = self.server.login(self.username, self.password) |
| self.assertEqual(rs[0], 'OK') |
| |
| def test_logout(self): |
| with transient_internet(self.host): |
| rs = self.server.logout() |
| self.server = None |
| self.assertEqual(rs[0], 'BYE') |
| |
| |
| @unittest.skipUnless(ssl, "SSL not available") |
| class RemoteIMAP_STARTTLSTest(RemoteIMAPTest): |
| |
| def setUp(self): |
| super().setUp() |
| with transient_internet(self.host): |
| rs = self.server.starttls() |
| self.assertEqual(rs[0], 'OK') |
| |
| def test_logincapa(self): |
| for cap in self.server.capabilities: |
| self.assertIsInstance(cap, str) |
| self.assertNotIn('LOGINDISABLED', self.server.capabilities) |
| |
| |
| @unittest.skipUnless(ssl, "SSL not available") |
| class RemoteIMAP_SSLTest(RemoteIMAPTest): |
| port = 993 |
| imap_class = IMAP4_SSL |
| |
| def setUp(self): |
| pass |
| |
| def tearDown(self): |
| pass |
| |
| def create_ssl_context(self): |
| ssl_context = ssl.SSLContext(ssl.PROTOCOL_SSLv23) |
| ssl_context.load_cert_chain(CERTFILE) |
| return ssl_context |
| |
| def check_logincapa(self, server): |
| try: |
| for cap in server.capabilities: |
| self.assertIsInstance(cap, str) |
| self.assertNotIn('LOGINDISABLED', server.capabilities) |
| self.assertIn('AUTH=PLAIN', server.capabilities) |
| rs = server.login(self.username, self.password) |
| self.assertEqual(rs[0], 'OK') |
| finally: |
| server.logout() |
| |
| def test_logincapa(self): |
| with transient_internet(self.host): |
| _server = self.imap_class(self.host, self.port) |
| self.check_logincapa(_server) |
| |
| def test_logincapa_with_client_certfile(self): |
| with transient_internet(self.host): |
| _server = self.imap_class(self.host, self.port, certfile=CERTFILE) |
| self.check_logincapa(_server) |
| |
| def test_logincapa_with_client_ssl_context(self): |
| with transient_internet(self.host): |
| _server = self.imap_class(self.host, self.port, ssl_context=self.create_ssl_context()) |
| self.check_logincapa(_server) |
| |
| def test_logout(self): |
| with transient_internet(self.host): |
| _server = self.imap_class(self.host, self.port) |
| rs = _server.logout() |
| self.assertEqual(rs[0], 'BYE') |
| |
| def test_ssl_context_certfile_exclusive(self): |
| with transient_internet(self.host): |
| self.assertRaises(ValueError, self.imap_class, self.host, self.port, |
| certfile=CERTFILE, ssl_context=self.create_ssl_context()) |
| |
| def test_ssl_context_keyfile_exclusive(self): |
| with transient_internet(self.host): |
| self.assertRaises(ValueError, self.imap_class, self.host, self.port, |
| keyfile=CERTFILE, ssl_context=self.create_ssl_context()) |
| |
| |
| def load_tests(*args): |
| tests = [TestImaplib] |
| |
| if support.is_resource_enabled('network'): |
| if ssl: |
| global CERTFILE |
| CERTFILE = os.path.join(os.path.dirname(__file__) or os.curdir, |
| "keycert.pem") |
| if not os.path.exists(CERTFILE): |
| raise support.TestFailed("Can't read certificate files!") |
| tests.extend([ |
| ThreadedNetworkedTests, ThreadedNetworkedTestsSSL, |
| RemoteIMAPTest, RemoteIMAP_SSLTest, RemoteIMAP_STARTTLSTest, |
| ]) |
| |
| return unittest.TestSuite([unittest.makeSuite(test) for test in tests]) |
| |
| |
| if __name__ == "__main__": |
| support.use_resources = ['network'] |
| unittest.main() |