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

[bridgedb/master] Fix docstring context for bridgedb.Dist.uniformMap().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 35bd1278cd600dd673d07ab8f1c0f3a2f0dc36fe Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 06:59:49 2013 +0000 Fix docstring context for bridgedb.Dist.uniformMap(). --- lib/bridgedb/Dist.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/lib/bridgedb/Dist.py b/lib/bridgedb/Dist.py index cd34dcb..706873f 100644 --- a/lib/bridgedb/Dist.py +++ b/lib/bridgedb/Dist.py @@ -24,7 +24,8 @@ def uniformMap(ip): """Map an IP to an arbitrary 'area' string, such that any two /24 addresses get the same string. - >>> uniformMap('1.2.3.4') + >>> from bridgedb import Dist + >>> Dist.uniformMap('1.2.3.4') '1.2.3' """ if type(IPAddress(ip)) is IPv6Address:

1 0

[bridgedb/master] Fix doctest for bridgedb.crypto.getKey().
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit c6ca47bb1acba136378b6ce4bea48636e103fcdf Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:02:31 2013 +0000 Fix doctest for bridgedb.crypto.getKey(). --- lib/bridgedb/crypto.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/lib/bridgedb/crypto.py b/lib/bridgedb/crypto.py index d67966d..6b16e49 100644 --- a/lib/bridgedb/crypto.py +++ b/lib/bridgedb/crypto.py @@ -25,15 +25,17 @@ def getKey(filename): If ``filename`` does not exist, create a new 32-byte key and store it in ``filename``. - >>> name = os.tmpnam() + >>> import os + >>> from bridgedb import crypto + >>> name = 'doctest_getKey' >>> os.path.exists(name) False - >>> k1 = getKey(name) + >>> k1 = crypto.getKey(name) >>> os.path.exists(name) True >>> open(name).read() == k1 True - >>> k2 = getKey(name) + >>> k2 = crypto.getKey(name) >>> k1 == k2 True

1 0

