wireproto: introduce a reactor for client-side state
We have a nice state machine of sorts for reacting to server-side
events. Now it is time to implement the client equivalent.
We introduce a "clientreactor." It allows callers to request
that commands be issued. It has multiple modes of operation to
reflect what the underlying transport supports. e.g. for SSH,
we can perform wire sends immediately but for HTTP we need to
buffer sends until all command requests are received. In addition,
SSH allows sending multiple requests as long as the connection is
open. But HTTP/1.1 only allows sending request data once.
For SSH, we'll have one reactor per connection. For HTTP, we'll
have one reactor per HTTP request. But because code that calls
wire protocol commands should not be aware of how the underlying
transport works, this will all be abstracted away by the peer
interface.
Our crude HTTP peer has been updated to use the reactor instead
of formulating frames directly. No behavior should have changed
here and tests seem to confirm that.
Basic unit tests for the reactor behavior have been added.
Differential Revision: https://phab.mercurial-scm.org/D3223
from __future__ import absolute_import
import unittest
from mercurial import (
error,
wireprotoframing as framing,
)
class SingleSendTests(unittest.TestCase):
"""A reactor that can only send once rejects subsequent sends."""
def testbasic(self):
reactor = framing.clientreactor(hasmultiplesend=False, buffersends=True)
request, action, meta = reactor.callcommand(b'foo', {})
self.assertEqual(request.state, 'pending')
self.assertEqual(action, 'noop')
action, meta = reactor.flushcommands()
self.assertEqual(action, 'sendframes')
for frame in meta['framegen']:
self.assertEqual(request.state, 'sending')
self.assertEqual(request.state, 'sent')
with self.assertRaisesRegexp(error.ProgrammingError,
'cannot issue new commands'):
reactor.callcommand(b'foo', {})
with self.assertRaisesRegexp(error.ProgrammingError,
'cannot issue new commands'):
reactor.callcommand(b'foo', {})
class NoBufferTests(unittest.TestCase):
"""A reactor without send buffering sends requests immediately."""
def testbasic(self):
reactor = framing.clientreactor(hasmultiplesend=True, buffersends=False)
request, action, meta = reactor.callcommand(b'command1', {})
self.assertEqual(request.requestid, 1)
self.assertEqual(action, 'sendframes')
self.assertEqual(request.state, 'pending')
for frame in meta['framegen']:
self.assertEqual(request.state, 'sending')
self.assertEqual(request.state, 'sent')
action, meta = reactor.flushcommands()
self.assertEqual(action, 'noop')
# And we can send another command.
request, action, meta = reactor.callcommand(b'command2', {})
self.assertEqual(request.requestid, 3)
self.assertEqual(action, 'sendframes')
for frame in meta['framegen']:
self.assertEqual(request.state, 'sending')
self.assertEqual(request.state, 'sent')
if __name__ == '__main__':
import silenttestrunner
silenttestrunner.main(__name__)