This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2852

wireproto: implement basic frame reading and processing
ClosedPublic

Authored by indygreg on Mar 13 2018, 10:49 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG8c3c47362934: wireproto: implement basic frame reading and processing
Summary

We just implemented support for writing frames. Now let's implement
support for reading them.

The bulk of the new code is for a class that maintains the state of
a server. Essentially, you construct an instance, feed frames to it,
and it tells you what you should do next. The design is inspired by
the "sans I/O" movement and the reactor pattern. We don't want to
perform I/O or any major blocking event during frame ingestion because
this arbitrarily limits ways that server pieces can be implemented.
For example, it makes it much harder to swap in an alternate
implementation based on asyncio or do crazy things like have requests
dispatch to other processes.

We do still implement readframe() which does I/O. But it is decoupled
from the server reactor. And important parsing of frame headers is
a standalone function. So I/O is only needed to obtain frame data.

Because testing server-side ingest is useful and difficult on running
servers, we create a new "debugreflect" endpoint that will echo back
to the client what was received and how it was interpreted. This could
be useful for a server admin, someone implementing a client. But
immediately, it is useful for testing: we're able to demonstrate that
frames are parsed correctly and turned into requests to run commands
without having to implement command dispatch on the server!

In addition, we implement Python level unit tests for the reactor.
This is vastly more efficient than sending requests to the
"debugreflect" endpoint and vastly more powerful for advanced
testing.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

indygreg created this revision.Mar 13 2018, 10:49 PM
indygreg abandoned this revision.Mar 14 2018, 3:21 PM
indygreg added inline comments.
mercurial/wireprotoframing.py
82–88

I have a minor refactor of this code locally so we can better support "sans I/O." Will send a new version once someone starts to look at this series.

indygreg edited the summary of this revision. (Show Details)Mar 14 2018, 9:10 PM
indygreg updated this revision to Diff 7048.
indygreg updated this revision to Diff 7140.Mar 19 2018, 7:59 PM
durin42 accepted this revision.Mar 21 2018, 9:32 PM
This revision is now accepted and ready to land.Mar 21 2018, 9:32 PM
Closed by commit rHG8c3c47362934: wireproto: implement basic frame reading and processing (authored by indygreg). · Explain WhyMar 21 2018, 9:40 PM
This revision was automatically updated to reflect the committed changes.
yuja added a subscriber: yuja.Mar 24 2018, 10:48 AM
yuja added inline comments.
mercurial/util.py
2566

I think read() never returns None.

mercurial/wireprotoserver.py
402

This wouldn't work on Python 3 because JSON requires unicode.

Revision Contents
Changeset List

Diff 7048

mercurial/configitems.py

