This is an archive of the discontinued Mercurial Phabricator instance.

Differential D5751

tests: change how sockets are closed
ClosedPublic

Authored by indygreg on Jan 30 2019, 3:56 PM.

Details

Reviewers
None
Group Reviewers
hg-reviewers
Commits
rHGd343d9ac173e: tests: change how sockets are closed
rHG889d115db0de: tests: change how sockets are closed
Summary

Python 3 uses a different type to represent a socket file object
than Python 2. We need to conditionalize how the socket is closed
accordingly.

While we're here, we switch to use socket.shutdown() to close the
socket. This is because socket.close() may not actually close
the socket until it is GCd. socket.shutdown() forces an immediate
shutdown.

I suspect Python 3 changed semantic behavior here, as I can't get
test-http-bad-server.t to work with socket.close(). socket.shutdown()
does appear to work, however.

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.Jan 30 2019, 3:56 PM
durin42 added a subscriber: durin42.Jan 30 2019, 4:07 PM
durin42 added inline comments.
tests/badserverext.py
140

pycompat.ispy3

indygreg updated this revision to Diff 13585.Jan 30 2019, 4:09 PM
Closed by commit rHG889d115db0de: tests: change how sockets are closed (authored by indygreg). · Explain WhyJan 30 2019, 4:13 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mtests/badserverext.py (25 lines)

Diff 13588

tests/badserverext.py

If defined, close the client socket after sending this many bytes. If defined, close the client socket after sending this many bytes.
""" """
from __future__ import absolute_import from __future__ import absolute_import
import socket import socket
from mercurial import( from mercurial import(
pycompat,
registrar, registrar,
) )
from mercurial.hgweb import ( from mercurial.hgweb import (
server, server,
) )
configtable = {} configtable = {}
def __init__(self, obj, logfp, closeafterrecvbytes=0, def __init__(self, obj, logfp, closeafterrecvbytes=0,
closeaftersendbytes=0): closeaftersendbytes=0):
object.__setattr__(self, '_orig', obj) object.__setattr__(self, '_orig', obj)
object.__setattr__(self, '_logfp', logfp) object.__setattr__(self, '_logfp', logfp)
object.__setattr__(self, '_closeafterrecvbytes', closeafterrecvbytes) object.__setattr__(self, '_closeafterrecvbytes', closeafterrecvbytes)
object.__setattr__(self, '_closeaftersendbytes', closeaftersendbytes) object.__setattr__(self, '_closeaftersendbytes', closeaftersendbytes)
def __getattribute__(self, name): def __getattribute__(self, name):
if name in ('read', 'readline', 'write', '_writelog'): if name in ('_close', 'read', 'readline', 'write', '_writelog'):
return object.__getattribute__(self, name) return object.__getattribute__(self, name)
return getattr(object.__getattribute__(self, '_orig'), name) return getattr(object.__getattribute__(self, '_orig'), name)
def __delattr__(self, name): def __delattr__(self, name):
delattr(object.__getattribute__(self, '_orig'), name) delattr(object.__getattribute__(self, '_orig'), name)
def __setattr__(self, name, value): def __setattr__(self, name, value):
setattr(object.__getattribute__(self, '_orig'), name, value) setattr(object.__getattribute__(self, '_orig'), name, value)
def _writelog(self, msg): def _writelog(self, msg):
msg = msg.replace(b'\r', b'\\r').replace(b'\n', b'\\n') msg = msg.replace(b'\r', b'\\r').replace(b'\n', b'\\n')
object.__getattribute__(self, '_logfp').write(msg) object.__getattribute__(self, '_logfp').write(msg)
object.__getattribute__(self, '_logfp').write(b'\n') object.__getattribute__(self, '_logfp').write(b'\n')
object.__getattribute__(self, '_logfp').flush() object.__getattribute__(self, '_logfp').flush()
def _close(self):
# Python 3 uses an io.BufferedIO instance. Python 2 uses some file
# object wrapper.
if pycompat.ispy3:
durin42Unsubmitted
Not Done

pycompat.ispy3

durin42: pycompat.ispy3
orig = object.__getattribute__(self, '_orig')
if hasattr(orig, 'raw'):
orig.raw._sock.shutdown(socket.SHUT_RDWR)
else:
self.close()
else:
self._sock.shutdown(socket.SHUT_RDWR)
def read(self, size=-1): def read(self, size=-1):
remaining = object.__getattribute__(self, '_closeafterrecvbytes') remaining = object.__getattribute__(self, '_closeafterrecvbytes')
# No read limit. Call original function. # No read limit. Call original function.
if not remaining: if not remaining:
result = object.__getattribute__(self, '_orig').read(size) result = object.__getattribute__(self, '_orig').read(size)
self._writelog(b'read(%d) -> (%d) (%s) %s' % (size, self._writelog(b'read(%d) -> (%d) (%s) %s' % (size,
len(result), len(result),
self._writelog(b'read(%d from %d) -> (%d) %s' % ( self._writelog(b'read(%d from %d) -> (%d) %s' % (
size, origsize, len(result), result)) size, origsize, len(result), result))
object.__setattr__(self, '_closeafterrecvbytes', remaining) object.__setattr__(self, '_closeafterrecvbytes', remaining)
if remaining <= 0: if remaining <= 0:
self._writelog(b'read limit reached, closing socket') self._writelog(b'read limit reached, closing socket')
self._sock.close() self._close()
# This is the easiest way to abort the current request. # This is the easiest way to abort the current request.
raise Exception('connection closed after receiving N bytes') raise Exception('connection closed after receiving N bytes')
return result return result
def readline(self, size=-1): def readline(self, size=-1):
remaining = object.__getattribute__(self, '_closeafterrecvbytes') remaining = object.__getattribute__(self, '_closeafterrecvbytes')
self._writelog(b'readline(%d from %d) -> (%d) %s' % ( self._writelog(b'readline(%d from %d) -> (%d) %s' % (
size, origsize, len(result), result)) size, origsize, len(result), result))
object.__setattr__(self, '_closeafterrecvbytes', remaining) object.__setattr__(self, '_closeafterrecvbytes', remaining)
if remaining <= 0: if remaining <= 0:
self._writelog(b'read limit reached; closing socket') self._writelog(b'read limit reached; closing socket')
self._sock.close() self._close()
# This is the easiest way to abort the current request. # This is the easiest way to abort the current request.
raise Exception('connection closed after receiving N bytes') raise Exception('connection closed after receiving N bytes')
return result return result
def write(self, data): def write(self, data):
remaining = object.__getattribute__(self, '_closeaftersendbytes') remaining = object.__getattribute__(self, '_closeaftersendbytes')
len(newdata), len(data), remaining, newdata)) len(newdata), len(data), remaining, newdata))
result = object.__getattribute__(self, '_orig').write(newdata) result = object.__getattribute__(self, '_orig').write(newdata)
object.__setattr__(self, '_closeaftersendbytes', remaining) object.__setattr__(self, '_closeaftersendbytes', remaining)
if remaining <= 0: if remaining <= 0:
self._writelog(b'write limit reached; closing socket') self._writelog(b'write limit reached; closing socket')
self._sock.close() self._close()
raise Exception('connection closed after sending N bytes') raise Exception('connection closed after sending N bytes')
return result return result
def extsetup(ui): def extsetup(ui):
# Change the base HTTP server class so various events can be performed. # Change the base HTTP server class so various events can be performed.
# See SocketServer.BaseServer for how the specially named methods work. # See SocketServer.BaseServer for how the specially named methods work.
class badserver(server.MercurialHTTPServer): class badserver(server.MercurialHTTPServer):