May 2017 - tor-commits - lists.torproject.org

[tor-browser/tor-browser-52.1.1esr-7.0-1] fixup! TB4: Tor Browser's Firefox preference overrides.
by gk＠torproject.org 29 May '17

29 May '17

commit 29b34b444229fd09fcf7741a206230385e843fde Author: Georg Koppen <gk(a)torproject.org> Date: Mon May 29 09:10:13 2017 +0000 fixup! TB4: Tor Browser's Firefox preference overrides. Fixes bug 21323. We are using Mixed Content Blocking now in Tor Browser as the advantages of doing so seem to outweigh the downsides. --- browser/app/profile/000-tor-browser.js | 1 - 1 file changed, 1 deletion(-) diff --git a/browser/app/profile/000-tor-browser.js b/browser/app/profile/000-tor-browser.js index 78e6a05..d2fb5e5 100644 --- a/browser/app/profile/000-tor-browser.js +++ b/browser/app/profile/000-tor-browser.js @@ -100,7 +100,6 @@ pref("experiments.enabled", false); // Disable the UITour backend so there is no chance that a remote page // can use it to confuse Tor Browser users. pref("browser.uitour.enabled", false); -pref("security.mixed_content.block_active_content", false); // Disable until https://bugzilla.mozilla.org/show_bug.cgi?id=878890 is patched pref("browser.syncPromoViewsLeftMap", "{\"addons\":0, \"passwords\":0, \"bookmarks\":0}"); // Don't promote sync pref("services.sync.engine.prefs", false); // Never sync prefs, addons, or tabs with other browsers pref("services.sync.engine.addons", false);

1 0

[tor-browser/tor-browser-52.1.1esr-7.0-1] fixup! Bug 5282: Randomize HTTP request order and pipeline depth.
by gk＠torproject.org 29 May '17

29 May '17

commit e404251e7a4e86981a33be035e7fdb0b7ed42c3b Author: Arthur Edelstein <arthuredelstein(a)gmail.com> Date: Sat May 27 00:22:17 2017 -0700 fixup! Bug 5282: Randomize HTTP request order and pipeline depth. Use format specifiers for unsigned long integers. --- netwerk/protocol/http/nsHttpPipeline.cpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/netwerk/protocol/http/nsHttpPipeline.cpp b/netwerk/protocol/http/nsHttpPipeline.cpp index 207c55b..6735c55 100644 --- a/netwerk/protocol/http/nsHttpPipeline.cpp +++ b/netwerk/protocol/http/nsHttpPipeline.cpp @@ -16,6 +16,10 @@ #include <algorithm> #include "nsHttpRequestHead.h" +#ifdef WTF_TEST +#include <inttypes.h> +#endif + #ifdef DEBUG #include "prthread.h" #endif @@ -965,7 +969,9 @@ nsHttpPipeline::FillSendBuf() #ifdef WTF_TEST if (totalSent) - fprintf(stderr, "WTF-combine: Sent %lld/%lld bytes of %lld combined pipelined requests for host %s\n", + fprintf(stderr, + "WTF-combine: Sent %" PRIu64 "/%" PRIu64 " bytes of %" PRIu64 + " combined pipelined requests for host %s\n", alreadyPending+totalSent, totalAvailable, reqsSent, ci->Origin()); #endif

1 0

[tor-browser/tor-browser-52.1.0esr-7.0-2] fixup! Bug 5282: Randomize HTTP request order and pipeline depth.
by gk＠torproject.org 29 May '17

29 May '17

