def test_send_message(self):
# After the "Hello" message, it should be possible to send other
# messages.
transport = MockTransport()
protocol = DbusProtocol(True, self.store_messages, 'foo')
transport.start(protocol)
protocol.data_received(b'\0AUTH ANONYMOUS\r\nBEGIN\r\n')
auth = protocol._authenticator
self.assertTrue(auth.authenticationSucceeded())
message = txdbus.MethodCallMessage('/org/freedesktop/DBus', 'Hello',
interface='org.freedesktop.DBus', destination='org.freedesktop.DBus')
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertIsNone(protocol._error)
self.assertFalse(transport.closed)
self.assertTrue(protocol._name_acquired)
self.assertEqual(len(self.messages), 0)
message = txdbus.MethodCallMessage('/my/path', 'Method')
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertIsNone(protocol._error)
self.assertFalse(transport.closed)
self.assertEqual(len(self.messages), 1)
self.assertEqual(self.messages[0].path, '/my/path')
self.assertEqual(self.messages[0].member, 'Method')
self.assertEqual(self.protocols, [protocol])
def test_writelines(self):
# Test that writelines() works.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
protocol.stream.writelines([b'foo', b'bar'])
self.assertEqual(transport.buffer.getvalue(), b'foobar')
def test_send_message_incremental(self):
# Send a message byte by byte. The protocol should be able process it.
transport = MockTransport()
protocol = DbusProtocol(True, self.store_messages, 'foo')
transport.start(protocol)
authexchange = b'\0AUTH ANONYMOUS\r\nBEGIN\r\n'
for i in range(len(authexchange)):
protocol.data_received(authexchange[i:i+1])
auth = protocol._authenticator
self.assertTrue(auth.authenticationSucceeded())
message = txdbus.MethodCallMessage('/org/freedesktop/DBus', 'Hello',
interface='org.freedesktop.DBus', destination='org.freedesktop.DBus')
for i in range(len(message.rawMessage)):
protocol.data_received(message.rawMessage[i:i+1])
gruvi.sleep(0)
self.assertIsNone(protocol._error)
self.assertFalse(transport.closed)
self.assertEqual(len(self.messages), 0)
message = txdbus.MethodCallMessage('/my/path', 'Method')
for i in range(len(message.rawMessage)):
protocol.data_received(message.rawMessage[i:i+1])
gruvi.sleep(0)
self.assertIsNone(protocol._error)
self.assertFalse(transport.closed)
self.assertEqual(len(self.messages), 1)
self.assertEqual(self.messages[0].path, '/my/path')
self.assertEqual(self.messages[0].member, 'Method')
self.assertEqual(self.protocols, [protocol])
def test_send_message_too_large(self):
# Send a message that exceeds the maximum message size. The connection
# should be closed.
transport = MockTransport()
protocol = DbusProtocol(True, self.store_messages, 'foo')
transport.start(protocol)
protocol.data_received(b'\0AUTH ANONYMOUS\r\nBEGIN\r\n')
message = txdbus.MethodCallMessage('/org/freedesktop/DBus', 'Hello',
interface='org.freedesktop.DBus', destination='org.freedesktop.DBus')
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertTrue(protocol._name_acquired)
# Send a signal with a size equal to the high-water mark. This should work.
message = txdbus.SignalMessage('/my/path', 'Signal', 'my.iface',
signature='s', body=['x'*100])
msglen = len(message.rawMessage)
self.assertGreater(msglen, 100)
protocol.set_read_buffer_limits(msglen)
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertIsNone(protocol._error)
self.assertFalse(transport.closed)
self.assertEqual(len(self.messages), 1)
# Now send a signal with a size larger than the high-water mark. This should fail.
message = txdbus.SignalMessage('/my/path', 'Signal', 'my.iface',
signature='s', body=['x'*100])
msglen = len(message.rawMessage)
protocol.set_read_buffer_limits(msglen-1)
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertIsInstance(protocol._error, DbusError)
self.assertTrue(transport.closed)
self.assertEqual(len(self.messages), 1)
def setUp(self):
super(TestJsonRpcProtocol, self).setUp()
self.transport = MockTransport()
self.protocol = JsonRpcProtocol(self.message_handler)
self.transport.start(self.protocol)
self.messages = []
self.protocols = []
def test_readline(self):
# Test that readline() works.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
protocol.data_received(b'foo\n')
stream = protocol.stream
self.assertEqual(stream.readline(), b'foo\n')
def test_write_eof(self):
# Test that write_eof() works.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
self.assertFalse(transport.eof)
protocol.stream.write_eof()
self.assertTrue(transport.eof)
def test_auth_non_ascii(self):
# After the '\0' byte, an authentiction phase happens. The
# authentication protocol is line based and all lines should be ascii.
transport = MockTransport()
protocol = DbusProtocol(True, None)
transport.start(protocol)
self.assertFalse(transport.closed)
protocol.data_received(b'\0\xff\r\n')
self.assertIsInstance(protocol._error, DbusError)
self.assertTrue(transport.closed)
def test_auth_missing_creds_byte(self):
# The first thing a client should send to the server is a '\0' byte. If
# not, the server should close the connection.
transport = MockTransport()
protocol = DbusProtocol(True, None)
transport.start(protocol)
self.assertFalse(transport.closed)
protocol.data_received(b'\1')
self.assertIsInstance(protocol._error, DbusError)
self.assertTrue(transport.closed)
def test_auth_long_line(self):
# An authentication line should not exceed the maximum line size.
transport = MockTransport()
protocol = DbusProtocol(True, None, 'foo')
protocol.max_line_size = 5
transport.start(protocol)
self.assertFalse(transport.closed)
protocol.data_received(b'\0AUTH ANONYMOUS\r\n')
self.assertIsInstance(protocol._error, DbusError)
self.assertTrue(transport.closed)
def parse_request(self, *chunks):
# Parse the HTTP request made up of *chunks.
transport = MockTransport()
protocol = HttpProtocol(self.store_request, server_side=True)
transport.start(protocol)
for chunk in chunks:
protocol.data_received(chunk)
self.assertIsNone(protocol._error)
self.transport = transport
self.protocol = protocol
def test_read_after_error(self):
# Test that the buffer can be emptied after an error occurs.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
protocol.data_received(b'foobar')
protocol.connection_lost(RuntimeError)
stream = protocol.stream
self.assertEqual(stream.read(3), b'foo')
self.assertEqual(stream.read(3), b'bar')
self.assertEqual(stream.read(), b'')
def test_iter(self):
# Ensure that iterating over a stream protocol produces lines.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
protocol.data_received(b'foo\nbar\n')
protocol.eof_received()
it = iter(protocol.stream)
self.assertEqual(six.next(it), b'foo\n')
self.assertEqual(six.next(it), b'bar\n')
self.assertRaises(StopIteration, six.next, it)
def parse_response(self, *chunks, **kwargs):
# Parse the HTTP resposne made up of *chunks.
transport = MockTransport()
protocol = HttpProtocol()
transport.start(protocol)
methods = kwargs.get('methods', [])
if methods:
protocol._requests = methods
for chunk in chunks:
protocol.data_received(chunk)
self.assertIsNone(protocol._error)
self.transport = transport
self.protocol = protocol
def test_missing_hello(self):
# After authentication, the first message should be a "Hello".
# Otherwise, the server should close the connection.
transport = MockTransport()
protocol = DbusProtocol(True, self.store_messages, 'foo')
transport.start(protocol)
protocol.data_received(b'\0AUTH ANONYMOUS\r\nBEGIN\r\n')
message = txdbus.MethodCallMessage('/my/path', 'Method')
auth = protocol._authenticator
self.assertTrue(auth.authenticationSucceeded())
protocol.data_received(message.rawMessage)
self.assertIsInstance(protocol._error, DbusError)
self.assertTrue(transport.closed)
def test_auth_ok(self):
# Test anonymous authenication. Ensure that the server GUID is
# correctly sent back.
transport = MockTransport()
protocol = DbusProtocol(True, None, 'foo')
transport.start(protocol)
protocol.data_received(b'\0AUTH ANONYMOUS\r\nBEGIN\r\n')
buf = transport.buffer.getvalue()
self.assertTrue(buf.startswith(b'OK foo'))
auth = protocol._authenticator
self.assertTrue(auth.authenticationSucceeded())
self.assertTrue(auth.getGUID(), 'foo')
self.assertFalse(transport.closed)
def perf_parsing_speed(self):
transport = MockTransport()
protocol = HttpProtocol()
transport.start(protocol)
r = b'HTTP/1.1 200 OK\r\nContent-Length: 10000\r\n\r\n'
r += b'x' * 10000
reqs = 4 * r
nbytes = 0
t0 = t1 = time.time()
while t1 - t0 < 0.2:
protocol.data_received(reqs)
del protocol._queue._heap[:]
nbytes += len(reqs)
t1 = time.time()
speed = nbytes / (t1 - t0) / (1024 * 1024)
self.add_result(speed)
def test_read_write_flow_control(self):
# Send a lot of messages filling up the protocol read buffer.
transport = MockTransport()
protocol = DbusProtocol(True, self.store_and_echo_messages)
transport.start(protocol)
protocol.data_received(b'\0AUTH ANONYMOUS\r\nBEGIN\r\n')
auth = protocol._authenticator
self.assertTrue(auth.authenticationSucceeded())
message = txdbus.MethodCallMessage('/org/freedesktop/DBus', 'Hello',
interface='org.freedesktop.DBus', destination='org.freedesktop.DBus')
protocol.data_received(message.rawMessage)
gruvi.sleep(0)
self.assertTrue(protocol._name_acquired)
interrupted = 0
message = txdbus.SignalMessage('/my/path', 'Signal', 'my.iface',
signature='s', body=['x'*100])
msglen = len(message.rawMessage)
protocol.set_read_buffer_limits(10*msglen)
transport.buffer.seek(0)
transport.buffer.truncate()
transport.set_write_buffer_limits(7*msglen)
for i in range(100):
# Fill up protocol read buffer
message = txdbus.SignalMessage('/my/path', 'Signal', 'my.iface',
signature='s', body=['x'*100])
protocol.data_received(message.rawMessage)
if protocol._reading:
continue
interrupted += 1
self.assertGreater(protocol._queue.qsize(), 0)
# Run the dispatcher to fill up the transport write buffer
gruvi.sleep(0)
# Now the write buffer is full and the read buffer still contains
# some entries because it is larger.
self.assertTrue(protocol._reading)
self.assertGreater(protocol._queue.qsize(), 0)
self.assertFalse(protocol._may_write.is_set())
# Drain write buffer and resume writing
transport.buffer.seek(0)
transport.buffer.truncate()
protocol.resume_writing()
# Should be interrupted > 10 times. The write buffer is the limiting factor
# not the read buffer.
self.assertGreater(interrupted, 10)
def test_read_write_flow_control(self):
# Test the read and write flow control of a stream transport.
transport = MockTransport()
protocol = StreamProtocol()
transport.start(protocol)
protocol.set_read_buffer_limits(100)
transport.set_write_buffer_limits(50)
stream = protocol.stream
def reader():
while True:
buf = stream.read(20)
if not buf:
break
stream.write(buf)
fib = gruvi.spawn(reader)
buf = b'x' * 20
interrupted = 0
for i in range(100):
protocol.data_received(buf)
if protocol._reading:
continue
interrupted += 1
self.assertGreater(protocol._read_buffer_size, 0)
# Switch to the reader() fiber which will fill up the transport
# write buffer.
gruvi.sleep(0)
# The transport write buffer should be full but the protocol read
# buffer should still contain something.
self.assertTrue(protocol._reading)
self.assertGreater(protocol._read_buffer_size, 0)
self.assertFalse(protocol._may_write.is_set())
# Drain write buffer and resume writing
transport.buffer.seek(0)
transport.buffer.truncate()
protocol.resume_writing()
self.assertGreater(interrupted, 30)
fib.cancel()
gruvi.sleep(0)