default=False, default=False,
) )
coreconfigitem('experimental', 'web.apiserver', coreconfigitem('experimental', 'web.apiserver',
default=False, default=False,
) )
coreconfigitem('experimental', 'web.api.http-v2', coreconfigitem('experimental', 'web.api.http-v2',
default=False, default=False,
) )
coreconfigitem('experimental', 'web.api.debugreflect',
default=False,
)
coreconfigitem('experimental', 'xdiff', coreconfigitem('experimental', 'xdiff',
default=False, default=False,
) )
coreconfigitem('extensions', '.*', coreconfigitem('extensions', '.*',
default=None, default=None,
generic=True, generic=True,
) )
coreconfigitem('extdata', '.*', coreconfigitem('extdata', '.*',

mercurial/util.py

n = self._left n = self._left
data = self._fh.read(min(n, self._left)) data = self._fh.read(min(n, self._left))
self._left -= len(data) self._left -= len(data)
assert self._left >= 0 assert self._left >= 0
return data return data
def readinto(self, b):
res = self.read(len(b))
if res is None:
yujaUnsubmitted
Not Done

I think read() never returns None.

yuja: I think read() never returns None.
return None
b[0:len(res)] = res
return len(res)
def stringmatcher(pattern, casesensitive=True): def stringmatcher(pattern, casesensitive=True):
""" """
accepts a string, possibly starting with 're:' or 'literal:' prefix. accepts a string, possibly starting with 're:' or 'literal:' prefix.
returns the matcher name, pattern, and matcher function. returns the matcher name, pattern, and matcher function.
missing or unknown prefixes are treated as literal matches. missing or unknown prefixes are treated as literal matches.
helper for tests: helper for tests:
>>> def test(pattern, *tests): >>> def test(pattern, *tests):

mercurial/wireprotoframing.py

# wireprotoframing.py - unified framing protocol for wire protocol # wireprotoframing.py - unified framing protocol for wire protocol
# #
# Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com> # Copyright 2018 Gregory Szorc <gregory.szorc@gmail.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
# This file contains functionality to support the unified frame-based wire # This file contains functionality to support the unified frame-based wire
# protocol. For details about the protocol, see # protocol. For details about the protocol, see
# `hg help internals.wireprotocol`. # `hg help internals.wireprotocol`.
from __future__ import absolute_import from __future__ import absolute_import
import struct import struct
from .i18n import _
from . import ( from . import (
error,
util, util,
) )
FRAME_HEADER_SIZE = 4 FRAME_HEADER_SIZE = 4
DEFAULT_MAX_FRAME_SIZE = 32768 DEFAULT_MAX_FRAME_SIZE = 32768
FRAME_TYPE_COMMAND_NAME = 0x01 FRAME_TYPE_COMMAND_NAME = 0x01
FRAME_TYPE_COMMAND_ARGUMENT = 0x02 FRAME_TYPE_COMMAND_ARGUMENT = 0x02
l = struct.pack(r'<I', len(payload)) l = struct.pack(r'<I', len(payload))
frame[0:3] = l[0:3] frame[0:3] = l[0:3]
frame[3] = (frametype << 4) | frameflags frame[3] = (frametype << 4) | frameflags
frame[4:] = payload frame[4:] = payload
return frame return frame
def makeframefromhumanstring(s): def makeframefromhumanstring(s):
"""Given a string of the form: <type> <flags> <payload>, creates a frame. """Given a string of the form: <type> <flags> <payload>, creates a frame.
This can be used by user-facing applications and tests for creating This can be used by user-facing applications and tests for creating
frames easily without having to type out a bunch of constants. frames easily without having to type out a bunch of constants.
Frame type and flags can be specified by integer or named constant. Frame type and flags can be specified by integer or named constant.
indygregAuthorUnsubmitted
Not Done

I have a minor refactor of this code locally so we can better support "sans I/O." Will send a new version once someone starts to look at this series.

indygreg: I have a minor refactor of this code locally so we can better support "sans I/O." Will send a…
Flags can be delimited by `|` to bitwise OR them together. Flags can be delimited by `|` to bitwise OR them together.
""" """
frametype, frameflags, payload = s.split(b' ', 2) frametype, frameflags, payload = s.split(b' ', 2)
if frametype in FRAME_TYPES: if frametype in FRAME_TYPES:
frametype = FRAME_TYPES[frametype] frametype = FRAME_TYPES[frametype]
else: else:
frametype = int(frametype) frametype = int(frametype)
finalflags = 0 finalflags = 0
validflags = FRAME_TYPE_FLAGS[frametype] validflags = FRAME_TYPE_FLAGS[frametype]
for flag in frameflags.split(b'|'): for flag in frameflags.split(b'|'):
if flag in validflags: if flag in validflags:
finalflags |= validflags[flag] finalflags |= validflags[flag]
else: else:
finalflags |= int(flag) finalflags |= int(flag)
payload = util.unescapestr(payload) payload = util.unescapestr(payload)
return makeframe(frametype, finalflags, payload) return makeframe(frametype, finalflags, payload)
def parseheader(data):
"""Parse a unified framing protocol frame header from a buffer.
The header is expected to be in the buffer at offset 0 and the
buffer is expected to be large enough to hold a full header.
"""
# 24 bits payload length (little endian)
# 4 bits frame type
# 4 bits frame flags
# ... payload
framelength = data[0] + 256 * data[1] + 16384 * data[2]
typeflags = data[3]
frametype = (typeflags & 0xf0) >> 4
frameflags = typeflags & 0x0f
return frametype, frameflags, framelength
def readframe(fh):
"""Read a unified framing protocol frame from a file object.
Returns a 3-tuple of (type, flags, payload) for the decoded frame or
None if no frame is available. May raise if a malformed frame is
seen.
"""
header = bytearray(FRAME_HEADER_SIZE)
readcount = fh.readinto(header)
if readcount == 0:
return None
if readcount != FRAME_HEADER_SIZE:
raise error.Abort(_('received incomplete frame: got %d bytes: %s') %
(readcount, header))
frametype, frameflags, framelength = parseheader(header)
payload = fh.read(framelength)
if len(payload) != framelength:
raise error.Abort(_('frame length error: expected %d; got %d') %
(framelength, len(payload)))
return frametype, frameflags, payload
def createcommandframes(cmd, args, datafh=None): def createcommandframes(cmd, args, datafh=None):
"""Create frames necessary to transmit a request to run a command. """Create frames necessary to transmit a request to run a command.
This is a generator of bytearrays. Each item represents a frame This is a generator of bytearrays. Each item represents a frame
ready to be sent over the wire to a peer. ready to be sent over the wire to a peer.
""" """
flags = 0 flags = 0
if args: if args:
flags = FLAG_COMMAND_DATA_EOS flags = FLAG_COMMAND_DATA_EOS
assert datafh.read(1) == b'' assert datafh.read(1) == b''
done = True done = True
yield makeframe(FRAME_TYPE_COMMAND_DATA, flags, data) yield makeframe(FRAME_TYPE_COMMAND_DATA, flags, data)
if done: if done:
break break
class serverreactor(object):
"""Holds state of a server handling frame-based protocol requests.
This class is the "brain" of the unified frame-based protocol server
component. While the protocol is stateless from the perspective of
requests/commands, something needs to track which frames have been
received, what frames to expect, etc. This class is that thing.
Instances are modeled as a state machine of sorts. Instances are also
reactionary to external events. The point of this class is to encapsulate
the state of the connection and the exchange of frames, not to perform
work. Instead, callers tell this class when something occurs, like a
frame arriving. If that activity is worthy of a follow-up action (say
*run a command*), the return value of that handler will say so.
I/O and CPU intensive operations are purposefully delegated outside of
this class.
Consumers are expected to tell instances when events occur. They do so by
calling the various ``on*`` methods. These methods return a 2-tuple
describing any follow-up action(s) to take. The first element is the
name of an action to perform. The second is a data structure (usually
a dict) specific to that action that contains more information. e.g.
if the server wants to send frames back to the client, the data structure
will contain a reference to those frames.
Valid actions that consumers can be instructed to take are:
error
Indicates that an error occurred. Consumer should probably abort.
runcommand
Indicates that the consumer should run a wire protocol command. Details
of the command to run are given in the data structure.
wantframe
Indicates that nothing of interest happened and the server is waiting on
more frames from the client before anything interesting can be done.
"""
def __init__(self):
self._state = 'idle'
self._activecommand = None
self._activeargs = None
self._activedata = None
self._expectingargs = None
self._expectingdata = None
self._activeargname = None
self._activeargchunks = None
def onframerecv(self, frametype, frameflags, payload):
"""Process a frame that has been received off the wire.
Returns a dict with an ``action`` key that details what action,
if any, the consumer should take next.
"""
handlers = {
'idle': self._onframeidle,
'command-receiving-args': self._onframereceivingargs,
'command-receiving-data': self._onframereceivingdata,
'errored': self._onframeerrored,
}
meth = handlers.get(self._state)
if not meth:
raise error.ProgrammingError('unhandled state: %s' % self._state)
return meth(frametype, frameflags, payload)
def _makeerrorresult(self, msg):
return 'error', {
'message': msg,
}
def _makeruncommandresult(self):
return 'runcommand', {
'command': self._activecommand,
'args': self._activeargs,
'data': self._activedata.getvalue() if self._activedata else None,
}
def _makewantframeresult(self):
return 'wantframe', {
'state': self._state,
}
def _onframeidle(self, frametype, frameflags, payload):
# The only frame type that should be received in this state is a
# command request.
if frametype != FRAME_TYPE_COMMAND_NAME:
self._state = 'errored'
return self._makeerrorresult(
_('expected command frame; got %d') % frametype)
self._activecommand = payload
self._activeargs = {}
self._activedata = None
if frameflags & FLAG_COMMAND_NAME_EOS:
return self._makeruncommandresult()
self._expectingargs = bool(frameflags & FLAG_COMMAND_NAME_HAVE_ARGS)
self._expectingdata = bool(frameflags & FLAG_COMMAND_NAME_HAVE_DATA)
if self._expectingargs:
self._state = 'command-receiving-args'
return self._makewantframeresult()
elif self._expectingdata:
self._activedata = util.bytesio()
self._state = 'command-receiving-data'
return self._makewantframeresult()
else:
self._state = 'errored'
return self._makeerrorresult(_('missing frame flags on '
'command frame'))
def _onframereceivingargs(self, frametype, frameflags, payload):
if frametype != FRAME_TYPE_COMMAND_ARGUMENT:
self._state = 'errored'
return self._makeerrorresult(_('expected command argument '
'frame; got %d') % frametype)
offset = 0
namesize, valuesize = ARGUMENT_FRAME_HEADER.unpack_from(payload)
offset += ARGUMENT_FRAME_HEADER.size
# The argument name MUST fit inside the frame.
argname = bytes(payload[offset:offset + namesize])
offset += namesize
if len(argname) != namesize:
self._state = 'errored'
return self._makeerrorresult(_('malformed argument frame: '
'partial argument name'))
argvalue = bytes(payload[offset:])
# Argument value spans multiple frames. Record our active state
# and wait for the next frame.
if frameflags & FLAG_COMMAND_ARGUMENT_CONTINUATION:
raise error.ProgrammingError('not yet implemented')
self._activeargname = argname
self._activeargchunks = [argvalue]
self._state = 'command-arg-continuation'
return self._makewantframeresult()
# Common case: the argument value is completely contained in this
# frame.
if len(argvalue) != valuesize:
self._state = 'errored'
return self._makeerrorresult(_('malformed argument frame: '
'partial argument value'))
self._activeargs[argname] = argvalue
if frameflags & FLAG_COMMAND_ARGUMENT_EOA:
if self._expectingdata:
self._state = 'command-receiving-data'
self._activedata = util.bytesio()
# TODO signal request to run a command once we don't
# buffer data frames.
return self._makewantframeresult()
else:
self._state = 'waiting'
return self._makeruncommandresult()
else:
return self._makewantframeresult()
def _onframereceivingdata(self, frametype, frameflags, payload):
if frametype != FRAME_TYPE_COMMAND_DATA:
self._state = 'errored'
return self._makeerrorresult(_('expected command data frame; '
'got %d') % frametype)
# TODO support streaming data instead of buffering it.
self._activedata.write(payload)
if frameflags & FLAG_COMMAND_DATA_CONTINUATION:
return self._makewantframeresult()
elif frameflags & FLAG_COMMAND_DATA_EOS:
self._activedata.seek(0)
self._state = 'idle'
return self._makeruncommandresult()
else:
self._state = 'errored'
return self._makeerrorresult(_('command data frame without '
'flags'))
def _onframeerrored(self, frametype, frameflags, payload):
return self._makeerrorresult(_('server already errored'))

mercurial/wireprotoserver.py

from .i18n import _ from .i18n import _
from . import ( from . import (
encoding, encoding,
error, error,
hook, hook,
pycompat, pycompat,
util, util,
wireproto, wireproto,
wireprotoframing,
wireprototypes, wireprototypes,
) )
stringio = util.stringio stringio = util.stringio
urlerr = util.urlerr urlerr = util.urlerr
urlreq = util.urlreq urlreq = util.urlreq
checkperm(rctx, req, 'pull' if permission == b'ro' else 'push') checkperm(rctx, req, 'pull' if permission == b'ro' else 'push')
except hgwebcommon.ErrorResponse as e: except hgwebcommon.ErrorResponse as e:
res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e)) res.status = hgwebcommon.statusmessage(e.code, pycompat.bytestr(e))
for k, v in e.headers: for k, v in e.headers:
res.headers[k] = v res.headers[k] = v
res.setbodybytes('permission denied') res.setbodybytes('permission denied')
return return
# We have a special endpoint to reflect the request back at the client.
if command == b'debugreflect':
_processhttpv2reflectrequest(rctx.repo.ui, rctx.repo, req, res)
return
if command not in wireproto.commands: if command not in wireproto.commands:
res.status = b'404 Not Found' res.status = b'404 Not Found'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('unknown wire protocol command: %s\n') % command) res.setbodybytes(_('unknown wire protocol command: %s\n') % command)
return return
repo = rctx.repo repo = rctx.repo
ui = repo.ui ui = repo.ui
proto = httpv2protocolhandler(req, ui) proto = httpv2protocolhandler(req, ui)
if not wireproto.commands.commandavailable(command, proto): if not wireproto.commands.commandavailable(command, proto):
res.status = b'404 Not Found' res.status = b'404 Not Found'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('invalid wire protocol command: %s') % command) res.setbodybytes(_('invalid wire protocol command: %s') % command)
return return
if req.headers.get(b'Accept') != FRAMINGTYPE: if req.headers.get(b'Accept') != FRAMINGTYPE:
res.status = b'406 Not Acceptable' res.status = b'406 Not Acceptable'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('client MUST specify Accept header with value: %s\n') res.setbodybytes(_('client MUST specify Accept header with value: %s\n')
% FRAMINGTYPE) % FRAMINGTYPE)
return return
if (b'Content-Type' in req.headers if req.headers.get(b'Content-Type') != FRAMINGTYPE:
and req.headers[b'Content-Type'] != FRAMINGTYPE):
res.status = b'415 Unsupported Media Type' res.status = b'415 Unsupported Media Type'
# TODO we should send a response with appropriate media type, # TODO we should send a response with appropriate media type,
# since client does Accept it. # since client does Accept it.
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('client MUST send Content-Type header with ' res.setbodybytes(_('client MUST send Content-Type header with '
'value: %s\n') % FRAMINGTYPE) 'value: %s\n') % FRAMINGTYPE)
return return
# We don't do anything meaningful yet. # We don't do anything meaningful yet.
res.status = b'200 OK' res.status = b'200 OK'
res.headers[b'Content-Type'] = b'text/plain' res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(b'/'.join(urlparts) + b'\n') res.setbodybytes(b'/'.join(urlparts) + b'\n')
def _processhttpv2reflectrequest(ui, repo, req, res):
"""Reads unified frame protocol request and dumps out state to client.
This special endpoint can be used to help debug the wire protocol.
Instead of routing the request through the normal dispatch mechanism,
we instead read all frames, decode them, and feed them into our state
tracker. We then dump the log of all that activity back out to the
client.
"""
import json
# Reflection APIs have a history of being abused, accidentally disclosing
# sensitive data, etc. So we have a config knob.
if not ui.configbool('experimental', 'web.api.debugreflect'):
res.status = b'404 Not Found'
res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(_('debugreflect service not available'))
return
# We assume we have a unified framing protocol request body.
reactor = wireprotoframing.serverreactor()
states = []
while True:
frame = wireprotoframing.readframe(req.bodyfh)
if not frame:
states.append(b'received: <no frame>')
break
frametype, frameflags, payload = frame
states.append(b'received: %d %d %s' % (frametype, frameflags, payload))
action, meta = reactor.onframerecv(frametype, frameflags, payload)
states.append(json.dumps((action, meta), sort_keys=True,
yujaUnsubmitted
Not Done

This wouldn't work on Python 3 because JSON requires unicode.

yuja: This wouldn't work on Python 3 because JSON requires unicode.
separators=(', ', ': ')))
res.status = b'200 OK'
res.headers[b'Content-Type'] = b'text/plain'
res.setbodybytes(b'\n'.join(states))
# Maps API name to metadata so custom API can be registered. # Maps API name to metadata so custom API can be registered.
API_HANDLERS = { API_HANDLERS = {
HTTPV2: { HTTPV2: {
'config': ('experimental', 'web.api.http-v2'), 'config': ('experimental', 'web.api.http-v2'),
'handler': _handlehttpv2request, 'handler': _handlehttpv2request,
}, },
} }

