Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 1 | import socket |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 2 | import selectors |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 3 | import telnetlib |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 4 | import contextlib |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 5 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 6 | from test import support |
Zachary Ware | ac28b79 | 2015-12-04 23:32:23 -0600 | [diff] [blame] | 7 | import unittest |
Victor Stinner | 45df820 | 2010-04-28 22:31:17 +0000 | [diff] [blame] | 8 | threading = support.import_module('threading') |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 9 | |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 10 | HOST = support.HOST |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 11 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 12 | def server(evt, serv): |
Charles-François Natali | 6e20460 | 2014-07-23 19:28:13 +0100 | [diff] [blame] | 13 | serv.listen() |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame] | 14 | evt.set() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 15 | try: |
| 16 | conn, addr = serv.accept() |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 17 | conn.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 18 | except socket.timeout: |
| 19 | pass |
| 20 | finally: |
| 21 | serv.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 22 | |
Zachary Ware | ac28b79 | 2015-12-04 23:32:23 -0600 | [diff] [blame] | 23 | class GeneralTests(unittest.TestCase): |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 24 | |
| 25 | def setUp(self): |
| 26 | self.evt = threading.Event() |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 27 | self.sock = socket.socket(socket.AF_INET, socket.SOCK_STREAM) |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 28 | self.sock.settimeout(60) # Safety net. Look issue 11812 |
Benjamin Peterson | ee8712c | 2008-05-20 21:35:26 +0000 | [diff] [blame] | 29 | self.port = support.bind_port(self.sock) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 30 | self.thread = threading.Thread(target=server, args=(self.evt,self.sock)) |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 31 | self.thread.setDaemon(True) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 32 | self.thread.start() |
Christian Heimes | af98da1 | 2008-01-27 15:18:18 +0000 | [diff] [blame] | 33 | self.evt.wait() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 34 | |
| 35 | def tearDown(self): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 36 | self.thread.join() |
Brett Cannon | 40ccea7 | 2011-08-04 22:37:55 -0700 | [diff] [blame] | 37 | del self.thread # Clear out any dangling Thread objects. |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 38 | |
| 39 | def testBasic(self): |
| 40 | # connects |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 41 | telnet = telnetlib.Telnet(HOST, self.port) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 42 | telnet.sock.close() |
| 43 | |
R David Murray | 4f09806 | 2015-11-28 12:24:52 -0500 | [diff] [blame] | 44 | def testContextManager(self): |
| 45 | with telnetlib.Telnet(HOST, self.port) as tn: |
| 46 | self.assertIsNotNone(tn.get_socket()) |
| 47 | self.assertIsNone(tn.get_socket()) |
| 48 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 49 | def testTimeoutDefault(self): |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 50 | self.assertTrue(socket.getdefaulttimeout() is None) |
| 51 | socket.setdefaulttimeout(30) |
| 52 | try: |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 53 | telnet = telnetlib.Telnet(HOST, self.port) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 54 | finally: |
| 55 | socket.setdefaulttimeout(None) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 56 | self.assertEqual(telnet.sock.gettimeout(), 30) |
| 57 | telnet.sock.close() |
| 58 | |
| 59 | def testTimeoutNone(self): |
| 60 | # None, having other default |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 61 | self.assertTrue(socket.getdefaulttimeout() is None) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 62 | socket.setdefaulttimeout(30) |
| 63 | try: |
Christian Heimes | 5e69685 | 2008-04-09 08:37:03 +0000 | [diff] [blame] | 64 | telnet = telnetlib.Telnet(HOST, self.port, timeout=None) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 65 | finally: |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 66 | socket.setdefaulttimeout(None) |
| 67 | self.assertTrue(telnet.sock.gettimeout() is None) |
| 68 | telnet.sock.close() |
| 69 | |
| 70 | def testTimeoutValue(self): |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 71 | telnet = telnetlib.Telnet(HOST, self.port, timeout=30) |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 72 | self.assertEqual(telnet.sock.gettimeout(), 30) |
| 73 | telnet.sock.close() |
| 74 | |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 75 | def testTimeoutOpen(self): |
| 76 | telnet = telnetlib.Telnet() |
Jesus Cea | bc91b46 | 2011-11-08 16:24:43 +0100 | [diff] [blame] | 77 | telnet.open(HOST, self.port, timeout=30) |
Georg Brandl | f78e02b | 2008-06-10 17:40:04 +0000 | [diff] [blame] | 78 | self.assertEqual(telnet.sock.gettimeout(), 30) |
| 79 | telnet.sock.close() |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 80 | |
Ezio Melotti | 4f1353a | 2013-08-25 23:56:43 +0300 | [diff] [blame] | 81 | def testGetters(self): |
| 82 | # Test telnet getter methods |
| 83 | telnet = telnetlib.Telnet(HOST, self.port, timeout=30) |
| 84 | t_sock = telnet.sock |
| 85 | self.assertEqual(telnet.get_socket(), t_sock) |
| 86 | self.assertEqual(telnet.fileno(), t_sock.fileno()) |
| 87 | telnet.sock.close() |
| 88 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 89 | class SocketStub(object): |
| 90 | ''' a socket proxy that re-defines sendall() ''' |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 91 | def __init__(self, reads=()): |
| 92 | self.reads = list(reads) # Intentionally make a copy. |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 93 | self.writes = [] |
| 94 | self.block = False |
| 95 | def sendall(self, data): |
| 96 | self.writes.append(data) |
| 97 | def recv(self, size): |
| 98 | out = b'' |
| 99 | while self.reads and len(out) < size: |
| 100 | out += self.reads.pop(0) |
| 101 | if len(out) > size: |
| 102 | self.reads.insert(0, out[size:]) |
| 103 | out = out[:size] |
| 104 | return out |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 105 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 106 | class TelnetAlike(telnetlib.Telnet): |
| 107 | def fileno(self): |
| 108 | raise NotImplementedError() |
| 109 | def close(self): pass |
| 110 | def sock_avail(self): |
| 111 | return (not self.sock.block) |
| 112 | def msg(self, msg, *args): |
| 113 | with support.captured_stdout() as out: |
| 114 | telnetlib.Telnet.msg(self, msg, *args) |
| 115 | self._messages += out.getvalue() |
| 116 | return |
| 117 | |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 118 | class MockSelector(selectors.BaseSelector): |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 119 | |
| 120 | def __init__(self): |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 121 | self.keys = {} |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 122 | |
Victor Stinner | 3c2f175 | 2014-01-25 23:53:28 +0100 | [diff] [blame] | 123 | @property |
| 124 | def resolution(self): |
| 125 | return 1e-3 |
| 126 | |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 127 | def register(self, fileobj, events, data=None): |
| 128 | key = selectors.SelectorKey(fileobj, 0, events, data) |
| 129 | self.keys[fileobj] = key |
| 130 | return key |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 131 | |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 132 | def unregister(self, fileobj): |
Charles-François Natali | b3330a0a | 2013-12-01 11:04:17 +0100 | [diff] [blame] | 133 | return self.keys.pop(fileobj) |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 134 | |
| 135 | def select(self, timeout=None): |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 136 | block = False |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 137 | for fileobj in self.keys: |
| 138 | if isinstance(fileobj, TelnetAlike): |
| 139 | block = fileobj.sock.block |
| 140 | break |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 141 | if block: |
| 142 | return [] |
| 143 | else: |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 144 | return [(key, key.events) for key in self.keys.values()] |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 145 | |
Charles-François Natali | b3330a0a | 2013-12-01 11:04:17 +0100 | [diff] [blame] | 146 | def get_map(self): |
| 147 | return self.keys |
| 148 | |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 149 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 150 | @contextlib.contextmanager |
| 151 | def test_socket(reads): |
| 152 | def new_conn(*ignored): |
| 153 | return SocketStub(reads) |
| 154 | try: |
| 155 | old_conn = socket.create_connection |
| 156 | socket.create_connection = new_conn |
| 157 | yield None |
| 158 | finally: |
| 159 | socket.create_connection = old_conn |
| 160 | return |
| 161 | |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 162 | def test_telnet(reads=(), cls=TelnetAlike): |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 163 | ''' return a telnetlib.Telnet object that uses a SocketStub with |
| 164 | reads queued up to be read ''' |
| 165 | for x in reads: |
| 166 | assert type(x) is bytes, x |
| 167 | with test_socket(reads): |
| 168 | telnet = cls('dummy', 0) |
| 169 | telnet._messages = '' # debuglevel output |
| 170 | return telnet |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 171 | |
Zachary Ware | ac28b79 | 2015-12-04 23:32:23 -0600 | [diff] [blame] | 172 | class ExpectAndReadTestCase(unittest.TestCase): |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 173 | def setUp(self): |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 174 | self.old_selector = telnetlib._TelnetSelector |
| 175 | telnetlib._TelnetSelector = MockSelector |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 176 | def tearDown(self): |
Charles-François Natali | 6459025 | 2013-10-21 14:02:12 +0200 | [diff] [blame] | 177 | telnetlib._TelnetSelector = self.old_selector |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 178 | |
| 179 | class ReadTests(ExpectAndReadTestCase): |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 180 | def test_read_until(self): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 181 | """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 182 | read_until(expected, timeout=None) |
| 183 | test the blocking version of read_util |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 184 | """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 185 | want = [b'xxxmatchyyy'] |
| 186 | telnet = test_telnet(want) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 187 | data = telnet.read_until(b'match') |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 188 | self.assertEqual(data, b'xxxmatch', msg=(telnet.cookedq, telnet.rawq, telnet.sock.reads)) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 189 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 190 | reads = [b'x' * 50, b'match', b'y' * 50] |
| 191 | expect = b''.join(reads[:-1]) |
| 192 | telnet = test_telnet(reads) |
| 193 | data = telnet.read_until(b'match') |
| 194 | self.assertEqual(data, expect) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 195 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 196 | |
| 197 | def test_read_all(self): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 198 | """ |
| 199 | read_all() |
| 200 | Read all data until EOF; may block. |
| 201 | """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 202 | reads = [b'x' * 500, b'y' * 500, b'z' * 500] |
| 203 | expect = b''.join(reads) |
| 204 | telnet = test_telnet(reads) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 205 | data = telnet.read_all() |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 206 | self.assertEqual(data, expect) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 207 | return |
| 208 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 209 | def test_read_some(self): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 210 | """ |
| 211 | read_some() |
| 212 | Read at least one byte or EOF; may block. |
| 213 | """ |
| 214 | # test 'at least one byte' |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 215 | telnet = test_telnet([b'x' * 500]) |
| 216 | data = telnet.read_some() |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 217 | self.assertTrue(len(data) >= 1) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 218 | # test EOF |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 219 | telnet = test_telnet() |
| 220 | data = telnet.read_some() |
| 221 | self.assertEqual(b'', data) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 222 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 223 | def _read_eager(self, func_name): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 224 | """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 225 | read_*_eager() |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 226 | Read all data available already queued or on the socket, |
| 227 | without blocking. |
| 228 | """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 229 | want = b'x' * 100 |
| 230 | telnet = test_telnet([want]) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 231 | func = getattr(telnet, func_name) |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 232 | telnet.sock.block = True |
| 233 | self.assertEqual(b'', func()) |
| 234 | telnet.sock.block = False |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 235 | data = b'' |
| 236 | while True: |
| 237 | try: |
| 238 | data += func() |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 239 | except EOFError: |
| 240 | break |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 241 | self.assertEqual(data, want) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 242 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 243 | def test_read_eager(self): |
Martin Panter | 46f5072 | 2016-05-26 05:35:26 +0000 | [diff] [blame] | 244 | # read_eager and read_very_eager make the same guarantees |
| 245 | # (they behave differently but we only test the guarantees) |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 246 | self._read_eager('read_eager') |
| 247 | self._read_eager('read_very_eager') |
| 248 | # NB -- we need to test the IAC block which is mentioned in the |
| 249 | # docstring but not in the module docs |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 250 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 251 | def read_very_lazy(self): |
| 252 | want = b'x' * 100 |
| 253 | telnet = test_telnet([want]) |
| 254 | self.assertEqual(b'', telnet.read_very_lazy()) |
| 255 | while telnet.sock.reads: |
| 256 | telnet.fill_rawq() |
| 257 | data = telnet.read_very_lazy() |
| 258 | self.assertEqual(want, data) |
| 259 | self.assertRaises(EOFError, telnet.read_very_lazy) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 260 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 261 | def test_read_lazy(self): |
| 262 | want = b'x' * 100 |
| 263 | telnet = test_telnet([want]) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 264 | self.assertEqual(b'', telnet.read_lazy()) |
| 265 | data = b'' |
| 266 | while True: |
| 267 | try: |
| 268 | read_data = telnet.read_lazy() |
| 269 | data += read_data |
| 270 | if not read_data: |
| 271 | telnet.fill_rawq() |
| 272 | except EOFError: |
| 273 | break |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 274 | self.assertTrue(want.startswith(data)) |
| 275 | self.assertEqual(data, want) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 276 | |
| 277 | class nego_collector(object): |
| 278 | def __init__(self, sb_getter=None): |
| 279 | self.seen = b'' |
| 280 | self.sb_getter = sb_getter |
| 281 | self.sb_seen = b'' |
| 282 | |
| 283 | def do_nego(self, sock, cmd, opt): |
| 284 | self.seen += cmd + opt |
| 285 | if cmd == tl.SE and self.sb_getter: |
| 286 | sb_data = self.sb_getter() |
| 287 | self.sb_seen += sb_data |
| 288 | |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 289 | tl = telnetlib |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 290 | |
Zachary Ware | ac28b79 | 2015-12-04 23:32:23 -0600 | [diff] [blame] | 291 | class WriteTests(unittest.TestCase): |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 292 | '''The only thing that write does is replace each tl.IAC for |
| 293 | tl.IAC+tl.IAC''' |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 294 | |
| 295 | def test_write(self): |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 296 | data_sample = [b'data sample without IAC', |
| 297 | b'data sample with' + tl.IAC + b' one IAC', |
| 298 | b'a few' + tl.IAC + tl.IAC + b' iacs' + tl.IAC, |
| 299 | tl.IAC, |
| 300 | b''] |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 301 | for data in data_sample: |
| 302 | telnet = test_telnet() |
| 303 | telnet.write(data) |
| 304 | written = b''.join(telnet.sock.writes) |
| 305 | self.assertEqual(data.replace(tl.IAC,tl.IAC+tl.IAC), written) |
Jack Diederich | 36596a3 | 2009-07-26 22:23:04 +0000 | [diff] [blame] | 306 | |
Zachary Ware | ac28b79 | 2015-12-04 23:32:23 -0600 | [diff] [blame] | 307 | class OptionTests(unittest.TestCase): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 308 | # RFC 854 commands |
| 309 | cmds = [tl.AO, tl.AYT, tl.BRK, tl.EC, tl.EL, tl.GA, tl.IP, tl.NOP] |
| 310 | |
| 311 | def _test_command(self, data): |
| 312 | """ helper for testing IAC + cmd """ |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 313 | telnet = test_telnet(data) |
| 314 | data_len = len(b''.join(data)) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 315 | nego = nego_collector() |
| 316 | telnet.set_option_negotiation_callback(nego.do_nego) |
| 317 | txt = telnet.read_all() |
| 318 | cmd = nego.seen |
| 319 | self.assertTrue(len(cmd) > 0) # we expect at least one command |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 320 | self.assertIn(cmd[:1], self.cmds) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 321 | self.assertEqual(cmd[1:2], tl.NOOPT) |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 322 | self.assertEqual(data_len, len(txt + cmd)) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 323 | nego.sb_getter = None # break the nego => telnet cycle |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 324 | |
| 325 | def test_IAC_commands(self): |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 326 | for cmd in self.cmds: |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 327 | self._test_command([tl.IAC, cmd]) |
| 328 | self._test_command([b'x' * 100, tl.IAC, cmd, b'y'*100]) |
| 329 | self._test_command([b'x' * 10, tl.IAC, cmd, b'y'*10]) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 330 | # all at once |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 331 | self._test_command([tl.IAC + cmd for (cmd) in self.cmds]) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 332 | |
| 333 | def test_SB_commands(self): |
| 334 | # RFC 855, subnegotiations portion |
| 335 | send = [tl.IAC + tl.SB + tl.IAC + tl.SE, |
| 336 | tl.IAC + tl.SB + tl.IAC + tl.IAC + tl.IAC + tl.SE, |
| 337 | tl.IAC + tl.SB + tl.IAC + tl.IAC + b'aa' + tl.IAC + tl.SE, |
| 338 | tl.IAC + tl.SB + b'bb' + tl.IAC + tl.IAC + tl.IAC + tl.SE, |
| 339 | tl.IAC + tl.SB + b'cc' + tl.IAC + tl.IAC + b'dd' + tl.IAC + tl.SE, |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 340 | ] |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 341 | telnet = test_telnet(send) |
Jack Diederich | 1c8f38c | 2009-04-10 05:33:26 +0000 | [diff] [blame] | 342 | nego = nego_collector(telnet.read_sb_data) |
| 343 | telnet.set_option_negotiation_callback(nego.do_nego) |
| 344 | txt = telnet.read_all() |
| 345 | self.assertEqual(txt, b'') |
| 346 | want_sb_data = tl.IAC + tl.IAC + b'aabb' + tl.IAC + b'cc' + tl.IAC + b'dd' |
| 347 | self.assertEqual(nego.sb_seen, want_sb_data) |
| 348 | self.assertEqual(b'', telnet.read_sb_data()) |
| 349 | nego.sb_getter = None # break the nego => telnet cycle |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 350 | |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 351 | def test_debuglevel_reads(self): |
Jack Diederich | 36596a3 | 2009-07-26 22:23:04 +0000 | [diff] [blame] | 352 | # test all the various places that self.msg(...) is called |
| 353 | given_a_expect_b = [ |
| 354 | # Telnet.fill_rawq |
| 355 | (b'a', ": recv b''\n"), |
| 356 | # Telnet.process_rawq |
| 357 | (tl.IAC + bytes([88]), ": IAC 88 not recognized\n"), |
| 358 | (tl.IAC + tl.DO + bytes([1]), ": IAC DO 1\n"), |
| 359 | (tl.IAC + tl.DONT + bytes([1]), ": IAC DONT 1\n"), |
| 360 | (tl.IAC + tl.WILL + bytes([1]), ": IAC WILL 1\n"), |
| 361 | (tl.IAC + tl.WONT + bytes([1]), ": IAC WONT 1\n"), |
Jack Diederich | 36596a3 | 2009-07-26 22:23:04 +0000 | [diff] [blame] | 362 | ] |
| 363 | for a, b in given_a_expect_b: |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 364 | telnet = test_telnet([a]) |
| 365 | telnet.set_debuglevel(1) |
| 366 | txt = telnet.read_all() |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 367 | self.assertIn(b, telnet._messages) |
Jack Diederich | 36596a3 | 2009-07-26 22:23:04 +0000 | [diff] [blame] | 368 | return |
| 369 | |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 370 | def test_debuglevel_write(self): |
Jack Diederich | 1766b9d | 2009-11-06 17:20:42 +0000 | [diff] [blame] | 371 | telnet = test_telnet() |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 372 | telnet.set_debuglevel(1) |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 373 | telnet.write(b'xxx') |
| 374 | expected = "send b'xxx'\n" |
Benjamin Peterson | 577473f | 2010-01-19 00:09:57 +0000 | [diff] [blame] | 375 | self.assertIn(expected, telnet._messages) |
Jack Diederich | f31f7bb | 2009-09-03 20:37:58 +0000 | [diff] [blame] | 376 | |
R. David Murray | 32ef70c | 2010-12-14 14:16:20 +0000 | [diff] [blame] | 377 | def test_debug_accepts_str_port(self): |
| 378 | # Issue 10695 |
| 379 | with test_socket([]): |
| 380 | telnet = TelnetAlike('dummy', '0') |
| 381 | telnet._messages = '' |
| 382 | telnet.set_debuglevel(1) |
| 383 | telnet.msg('test') |
| 384 | self.assertRegex(telnet._messages, r'0.*test') |
| 385 | |
| 386 | |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 387 | class ExpectTests(ExpectAndReadTestCase): |
| 388 | def test_expect(self): |
| 389 | """ |
| 390 | expect(expected, [timeout]) |
| 391 | Read until the expected string has been seen, or a timeout is |
| 392 | hit (default is no timeout); may block. |
| 393 | """ |
| 394 | want = [b'x' * 10, b'match', b'y' * 10] |
| 395 | telnet = test_telnet(want) |
| 396 | (_,_,data) = telnet.expect([b'match']) |
| 397 | self.assertEqual(data, b''.join(want[:-1])) |
| 398 | |
Gregory P. Smith | dad5711 | 2012-07-15 23:42:26 -0700 | [diff] [blame] | 399 | |
Guido van Rossum | d8faa36 | 2007-04-27 19:54:29 +0000 | [diff] [blame] | 400 | if __name__ == '__main__': |
Zachary Ware | 38c707e | 2015-04-13 15:00:43 -0500 | [diff] [blame] | 401 | unittest.main() |