This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2464

debugcommands: add debugserve command
ClosedPublic

Authored by indygreg on Feb 26 2018, 4:16 PM.

Details

Reviewers
durin42
Group Reviewers
hg-reviewers
Commits
rHG44dc34b8d17b: debugcommands: add debugserve command
rHG33403069f376: debugcommands: add debugserve command
Summary

hg serve --stdio requires the exact command argument form
hg -R <path> serve --stdio for security reasons. An upcoming
commit will need to start an SSH protocol server process with
custom settings.

This commit creates a hg debugserve command for starting servers
with custom options. There are no security restrictions and we can
add options here that aren't appropriate for built-in commands.

We currently only support starting an SSH protocol server using
the process's stdio file descriptors. The server supports logging
its I/O activity to a file descriptor number passed as a command
argument.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Feb 26 2018, 4:16 PM
indygreg updated this revision to Diff 6179.Feb 27 2018, 6:47 PM
indygreg updated this revision to Diff 6249.Mar 1 2018, 11:30 AM
durin42 accepted this revision.Mar 1 2018, 4:13 PM
This revision is now accepted and ready to land.Mar 1 2018, 4:13 PM
Closed by commit rHG33403069f376: debugcommands: add debugserve command (authored by indygreg). · Explain WhyMar 1 2018, 4:30 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

Diff 6282

mercurial/debugcommands.py

sslutil, sslutil,
streamclone, streamclone,
templater, templater,
treediscovery, treediscovery,
upgrade, upgrade,
url as urlmod, url as urlmod,
util, util,
vfs as vfsmod, vfs as vfsmod,
wireprotoserver,
) )
release = lockmod.release release = lockmod.release
command = registrar.command() command = registrar.command()
@command('debugancestor', [], _('[INDEX] REV1 REV2'), optionalrepo=True) @command('debugancestor', [], _('[INDEX] REV1 REV2'), optionalrepo=True)
def debugancestor(ui, repo, *args): def debugancestor(ui, repo, *args):
revs = func(repo) revs = func(repo)
if opts['show_set'] or (opts['show_set'] is None and ui.verbose): if opts['show_set'] or (opts['show_set'] is None and ui.verbose):
ui.write(("* set:\n"), smartset.prettyformat(revs), "\n") ui.write(("* set:\n"), smartset.prettyformat(revs), "\n")
if not opts['show_revs']: if not opts['show_revs']:
return return
for c in revs: for c in revs:
ui.write("%d\n" % c) ui.write("%d\n" % c)
@command('debugserve', [
('', 'sshstdio', False, _('run an SSH server bound to process handles')),
('', 'logiofd', '', _('file descriptor to log server I/O to')),
('', 'logiofile', '', _('file to log server I/O to')),
], '')
def debugserve(ui, repo, **opts):
"""run a server with advanced settings
This command is similar to :hg:`serve`. It exists partially as a
workaround to the fact that ``hg serve --stdio`` must have specific
arguments for security reasons.
"""
opts = pycompat.byteskwargs(opts)
if not opts['sshstdio']:
raise error.Abort(_('only --sshstdio is currently supported'))
logfh = None
if opts['logiofd'] and opts['logiofile']:
raise error.Abort(_('cannot use both --logiofd and --logiofile'))
if opts['logiofd']:
# Line buffered because output is line based.
logfh = os.fdopen(int(opts['logiofd']), 'ab', 1)
elif opts['logiofile']:
logfh = open(opts['logiofile'], 'ab', 1)
s = wireprotoserver.sshserver(ui, repo, logfh=logfh)
s.serve_forever()
@command('debugsetparents', [], _('REV1 [REV2]')) @command('debugsetparents', [], _('REV1 [REV2]'))
def debugsetparents(ui, repo, rev1, rev2=None): def debugsetparents(ui, repo, rev1, rev2=None):
"""manually set the parents of the current working directory """manually set the parents of the current working directory
This is useful for writing repository conversion tools, but should This is useful for writing repository conversion tools, but should
be used with care. For example, neither the working directory nor the be used with care. For example, neither the working directory nor the
dirstate is updated, so file status may be incorrect after running this dirstate is updated, so file status may be incorrect after running this
command. command.

tests/test-completion.t