tests/test-http-api-httpv2.t

> [experimental] > [experimental]
> web.apiserver = true > web.apiserver = true
> web.api.http-v2 = true > web.api.http-v2 = true
> [web] > [web]
> push_ssl = false > push_ssl = false
> allow-push = * > allow-push = *
> EOF > EOF
$ hg -R server serve -p $HGPORT -d --pid-file hg.pid $ hg -R server serve -p $HGPORT -d --pid-file hg.pid -E error.log
$ cat hg.pid > $DAEMON_PIDS $ cat hg.pid > $DAEMON_PIDS
Authorized request for valid read-write command works Authorized request for valid read-write command works
$ send << EOF $ send << EOF
> httprequest POST api/$HTTPV2/rw/capabilities > httprequest POST api/$HTTPV2/rw/capabilities
> user-agent: test > user-agent: test
> accept: $MEDIATYPE > accept: $MEDIATYPE
s> makefile('rb', None) s> makefile('rb', None)
s> HTTP/1.1 404 Not Found\r\n s> HTTP/1.1 404 Not Found\r\n
s> Server: testing stub value\r\n s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n s> Content-Type: text/plain\r\n
s> Content-Length: 42\r\n s> Content-Length: 42\r\n
s> \r\n s> \r\n
s> unknown wire protocol command: badcommand\n s> unknown wire protocol command: badcommand\n
debugreflect isn't enabled by default
$ send << EOF
> httprequest POST api/$HTTPV2/ro/debugreflect
> user-agent: test
> EOF
using raw connection to peer
s> POST /api/exp-http-v2-0001/ro/debugreflect HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n
s> user-agent: test\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n
s> makefile('rb', None)
s> HTTP/1.1 404 Not Found\r\n
s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n
s> Content-Length: 34\r\n
s> \r\n
s> debugreflect service not available
Restart server to get debugreflect endpoint
$ killdaemons.py
$ cat > server/.hg/hgrc << EOF
> [experimental]
> web.apiserver = true
> web.api.debugreflect = true
> web.api.http-v2 = true
> [web]
> push_ssl = false
> allow-push = *
> EOF
$ hg -R server serve -p $HGPORT -d --pid-file hg.pid -E error.log
$ cat hg.pid > $DAEMON_PIDS
Command frames can be reflected via debugreflect
$ send << EOF
> httprequest POST api/$HTTPV2/ro/debugreflect
> accept: $MEDIATYPE
> content-type: $MEDIATYPE
> user-agent: test
> frame command-name have-args command1
> frame command-argument 0 \x03\x00\x04\x00fooval1
> frame command-argument eoa \x04\x00\x03\x00bar1val
> EOF
using raw connection to peer
s> POST /api/exp-http-v2-0001/ro/debugreflect HTTP/1.1\r\n
s> Accept-Encoding: identity\r\n
s> accept: application/mercurial-exp-framing-0001\r\n
s> content-type: application/mercurial-exp-framing-0001\r\n
s> user-agent: test\r\n
s> content-length: 42\r\n
s> host: $LOCALIP:$HGPORT\r\n (glob)
s> \r\n
s> \x08\x00\x00\x12command1\x0b\x00\x00 \x03\x00\x04\x00fooval1\x0b\x00\x00"\x04\x00\x03\x00bar1val
s> makefile('rb', None)
s> HTTP/1.1 200 OK\r\n
s> Server: testing stub value\r\n
s> Date: $HTTP_DATE$\r\n
s> Content-Type: text/plain\r\n
s> Content-Length: 291\r\n
s> \r\n
s> received: 1 2 command1\n
s> ["wantframe", {"state": "command-receiving-args"}]\n
s> received: 2 0 \x03\x00\x04\x00fooval1\n
s> ["wantframe", {"state": "command-receiving-args"}]\n
s> received: 2 2 \x04\x00\x03\x00bar1val\n
s> ["runcommand", {"args": {"bar1": "val", "foo": "val1"}, "command": "command1", "data": null}]\n
s> received: <no frame>
$ cat error.log