[bridgedb/master] Fix docs in test_Tests.py and deprecated.py to use :api: for twisted.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 53e72074e1ab59666e021b0b6166af89d862bc91 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:05:38 2013 +0000 Fix docs in test_Tests.py and deprecated.py to use :api: for twisted. --- lib/bridgedb/test/deprecated.py | 4 ++-- lib/bridgedb/test/test_Tests.py | 45 +++++++++++++++++++-------------------- 2 files changed, 24 insertions(+), 25 deletions(-) diff --git a/lib/bridgedb/test/deprecated.py b/lib/bridgedb/test/deprecated.py index 93f28ba..8238b53 100644 --- a/lib/bridgedb/test/deprecated.py +++ b/lib/bridgedb/test/deprecated.py @@ -57,7 +57,7 @@ def parseORAddressLine(line): bridgedb-0.1.0, in commit 1f111e5. This function and the newer parsers from :mod:`bridgedb.parse.netstatus` - are alternately :meth:`~twisted.python.monkey.MonkeyPatcher.patch`ed into + are alternately :api:`~twisted.python.monkey.MonkeyPatcher.patch`ed into the :mod:`old unittests <bridgedb.Tests>`, so that the later functions as a suite of regression tests. """ @@ -98,7 +98,7 @@ class PortList: :class:`bridgedb.parse.addr.PortList`. This class and the newer class from :mod:`bridgedb.parse.addr` are - alternately :meth:`~twisted.python.monkey.MonkeyPatcher.patch`ed into the + alternately :api:`~twisted.python.monkey.MonkeyPatcher.patch`ed into the :mod:`old unittests <bridgedb.Tests>`, so that the later functions as a suite of regression tests. """ diff --git a/lib/bridgedb/test/test_Tests.py b/lib/bridgedb/test/test_Tests.py index 4cd834f..99295d6 100644 --- a/lib/bridgedb/test/test_Tests.py +++ b/lib/bridgedb/test/test_Tests.py @@ -10,7 +10,7 @@ # :license: 3-Clause BSD, see LICENSE for licensing information """Class wrappers to adapt BridgeDB old unittests in :mod:`bridgedb.Tests` to -be compatible with the newer :mod:`twisted.trial` unittests in this directory. +be compatible with the newer :api:`twisted.trial` unittests in this directory. """ from __future__ import print_function @@ -77,8 +77,8 @@ def monkeypatchTests(): 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 + :rtype: :api:`~twisted.python.monkey.MonkeyPatcher` + :returns: A :api:`~twisted.python.monkey.MonkeyPatcher`, preloaded with patches from :mod:`bridgedb.test.deprecated`. """ patcher = monkey.MonkeyPatcher() @@ -97,14 +97,14 @@ class DynamicTestCaseMeta(type): warez… beware! Be afraid; be very afraid. :ivar testResult: An :class:`unittest.TestResult` adapted with - :class:`twisted.trial.unittest.PyUnitResultAdapter`, for + :api:`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). + :mod:`doctest` or :api:`twisted.trial` equivalents). :ivar methodPrefix: A string to prefix the generated method names with. (default: 'test_') """ @@ -113,8 +113,7 @@ class DynamicTestCaseMeta(type): def __new__(cls, name, bases, attrs): """Construct the initialiser for a new - :class:`twisted.trial.unittest.TestCase`. - + :api:`twisted.trial.unittest.TestCase`. """ logging.debug("Metaclass __new__ constructor called for %r" % name) @@ -137,10 +136,10 @@ class DynamicTestCaseMeta(type): @classmethod def generateTestMethods(cls, testSuites, methodPrefix='test_'): """Dynamically generate methods and their names for a - :class:`twisted.trial.unittest.TestCase`. + :api:`twisted.trial.unittest.TestCase`. :param list testSuites: A list of :class:`unittest.TestSuite`s (or - their :mod:`doctest` or :mod:`twisted.trial` + their :mod:`doctest` or :api:`twisted.trial` equivalents). :param str methodPrefix: A string to prefix the generated method names with. (default: 'test_') @@ -157,7 +156,7 @@ class DynamicTestCaseMeta(type): 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`. + :api:`~twisted.trial.unittest.TestCase`. """ # Get the number of failures before test.run(): origFails = len(cls.testResult.original.failures) @@ -190,18 +189,18 @@ class DynamicTestCaseMeta(type): class OldUnittests(unittest.TestCase): - """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` + """A wrapper around :mod:`bridgedb.Tests` to produce :api:`~twisted.trial` compatible output. - Generates a :class:`twisted.trial.unittest.TestCase` containing a + Generates a :api:`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. + Each test in this :api:`~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 + :api:`~twisted.trial` compatible. - :returns: A :class:`twisted.trial.unittest.TestCase`. + :returns: A :api:`twisted.trial.unittest.TestCase`. """ __metaclass__ = DynamicTestCaseMeta testSuites = Tests.testSuite() @@ -210,14 +209,14 @@ class OldUnittests(unittest.TestCase): class MonkeypatchedOldUnittests(unittest.TestCase): - """A wrapper around :mod:`bridgedb.Tests` to produce :mod:`~twisted.trial` + """A wrapper around :mod:`bridgedb.Tests` to produce :api:`~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. + are :api:`twisted.python.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() @@ -226,7 +225,7 @@ class MonkeypatchedOldUnittests(unittest.TestCase): patcher = monkeypatchTests() def runWithPatches(self, *args): - """Replaces :meth:`~twisted.trial.unittest.TestCase.run` as the default + """Replaces :api:`~twisted.trial.unittest.TestCase.run` as the default methodName to run. This method calls ``run()`` though ``self.patcher.runWithPatches``, using the class **testResult** object. """ @@ -241,7 +240,7 @@ 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`. + all Python modules and packages, and runs them with :api:`twisted.trial`. """ __metaclass__ = DynamicTestCaseMeta testSuites = generateTrialAdaptedDoctestsSuite()

1 0

[bridgedb/master] Removed doctest from bridgedb.test.ParseNetworkStatusRLineTests.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit f24240f4ad72d1c9df5a52aa82fd9e28965ede65 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:03:22 2013 +0000 Removed doctest from bridgedb.test.ParseNetworkStatusRLineTests. --- lib/bridgedb/test/test_parse_networkstatus.py | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/lib/bridgedb/test/test_parse_networkstatus.py b/lib/bridgedb/test/test_parse_networkstatus.py index 6d78d41..46bd90d 100644 --- a/lib/bridgedb/test/test_parse_networkstatus.py +++ b/lib/bridgedb/test/test_parse_networkstatus.py @@ -74,15 +74,10 @@ class ParseNetworkStatusRLineTests(unittest.TestCase): """Concatenate parameters into an 'r'-line and store the result as ``self.line``. - To create an invalid networkstatus 'r'-line, for example with an - invalid IP address, use me like this: - - >>> makeRLine(ip='0.0.0.0') - :keywords: The keyword arguments may be any of the class variables, - i.e. 'nick' or 'ident', and the variables should be similar to the - defaults in the class variables. If not given as parameters, the - class variables will be used. + i.e. 'nick' or 'ident', and the variables should be similar + to the defaults in the class variables. If not given as + parameters, the class variables will be used. """ line = [] for kw in ('pre', 'nick', 'ident', 'desc', 'ts', 'ip', 'port', 'dirp'):

