comparison mercurial/debugcommands.py @ 36534:5faeabb07cf5

debugcommands: support for triggering push protocol

The mechanism for pushing to a remote is a bit more complicated
than other commands. On SSH, we wait for a positive reply from
the server before we start sending the bundle payload.

This commit adds a mechanism to the "command" action in
`hg debugwireproto` to trigger the "push protocol" and to
specify a file whose contents should be submitted as the command
payload.

With this new feature, we implement a handful of tests for the
"unbundle" command. We try to cover various server failures and
hook/output scenarios so protocol behavior is as comprehensively
tested as possible. Even with so much test output, we only cover
bundle1 with Python hooks. There's still a lot of test coverage
that needs to be implemented. But this is certainly a good start.

Because there are so many new tests, we split these tests into their
own test file.

In order to make output deterministic, we need to disable the
doublepipe primitive. We add an option to `hg debugwireproto`
to do that. Because something in the bowels of the peer does a
read of stderr, we still capture read I/O from stderr. So there
is test coverage of what the server emits.

The tests around I/O capture some wonkiness. For example,
interleaved ui.write() and ui.write_err() calls are emitted in
order. However, (presumably due to buffering), print() to
sys.stdout and sys.stderr aren't in order.

We currently only test bundle1 because bundle2 is substantially
harder to test because it is more complicated (the server responds
with a stream containing a bundle2 instead of a frame).

Differential Revision: https://phab.mercurial-scm.org/D2471

36533:1a36ef7df70a

@command('debugwireproto',
    [
        ('', 'localssh', False, _('start an SSH server for this repo')),
        ('', 'peer', '', _('construct a specific version of the peer')),
    ] + cmdutil.remoteopts,
    _('[REPO]'),
    optionalrepo=True)
def debugwireproto(ui, repo, **opts):
    """send wire protocol commands to a server

    ``--peer`` can be used to bypass the handshake protocol and construct a
    peer instance using the specified class type. Valid values are ``raw``,
    ``ssh1``, and ``ssh2``. ``raw`` instances only allow sending raw data
    payloads and don't support higher-level command actions.

    Commands are issued via a mini language which is specified via stdin.
    The language consists of individual actions to perform. An action is
    defined by a block. A block is defined as a line with no leading
    space followed by 0 or more lines with leading space. Blocks are
    effectively a high-level command with additional metadata.

       command listkeys
           namespace bookmarks

    Values are interpreted as Python b'' literals. This allows encoding
    special byte sequences via backslash escaping.

    batchbegin
    ----------

    Instruct the peer to begin a batched send.

                                                logdata=True)

        # --localssh also implies the peer connection settings.

        url = 'ssh://localserver'

        if opts['peer'] == 'ssh1':
            ui.write(_('creating ssh peer for wire protocol version 1\n'))
            peer = sshpeer.sshv1peer(ui, url, proc, stdin, stdout, stderr,
                                     None)
        elif opts['peer'] == 'ssh2':
            ui.write(_('creating ssh peer for wire protocol version 2\n'))
            peer = sshpeer.sshv2peer(ui, url, proc, stdin, stdout, stderr,
                                     None)
        elif opts['peer'] == 'raw':
            ui.write(_('using raw connection to peer\n'))
            peer = None
        else:
            ui.write(_('creating ssh peer from handshake results\n'))
            peer = sshpeer.makepeer(ui, url, proc, stdin, stdout, stderr)

    else:
        raise error.Abort(_('only --localssh is currently supported'))

    batchedcommands = None

            if batchedcommands is not None:
                batchedcommands.append((command, args))
                continue

            ui.status(_('sending %s command\n') % command)
            res = peer._call(command, **args)
            ui.status(_('response: %s\n') % util.escapedata(res))

        elif action == 'batchbegin':
            if batchedcommands is not None:
                raise error.Abort(_('nested batchbegin not allowed'))

36534:5faeabb07cf5

@command('debugwireproto',
    [
        ('', 'localssh', False, _('start an SSH server for this repo')),
        ('', 'peer', '', _('construct a specific version of the peer')),
        ('', 'noreadstderr', False, _('do not read from stderr of the remote')),
    ] + cmdutil.remoteopts,
    _('[REPO]'),
    optionalrepo=True)
def debugwireproto(ui, repo, **opts):
    """send wire protocol commands to a server

    ``--peer`` can be used to bypass the handshake protocol and construct a
    peer instance using the specified class type. Valid values are ``raw``,
    ``ssh1``, and ``ssh2``. ``raw`` instances only allow sending raw data
    payloads and don't support higher-level command actions.

    ``--noreadstderr`` can be used to disable automatic reading from stderr
    of the peer (for SSH connections only). Disabling automatic reading of
    stderr is useful for making output more deterministic.

    Commands are issued via a mini language which is specified via stdin.
    The language consists of individual actions to perform. An action is
    defined by a block. A block is defined as a line with no leading
    space followed by 0 or more lines with leading space. Blocks are
    effectively a high-level command with additional metadata.

       command listkeys
           namespace bookmarks

    Values are interpreted as Python b'' literals. This allows encoding
    special byte sequences via backslash escaping.

    The following arguments have special meaning:

    ``PUSHFILE``
        When defined, the *push* mechanism of the peer will be used instead
        of the static request-response mechanism and the content of the
        file specified in the value of this argument will be sent as the
        command payload.

        This can be used to submit a local bundle file to the remote.

    batchbegin
    ----------

    Instruct the peer to begin a batched send.

                                                logdata=True)

        # --localssh also implies the peer connection settings.

        url = 'ssh://localserver'
        autoreadstderr = not opts['noreadstderr']

        if opts['peer'] == 'ssh1':
            ui.write(_('creating ssh peer for wire protocol version 1\n'))
            peer = sshpeer.sshv1peer(ui, url, proc, stdin, stdout, stderr,
                                     None, autoreadstderr=autoreadstderr)
        elif opts['peer'] == 'ssh2':
            ui.write(_('creating ssh peer for wire protocol version 2\n'))
            peer = sshpeer.sshv2peer(ui, url, proc, stdin, stdout, stderr,
                                     None, autoreadstderr=autoreadstderr)
        elif opts['peer'] == 'raw':
            ui.write(_('using raw connection to peer\n'))
            peer = None
        else:
            ui.write(_('creating ssh peer from handshake results\n'))
            peer = sshpeer.makepeer(ui, url, proc, stdin, stdout, stderr,
                                    autoreadstderr=autoreadstderr)

    else:
        raise error.Abort(_('only --localssh is currently supported'))

    batchedcommands = None

            if batchedcommands is not None:
                batchedcommands.append((command, args))
                continue

            ui.status(_('sending %s command\n') % command)

            if 'PUSHFILE' in args:
                with open(args['PUSHFILE'], r'rb') as fh:
                    del args['PUSHFILE']
                    res, output = peer._callpush(command, fh, **args)
                    ui.status(_('result: %s\n') % util.escapedata(res))
                    ui.status(_('remote output: %s\n') %
                              util.escapedata(output))
            else:
                res = peer._call(command, **args)
                ui.status(_('response: %s\n') % util.escapedata(res))

        elif action == 'batchbegin':
            if batchedcommands is not None:
                raise error.Abort(_('nested batchbegin not allowed'))