commit 7aa5a5c8565273ea41a0c003160226f3229373f6 Author: Arthur Edelstein <arthuredelstein(a)gmail.com> Date: Sat May 27 00:22:17 2017 -0700 fixup! Bug 5282: Randomize HTTP request order and pipeline depth. Use format specifiers for unsigned long integers. --- netwerk/protocol/http/nsHttpPipeline.cpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/netwerk/protocol/http/nsHttpPipeline.cpp b/netwerk/protocol/http/nsHttpPipeline.cpp index 207c55b..6735c55 100644 --- a/netwerk/protocol/http/nsHttpPipeline.cpp +++ b/netwerk/protocol/http/nsHttpPipeline.cpp @@ -16,6 +16,10 @@ #include <algorithm> #include "nsHttpRequestHead.h" +#ifdef WTF_TEST +#include <inttypes.h> +#endif + #ifdef DEBUG #include "prthread.h" #endif @@ -965,7 +969,9 @@ nsHttpPipeline::FillSendBuf() #ifdef WTF_TEST if (totalSent) - fprintf(stderr, "WTF-combine: Sent %lld/%lld bytes of %lld combined pipelined requests for host %s\n", + fprintf(stderr, + "WTF-combine: Sent %" PRIu64 "/%" PRIu64 " bytes of %" PRIu64 + " combined pipelined requests for host %s\n", alreadyPending+totalSent, totalAvailable, reqsSent, ci->Origin()); #endif

1 0

[tor-browser/tor-browser-52.1.0esr-7.0-2] Bug 21684: Don't expose navigator.AddonManager to content
by gk＠torproject.org 29 May '17

29 May '17

