This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2391

sshpeer: factor out code for creating peers from pipes
ClosedPublic

Authored by indygreg on Feb 22 2018, 7:50 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHGdabf86721200: sshpeer: factor out code for creating peers from pipes
rHGcaf423782b3a: sshpeer: factor out code for creating peers from pipes
Summary

An upcoming commit will want to instantiate an SSH peer via
an alternate mechanism that doesn't require running a new
ssh command. To facilitate that, we extract the code for
creating a peer from pipes to its own function.

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 22 2018, 7:50 PM
dhduvall added a subscriber: dhduvall.Feb 23 2018, 12:29 AM
dhduvall added inline comments.
mercurial/sshpeer.py
537

That second path should be proc?

indygreg updated this revision to Diff 6018.Feb 23 2018, 11:29 AM
yuja accepted this revision.Mar 1 2018, 5:54 AM
This revision is now accepted and ready to land.Mar 1 2018, 5:54 AM
Closed by commit rHGcaf423782b3a: sshpeer: factor out code for creating peers from pipes (authored by indygreg). · Explain WhyMar 1 2018, 6:08 AM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/sshpeer.py (44 lines)

Diff 6243

mercurial/sshpeer.py

self._readerr() self._readerr()
class sshv2peer(sshv1peer): class sshv2peer(sshv1peer):
"""A peer that speakers version 2 of the transport protocol.""" """A peer that speakers version 2 of the transport protocol."""
# Currently version 2 is identical to version 1 post handshake. # Currently version 2 is identical to version 1 post handshake.
# And handshake is performed before the peer is instantiated. So # And handshake is performed before the peer is instantiated. So
# we need no custom code. # we need no custom code.
def makepeer(ui, path, proc, stdin, stdout, stderr):
"""Make a peer instance from existing pipes.
``path`` and ``proc`` are stored on the eventual peer instance and may
dhduvallUnsubmitted
Not Done

That second path should be proc?

dhduvall: That second `path` should be `proc`?
not be used for anything meaningful.
``stdin``, ``stdout``, and ``stderr`` are the pipes connected to the
SSH server's stdio handles.
This function is factored out to allow creating peers that don't
actually spawn a new process. It is useful for starting SSH protocol
servers and clients via non-standard means, which can be useful for
testing.
"""
try:
protoname, caps = _performhandshake(ui, stdin, stdout, stderr)
except Exception:
_cleanuppipes(ui, stdout, stdin, stderr)
raise
if protoname == wireprotoserver.SSHV1:
return sshv1peer(ui, path, proc, stdin, stdout, stderr, caps)
elif protoname == wireprotoserver.SSHV2:
return sshv2peer(ui, path, proc, stdin, stdout, stderr, caps)
else:
_cleanuppipes(ui, stdout, stdin, stderr)
raise error.RepoError(_('unknown version of SSH protocol: %s') %
protoname)
def instance(ui, path, create): def instance(ui, path, create):
"""Create an SSH peer. """Create an SSH peer.
The returned object conforms to the ``wireproto.wirepeer`` interface. The returned object conforms to the ``wireproto.wirepeer`` interface.
""" """
u = util.url(path, parsequery=False, parsefragment=False) u = util.url(path, parsequery=False, parsefragment=False)
if u.scheme != 'ssh' or not u.host or u.path is None: if u.scheme != 'ssh' or not u.host or u.path is None:
raise error.RepoError(_("couldn't parse location %s") % path) raise error.RepoError(_("couldn't parse location %s") % path)
ui.debug('running %s\n' % cmd) ui.debug('running %s\n' % cmd)
res = ui.system(cmd, blockedtag='sshpeer', environ=sshenv) res = ui.system(cmd, blockedtag='sshpeer', environ=sshenv)
if res != 0: if res != 0:
raise error.RepoError(_('could not create remote repo')) raise error.RepoError(_('could not create remote repo'))
proc, stdin, stdout, stderr = _makeconnection(ui, sshcmd, args, remotecmd, proc, stdin, stdout, stderr = _makeconnection(ui, sshcmd, args, remotecmd,
remotepath, sshenv) remotepath, sshenv)
try: return makepeer(ui, path, proc, stdin, stdout, stderr)
protoname, caps = _performhandshake(ui, stdin, stdout, stderr)
except Exception:
_cleanuppipes(ui, stdout, stdin, stderr)
raise
if protoname == wireprotoserver.SSHV1:
return sshv1peer(ui, path, proc, stdin, stdout, stderr, caps)
elif protoname == wireprotoserver.SSHV2:
return sshv2peer(ui, path, proc, stdin, stdout, stderr, caps)
else:
_cleanuppipes(ui, stdout, stdin, stderr)
raise error.RepoError(_('unknown version of SSH protocol: %s') %
protoname)