Mercurial > hg
view tests/test-check-interfaces.py @ 37296:78103e4138b1
wireproto: port protocol handler to zope.interface
zope.interface is superior to the abc module. Let's port to it.
As part of this, we add tests for interface conformance for
classes implementing the interface.
Differential Revision: https://phab.mercurial-scm.org/D2983
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Fri, 23 Mar 2018 16:24:53 -0700 |
parents | 0dfb5672f015 |
children | 39f7d4ee8bcd |
line wrap: on
line source
# Test that certain objects conform to well-defined interfaces. from __future__ import absolute_import, print_function import os from mercurial.thirdparty.zope import ( interface as zi, ) from mercurial.thirdparty.zope.interface import ( verify as ziverify, ) from mercurial import ( bundlerepo, httppeer, localrepo, repository, sshpeer, statichttprepo, ui as uimod, unionrepo, wireprotoserver, wireprototypes, ) rootdir = os.path.normpath(os.path.join(os.path.dirname(__file__), '..')) def checkobject(o): """Verify a constructed object conforms to interface rules. An object must have __abstractmethods__ defined. All "public" attributes of the object (attributes not prefixed with an underscore) must be in __abstractmethods__ or appear on a base class with __abstractmethods__. """ name = o.__class__.__name__ allowed = set() for cls in o.__class__.__mro__: if not getattr(cls, '__abstractmethods__', set()): continue allowed |= cls.__abstractmethods__ allowed |= {a for a in dir(cls) if not a.startswith('_')} if not allowed: print('%s does not have abstract methods' % name) return public = {a for a in dir(o) if not a.startswith('_')} for attr in sorted(public - allowed): print('public attributes not in abstract interface: %s.%s' % ( name, attr)) def checkzobject(o): """Verify an object with a zope interface.""" ifaces = zi.providedBy(o) if not ifaces: print('%r does not provide any zope interfaces' % o) return # Run zope.interface's built-in verification routine. This verifies that # everything that is supposed to be present is present. for iface in ifaces: ziverify.verifyObject(iface, o) # Now verify that the object provides no extra public attributes that # aren't declared as part of interfaces. allowed = set() for iface in ifaces: allowed |= set(iface.names(all=True)) public = {a for a in dir(o) if not a.startswith('_')} for attr in sorted(public - allowed): print('public attribute not declared in interfaces: %s.%s' % ( o.__class__.__name__, attr)) # Facilitates testing localpeer. class dummyrepo(object): def __init__(self): self.ui = uimod.ui() def filtered(self, name): pass def _restrictcapabilities(self, caps): pass class dummyopener(object): handlers = [] # Facilitates testing sshpeer without requiring an SSH server. class badpeer(httppeer.httppeer): def __init__(self): super(badpeer, self).__init__(None, None, None, dummyopener()) self.badattribute = True def badmethod(self): pass class dummypipe(object): def close(self): pass def main(): ui = uimod.ui() # Needed so we can open a local repo with obsstore without a warning. ui.setconfig('experimental', 'evolution.createmarkers', True) checkobject(badpeer()) checkobject(httppeer.httppeer(None, None, None, dummyopener())) checkobject(localrepo.localpeer(dummyrepo())) checkobject(sshpeer.sshv1peer(ui, 'ssh://localhost/foo', None, dummypipe(), dummypipe(), None, None)) checkobject(sshpeer.sshv2peer(ui, 'ssh://localhost/foo', None, dummypipe(), dummypipe(), None, None)) checkobject(bundlerepo.bundlepeer(dummyrepo())) checkobject(statichttprepo.statichttppeer(dummyrepo())) checkobject(unionrepo.unionpeer(dummyrepo())) ziverify.verifyClass(repository.completelocalrepository, localrepo.localrepository) repo = localrepo.localrepository(ui, rootdir) checkzobject(repo) ziverify.verifyClass(wireprototypes.baseprotocolhandler, wireprotoserver.sshv1protocolhandler) ziverify.verifyClass(wireprototypes.baseprotocolhandler, wireprotoserver.sshv2protocolhandler) ziverify.verifyClass(wireprototypes.baseprotocolhandler, wireprotoserver.httpv1protocolhandler) ziverify.verifyClass(wireprototypes.baseprotocolhandler, wireprotoserver.httpv2protocolhandler) sshv1 = wireprotoserver.sshv1protocolhandler(None, None, None) checkzobject(sshv1) sshv2 = wireprotoserver.sshv2protocolhandler(None, None, None) checkzobject(sshv2) httpv1 = wireprotoserver.httpv1protocolhandler(None, None, None) checkzobject(httpv1) httpv2 = wireprotoserver.httpv2protocolhandler(None, None) checkzobject(httpv2) main()