This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1683

sshpeer: allow for additional environment passing to ssh exe
ClosedPublic

Authored by ikostia on Dec 14 2017, 9:39 AM.

Details

Reviewers
mbthomas
durin42
Group Reviewers
hg-reviewers
Commits
rHG31d21309635b: sshpeer: allow for additional environment passing to ssh exe
rHG47921dafb44b: sshpeer: allow for additional environment passing to ssh exe
Summary

We already have the ability to customize the ssh command line arguments, let's
add the ability to customize its environment as well.

Example use-case is ssh.exe from Git on Windows. If HOME enviroment variable
is present and has some non-empty value, ssh.exe will try to access that
location for some stuff (for example, it seems for resolving ~ in
.ssh/config). Git for Windows seems to sometimess set this variable to the
value of /home/username which probably works under Git Bash, but does not
work in a native cmd.exe or powershell. Whatever the root cause, setting
HOME to be an empty string heals things. Therefore, some distributors
might want to set sshenv.HOME= in the configuration (seems less intrusive
that forcing everyone to tweak their env).

Test Plan
  • rt

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

ikostia created this revision.Dec 14 2017, 9:39 AM
mbthomas accepted this revision.Dec 14 2017, 11:21 AM
mbthomas added a subscriber: mbthomas.

Looks reasonable to me. This could also be achieved by making SSH a script which sets the environment up and invokes the real SSH, but that's clumsy, whereas this allows use of config to set the env vars.

durin42 accepted this revision.Dec 15 2017, 4:14 PM
durin42 added a subscriber: durin42.

Ugh. But clearly needed.

This revision is now accepted and ready to land.Dec 15 2017, 4:14 PM
Closed by commit rHG47921dafb44b: sshpeer: allow for additional environment passing to ssh exe (authored by ikostia). · Explain WhyDec 15 2017, 4:15 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/sshpeer.py (10 lines)
Mtests/test-ssh.t (18 lines)

Diff 4519

mercurial/sshpeer.py

self._user = u.user self._user = u.user
self._host = u.host self._host = u.host
self._port = u.port self._port = u.port
self._path = u.path or '.' self._path = u.path or '.'
sshcmd = self.ui.config("ui", "ssh") sshcmd = self.ui.config("ui", "ssh")
remotecmd = self.ui.config("ui", "remotecmd") remotecmd = self.ui.config("ui", "remotecmd")
sshaddenv = dict(self.ui.configitems("sshenv"))
sshenv = util.shellenviron(sshaddenv)
args = util.sshargs(sshcmd, self._host, self._user, self._port) args = util.sshargs(sshcmd, self._host, self._user, self._port)
if create: if create:
cmd = '%s %s %s' % (sshcmd, args, cmd = '%s %s %s' % (sshcmd, args,
util.shellquote("%s init %s" % util.shellquote("%s init %s" %
(_serverquote(remotecmd), _serverquote(self._path)))) (_serverquote(remotecmd), _serverquote(self._path))))
ui.debug('running %s\n' % cmd) ui.debug('running %s\n' % cmd)
res = ui.system(cmd, blockedtag='sshpeer') res = ui.system(cmd, blockedtag='sshpeer', environ=sshenv)
if res != 0: if res != 0:
self._abort(error.RepoError(_("could not create remote repo"))) self._abort(error.RepoError(_("could not create remote repo")))
self._validaterepo(sshcmd, args, remotecmd) self._validaterepo(sshcmd, args, remotecmd, sshenv)
# Begin of _basepeer interface. # Begin of _basepeer interface.
@util.propertycache @util.propertycache
def ui(self): def ui(self):
return self._ui return self._ui
def url(self): def url(self):
# Begin of _basewirecommands interface. # Begin of _basewirecommands interface.
def capabilities(self): def capabilities(self):
return self._caps return self._caps
# End of _basewirecommands interface. # End of _basewirecommands interface.
def _validaterepo(self, sshcmd, args, remotecmd): def _validaterepo(self, sshcmd, args, remotecmd, sshenv=None):
# cleanup up previous run # cleanup up previous run
self._cleanup() self._cleanup()
cmd = '%s %s %s' % (sshcmd, args, cmd = '%s %s %s' % (sshcmd, args,
util.shellquote("%s -R %s serve --stdio" % util.shellquote("%s -R %s serve --stdio" %
(_serverquote(remotecmd), _serverquote(self._path)))) (_serverquote(remotecmd), _serverquote(self._path))))
self.ui.debug('running %s\n' % cmd) self.ui.debug('running %s\n' % cmd)
cmd = util.quotecommand(cmd) cmd = util.quotecommand(cmd)
# while self._subprocess isn't used, having it allows the subprocess to # while self._subprocess isn't used, having it allows the subprocess to
# to clean up correctly later # to clean up correctly later
# #
# no buffer allow the use of 'select' # no buffer allow the use of 'select'
# feel free to remove buffering and select usage when we ultimately # feel free to remove buffering and select usage when we ultimately
# move to threading. # move to threading.
sub = util.popen4(cmd, bufsize=0) sub = util.popen4(cmd, bufsize=0, env=sshenv)
self._pipeo, self._pipei, self._pipee, self._subprocess = sub self._pipeo, self._pipei, self._pipee, self._subprocess = sub
self._pipei = util.bufferedinputpipe(self._pipei) self._pipei = util.bufferedinputpipe(self._pipei)
self._pipei = doublepipe(self.ui, self._pipei, self._pipee) self._pipei = doublepipe(self.ui, self._pipei, self._pipee)
self._pipeo = doublepipe(self.ui, self._pipeo, self._pipee) self._pipeo = doublepipe(self.ui, self._pipeo, self._pipee)
def badresponse(): def badresponse():
msg = _("no suitable response from remote hg") msg = _("no suitable response from remote hg")

tests/test-ssh.t

abort with configured error hint when there is a ssh problem when pulling abort with configured error hint when there is a ssh problem when pulling
$ hg pull ssh://brokenrepository -e "\"$PYTHON\" \"$TESTDIR/dummyssh\"" \ $ hg pull ssh://brokenrepository -e "\"$PYTHON\" \"$TESTDIR/dummyssh\"" \
> --config ui.ssherrorhint="Please see http://company/internalwiki/ssh.html" > --config ui.ssherrorhint="Please see http://company/internalwiki/ssh.html"
pulling from ssh://brokenrepository/ pulling from ssh://brokenrepository/
abort: no suitable response from remote hg! abort: no suitable response from remote hg!
(Please see http://company/internalwiki/ssh.html) (Please see http://company/internalwiki/ssh.html)
[255] [255]
test that custom environment is passed down to ssh executable
$ cat >>dumpenv <<EOF
> #! /bin/sh
> echo \$VAR >&2
> EOF
$ chmod +x dumpenv
$ hg pull ssh://something --config ui.ssh="./dumpenv"
pulling from ssh://something/
remote:
abort: no suitable response from remote hg!
[255]
$ hg pull ssh://something --config ui.ssh="./dumpenv" --config sshenv.VAR=17
pulling from ssh://something/
remote: 17
abort: no suitable response from remote hg!
[255]