This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2463

wireprotoserver: support logging SSH server I/O to a file descriptor
ClosedPublic

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

Download Raw Diff

Details

Reviewers

durin42

Group Reviewers

hg-reviewers

Commits

rHG7cc4a9b9732a: wireprotoserver: support logging SSH server I/O to a file descriptor
rHG64efadb62026: wireprotoserver: support logging SSH server I/O to a file descriptor

Summary

We will soon introduce a debug command and tests for low-level I/O
behavior of the SSH wire protocol.

To facilitate this, we need to instrument the SSH server so it
can log its I/O as events occur.

We teach the SSH server to convert its stdout and stderr file objects
into file object proxies. We configure these proxies to log to a
file descriptor whose file number is specified via a config option.
The idea is to have a future debug command start the SSH server
process with access to an extra file descriptor that can be used
by the server process to log I/O. Monitoring only the write I/O
will be more robust than monitoring both writes and reads from the
client process because read operations are not deterministic. This
will matter for tests that capture raw I/O activity.

Diff Detail

Repository

rHG Mercurial

Lint

Lint Skipped

Unit

Unit Tests Skipped

Event Timeline

indygreg created this revision.Feb 26 2018, 4:16 PM

Herald added a reviewer: hg-reviewers. · View Herald TranscriptFeb 26 2018, 4:16 PM

Herald added a subscriber: mercurial-devel. · View Herald Transcript

indygreg added a child revision: D2464: debugcommands: add debugserve command.Feb 26 2018, 4:16 PM

indygreg updated this revision to Diff 6248.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 rHG64efadb62026: wireprotoserver: support logging SSH server I/O to a file descriptor (authored by indygreg). · Explain WhyMar 1 2018, 4:30 PM

This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

			Path	Packages
M			mercurial/wireprotoserver.py (10 lines)

Diff	ID	Description	Created	Lint	Unit
Base		Base
Diff 1	6137		Feb 26 2018, 4:16 PM	★	★
Diff 2	6248		Mar 1 2018, 11:30 AM	★	★
Diff 3	6281	rHG64efadb620262f0f1a6c0fc4709be463b295434a	Feb 25 2018, 2:16 PM	★	★

Status	Author	Revision
Closed	indygreg	D2550 tests: add more tests around hook output and getbundle
Closed	indygreg	D2513 wireproto: only expose "between" to version 1 of wire protocols
Closed	indygreg	D2512 wireproto: add transport specific capabilities in the transport
Closed	indygreg	D2486 wireproto: don't expose changegroupsubset capability if not available
Closed	indygreg	D2485 wireproto: don't expose legacy commands to version 2 of wire protocol
Closed	indygreg	D2484 wireprotoserver: identify requests via version 2 of SSH protocol as such
Closed	indygreg	D2483 wireproto: allow wire protocol commands to declare transport support
Closed	indygreg	D2482 wireprotoserver: move SSHV1 and SSHV2 constants to wireprototypes
Closed	indygreg	D2481 wireproto: use named arguments for commandentry
Closed	indygreg	D2471 debugcommands: support for triggering push protocol
Closed	indygreg	D2467 sshpeer: support not reading and forwarding stderr
Closed	indygreg	D2466 tests: add wire protocol tests for pushkey
Abandoned	indygreg	D2465 debugcommands: allow empty argument values
Closed	indygreg	D2408 debugcommands: support for sending "batch" requests
Closed	indygreg	D2571 sshpeer: don't read from stderr when that behavior is disabled
Abandoned	indygreg	D2407 tests: add low-level SSH protocol tests for listkeys
Closed	indygreg	D2406 debugcommands: allow sending of simple commands with debugwireproto
Closed	indygreg	D2405 wireproto: sort response to listkeys
Closed	indygreg	D2392 debugcommands: add debugwireproto command
Closed	indygreg	D2464 debugcommands: add debugserve command
Closed	indygreg	D2463 wireprotoserver: support logging SSH server I/O to a file descriptor
Closed	indygreg	D2404 util: enable observing of util.bufferedinputpipe
Closed	indygreg	D2462 util: add a file object proxy that can notify observers
Closed	indygreg	D2461 wireprotoserver: ability to run an SSH server until an event is set
Closed	indygreg	D2391 sshpeer: factor out code for creating peers from pipes

Diff 6248

mercurial/wireprotoserver.py

	# Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>			# Copyright 21 May 2005 - (c) 2005 Jake Edge <jake@edge2.net>
	# Copyright 2005-2007 Matt Mackall <mpm@selenic.com>			# Copyright 2005-2007 Matt Mackall <mpm@selenic.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.

	from __future__ import absolute_import			from __future__ import absolute_import

	import contextlib			import contextlib
				import os
	import struct			import struct
	import sys			import sys
	import threading			import threading

	from .i18n import _			from .i18n import _
	from . import (			from . import (
	encoding,			encoding,
	error,			error,
	elif state == 'shutdown':			elif state == 'shutdown':
	break			break

	else:			else:
	raise error.ProgrammingError('unhandled ssh server state: %s' %			raise error.ProgrammingError('unhandled ssh server state: %s' %
	state)			state)

	class sshserver(object):			class sshserver(object):
	def __init__(self, ui, repo):			def __init__(self, ui, repo, logfh=None):
	self._ui = ui			self._ui = ui
	self._repo = repo			self._repo = repo
	self._fin = ui.fin			self._fin = ui.fin
	self._fout = ui.fout			self._fout = ui.fout

				# Log write I/O to stdout and stderr if configured.
				if logfh:
				self._fout = util.makeloggingfileobject(
				logfh, self._fout, 'o', logdata=True)
				ui.ferr = util.makeloggingfileobject(
				logfh, ui.ferr, 'e', logdata=True)

	hook.redirect(True)			hook.redirect(True)
	ui.fout = repo.ui.fout = ui.ferr			ui.fout = repo.ui.fout = ui.ferr

	# Prevent insertion/deletion of CRs			# Prevent insertion/deletion of CRs
	util.setbinary(self._fin)			util.setbinary(self._fin)
	util.setbinary(self._fout)			util.setbinary(self._fout)

	def serve_forever(self):			def serve_forever(self):
	self.serveuntil(threading.Event())			self.serveuntil(threading.Event())
	sys.exit(0)			sys.exit(0)

	def serveuntil(self, ev):			def serveuntil(self, ev):
	"""Serve until a threading.Event is set."""			"""Serve until a threading.Event is set."""
	_runsshserver(self._ui, self._repo, self._fin, self._fout, ev)			_runsshserver(self._ui, self._repo, self._fin, self._fout, ev)