tests/test-wireproto-serverreactor.py

  • This file was added.
from __future__ import absolute_import, print_function
import unittest
from mercurial import (
util,
wireprotoframing as framing,
)
ffs = framing.makeframefromhumanstring
def makereactor():
return framing.serverreactor()
def sendframes(reactor, gen):
"""Send a generator of frame bytearray to a reactor.
Emits a generator of results from ``onframerecv()`` calls.
"""
for frame in gen:
frametype, frameflags, framelength = framing.parseheader(frame)
payload = frame[framing.FRAME_HEADER_SIZE:]
assert len(payload) == framelength
yield reactor.onframerecv(frametype, frameflags, payload)
def sendcommandframes(reactor, cmd, args, datafh=None):
"""Generate frames to run a command and send them to a reactor."""
return sendframes(reactor, framing.createcommandframes(cmd, args, datafh))
class FrameTests(unittest.TestCase):
def testdataexactframesize(self):
data = util.bytesio(b'x' * framing.DEFAULT_MAX_FRAME_SIZE)
frames = list(framing.createcommandframes(b'command', {}, data))
self.assertEqual(frames, [
ffs(b'command-name have-data command'),
ffs(b'command-data continuation %s' % data.getvalue()),
ffs(b'command-data eos ')
])
def testdatamultipleframes(self):
data = util.bytesio(b'x' * (framing.DEFAULT_MAX_FRAME_SIZE + 1))
frames = list(framing.createcommandframes(b'command', {}, data))
self.assertEqual(frames, [
ffs(b'command-name have-data command'),
ffs(b'command-data continuation %s' % (
b'x' * framing.DEFAULT_MAX_FRAME_SIZE)),
ffs(b'command-data eos x'),
])
def testargsanddata(self):
data = util.bytesio(b'x' * 100)
frames = list(framing.createcommandframes(b'command', {
b'key1': b'key1value',
b'key2': b'key2value',
b'key3': b'key3value',
}, data))
self.assertEqual(frames, [
ffs(b'command-name have-args|have-data command'),
ffs(br'command-argument 0 \x04\x00\x09\x00key1key1value'),
ffs(br'command-argument 0 \x04\x00\x09\x00key2key2value'),
ffs(br'command-argument eoa \x04\x00\x09\x00key3key3value'),
ffs(b'command-data eos %s' % data.getvalue()),
])
class ServerReactorTests(unittest.TestCase):
def _sendsingleframe(self, reactor, s):
results = list(sendframes(reactor, [ffs(s)]))
self.assertEqual(len(results), 1)
return results[0]
def assertaction(self, res, expected):
self.assertIsInstance(res, tuple)
self.assertEqual(len(res), 2)
self.assertIsInstance(res[1], dict)
self.assertEqual(res[0], expected)
def test1framecommand(self):
"""Receiving a command in a single frame yields request to run it."""
reactor = makereactor()
results = list(sendcommandframes(reactor, b'mycommand', {}))
self.assertEqual(len(results), 1)
self.assertaction(results[0], 'runcommand')
self.assertEqual(results[0][1], {
'command': b'mycommand',
'args': {},
'data': None,
})
def test1argument(self):
reactor = makereactor()
results = list(sendcommandframes(reactor, b'mycommand',
{b'foo': b'bar'}))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'runcommand')
self.assertEqual(results[1][1], {
'command': b'mycommand',
'args': {b'foo': b'bar'},
'data': None,
})
def testmultiarguments(self):
reactor = makereactor()
results = list(sendcommandframes(reactor, b'mycommand',
{b'foo': b'bar', b'biz': b'baz'}))
self.assertEqual(len(results), 3)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'wantframe')
self.assertaction(results[2], 'runcommand')
self.assertEqual(results[2][1], {
'command': b'mycommand',
'args': {b'foo': b'bar', b'biz': b'baz'},
'data': None,
})
def testsimplecommanddata(self):
reactor = makereactor()
results = list(sendcommandframes(reactor, b'mycommand', {},
util.bytesio(b'data!')))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'runcommand')
self.assertEqual(results[1][1], {
'command': b'mycommand',
'args': {},
'data': b'data!',
})
def testmultipledataframes(self):
frames = [
ffs(b'command-name have-data mycommand'),
ffs(b'command-data continuation data1'),
ffs(b'command-data continuation data2'),
ffs(b'command-data eos data3'),
]
reactor = makereactor()
results = list(sendframes(reactor, frames))
self.assertEqual(len(results), 4)
for i in range(3):
self.assertaction(results[i], 'wantframe')
self.assertaction(results[3], 'runcommand')
self.assertEqual(results[3][1], {
'command': b'mycommand',
'args': {},
'data': b'data1data2data3',
})
def testargumentanddata(self):
frames = [
ffs(b'command-name have-args|have-data command'),
ffs(br'command-argument 0 \x03\x00\x03\x00keyval'),
ffs(br'command-argument eoa \x03\x00\x03\x00foobar'),
ffs(b'command-data continuation value1'),
ffs(b'command-data eos value2'),
]
reactor = makereactor()
results = list(sendframes(reactor, frames))
self.assertaction(results[-1], 'runcommand')
self.assertEqual(results[-1][1], {
'command': b'command',
'args': {
b'key': b'val',
b'foo': b'bar',
},
'data': b'value1value2',
})
def testunexpectedcommandargument(self):
"""Command argument frame when not running a command is an error."""
result = self._sendsingleframe(makereactor(),
b'command-argument 0 ignored')
self.assertaction(result, 'error')
self.assertEqual(result[1], {
'message': b'expected command frame; got 2',
})
def testunexpectedcommanddata(self):
"""Command argument frame when not running a command is an error."""
result = self._sendsingleframe(makereactor(),
b'command-data 0 ignored')
self.assertaction(result, 'error')
self.assertEqual(result[1], {
'message': b'expected command frame; got 3',
})
def testmissingcommandframeflags(self):
"""Command name frame must have flags set."""
result = self._sendsingleframe(makereactor(),
b'command-name 0 command')
self.assertaction(result, 'error')
self.assertEqual(result[1], {
'message': b'missing frame flags on command frame',
})
def testmissingargumentframe(self):
frames = [
ffs(b'command-name have-args command'),
ffs(b'command-name 0 ignored'),
]
results = list(sendframes(makereactor(), frames))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'error')
self.assertEqual(results[1][1], {
'message': b'expected command argument frame; got 1',
})
def testincompleteargumentname(self):
"""Argument frame with incomplete name."""
frames = [
ffs(b'command-name have-args command1'),
ffs(br'command-argument eoa \x04\x00\xde\xadfoo'),
]
results = list(sendframes(makereactor(), frames))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'error')
self.assertEqual(results[1][1], {
'message': b'malformed argument frame: partial argument name',
})
def testincompleteargumentvalue(self):
"""Argument frame with incomplete value."""
frames = [
ffs(b'command-name have-args command'),
ffs(br'command-argument eoa \x03\x00\xaa\xaafoopartialvalue'),
]
results = list(sendframes(makereactor(), frames))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'error')
self.assertEqual(results[1][1], {
'message': b'malformed argument frame: partial argument value',
})
def testmissingcommanddataframe(self):
frames = [
ffs(b'command-name have-data command1'),
ffs(b'command-name eos command2'),
]
results = list(sendframes(makereactor(), frames))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'error')
self.assertEqual(results[1][1], {
'message': b'expected command data frame; got 1',
})
def testmissingcommanddataframeflags(self):
frames = [
ffs(b'command-name have-data command1'),
ffs(b'command-data 0 data'),
]
results = list(sendframes(makereactor(), frames))
self.assertEqual(len(results), 2)
self.assertaction(results[0], 'wantframe')
self.assertaction(results[1], 'error')
self.assertEqual(results[1][1], {
'message': b'command data frame without flags',
})
if __name__ == '__main__':
import silenttestrunner
silenttestrunner.main(__name__)