debugpickmergetool debugpickmergetool
debugpushkey debugpushkey
debugpvec debugpvec
debugrebuilddirstate debugrebuilddirstate
debugrebuildfncache debugrebuildfncache
debugrename debugrename
debugrevlog debugrevlog
debugrevspec debugrevspec
debugserve
debugsetparents debugsetparents
debugssl debugssl
debugsub debugsub
debugsuccessorssets debugsuccessorssets
debugtemplate debugtemplate
debugupdatecaches debugupdatecaches
debugupgraderepo debugupgraderepo
debugwalk debugwalk
debugpickmergetool: rev, changedelete, include, exclude, tool debugpickmergetool: rev, changedelete, include, exclude, tool
debugpushkey: debugpushkey:
debugpvec: debugpvec:
debugrebuilddirstate: rev, minimal debugrebuilddirstate: rev, minimal
debugrebuildfncache: debugrebuildfncache:
debugrename: rev debugrename: rev
debugrevlog: changelog, manifest, dir, dump debugrevlog: changelog, manifest, dir, dump
debugrevspec: optimize, show-revs, show-set, show-stage, no-optimized, verify-optimized debugrevspec: optimize, show-revs, show-set, show-stage, no-optimized, verify-optimized
debugserve: sshstdio, logiofd, logiofile
debugsetparents: debugsetparents:
debugssl: debugssl:
debugsub: rev debugsub: rev
debugsuccessorssets: closest debugsuccessorssets: closest
debugtemplate: rev, define debugtemplate: rev, define
debugupdatecaches: debugupdatecaches:
debugupgraderepo: optimize, run debugupgraderepo: optimize, run
debugwalk: include, exclude debugwalk: include, exclude

tests/test-help.t

debugrebuilddirstate debugrebuilddirstate
rebuild the dirstate as it would look like for the given rebuild the dirstate as it would look like for the given
revision revision
debugrebuildfncache debugrebuildfncache
rebuild the fncache file rebuild the fncache file
debugrename dump rename information debugrename dump rename information
debugrevlog show data and statistics about a revlog debugrevlog show data and statistics about a revlog
debugrevspec parse and apply a revision specification debugrevspec parse and apply a revision specification
debugserve run a server with advanced settings
debugsetparents debugsetparents
manually set the parents of the current working directory manually set the parents of the current working directory
debugssl test a secure connection to a server debugssl test a secure connection to a server
debugsub (no help text available) debugsub (no help text available)
debugsuccessorssets debugsuccessorssets
show set of successors for revision show set of successors for revision
debugtemplate debugtemplate
parse and apply a template parse and apply a template

tests/test-ssh-proto.t

Server should answer the "hello" command in isolation Server should answer the "hello" command in isolation
$ hg -R server serve --stdio << EOF $ hg -R server serve --stdio << EOF
> hello > hello
> EOF > EOF
384 384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
`hg debugserve --sshstdio` works
$ cd server
$ hg debugserve --sshstdio << EOF
> hello
> EOF
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
I/O logging works
$ hg debugserve --sshstdio --logiofd 1 << EOF
> hello
> EOF
o> write(4) -> None:
o> 384\n
o> write(384) -> None:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
o> flush() -> None
$ hg debugserve --sshstdio --logiofile $TESTTMP/io << EOF
> hello
> EOF
384
capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN
$ cat $TESTTMP/io
o> write(4) -> None:
o> 384\n
o> write(384) -> None:
o> capabilities: lookup changegroupsubset branchmap pushkey known getbundle unbundlehash batch streamreqs=generaldelta,revlogv1 $USUAL_BUNDLE2_CAPS_SERVER$ unbundle=HG10GZ,HG10BZ,HG10UN\n
o> flush() -> None
$ cd ..
>=0.9.1 clients send a "hello" + "between" for the null range as part of handshake. >=0.9.1 clients send a "hello" + "between" for the null range as part of handshake.
Server should reply with capabilities and should send "1\n\n" as a successful Server should reply with capabilities and should send "1\n\n" as a successful
reply with empty response to the "between". reply with empty response to the "between".
$ hg -R server serve --stdio << EOF $ hg -R server serve --stdio << EOF
> hello > hello
> between > between
> pairs 81 > pairs 81