January 2014 - tor-commits - lists.torproject.org

[bridgedb/master] Add another __future__ import to test_Tests.py.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit a62c34bdd803f5f31efdfdb7686733f373449f95 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:33:59 2013 +0000 Add another __future__ import to test_Tests.py. --- lib/bridgedb/test/test_Tests.py | 1 + 1 file changed, 1 insertion(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 6801565..ca37ecf 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -14,6 +14,7 @@ be compatible with the newer :mod:`twisted.trial` unittests in this directory. """ from __future__ import print_function +from __future__ import unicode_literals import logging import warnings

1 0

[bridgedb/master] Remove imports for bridgedb.Tests classes; import whole module.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit b5a3f41b284e737ef51127c00508aecb8ff3e543 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:34:59 2013 +0000 Remove imports for bridgedb.Tests classes; import whole module. --- lib/bridgedb/test/test_Tests.py | 6 ------ 1 file changed, 6 deletions(-) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index ca37ecf..08c5704 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -22,12 +22,6 @@ import warnings from twisted.trial import unittest from bridgedb import Tests -from bridgedb.Tests import EmailBridgeDistTests -from bridgedb.Tests import IPBridgeDistTests -from bridgedb.Tests import DictStorageTests -from bridgedb.Tests import SQLStorageTests -from bridgedb.Tests import ParseDescFileTests -from bridgedb.Tests import BridgeStabilityTests logging.warnings.filterwarnings('ignore', module="Tests") pyunit = __import__('unittest')

1 0

[bridgedb/master] Add test_Tests.MonkeypatchedOldUnittests class.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit a618ded894d5f6339303119853161ca5fe6a5faa Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 03:26:31 2013 +0000 Add test_Tests.MonkeypatchedOldUnittests class. This is precisely the same as `test_Tests.OldUnittests`, except that it re-runs all of the old unittests in lib/bridgedb/Tests.py with old code from `bridgedb.test.deprecated` to assist in finding regressions. --- lib/bridgedb/test/test_Tests.py | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index d45d27a..4afa0fd 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -208,3 +208,30 @@ class OldUnittests(unittest.TestCase): testResult = unittest.PyUnitResultAdapter(pyunit.TestResult()) methodPrefix = 'test_regressionsNewCode_' + +class MonkeypatchedOldUnittests(unittest.TestCase): + """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` + compatible output. + + For each test in this ``TestCase``, one of the old unittests in + bridgedb/Tests.py is run. For all of the tests, some functions and classes + are :func:`monkey.MonkeyPatcher.patch`ed with old, deprecated code from + :mod:`bridgedb.test.deprecated` to ensure that any new code has not caused + any regressions. + """ + __metaclass__ = DynamicTestCaseMeta + testSuites = Tests.testSuite() + testResult = unittest.PyUnitResultAdapter(pyunit.TestResult()) + methodPrefix = 'test_regressionsOldCode_' + patcher = monkeypatchTests() + + def runWithPatches(self, *args): + """Replaces :meth:`~twisted.trial.unittest.TestCase.run` as the default + methodName to run. This method calls ``run()`` though + ``self.patcher.runWithPatches``, using the class **testResult** object. + """ + self.patcher.runWithPatches(self.run, self.testResult) + self.patcher.restore() + + def __init__(self, methodName='runWithPatches'): + super(MonkeypatchedOldUnittests, self).__init__(methodName=methodName)

1 0

[bridgedb/master] Add dynamic TestCase class generator.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 0b89ae36724cfc4cbec4ebb310471d9871904674 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:51:07 2013 +0000 Add dynamic TestCase class generator. This is not *strictly* necessary; however, the previous manner that I had devised for running the old unittests in lib/bridgedb/Tests.py had a small problem: it ran *all* the tests in lib/bridgedb/Tests.py as a single trial test. This meant that if a single test from Tests.py failed, the whole test would fail, which doesn't give us very fine-grained reporting, especially if there were multiple failures (the whole thing would fail when the first one failed). To fix that, it would be necessary to create one `TestCase` "test_*" method per original unittest. Each individual unittest would also need to be wrapped with a `twisted.trial.unittest.PyUnitResultAdapter`, in order for twisted.trial to be able to capture tracebacks and `failure.Failures` correctly. Additionally, it would be nice if we could simply take each `TestCase` method from the original unittests and reuse their method names (so that we know exactly which one of the original unittests is being run); therefore, the methods need to be wrapped yet again to reassign dynamic instancemethod names. (Normally, dynamically mucking around with Python's namespace is a BadIdea™, but it turns out not only that this works, but that it *also* works with the dynamically discovered doctests from `test_Tests.generateTrialAdaptedDoctestSuite()` as well!) I mostly wanted to see if I could do it. Turns out, I can, and it seems to work well. This black-magic encrusted monster I've munged together, `DynamicTestCaseMeta`, works in the following manner: 1. It generates dynamic methodnames with a given `methodPrefix` 2. It generates corresponding methods for a `twisted.trial.unittest.TestCase` base class. 3. Next, it wraps the generated methods. Sometimes, depending on the base class, it wraps them multiple times. It also allows further layers of wrapping, i.e. the `MonkeyPatcher` returned from `monkeypatchTests()` still works. 4. Then, it assigns each generated methodname and method pair, using the special __new__() constructor, to the base class *when the base class is compiled* (i.e. when the test_Tests module is first imported into a Python interpreter). Therefore, each time you initialise a base class which uses `DynamicTestCaseMeta` as its __metaclass__, every initialised instance will have the *same* generated code, because the code which is generated is decided at compile time, not access time. * ADD the terrifying `test_Tests.DynamicTestCaseMeta` class generator. post scriptum: Take that, C++! :P --- lib/bridgedb/test/test_Tests.py | 98 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 98 insertions(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 2532be1..4e383d5 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -91,6 +91,104 @@ def monkeypatchTests(): return patcher +class DynamicTestCaseMeta(type): + """You how scary the seemingly-arbitrary constants in elliptic curve + cryptography seem? Well, I am over nine thousand times more scary. Dynamic + warez… beware! Be afraid; be very afraid. + + :ivar testResult: An :class:`unittest.TestResult` adapted with + :class:`twisted.trial.unittest.PyUnitResultAdapter`, for + storing test failures and successes in. + + A base class which uses this metaclass should define the following class + attributes: + + :ivar testSuites: A list of :class:`unittest.TestSuite`s (or their + :mod:`doctest` or :mod:`twisted.trial` equivalents). + :ivar methodPrefix: A string to prefix the generated method names + with. (default: 'test_') + """ + + testResult = unittest.PyUnitResultAdapter(pyunit.TestResult()) + + def __new__(cls, name, bases, attrs): + """Construct the initialiser for a new + :class:`twisted.trial.unittest.TestCase`. + + """ + logging.debug("Metaclass __new__ constructor called for %r" % name) + + if not 'testSuites' in attrs: + attrs['testSuites'] = list() + if not 'methodPrefix' in attrs: + attrs['methodPrefix'] = 'test_' + + testSuites = attrs['testSuites'] + methodPrefix = attrs['methodPrefix'] + logging.debug( + "Metaclass __new__() class %r(testSuites=%r, methodPrefix=%r)" % + (name, '\n\t'.join([str(ts) for ts in testSuites]), methodPrefix)) + + generatedMethods = cls.generateTestMethods(testSuites, methodPrefix) + attrs.update(generatedMethods) + #attrs['init'] = cls.__init__ # call the standard initialiser + return super(DynamicTestCaseMeta, cls).__new__(cls, name, bases, attrs) + + @classmethod + def generateTestMethods(cls, testSuites, methodPrefix='test_'): + """Dynamically generate methods and their names for a + :class:`twisted.trial.unittest.TestCase`. + + :param list testSuites: A list of :class:`unittest.TestSuite`s (or + their :mod:`doctest` or :mod:`twisted.trial` + equivalents). + :param str methodPrefix: A string to prefix the generated method names + with. (default: 'test_') + :rtype: dict + :returns: A dictionary of class attributes whose keys are dynamically + generated method names (prefixed with **methodPrefix**), and + whose corresponding values are dynamically generated methods + (taken out of the class attribute ``testSuites``). + """ + def testMethodFactory(test, name): + def createTestMethod(test): + def testMethod(*args, **kwargs): + """When this function is generated, a methodname (beginning + with whatever **methodPrefix** was set to) will also be + generated, and the (methodname, method) pair will be + assigned as attributes of the generated + :class:`~twisted.trial.unittest.TestCase`. + """ + # Get the number of failures before test.run(): + origFails = len(cls.testResult.original.failures) + test.run(cls.testResult) + # Fail the generated testMethod if the underlying failure + # count has increased: + if (len(cls.testResult.original.failures) > origFails): + fail = cls.testResult.original.failures[origFails:][0] + raise unittest.FailTest(''.join([str(fail[0]), + str(fail[1])])) + return cls.testResult + testMethod.__name__ = str(name) + return testMethod + return createTestMethod(test) + + newAttrs = {} + for testSuite in testSuites: + for test in testSuite: + origName = test.id() + if origName.find('.') > 0: + origFunc = origName.split('.')[-2:] + origName = '_'.join(origFunc) + if origName.endswith('_py'): # this happens with doctests + origName = origName.strip('_py') + methName = str(methodPrefix + origName).replace('.', '_') + meth = testMethodFactory(test, methName) + logging.debug("Set %s.%s=%r" % (cls.__name__, methName, meth)) + newAttrs[methName] = meth + return newAttrs + + class OldUnittests(unittest.TestCase): """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` compatible output.

1 0

[bridgedb/master] Rename `TrialAdaptedOldUnittests` → `OldUnittests`.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 869ffa80779f5dac7881995bf1255d8abf93103c Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:40:16 2013 +0000 Rename `TrialAdaptedOldUnittests` → `OldUnittests`. --- lib/bridgedb/test/test_Tests.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 08c5704..f261168 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -27,7 +27,7 @@ logging.warnings.filterwarnings('ignore', module="Tests") pyunit = __import__('unittest') -class TrialAdaptedOldUnittests(unittest.TestCase): +class OldUnittests(unittest.TestCase): """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` compatible output. """

1 0

[bridgedb/master] Add test_Tests.monkeypatchTests() to setup regression tests.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 9a4c98a72cda5bbd440282123a2a4a073cadd5c8 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:45:47 2013 +0000 Add test_Tests.monkeypatchTests() to setup regression tests. This function creates a `twisted.python.monkey.MonkeyPatcher` which will add deprecated code from `bridgedb.test.deprecated` back in, so that a TestCase class can run its tests on pre-refactored code to test for regressions. --- lib/bridgedb/test/test_Tests.py | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index b898cc4..2532be1 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -22,9 +22,12 @@ import logging import os import warnings +from twisted.python import monkey from twisted.trial import unittest from bridgedb import Tests +from bridgedb.test import deprecated + logging.warnings.filterwarnings('ignore', module="Tests") pyunit = __import__('unittest') @@ -57,6 +60,36 @@ def generateTrialAdaptedDoctestsSuite(): globs=fakedGlobals)) return testSuites +def monkeypatchTests(): + """Monkeypatch the old unittests, replacing new, refactored code with their + original equivalents from :mod:`bridgedb.test.deprecated`. + + The first patch replaces the newer parsing function, + :func:`~bridgedb.parse.networkstatus.parseALine`, with the older, + :func:`deprecated one <bridgedb.test.deprecated.parseORAddressLine>` (the + old function was previously located at + ``bridgedb.Bridges.parseORAddressLine``). + + The second patch replaces the new :class:`~bridgedb.parse.addr.PortList`, + with the :class:`older one <bridgedb.test.deprecated.PortList>` (which + was previously located at ``bridgedb.Bridges.PortList``). + + The third, forth, and fifth monkeypatches add some module-level attributes + back into :mod:`bridgedb.Bridges`. + + :rtype: :class:`~twisted.python.monkey.MonkeyPatcher` + :returns: A :class:`~twisted.python.monkey.MonkeyPatcher`, preloaded with + patches from :mod:`bridgedb.test.deprecated`. + """ + patcher = monkey.MonkeyPatcher() + patcher.addPatch(Tests.networkstatus, 'parseALine', + deprecated.parseORAddressLine) + patcher.addPatch(Tests.addr, 'PortList', deprecated.PortList) + patcher.addPatch(Tests.bridgedb.Bridges, 'PORTSPEC_LEN', 16) + patcher.addPatch(Tests.bridgedb.Bridges, 're_ipv4', deprecated.re_ipv4) + patcher.addPatch(Tests.bridgedb.Bridges, 're_ipv6', deprecated.re_ipv6) + return patcher + class OldUnittests(unittest.TestCase): """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial`

1 0

[bridgedb/master] Add test_Tests.generateTrialAdaptedDoctestsSuite().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit f405105fe5a60fac55f388d554a4f6ea8dea8a42 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 02:41:53 2013 +0000 Add test_Tests.generateTrialAdaptedDoctestsSuite(). This function discovers doctests within the directory that BridgeDB was installed within, and then it builds a `twisted.trial.unittest.TestSuite` from all discovered doctests. --- lib/bridgedb/test/test_Tests.py | 31 +++++++++++++++++++++++++++++++ 1 file changed, 31 insertions(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index f261168..b898cc4 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -16,7 +16,10 @@ be compatible with the newer :mod:`twisted.trial` unittests in this directory. from __future__ import print_function from __future__ import unicode_literals +import doctest +import glob import logging +import os import warnings from twisted.trial import unittest @@ -27,6 +30,34 @@ logging.warnings.filterwarnings('ignore', module="Tests") pyunit = __import__('unittest') +def generateTrialAdaptedDoctestsSuite(): + """Dynamically generates a :class:`unittest.TestSuite` all containing + discovered doctests within the installed ``bridgedb`` package. + """ + bridgedb = __import__('bridgedb') + fakedGlobals = globals().update({'bridgedb': bridgedb}) + modulePath = bridgedb.__path__[0] + + #: The package directories to search for source code with doctests. + packagePaths = [modulePath, + os.path.join(modulePath, 'parse'), + os.path.join(modulePath, 'test')] + #: The source code files which will be searched for doctests. + files = [] + #: The cls.testSuites which the test methods will be generated from. + testSuites = [] + + packages = [os.path.join(pkg, '*.py') for pkg in packagePaths] + [files.extend(glob.glob(pkg)) for pkg in packages] + + for filename in files: + testSuites.append( + doctest.DocFileSuite(filename, + module_relative=False, + globs=fakedGlobals)) + return testSuites + + class OldUnittests(unittest.TestCase): """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` compatible output.

1 0

[bridgedb/master] Rewrite test_Tests.OldUnittests to use DynamicTestCaseMeta.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 4d2335da6960979f553aab532001479d53fadcf9 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 03:25:22 2013 +0000 Rewrite test_Tests.OldUnittests to use DynamicTestCaseMeta. --- lib/bridgedb/test/test_Tests.py | 19 ++++++++++++++----- 1 file changed, 14 insertions(+), 5 deletions(-) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 4e383d5..d45d27a 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -192,10 +192,19 @@ class DynamicTestCaseMeta(type): class OldUnittests(unittest.TestCase): """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` compatible output. + + Generates a :class:`twisted.trial.unittest.TestCase` containing a + test for each of the individual tests in :mod:`bridgedb.Tests`. + + Each test in this :class:`~twisted.trial.unittest.TestCase`` is + dynamically generated from one of the old unittests in + :mod:`bridgedb.Tests`. Then, the class is wrapped to cause the results + reporting mechanisms to be :mod:`~twisted.trial` compatible. + + :returns: A :class:`twisted.trial.unittest.TestCase`. """ + __metaclass__ = DynamicTestCaseMeta + testSuites = Tests.testSuite() + testResult = unittest.PyUnitResultAdapter(pyunit.TestResult()) + methodPrefix = 'test_regressionsNewCode_' - def test_allOldUnittests(self): - testSuite = Tests.testSuite() - testResult = pyunit.TestResult() - testSuite.run(testResult, debug=True) - return unittest.PyUnitResultAdapter(testResult)

1 0

[bridgedb/master] Add test_Tests.TrialAdaptedDoctests class.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit fd4aa319c92651f37054e86a0a41db0699eb9010 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 03:28:20 2013 +0000 Add test_Tests.TrialAdaptedDoctests class. This class uses the dynamic doctest discovery mechanism, `test_Tests.generateTrialAdaptedDoctestSuite`, to run all discovered doctests. The generated methodnames in this `TestCase` correspond to location in the source code where the doctest was discovered. It also (somewhat) magically manages to print exception/failure tracebacks for failed doctests in a manner which is compatible with twisted.trial. The printed tracebacks will tell you: 1. Where the doctest is, and which line caused the exception. 2. What the expected result was supposed to be (according to the doctest), compared with what it actually was when the doctest code was run. --- lib/bridgedb/test/test_Tests.py | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 4afa0fd..514e90c 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -235,3 +235,15 @@ class MonkeypatchedOldUnittests(unittest.TestCase): def __init__(self, methodName='runWithPatches'): super(MonkeypatchedOldUnittests, self).__init__(methodName=methodName) + + +class TrialAdaptedDoctests(unittest.TestCase): + """Discovers and runs all doctests within the ``bridgedb`` package. + + Finds all doctests from the directory that BridgeDB was installed in, in + all Python modules and packages, and runs them with :mod:`twisted.trial`. + """ + __metaclass__ = DynamicTestCaseMeta + testSuites = generateTrialAdaptedDoctestsSuite() + testResult = unittest.PyUnitResultAdapter(pyunit.TestResult()) + methodPrefix = 'test_doctestsIn_'

1 0

[bridgedb/master] One tiny PEP8 fix in bridgedb.Tests.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 53ac738dc59032b97f9b9c012f63cc565a3802b2 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 03:42:12 2013 +0000 One tiny PEP8 fix in bridgedb.Tests. --- lib/bridgedb/Tests.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/Tests.py b/lib/bridgedb/Tests.py index 8e61454..90726cb 100644 --- a/lib/bridgedb/Tests.py +++ b/lib/bridgedb/Tests.py @@ -39,7 +39,8 @@ def suppressWarnings(): warnings.filterwarnings('ignore', '.*tmpnam.*') def randomIP(): - if random.choice(xrange(2)): return randomIP4() + if random.choice(xrange(2)): + return randomIP4() return randomIP6() def randomIP4():

1 0