commit e5da14c4ae6e3917928b3004bca7bd49e972089e Author: Georg Koppen <gk(a)torproject.org> Date: Fri May 26 19:18:32 2017 +0000 Bug 21684: Don't expose navigator.AddonManager to content With https://bugzilla.mozilla.org/show_bug.cgi?id=1245571 support for websites to learn about installed add-ons landed. Currently, this is only enabled for AMO related sites but we don't think this functionality is something we want for Tor Browser as it might aid in fingerprinting users. The patch does not outright disable access to the API. Privileged code is still able to use it if needed. This should help with usability issues should they arise while mitigating possible fingerprinting and security problems by having this API available to content. This fixes bug 21684 by deleting the whitelist of URLs shipped with Firefox 52. --- toolkit/mozapps/extensions/AddonManagerWebAPI.cpp | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp b/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp index ca33f3a..45326fd 100644 --- a/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp +++ b/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp @@ -20,25 +20,10 @@ using namespace mozilla::dom; static bool IsValidHost(const nsACString& host) { - if (host.Equals("addons.mozilla.org") || - host.Equals("discovery.addons.mozilla.org") || - host.Equals("testpilot.firefox.com")) { - return true; - } - - // When testing allow access to the developer sites. - if (Preferences::GetBool("extensions.webapi.testing", false)) { - if (host.LowerCaseEqualsLiteral("addons.allizom.org") || - host.LowerCaseEqualsLiteral("discovery.addons.allizom.org") || - host.LowerCaseEqualsLiteral("addons-dev.allizom.org") || - host.LowerCaseEqualsLiteral("discovery.addons-dev.allizom.org") || - host.LowerCaseEqualsLiteral("testpilot.stage.mozaws.net") || - host.LowerCaseEqualsLiteral("testpilot.dev.mozaws.net") || - host.LowerCaseEqualsLiteral("example.com")) { - return true; - } - } - + // We don't want to allow content to get information about the state of the + // extensions a user has installed. This might aid in fingerprinting. And + // allowing content at all access to this kind of information seems + // potentially risky from a security point as well. Fixes bug 21684. return false; }

1 0

[tor-browser/tor-browser-52.1.1esr-7.0-1] Bug 21684: Don't expose navigator.AddonManager to content
by gk＠torproject.org 29 May '17

29 May '17

commit 9de9d5a74472423e5a7e5754f5d93b2d89103dfe Author: Georg Koppen <gk(a)torproject.org> Date: Fri May 26 19:18:32 2017 +0000 Bug 21684: Don't expose navigator.AddonManager to content With https://bugzilla.mozilla.org/show_bug.cgi?id=1245571 support for websites to learn about installed add-ons landed. Currently, this is only enabled for AMO related sites but we don't think this functionality is something we want for Tor Browser as it might aid in fingerprinting users. The patch does not outright disable access to the API. Privileged code is still able to use it if needed. This should help with usability issues should they arise while mitigating possible fingerprinting and security problems by having this API available to content. This fixes bug 21684 by deleting the whitelist of URLs shipped with Firefox 52. --- toolkit/mozapps/extensions/AddonManagerWebAPI.cpp | 23 ++++------------------- 1 file changed, 4 insertions(+), 19 deletions(-) diff --git a/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp b/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp index ca33f3a..45326fd 100644 --- a/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp +++ b/toolkit/mozapps/extensions/AddonManagerWebAPI.cpp @@ -20,25 +20,10 @@ using namespace mozilla::dom; static bool IsValidHost(const nsACString& host) { - if (host.Equals("addons.mozilla.org") || - host.Equals("discovery.addons.mozilla.org") || - host.Equals("testpilot.firefox.com")) { - return true; - } - - // When testing allow access to the developer sites. - if (Preferences::GetBool("extensions.webapi.testing", false)) { - if (host.LowerCaseEqualsLiteral("addons.allizom.org") || - host.LowerCaseEqualsLiteral("discovery.addons.allizom.org") || - host.LowerCaseEqualsLiteral("addons-dev.allizom.org") || - host.LowerCaseEqualsLiteral("discovery.addons-dev.allizom.org") || - host.LowerCaseEqualsLiteral("testpilot.stage.mozaws.net") || - host.LowerCaseEqualsLiteral("testpilot.dev.mozaws.net") || - host.LowerCaseEqualsLiteral("example.com")) { - return true; - } - } - + // We don't want to allow content to get information about the state of the + // extensions a user has installed. This might aid in fingerprinting. And + // allowing content at all access to this kind of information seems + // potentially risky from a security point as well. Fixes bug 21684. return false; }

1 0

[stem/master] Testing failed for higher python3 versions
by atagar＠torproject.org 28 May '17

28 May '17

commit 9df8c1214b572431b2ea08681931f6dcaa6dac05 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 28 14:49:25 2017 -0700 Testing failed for higher python3 versions When testing with python 3.6 our tests fail to run at all with... module 'unittest' has no attribute '__version__' With python 3.2 __import__ worked as we expected but in 3.6 running "__import__('unittest.mock')" provides the top unittest module rather than mock. Turns out the __import__ help info asks callers to never use it, and use importlib instead. Swapping over fixes this, and is still compatible with python 2.7. --- test/task.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/test/task.py b/test/task.py index 048eade..cff4c72 100644 --- a/test/task.py +++ b/test/task.py @@ -21,6 +21,7 @@ +- PYCODESTYLE_TASK - style checks """ +import importlib import os import re import sys @@ -199,7 +200,7 @@ class ModuleVersion(Task): if prereq_check is None or prereq_check(): for module in modules: if stem.util.test_tools._module_exists(module): - return __import__(module).__version__ + return importlib.import_module(module).__version__ return 'missing'

1 0

[stem/master] Simplify static test check tasks
by atagar＠torproject.org 28 May '17

28 May '17

commit 3feb659a72badec309253a6e5d77ab2444d68575 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 28 14:29:16 2017 -0700 Simplify static test check tasks Just about to add mypy as our third static check so good time to simplify how we do these so it slips right in. --- run_tests.py | 41 +++++++++++------------------------------ stem/util/test_tools.py | 19 ++++++++++--------- test/task.py | 32 ++++++++++++++++++++++++-------- 3 files changed, 45 insertions(+), 47 deletions(-) diff --git a/run_tests.py b/run_tests.py index 2bb75fc..8cb1404 100755 --- a/run_tests.py +++ b/run_tests.py @@ -149,7 +149,6 @@ def get_torrc_entries(target): def main(): start_time = time.time() - try: stem.prereq.check_requirements() except ImportError as exc: @@ -161,6 +160,7 @@ def main(): try: args = test.arguments.parse(sys.argv[1:]) + test.task.TOR_VERSION.args = (args.tor_path,) except ValueError as exc: println(str(exc)) sys.exit(1) @@ -193,23 +193,10 @@ def main(): sys.exit(1) - tor_version_check, pyflakes_task, pycodestyle_task = None, None, None - - if not args.specific_test: - if stem.util.test_tools.is_pyflakes_available(): - pyflakes_task = test.task.PYFLAKES_TASK - - if stem.util.test_tools.is_pycodestyle_available(): - pycodestyle_task = test.task.PYCODESTYLE_TASK - - if args.run_integ: - tor_version_check = test.task.TOR_VERSION - tor_version_check.args = (args.tor_path,) - test.task.run( 'INITIALISING', test.task.STEM_VERSION, - tor_version_check, + test.task.TOR_VERSION if args.run_integ else None, test.task.PYTHON_VERSION, test.task.CRYPTO_VERSION, test.task.PYNACL_VERSION, @@ -218,8 +205,8 @@ def main(): test.task.PYCODESTYLE_VERSION, test.task.CLEAN_PYC, test.task.UNUSED_TESTS, - pyflakes_task, - pycodestyle_task, + test.task.PYFLAKES_TASK if not args.specific_test else None, + test.task.PYCODESTYLE_TASK if not args.specific_test else None, ) # buffer that we log messages into so they can be printed after a test has finished @@ -339,19 +326,13 @@ def main(): static_check_issues = {} - if pyflakes_task and pyflakes_task.is_successful: - for path, issues in pyflakes_task.result.items(): - for issue in issues: - static_check_issues.setdefault(path, []).append(issue) - elif not stem.util.test_tools.is_pyflakes_available(): - println('Static error checking requires pyflakes version 0.7.3 or later. Please install it from ...\n http://pypi.python.org/pypi/pyflakes\n', ERROR) - - if pycodestyle_task and pycodestyle_task.is_successful: - for path, issues in pycodestyle_task.result.items(): - for issue in issues: - static_check_issues.setdefault(path, []).append(issue) - elif not stem.util.test_tools.is_pycodestyle_available(): - println('Style checks require pycodestyle version 1.4.2 or later. Please install it from...\n http://pypi.python.org/pypi/pycodestyle\n', ERROR) + for task in (test.task.PYFLAKES_TASK, test.task.PYCODESTYLE_TASK): + if task and task.is_successful: + for path, issues in task.result.items(): + for issue in issues: + static_check_issues.setdefault(path, []).append(issue) + elif not task.is_available and task.unavailable_msg: + println(task.unavailable_msg, ERROR) _print_static_issues(static_check_issues) diff --git a/stem/util/test_tools.py b/stem/util/test_tools.py index 51ac244..6964572 100644 --- a/stem/util/test_tools.py +++ b/stem/util/test_tools.py @@ -4,20 +4,28 @@ """ Helper functions for testing. +Our **stylistic_issues**, **pyflakes_issues**, and **type_check_issues** +respect a 'exclude_paths' in our test config, excluding any absolute paths +matching those regexes. Issue strings can start or end with an asterisk +to match just against the prefix or suffix. For instance... + +:: + + exclude_paths .*/stem/test/data/.* + .. versionadded:: 1.2.0 :: TimedTestRunner - test runner that tracks test runtimes test_runtimes - provides runtime of tests excuted through TimedTestRunners - clean_orphaned_pyc - delete *.pyc files without corresponding *.py is_pyflakes_available - checks if pyflakes is available is_pycodestyle_available - checks if pycodestyle is available - stylistic_issues - checks for PEP8 and other stylistic issues pyflakes_issues - static checks for problems via pyflakes + stylistic_issues - checks for PEP8 and other stylistic issues """ import collections @@ -218,9 +226,6 @@ def stylistic_issues(paths, check_newlines = False, check_exception_keyword = Fa issues = stylistic_issues('my_project') - If a 'exclude_paths' was set in our test config then we exclude any absolute - paths matching those regexes. - .. versionchanged:: 1.3.0 Renamed from get_stylistic_issues() to stylistic_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. @@ -345,10 +350,6 @@ def pyflakes_issues(paths): pyflakes.ignore stem/util/test_tools.py => 'pyflakes' imported but unused pyflakes.ignore stem/util/test_tools.py => 'pycodestyle' imported but unused - If a 'exclude_paths' was set in our test config then we exclude any absolute - paths matching those regexes. Issue strings can start or end with an asterisk - to match just against the prefix or suffix. - .. versionchanged:: 1.3.0 Renamed from get_pyflakes_issues() to pyflakes_issues(). The old name still works as an alias, but will be dropped in Stem version 2.0.0. diff --git a/test/task.py b/test/task.py index 1089cba..048eade 100644 --- a/test/task.py +++ b/test/task.py @@ -55,6 +55,9 @@ SRC_PATHS = [os.path.join(test.STEM_BASE, path) for path in ( os.path.join('docs', 'roles.py'), )] +PYFLAKES_UNAVAILABLE = 'Static error checking requires pyflakes version 0.7.3 or later. Please install it from ...\n http://pypi.python.org/pypi/pyflakes\n' +PYCODESTYLE_UNAVAILABLE = 'Style checks require pycodestyle version 1.4.2 or later. Please install it from...\n http://pypi.python.org/pypi/pycodestyle\n' + def _check_tor_version(tor_path): return str(test.tor_version(tor_path)).split()[0] @@ -203,6 +206,21 @@ class ModuleVersion(Task): super(ModuleVersion, self).__init__(label, version_check) +class StaticCheckTask(Task): + def __init__(self, label, runner, args = None, is_available = None, unavailable_msg = None): + super(StaticCheckTask, self).__init__(label, runner, args, is_required = False, print_result = False, print_runtime = True) + self.is_available = is_available + self.unavailable_msg = unavailable_msg + + def run(self): + if self.is_available: + return super(StaticCheckTask, self).run() + else: + println(' %s...' % self.label, STATUS, NO_NL) + println(' ' * (50 - len(self.label)), NO_NL) + println('unavailable', STATUS) + + STEM_VERSION = Task('checking stem version', lambda: stem.__version__) TOR_VERSION = Task('checking tor version', _check_tor_version) PYTHON_VERSION = Task('checking python version', lambda: '.'.join(map(str, sys.version_info[:3]))) @@ -218,20 +236,18 @@ UNUSED_TESTS = Task('checking for unused tests', _check_for_unused_tests, [( os.path.join(test.STEM_BASE, 'test', 'integ'), )]) -PYFLAKES_TASK = Task( +PYFLAKES_TASK = StaticCheckTask( 'running pyflakes', stem.util.test_tools.pyflakes_issues, args = (SRC_PATHS,), - is_required = False, - print_result = False, - print_runtime = True, + is_available = stem.util.test_tools.is_pyflakes_available(), + unavailable_msg = PYFLAKES_UNAVAILABLE, ) -PYCODESTYLE_TASK = Task( +PYCODESTYLE_TASK = StaticCheckTask( 'running pycodestyle', stem.util.test_tools.stylistic_issues, args = (SRC_PATHS, True, True, True), - is_required = False, - print_result = False, - print_runtime = True, + is_available = stem.util.test_tools.is_pycodestyle_available(), + unavailable_msg = PYCODESTYLE_UNAVAILABLE, )

1 0

[stem/master] With python3 map can't be indexed into
by atagar＠torproject.org 28 May '17

28 May '17

commit 0126c95718faba2a0a9d701fc225e40ced463680 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 28 16:03:21 2017 -0700 With python3 map can't be indexed into With python 3.2 it's fine but our integ tests fail under 3.6 with... ====================================================================== ERROR: test_install ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/atagar/Desktop/stem/test/require.py", line 43, in wrapped return func(self, *args, **kwargs) File "/home/atagar/Desktop/stem/test/integ/installation.py", line 118, in test_install self.assertEqual(stem.__version__, stem.util.system.call([PYTHON_EXE, '-c', "import sys;sys.path.insert(0, '%s');import stem;print(stem.__version__)" % INSTALL_PATH])[0]) File "/home/atagar/Desktop/stem/stem/util/system.py", line 1083, in call is_shell_command = command_list[0] in SHELL_COMMANDS TypeError: 'map' object is not subscriptable --- stem/util/system.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stem/util/system.py b/stem/util/system.py index 9f85304..69ec979 100644 --- a/stem/util/system.py +++ b/stem/util/system.py @@ -1074,7 +1074,7 @@ def call(command, default = UNDEFINED, ignore_exit_status = False, timeout = Non if isinstance(command, str): command_list = command.split(' ') else: - command_list = map(str, command) + command_list = list(map(str, command)) exit_status, runtime, stdout, stderr = None, None, None, None start_time = time.time()

1 0

[stem/master] Unit tests failed if bz2 unavailable
by atagar＠torproject.org 28 May '17

28 May '17

commit 6a66ccc33057634137211f0d3f57decf2b4199f3 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 28 15:25:30 2017 -0700 Unit tests failed if bz2 unavailable Python has bz2 built in but when python's compiled it omits bz2 by default. This causes our tests to fail with... ====================================================================== FAIL: test_archived_bz2 ---------------------------------------------------------------------- Traceback (most recent call last): File "/home/atagar/Desktop/stem/test/unit/descriptor/reader.py", line 404, in test_archived_bz2 self.assertEqual(expected_results, read_descriptors) AssertionError: Lists differ: ['router Amunet1 199.48.147.35 443 0 80\np[7520 chars]-\n'] != [] First list contains 3 additional elements. First extra element 0: 'router Amunet1 199.48.147.35 443 0 80\nplatform Tor 0.2.2.34 (git-f0e1ee98af443107) on Linux x86_64... Diff is 9261 characters long. Set self.maxDiff to None to see it. ---------------------------------------------------------------------- Ran 27 tests in 0.115s --- test/settings.cfg | 1 + test/unit/descriptor/reader.py | 7 +++++++ 2 files changed, 8 insertions(+) diff --git a/test/settings.cfg b/test/settings.cfg index b65ee37..5740f1b 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -160,6 +160,7 @@ pyflakes.ignore stem/interpreter/__init__.py => undefined name 'raw_input' pyflakes.ignore stem/util/conf.py => undefined name 'unicode' pyflakes.ignore stem/util/test_tools.py => 'pyflakes' imported but unused pyflakes.ignore stem/util/test_tools.py => 'pycodestyle' imported but unused +pyflakes.ignore test/unit/descriptor/reader.py => 'bz2' imported but unused pyflakes.ignore test/unit/response/events.py => 'from stem import *' used; unable to detect undefined names pyflakes.ignore test/unit/response/events.py => *may be undefined, or defined from star imports: stem pyflakes.ignore test/__init__.py => undefined name 'test' diff --git a/test/unit/descriptor/reader.py b/test/unit/descriptor/reader.py index ad6a425..e450f7c 100644 --- a/test/unit/descriptor/reader.py +++ b/test/unit/descriptor/reader.py @@ -396,6 +396,13 @@ class TestDescriptorReader(unittest.TestCase): Checks that we can read descriptors from an bzipped archive. """ + # when python's compiled it only optionally has bz2 support + + try: + import bz2 + except ImportError: + self.skipTest('(bz2 unsupported}') + expected_results = _get_raw_tar_descriptors() test_path = os.path.join(DESCRIPTOR_TEST_DATA, 'descriptor_archive.tar.bz2')

1 0

[stem/master] Manual provided options in the wrong order
by atagar＠torproject.org 28 May '17

28 May '17

commit 3c513aaddbec6e189de1e96d59c1d320fcaa7e29 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 28 15:58:32 2017 -0700 Manual provided options in the wrong order We made an effort to provide tor's configuration options by their order in the man page, but we still used basic dicts a couple places. Ran into this due to a unit testing failure for python 3.6 where dicts seem to be ordered by default. --- stem/manual.py | 20 ++++++++++---------- test/unit/manual.py | 14 +++++++------- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/stem/manual.py b/stem/manual.py index 86585a4..9287033 100644 --- a/stem/manual.py +++ b/stem/manual.py @@ -82,15 +82,15 @@ Category = stem.util.enum.Enum('GENERAL', 'CLIENT', 'RELAY', 'DIRECTORY', 'AUTHO GITWEB_MANUAL_URL = 'https://gitweb.torproject.org/tor.git/plain/doc/tor.1.txt' CACHE_PATH = os.path.join(os.path.dirname(__file__), 'cached_tor_manual.cfg') -CATEGORY_SECTIONS = { - 'GENERAL OPTIONS': Category.GENERAL, - 'CLIENT OPTIONS': Category.CLIENT, - 'SERVER OPTIONS': Category.RELAY, - 'DIRECTORY SERVER OPTIONS': Category.DIRECTORY, - 'DIRECTORY AUTHORITY SERVER OPTIONS': Category.AUTHORITY, - 'HIDDEN SERVICE OPTIONS': Category.HIDDEN_SERVICE, - 'TESTING NETWORK OPTIONS': Category.TESTING, -} +CATEGORY_SECTIONS = OrderedDict(( + ('GENERAL OPTIONS', Category.GENERAL), + ('CLIENT OPTIONS', Category.CLIENT), + ('SERVER OPTIONS', Category.RELAY), + ('DIRECTORY SERVER OPTIONS', Category.DIRECTORY), + ('DIRECTORY AUTHORITY SERVER OPTIONS', Category.AUTHORITY), + ('HIDDEN SERVICE OPTIONS', Category.HIDDEN_SERVICE), + ('TESTING NETWORK OPTIONS', Category.TESTING), +)) class ConfigOption(object): @@ -492,7 +492,7 @@ def _get_categories(content): if content and content[-1].startswith('Tor'): content = content[:-1] - categories = {} + categories = OrderedDict() category, lines = None, [] for line in content: diff --git a/test/unit/manual.py b/test/unit/manual.py index 28a8a8b..0e6a50d 100644 --- a/test/unit/manual.py +++ b/test/unit/manual.py @@ -61,13 +61,6 @@ EXPECTED_FILES = { EXPECTED_CONFIG_OPTIONS = OrderedDict() -EXPECTED_CONFIG_OPTIONS['Bridge'] = stem.manual.ConfigOption( - name = 'Bridge', - category = 'Client', - usage = '[transport] IP:ORPort [fingerprint]', - summary = 'Available bridges', - description = 'When set along with UseBridges, instructs Tor to use the relay at "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint" is provided (using the same format as for DirAuthority), we will verify that the relay running at that location has the right fingerprint. We also use fingerprint to look up the bridge descriptor at the bridge authority, if it\'s provided and if UpdateBridgesFromAuthority is set too.\n\nIf "transport" is provided, and matches to a ClientTransportPlugin line, we use that pluggable transports proxy to transfer data to the bridge.') - EXPECTED_CONFIG_OPTIONS['BandwidthRate'] = stem.manual.ConfigOption( name = 'BandwidthRate', category = 'General', @@ -89,6 +82,13 @@ EXPECTED_CONFIG_OPTIONS['MaxAdvertisedBandwidth'] = stem.manual.ConfigOption( summary = 'Limit for the bandwidth we advertise as being available for relaying', description = 'If set, we will not advertise more than this amount of bandwidth for our BandwidthRate. Server operators who want to reduce the number of clients who ask to build circuits through them (since this is proportional to advertised bandwidth rate) can thus reduce the CPU demands on their server without impacting network performance.') +EXPECTED_CONFIG_OPTIONS['Bridge'] = stem.manual.ConfigOption( + name = 'Bridge', + category = 'Client', + usage = '[transport] IP:ORPort [fingerprint]', + summary = 'Available bridges', + description = 'When set along with UseBridges, instructs Tor to use the relay at "IP:ORPort" as a "bridge" relaying into the Tor network. If "fingerprint" is provided (using the same format as for DirAuthority), we will verify that the relay running at that location has the right fingerprint. We also use fingerprint to look up the bridge descriptor at the bridge authority, if it\'s provided and if UpdateBridgesFromAuthority is set too.\n\nIf "transport" is provided, and matches to a ClientTransportPlugin line, we use that pluggable transports proxy to transfer data to the bridge.') + CACHED_MANUAL = None

1 0