Permalink
Fetching contributors…
Cannot retrieve contributors at this time
128 lines (109 sloc) 5.05 KB
# This file is part of Buildbot. Buildbot is free software: you can
# redistribute it and/or modify it under the terms of the GNU General Public
# License as published by the Free Software Foundation, version 2.
#
# This program is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
# details.
#
# You should have received a copy of the GNU General Public License along with
# this program; if not, write to the Free Software Foundation, Inc., 51
# Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Copyright Buildbot Team Members
import inspect
import pkg_resources
from future.builtins import range
from future.utils import PY3
from twisted.trial import unittest
class InterfaceTests(object):
# assertions
def assertArgSpecMatches(self, actualMethod, *fakeMethods):
"""Usage::
@self.assertArgSpecMatches(obj.methodUnderTest)
def methodTemplate(self, arg1, arg2):
pass
or, more useful when you will be faking out C{methodUnderTest}:
self.assertArgSpecMatches(obj.methodUnderTest, self.fakeMethod)
"""
def filter(spec):
# the tricky thing here is to align args and defaults, since the
# defaults correspond to the *last* n elements of args. To make
# things easier, we go in reverse, and keep a separate counter for
# the defaults
args = spec[0]
defaults = list(spec[3] if spec[3] is not None else [])
di = -1
for ai in range(len(args) - 1, -1, -1):
arg = args[ai]
if arg.startswith('_') or (arg == 'self' and ai == 0):
del args[ai]
if -di <= len(defaults):
del defaults[di]
di += 1
di -= 1
return (args, spec[1], spec[2], defaults or None)
def remove_decorators(func):
try:
return func.__wrapped__
except AttributeError:
return func
def assert_same_argspec(expected, actual):
if expected != actual:
msg = "Expected: %s; got: %s" % (
inspect.formatargspec(*expected),
inspect.formatargspec(*actual))
self.fail(msg)
if PY3:
actual_argspec = filter(
inspect.signature(remove_decorators(actualMethod)))
else:
actual_argspec = filter(
inspect.getargspec(remove_decorators(actualMethod)))
for fakeMethod in fakeMethods:
if PY3:
fake_argspec = filter(
inspect.signature(remove_decorators(fakeMethod)))
else:
fake_argspec = filter(
inspect.getargspec(remove_decorators(fakeMethod)))
assert_same_argspec(actual_argspec, fake_argspec)
def assert_same_argspec_decorator(decorated):
if PY3:
expected_argspec = filter(
inspect.signature(remove_decorators(decorated)))
else:
expected_argspec = filter(
inspect.getargspec(remove_decorators(decorated)))
assert_same_argspec(expected_argspec, actual_argspec)
# The decorated function works as usual.
return decorated
return assert_same_argspec_decorator
def assertInterfacesImplemented(self, cls):
"Given a class, assert that the zope.interface.Interfaces are implemented to specification."
# see if this version of zope.interface is too old to run these tests
zi_vers = pkg_resources.working_set.find(
pkg_resources.Requirement.parse('zope.interface')).version
if pkg_resources.parse_version(zi_vers) < pkg_resources.parse_version('4.1.1'):
raise unittest.SkipTest(
"zope.interfaces is too old to run this test")
import zope.interface.interface
for interface in zope.interface.implementedBy(cls):
for attr, template_argspec in interface.namesAndDescriptions():
if not hasattr(cls, attr):
msg = "Expected: %r; to implement: %s as specified in %r" % (
cls, attr,
interface)
self.fail(msg)
actual_argspec = getattr(cls, attr)
while hasattr(actual_argspec, '__wrapped__'):
actual_argspec = actual_argspec.__wrapped__
actual_argspec = zope.interface.interface.fromMethod(
actual_argspec)
if actual_argspec.getSignatureInfo() != template_argspec.getSignatureInfo():
msg = "%s: expected: %s; got: %s" % (
attr,
template_argspec.getSignatureString(),
actual_argspec.getSignatureString())
self.fail(msg)