1 0

[bridgedb/master] Skip doctest in bridgedb.test.util; cannot make doctest classes.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 98c37c2f25831466f644f8b836293cf3c4c672ca Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:04:06 2013 +0000 Skip doctest in bridgedb.test.util; cannot make doctest classes. --- lib/bridgedb/test/util.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/test/util.py b/lib/bridgedb/test/util.py index a09c0d1..a8c6903 100644 --- a/lib/bridgedb/test/util.py +++ b/lib/bridgedb/test/util.py @@ -23,7 +23,7 @@ from functools import wraps def fileCheckDecorator(func): """Method decorator for a t.t.unittest.TestCase test_* method. - >>> import shutil + >>> import shutil # doctest: +SKIP >>> from twisted.trial import unittest >>> pyunit = __import__('unittest') >>> class TestTests(unittest.TestCase): @@ -43,7 +43,7 @@ def fileCheckDecorator(func): :type func: callable :param func: The ``test_*`` method, from a - :api:`twisted.trial.unittest.TestCase` instance, to wrap. + :api:`twisted.trial.unittest.TestCase` instance, to wrap. """ @wraps(func) def wrapper(self, src, dst, description):

1 0

[bridgedb/master] Change str → basestring in lib/bridgedb/test/test_persistent.py unittest.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 393dc0545f3ef22ec71f4012ead384f80a719072 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:36:06 2013 +0000 Change str → basestring in lib/bridgedb/test/test_persistent.py unittest. --- lib/bridgedb/test/test_persistent.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/lib/bridgedb/test/test_persistent.py b/lib/bridgedb/test/test_persistent.py index c3c89ef..95abf61 100644 --- a/lib/bridgedb/test/test_persistent.py +++ b/lib/bridgedb/test/test_persistent.py @@ -142,8 +142,8 @@ class StateTest(unittest.TestCase): setattr(thatConfig, 'BAR', 'all of the things') setattr(thatConfig, 'LOGFILE', 42) - this(thatConfig).should.have.property('FOO').being.a(str) - this(thatConfig).should.have.property('BAR').being.a(str) + this(thatConfig).should.have.property('FOO').being.a(basestring) + this(thatConfig).should.have.property('BAR').being.a(basestring) this(thatConfig).should.have.property('LOGFILE').being.an(int) this(thatConfig).should.have.property('BRIDGE_FILES').being.a(list) @@ -156,8 +156,8 @@ class StateTest(unittest.TestCase): thatState.useChangedSettings(thatConfig) the(thatState.FOO).should.equal('fuuuuu') - the(thatState).should.have.property('FOO').being.a(str) - the(thatState).should.have.property('BAR').being.a(str) + the(thatState).should.have.property('FOO').being.a(basestring) + the(thatState).should.have.property('BAR').being.a(basestring) the(thatState).should.have.property('LOGFILE').being.an(int) the(thatState.FOO).must.equal(thatConfig.FOO) the(thatState.BAR).must.equal(thatConfig.BAR)

1 0

[bridgedb/master] Turn doctest we skip in bridgedb.test.util into a Sphinx codeblock.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 496bd0feacf5a2d426790fb3c386a1208dc43e3a Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:34:51 2013 +0000 Turn doctest we skip in bridgedb.test.util into a Sphinx codeblock. It was still failing. --- lib/bridgedb/test/util.py | 40 +++++++++++++++++++++++----------------- 1 file changed, 23 insertions(+), 17 deletions(-) diff --git a/lib/bridgedb/test/util.py b/lib/bridgedb/test/util.py index a8c6903..a012597 100644 --- a/lib/bridgedb/test/util.py +++ b/lib/bridgedb/test/util.py @@ -23,23 +23,29 @@ from functools import wraps def fileCheckDecorator(func): """Method decorator for a t.t.unittest.TestCase test_* method. - >>> import shutil # doctest: +SKIP - >>> from twisted.trial import unittest - >>> pyunit = __import__('unittest') - >>> class TestTests(unittest.TestCase): - ... @fileCheckDecorator - ... def doCopyFile(src, dst, description=None): - ... shutil.copy(src, dst) - ... def test_doCopyFile(self): - ... srcfile = self.mktemp() - ... dstfile = self.mktemp() - ... with open(srcfile, 'wb') as fh: - ... fh.write('testing TestCase method decorator utility') - ... fh.flush() - ... self.doCopyFile(srcfile, dstfile, 'asparagus') - ... - >>> testtest = TestTests() - >>> testtest.runTest() + .. codeblock:: python + + import shutil + from twisted.trial import unittest + + pyunit = __import__('unittest') + + class TestTests(unittest.TestCase): + @fileCheckDecorator + def doCopyFile(src, dst, description=None): + shutil.copy(src, dst) + def test_doCopyFile(self): + srcfile = self.mktemp() + dstfile = self.mktemp() + with open(srcfile, 'wb') as fh: + fh.write('testing TestCase method decorator utility') + fh.flush() + self.doCopyFile(srcfile, dstfile, 'asparagus') + + testtest = TestTests() + testtest.runTest() + + .. :type func: callable :param func: The ``test_*`` method, from a

1 0

[bridgedb/master] Add Sphinx param docs for bridgedb.Time.IntervalSchedule.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit a6d40e72bcec2b9778e5a9810878c80d50a128cc Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:01:56 2013 +0000 Add Sphinx param docs for bridgedb.Time.IntervalSchedule. --- lib/bridgedb/Time.py | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/lib/bridgedb/Time.py b/lib/bridgedb/Time.py index 57ba69f..794db9d 100644 --- a/lib/bridgedb/Time.py +++ b/lib/bridgedb/Time.py @@ -65,8 +65,8 @@ class IntervalSchedule(Schedule): assert False def getInterval(self, when): - """Return a string representing the interval that contains - the time 'when'. + """Return a string representing the interval that contains the time + **when**. >>> import calendar >>> from bridgedb.Time import IntervalSchedule @@ -74,6 +74,14 @@ class IntervalSchedule(Schedule): >>> I = IntervalSchedule('month', 1) >>> I.getInterval(t) '2007-12' + + :param int when: The time which we're trying to find the corresponding + interval for. + :rtype: str + :returns: A timestamp in the form ``YEAR-MONTH[-DAY[-HOUR]]``. It's + specificity depends on what type of interval we're + using. For example, if using ``"month"``, the return value + would be something like ``"2013-12"``. """ if self.itype == 'month': tm = time.gmtime(when)

1 0

[bridgedb/master] Small .travis.yml changes to reports, coverage runs, and geoip deps.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 4b2c7d3ec6039c9f089108d8712d5e8ef192c9b0 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:40:56 2013 +0000 Small .travis.yml changes to reports, coverage runs, and geoip deps. --- .travis.yml | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index fca67cf..c9eabc2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -9,18 +9,17 @@ notifications: #use_notice: true template: - "%{repository}#%{build_number} (%{branch} - %{commit} : %{author}): %{message}" - #- "Change view : %{compare_url}" - "Build details : %{build_url}" email: recipients: - isis(a)torproject.org - on_success: change + on_success: never on_failure: change before_install: - sudo apt-get update # Distro development header/library/resource/buildtime dependencies - - sudo apt-get install --no-install-suggests --no-install-recommends tor-geoipdb build-essential openssl sqlite3 libgpgme11 libgpgme11-dev + - sudo apt-get install --no-install-suggests --no-install-recommends build-essential openssl sqlite3 libgpgme11 libgpgme11-dev libgeoip-dev geoip-database # Distro python dependencies - sudo apt-get install --no-install-suggests --no-install-recommends python-dev python-setuptools @@ -44,9 +43,8 @@ script: - bridgedb mock -n 250 # Normally, we would do 'bridgedb test' here, but to run with coverage we # have to do this instead: - - coverage run $(which trial) ./lib/bridgedb/test/test_* + - coverage run $(which trial) ./lib/bridgedb/test/test_*.py - coverage report - - echo "Build successful." after_success: - coveralls

1 0

[bridgedb/master] Ignore doc/coverage-html directory.
by isis＠torproject.org 12 Jan '14

12 Jan '14

commit 8aa69a024f77310aff8943fa636c3e9161e29d29 Author: Isis Lovecruft <isis(a)torproject.org> Date: Fri Dec 20 07:37:14 2013 +0000 Ignore doc/coverage-html directory. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 6cd8738..de658ec 100644 --- a/.gitignore +++ b/.gitignore @@ -29,6 +29,7 @@ installed-files.txt .tox *.prof nosetests.xml +doc/coverage-html/* # Translations *.mo

1 0