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

[stem/master] Include test runtime in verbose test output
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit a1f241a45952ae2c2e9b7963d0c7658c80e78755 Author: Damian Johnson <atagar(a)torproject.org> Date: Wed Jan 4 10:45:07 2017 -0800 Include test runtime in verbose test output When running our tests with a --verbose flag including individual test runtimes. This'll greatly help us when investigating test performance. Also shortening a few test names so output aligns better. --- run_tests.py | 1 + test/integ/control/controller.py | 2 +- test/integ/descriptor/remote.py | 4 ++-- test/integ/util/connection.py | 18 +++++++++--------- test/output.py | 28 ++++++++++++++++++++++++++++ test/unit/control/controller.py | 2 +- 6 files changed, 42 insertions(+), 13 deletions(-) diff --git a/run_tests.py b/run_tests.py index df4da12..2d31a1b 100755 --- a/run_tests.py +++ b/run_tests.py @@ -177,6 +177,7 @@ def main(): output_filters = ( error_tracker.get_filter(), + test.output.runtimes, test.output.strip_module, test.output.align_results, test.output.colorize, diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index c249c08..1c80ae2 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -690,7 +690,7 @@ class TestController(unittest.TestCase): @require_controller @require_version(Requirement.ADD_ONION_BASIC_AUTH) - def test_with_ephemeral_hidden_services_basic_auth_without_credentials(self): + def test_with_ephemeral_hidden_services_basic_auth_no_credentials(self): """ Exercises creating ephemeral hidden services when attempting to use basic auth but not including any credentials. diff --git a/test/integ/descriptor/remote.py b/test/integ/descriptor/remote.py index 098041d..889f3d8 100644 --- a/test/integ/descriptor/remote.py +++ b/test/integ/descriptor/remote.py @@ -184,7 +184,7 @@ class TestDescriptorDownloader(unittest.TestCase): @require_online @only_run_once - def test_get_consensus_for_microdescriptors(self): + def test_get_microdescriptor_consensus(self): """ Exercises the downloader's get_consensus() method for fetching a microdescriptor consensus. @@ -239,7 +239,7 @@ class TestDescriptorDownloader(unittest.TestCase): self.fail("Stem's cached fallback directories are out of date. Please run 'cache_fallback_directories.py'...\n\n%s" % stem.descriptor.remote._fallback_directory_differences(cached_fallback_directories, latest_fallback_directories)) @require_online - def test_that_fallback_directories_are_reachable(self): + def test_fallback_directory_reachability(self): """ Fetch information from each fallback directory to confirm that it's available. diff --git a/test/integ/util/connection.py b/test/integ/util/connection.py index 64653d1..c6ca04a 100644 --- a/test/integ/util/connection.py +++ b/test/integ/util/connection.py @@ -18,7 +18,7 @@ class TestConnection(unittest.TestCase): test.runner.skip(self, '(no control port)') return elif not runner.is_ptraceable(): - test.runner.skip(self, '(DisableDebuggerAttachment is set)') + test.runner.skip(self, '(DisableDebuggerAttachment set)') return elif resolver not in system_resolvers(): test.runner.skip(self, '(resolver unavailable on this platform)') @@ -33,28 +33,28 @@ class TestConnection(unittest.TestCase): self.fail('Unable to find localhost connection with %s:\n%s' % (resolver, '\n'.join(connections))) - def test_get_connections_by_proc(self): + def test_connections_by_proc(self): self.check_resolver(Resolver.PROC) - def test_get_connections_by_netstat(self): + def test_connections_by_netstat(self): self.check_resolver(Resolver.NETSTAT) - def test_get_connections_by_windows_netstat(self): + def test_connections_by_windows_netstat(self): self.check_resolver(Resolver.NETSTAT_WINDOWS) - def test_get_connections_by_ss(self): + def test_connections_by_ss(self): self.check_resolver(Resolver.SS) - def test_get_connections_by_lsof(self): + def test_connections_by_lsof(self): self.check_resolver(Resolver.LSOF) - def test_get_connections_by_sockstat(self): + def test_connections_by_sockstat(self): self.check_resolver(Resolver.SOCKSTAT) - def test_get_connections_by_bsd_sockstat(self): + def test_connections_by_bsd_sockstat(self): self.check_resolver(Resolver.BSD_SOCKSTAT) - def test_get_connections_by_bsd_procstat(self): + def test_connections_by_bsd_procstat(self): self.check_resolver(Resolver.BSD_PROCSTAT) def test_that_we_are_checking_all_resolvers(self): diff --git a/test/output.py b/test/output.py index bff719a..c9a2116 100644 --- a/test/output.py +++ b/test/output.py @@ -10,6 +10,7 @@ import re import sys import stem.util.enum +import stem.util.test_tools from stem.util import system, term @@ -154,6 +155,27 @@ def strip_module(line_type, line_content): return line_content +def runtimes(line_type, line_content): + """ + Provides test runtimes if showing verbose results. + """ + + m = re.search('(test\.[^)]*)', line_content) + + if m and line_type == LineType.OK: + test = '%s.%s' % (m.group(0), line_content.split()[0]) + runtime = stem.util.test_tools.test_runtimes().get(test) + + if runtime is None: + pass + if runtime >= 1.0: + line_content = '%s (%0.2fs)' % (line_content, runtime) + else: + line_content = '%s (%i ms)' % (line_content, runtime * 1000) + + return line_content + + def align_results(line_type, line_content): """ Strips the normal test results, and adds a right aligned variant instead with @@ -169,6 +191,12 @@ def align_results(line_type, line_content): line_content = line_content.replace(ending, '', 1) break + # right align runtimes + + if line_content.endswith('s)'): + div = line_content.rfind(' (') + line_content = '%-53s%6s ' % (line_content[:div], line_content[div + 2:-1]) + # skipped tests have extra single quotes around the reason if line_type == LineType.SKIPPED: line_content = line_content.replace("'(", "(", 1).replace(")'", ")", 1) diff --git a/test/unit/control/controller.py b/test/unit/control/controller.py index fedb86a..0c82a94 100644 --- a/test/unit/control/controller.py +++ b/test/unit/control/controller.py @@ -462,7 +462,7 @@ class TestControl(unittest.TestCase): self.assertEqual(stem.descriptor.router_status_entry.RouterStatusEntryV3(desc), self.controller.get_network_status()) @patch('stem.control.Controller.get_info') - def test_get_network_status_when_raising_descriptor_unavailable(self, get_info_mock): + def test_get_network_status_when_unavailable(self, get_info_mock): """ Exercises the get_network_status() method. """

1 0

[stem/master] Note ticket for speeding up OwningControllerProcess tests
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit 189ec858dc935232741259c142f893a92c24ca6d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 22 13:51:31 2017 -0800 Note ticket for speeding up OwningControllerProcess tests Sadly I can't make this one faster, but with a small tor tweak we can. Shot them a ticket... https://trac.torproject.org/projects/tor/ticket/21281 --- test/integ/process.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/test/integ/process.py b/test/integ/process.py index d8e6b82..9e13be5 100644 --- a/test/integ/process.py +++ b/test/integ/process.py @@ -418,6 +418,8 @@ class TestProcess(unittest.TestCase): # tor polls for the process every fifteen seconds so this may take a # while... + # + # https://trac.torproject.org/projects/tor/ticket/21281 for seconds_waited in range(30): if tor_process.poll() == 0:

1 0

[stem/master] Include tor version in initialization information
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit d7eef9b7cf908e343bc28c8c4694f8a6838a2bf6 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Jan 19 11:02:19 2017 -0800 Include tor version in initialization information When running integ tests noting tor's version in our initialization information (along with stem, python, etc). --- run_tests.py | 6 +++++- test/util.py | 5 +++++ 2 files changed, 10 insertions(+), 1 deletion(-) diff --git a/run_tests.py b/run_tests.py index 2d31a1b..ca6be67 100755 --- a/run_tests.py +++ b/run_tests.py @@ -140,7 +140,7 @@ def main(): sys.exit(1) - pyflakes_task, pycodestyle_task = None, None + tor_version_check, pyflakes_task, pycodestyle_task = None, None, None if not args.specific_test: if stem.util.test_tools.is_pyflakes_available(): @@ -149,9 +149,13 @@ def main(): if stem.util.test_tools.is_pycodestyle_available(): pycodestyle_task = PYCODESTYLE_TASK + if args.run_integ: + tor_version_check = Task('checking tor version', test.util.check_tor_version, (args.tor_path,)) + test.util.run_tasks( 'INITIALISING', Task('checking stem version', test.util.check_stem_version), + tor_version_check, Task('checking python version', test.util.check_python_version), Task('checking pycrypto version', test.util.check_pycrypto_version), Task('checking mock version', test.util.check_mock_version), diff --git a/test/util.py b/test/util.py index a3348be..d62a080 100644 --- a/test/util.py +++ b/test/util.py @@ -20,6 +20,7 @@ Tasks are... Initialization |- check_stem_version - checks our version of stem + |- check_tor_version - checks our version of tor |- check_python_version - checks our version of python |- check_pycrypto_version - checks our version of pycrypto |- check_pyflakes_version - checks our version of pyflakes @@ -204,6 +205,10 @@ def check_stem_version(): return stem.__version__ +def check_tor_version(tor_path): + return str(stem.version.get_system_tor_version(tor_path)).split()[0] + + def check_python_version(): return '.'.join(map(str, sys.version_info[:3]))

1 0

[stem/master] Track individual test runtimes
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit a53a1d97d183b2681bfcd721fc8136a4386e7be0 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Dec 29 10:39:08 2016 -0800 Track individual test runtimes I'd like to further speed up our tests and the first step for doing so is getting more information about where we're spending our time. Python's built-in unittest module provides the runtime for full modules but makes it a surprising pita to get all individual runtimes. Expanding their runner to make this possible. Runtimes aren't weaved into our test output yet and I might fiddle with this some more (don't like the need for a global). Good starting place though. --- docs/change_log.rst | 4 ++++ run_tests.py | 7 +++++-- stem/util/test_tools.py | 51 +++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 60 insertions(+), 2 deletions(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index 5870beb..e16a948 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -48,6 +48,10 @@ The following are only available within Stem's `git repository * Support for protocol descriptor fields (:spec:`eb4fb3c`) * Shared randomness properties weren't being read in votes (:trac:`21102`) + * **Utilities** + + * Added :class:`~stem.util.test_tools.TimedTestRunner` and :func:`~stem.util.test_tools.test_runtimes` + .. _version_1.5: Version 1.5 (November 20th, 2016) diff --git a/run_tests.py b/run_tests.py index db34e5b..df4da12 100755 --- a/run_tests.py +++ b/run_tests.py @@ -158,7 +158,10 @@ def main(): Task('checking pyflakes version', test.util.check_pyflakes_version), Task('checking pycodestyle version', test.util.check_pycodestyle_version), Task('checking for orphaned .pyc files', test.util.clean_orphaned_pyc, (SRC_PATHS,)), - Task('checking for unused tests', test.util.check_for_unused_tests, ((os.path.join(STEM_BASE, 'test'),),)), + Task('checking for unused tests', test.util.check_for_unused_tests, [( + os.path.join(STEM_BASE, 'test', 'unit'), + os.path.join(STEM_BASE, 'test', 'integ'), + )]), pyflakes_task, pycodestyle_task, ) @@ -381,7 +384,7 @@ def _run_test(args, test_class, output_filters, logging_buffer): return None test_results = StringIO() - run_result = unittest.TextTestRunner(test_results, verbosity=2).run(suite) + run_result = stem.util.test_tools.TimedTestRunner(test_results, verbosity=2).run(suite) if args.verbose: println(test.output.apply_filters(test_results.getvalue(), *output_filters)) diff --git a/stem/util/test_tools.py b/stem/util/test_tools.py index 406ebd7..21adc9a 100644 --- a/stem/util/test_tools.py +++ b/stem/util/test_tools.py @@ -8,6 +8,9 @@ Helper functions for testing. :: + 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 @@ -21,6 +24,8 @@ import collections import linecache import os import re +import time +import unittest import stem.util.conf import stem.util.system @@ -32,6 +37,8 @@ CONFIG = stem.util.conf.config_dict('test', { 'exclude_paths': [], }) +TEST_RUNTIMES = {} + class Issue(collections.namedtuple('Issue', ['line_number', 'message', 'line'])): """ @@ -43,6 +50,50 @@ class Issue(collections.namedtuple('Issue', ['line_number', 'message', 'line'])) """ +class TimedTestRunner(unittest.TextTestRunner): + """ + Test runner that tracks the runtime of individual tests. When tests are run + with this their runtimes are made available through + :func:`stem.util.test_tools.test_runtimes`. + + .. versionadded:: 1.6.0 + """ + + def run(self, test): + for t in test._tests: + original_type = type(t) + + class _TestWrapper(original_type): + def run(self, result = None): + start_time = time.time() + result = super(type(self), self).run(result) + TEST_RUNTIMES[self.id()] = time.time() - start_time + return result + + def id(self): + return '%s.%s.%s' % (original_type.__module__, original_type.__name__, self._testMethodName) + + def __str__(self): + return '%s (%s.%s)' % (self._testMethodName, original_type.__module__, original_type.__name__) + + t.__class__ = _TestWrapper + + return super(TimedTestRunner, self).run(test) + + +def test_runtimes(): + """ + Provides the runtimes of tests executed through TimedTestRunners. + + :returns: **dict** of fully qualified test names to floats for the runtime in + seconds + + .. versionadded:: 1.6.0 + """ + + return dict(TEST_RUNTIMES) + + def clean_orphaned_pyc(paths): """ Deletes any file with a \*.pyc extention without a corresponding \*.py. This

1 0

[stem/master] Allow float timeout when starting tor
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit 20284e9785e408a85ea5e45aba0e4adc5cc77dc7 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 22 14:12:56 2017 -0800 Allow float timeout when starting tor Supporting floats for our timeout when spawning tor. This in turn lets us shave a couple more seconds off our test runtime. Trick is thanks to... https://stackoverflow.com/questions/11901328/how-to-timeout-function-in-pyt… --- stem/process.py | 5 ++++- test/integ/process.py | 6 +++--- 2 files changed, 7 insertions(+), 4 deletions(-) diff --git a/stem/process.py b/stem/process.py index a9c8e76..08e0426 100644 --- a/stem/process.py +++ b/stem/process.py @@ -50,6 +50,9 @@ def launch_tor(tor_cmd = 'tor', args = None, torrc_path = None, completion_perce Note: The timeout argument does not work on Windows, and relies on the global state of the signal module. + .. versionchanged:: 1.6.0 + Allowing the timeout argument to be a float. + :param str tor_cmd: command for starting tor :param list args: additional arguments for tor :param str torrc_path: location of the torrc for us to use @@ -119,7 +122,7 @@ def launch_tor(tor_cmd = 'tor', args = None, torrc_path = None, completion_perce raise OSError('reached a %i second timeout without success' % timeout) signal.signal(signal.SIGALRM, timeout_handler) - signal.alarm(timeout) + signal.setitimer(signal.ITIMER_REAL, timeout) bootstrap_line = re.compile('Bootstrapped ([0-9]+)%: ') problem_line = re.compile('\[(warn|err)\] (.*)$') diff --git a/test/integ/process.py b/test/integ/process.py index 9e13be5..b082d0b 100644 --- a/test/integ/process.py +++ b/test/integ/process.py @@ -378,11 +378,11 @@ class TestProcess(unittest.TestCase): runner = test.runner.get_runner() start_time = time.time() config = {'SocksPort': '2777', 'DataDirectory': self.data_directory} - self.assertRaises(OSError, stem.process.launch_tor_with_config, config, runner.get_tor_command(), 100, None, 2) + self.assertRaises(OSError, stem.process.launch_tor_with_config, config, runner.get_tor_command(), 100, None, 0.05) runtime = time.time() - start_time - if not (runtime > 2 and runtime < 3): - self.fail('Test should have taken 2-3 seconds, took %0.1f instead' % runtime) + if not (runtime > 0.05 and runtime < 1): + self.fail('Test should have taken 0.05-1 seconds, took %0.1f instead' % runtime) @require_version(stem.version.Requirement.TAKEOWNERSHIP) @only_run_once

1 0

[stem/master] Replace test_bw_event with a setconf test
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit d709e50ae789acc55a4e05056c7b22b657a861b4 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jan 20 11:32:35 2017 -0800 Replace test_bw_event with a setconf test Replacing another spot where we wait for BW events with a triggered CONF_CHANGED. This shaves a couple more seconds off our test runtime. --- test/integ/control/base_controller.py | 9 +++++---- test/integ/control/controller.py | 18 +++++------------- test/integ/socket/control_message.py | 22 +++++++++++++--------- test/mocking.py | 10 ++++++++++ 4 files changed, 33 insertions(+), 26 deletions(-) diff --git a/test/integ/control/base_controller.py b/test/integ/control/base_controller.py index 2507293..51576a8 100644 --- a/test/integ/control/base_controller.py +++ b/test/integ/control/base_controller.py @@ -2,8 +2,6 @@ Integration tests for the stem.control.BaseController class. """ -import hashlib -import os import re import threading import time @@ -13,6 +11,7 @@ import stem.control import stem.socket import stem.util.system +import test.mocking import test.runner from test.runner import require_controller @@ -155,10 +154,12 @@ class TestBaseController(unittest.TestCase): controller.msg('SETEVENTS CONF_CHANGED') for i in range(10): - random_fingerprint = hashlib.sha1(os.urandom(20)).hexdigest().upper() - controller.msg('SETCONF NodeFamily=%s' % random_fingerprint) + controller.msg('SETCONF NodeFamily=%s' % test.mocking.random_fingerprint()) test.runner.exercise_controller(self, controller) + controller.msg('SETEVENTS') + controller.msg('RESETCONF NodeFamily') + # Concurrently shut down the controller. We need to do this in another # thread because it'll block on the event handling, which in turn is # currently blocking on the reveive_notice. diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index f7b6555..0d17b0b 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -2,7 +2,6 @@ Integration tests for the stem.control.Controller class. """ -import hashlib import os import shutil import socket @@ -19,6 +18,7 @@ import stem.response.protocolinfo import stem.socket import stem.util.str_tools import stem.version +import test.mocking import test.network import test.runner @@ -42,14 +42,6 @@ from test.runner import ( TEST_ROUTER_STATUS_ENTRY = None -def random_fingerprint(): - """ - Provides a random 40 character hex string. - """ - - return hashlib.sha1(os.urandom(20)).hexdigest().upper() - - class TestController(unittest.TestCase): @only_run_once @require_controller @@ -158,7 +150,7 @@ class TestController(unittest.TestCase): controller.add_event_listener(listener2, EventType.CONF_CHANGED, EventType.DEBUG) # The NodeFamily is a harmless option we can toggle - controller.set_conf('NodeFamily', random_fingerprint()) + controller.set_conf('NodeFamily', test.mocking.random_fingerprint()) # Wait for the event. Assert that we get it within 10 seconds event_notice1.wait(10) @@ -175,7 +167,7 @@ class TestController(unittest.TestCase): buffer2_size = len(event_buffer2) - controller.set_conf('NodeFamily', random_fingerprint()) + controller.set_conf('NodeFamily', test.mocking.random_fingerprint()) event_notice1.wait(10) self.assertEqual(len(event_buffer1), 2) event_notice1.clear() @@ -212,7 +204,7 @@ class TestController(unittest.TestCase): # trigger an event - controller.set_conf('NodeFamily', random_fingerprint()) + controller.set_conf('NodeFamily', test.mocking.random_fingerprint()) event_notice.wait(4) self.assertTrue(len(event_buffer) >= 1) @@ -225,7 +217,7 @@ class TestController(unittest.TestCase): controller.connect() controller.authenticate(password = test.runner.CONTROL_PASSWORD) self.assertTrue(len(event_buffer) == 0) - controller.set_conf('NodeFamily', random_fingerprint()) + controller.set_conf('NodeFamily', test.mocking.random_fingerprint()) event_notice.wait(4) self.assertTrue(len(event_buffer) >= 1) diff --git a/test/integ/socket/control_message.py b/test/integ/socket/control_message.py index 567a78d..b873a59 100644 --- a/test/integ/socket/control_message.py +++ b/test/integ/socket/control_message.py @@ -7,6 +7,7 @@ import unittest import stem.socket import stem.version +import test.mocking import test.runner from test.runner import ( @@ -145,23 +146,26 @@ class TestControlMessage(unittest.TestCase): self.assertTrue('%s' % torrc_entry in config_text_response.content()[0][2]) @require_controller - def test_bw_event(self): + def test_setconf_event(self): """ - Issues 'SETEVENTS BW' and parses a couple events. + Issues 'SETEVENTS CONF_CHANGED' and parses an events. """ with test.runner.get_runner().get_tor_socket() as control_socket: - control_socket.send('SETEVENTS BW') + control_socket.send('SETEVENTS CONF_CHANGED') setevents_response = control_socket.recv() self.assertEqual('OK', str(setevents_response)) self.assertEqual(['OK'], list(setevents_response)) self.assertEqual('250 OK\r\n', setevents_response.raw_content()) self.assertEqual([('250', ' ', 'OK')], setevents_response.content()) - # Tor will emit a BW event once per second. Parsing two of them. + # CONF_CHANGED event will come before the SETCONF 'OK' response - for _ in range(2): - bw_event = control_socket.recv() - self.assertTrue(re.match('BW [0-9]+ [0-9]+', str(bw_event))) - self.assertTrue(re.match('650 BW [0-9]+ [0-9]+\r\n', bw_event.raw_content())) - self.assertEqual(('650', ' '), bw_event.content()[0][:2]) + control_socket.send('SETCONF NodeFamily=%s' % test.mocking.random_fingerprint()) + + conf_changed_event = control_socket.recv() + self.assertTrue(re.match('CONF_CHANGED\nNodeFamily=.*', str(conf_changed_event))) + self.assertTrue(re.match('650-CONF_CHANGED\r\n650-NodeFamily=.*\r\n650 OK', conf_changed_event.raw_content())) + self.assertEqual(('650', '-'), conf_changed_event.content()[0][:2]) + + self.assertEqual([('250', ' ', 'OK')], control_socket.recv().content()) diff --git a/test/mocking.py b/test/mocking.py index 7ffb11c..cb576d8 100644 --- a/test/mocking.py +++ b/test/mocking.py @@ -7,6 +7,7 @@ Helper functions for creating mock objects. :: get_all_combinations - provides all combinations of attributes + random_fingerprint - provides a random relay fingerprint Instance Constructors get_message - stem.response.ControlMessage @@ -41,6 +42,7 @@ Helper functions for creating mock objects. import base64 import hashlib import itertools +import os import re import textwrap @@ -242,6 +244,14 @@ def get_all_combinations(attr, include_empty = False): yield item +def random_fingerprint(): + """ + Provides a random relay fingerprint. + """ + + return hashlib.sha1(os.urandom(20)).hexdigest().upper() + + def get_message(content, reformat = True): """ Provides a ControlMessage with content modified to be parsable. This makes

1 0

[stem/master] Don't clone immutables when parsing descriptors
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit 1a50ce30e95dd11dbc80167f4c4df2df0b05f55b Author: Damian Johnson <atagar(a)torproject.org> Date: Tue Jan 24 10:44:01 2017 -0800 Don't clone immutables when parsing descriptors Avoiding an unnecessary copy call on types which are immutable. Seems even for empty lists and dictionaries calling the constructor rather than copy() is a tad faster. On my wee little netbook this speeds up reading microdescriptors by ~5% when there's validation and speeds our integ tests a bit... Before descriptor.microdescriptor... success (15.38s) descriptor.networkstatus... success (23.25s) After descriptor.microdescriptor... success (13.96s) descriptor.networkstatus... success (22.77s) This should help all descriptor reading though when validation is disabled this is boon is only when accessing attributes. --- docs/change_log.rst | 1 + stem/descriptor/__init__.py | 12 +++++++++++- 2 files changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/change_log.rst b/docs/change_log.rst index e16a948..477db2e 100644 --- a/docs/change_log.rst +++ b/docs/change_log.rst @@ -45,6 +45,7 @@ The following are only available within Stem's `git repository * **Descriptors** + * Sped descriptor reading by ~5% by not cloning immutable fields * Support for protocol descriptor fields (:spec:`eb4fb3c`) * Shared randomness properties weren't being read in votes (:trac:`21102`) diff --git a/stem/descriptor/__init__.py b/stem/descriptor/__init__.py index d7b1aea..67ea374 100644 --- a/stem/descriptor/__init__.py +++ b/stem/descriptor/__init__.py @@ -78,6 +78,7 @@ KEYWORD_LINE = re.compile('^([%s]+)(?:[%s]+(.*))?$' % (KEYWORD_CHAR, WHITESPACE) SPECIFIC_KEYWORD_LINE = '^(%%s)(?:[%s]+(.*))?$' % WHITESPACE PGP_BLOCK_START = re.compile('^-----BEGIN ([%s%s]+)-----$' % (KEYWORD_CHAR, WHITESPACE)) PGP_BLOCK_END = '-----END %s-----' +EMPTY_COLLECTION = ([], {}, set()) DocumentHandler = stem.util.enum.UppercaseEnum( 'ENTRIES', @@ -519,7 +520,16 @@ class Descriptor(object): for attr in self.ATTRIBUTES: if not hasattr(self, attr): - setattr(self, attr, copy.copy(self.ATTRIBUTES[attr][0])) + value = self.ATTRIBUTES[attr][0] + + if value is None or isinstance(value, (bool, stem.exit_policy.ExitPolicy)): + pass # immutable + elif value in EMPTY_COLLECTION: + value = type(value)() # collection construction tad faster than copy + else: + value = copy.copy(value) + + setattr(self, attr, value) for keyword, values in list(entries.items()): try:

1 0

[stem/master] Speed up controller's test_reattaching_listeners integ test
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit a55e9619fb23b8185f03a06e80930def882fc3d9 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Jan 6 10:50:13 2017 -0800 Speed up controller's test_reattaching_listeners integ test Test was decent, but overly extensive for the simple thing it aimed to assert. This test is supposed to simply check that when we reattach to tor we resume getting events we were previously subscribed for. Narrowing the test to be just about that and use events we can trigger rather than waiting for BW events to be emitted (which is the main cause of this test's long runtime). On my netbook this drops the test from 5.8s to 104 ms (98% faster). --- test/integ/control/controller.py | 51 ++++++---------------------------------- 1 file changed, 7 insertions(+), 44 deletions(-) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 1c80ae2..f7b6555 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -208,66 +208,29 @@ class TestController(unittest.TestCase): runner = test.runner.get_runner() with runner.get_tor_controller() as controller: - controller.add_event_listener(listener, EventType.BW) + controller.add_event_listener(listener, EventType.CONF_CHANGED) - # Get a BW event or two. These should be emitted each second but under - # heavy system load that's not always the case. + # trigger an event + controller.set_conf('NodeFamily', random_fingerprint()) event_notice.wait(4) self.assertTrue(len(event_buffer) >= 1) - # disconnect and check that we stop getting events + # disconnect, then reconnect and check that we get events again controller.close() event_notice.clear() event_buffer = [] - event_notice.wait(2) - self.assertTrue(len(event_buffer) == 0) - - # reconnect and check that we get events again - controller.connect() controller.authenticate(password = test.runner.CONTROL_PASSWORD) + self.assertTrue(len(event_buffer) == 0) + controller.set_conf('NodeFamily', random_fingerprint()) event_notice.wait(4) self.assertTrue(len(event_buffer) >= 1) - # disconnect - - controller.close() - event_notice.clear() - event_buffer = [] - - # reconnect and check that we get events again - - controller.connect() - stem.connection.authenticate(controller, password = test.runner.CONTROL_PASSWORD) - - event_notice.wait(4) - self.assertTrue(len(event_buffer) >= 1) - - # disconnect - - controller.close() - event_notice.clear() - event_buffer = [] - - # Reconnect and check that we get events again. This is being done by - # calling AUTHENTICATE manually so skipping cookie auth. - - tor_options = test.runner.get_runner().get_options() - - if test.runner.Torrc.COOKIE not in tor_options: - controller.connect() - - if test.runner.Torrc.PASSWORD in tor_options: - controller.msg('AUTHENTICATE "%s"' % test.runner.CONTROL_PASSWORD) - else: - controller.msg('AUTHENTICATE') - - event_notice.wait(4) - self.assertTrue(len(event_buffer) >= 1) + controller.reset_conf('NodeFamily') @require_controller def test_getinfo(self):

1 0

[stem/master] Displaying tor version in header broke unit test
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit 74999de6a93bd58747a3f8516f17c546e8f61d11 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Jan 22 16:01:13 2017 -0800 Displaying tor version in header broke unit test Oops, thought we mocked out the version cache but seems that's not the case. --- test/unit/version.py | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/test/unit/version.py b/test/unit/version.py index 2d9803e..2518a41 100644 --- a/test/unit/version.py +++ b/test/unit/version.py @@ -27,13 +27,13 @@ class TestVersion(unittest.TestCase): def test_get_system_tor_version(self, call_mock): call_mock.return_value = TOR_VERSION_OUTPUT.splitlines() - version = stem.version.get_system_tor_version() + version = stem.version.get_system_tor_version('tor_unit') self.assert_versions_match(version, 0, 2, 2, 35, None, 'git-73ff13ab3cc9570d') self.assertEqual('73ff13ab3cc9570d', version.git_commit) - call_mock.assert_called_once_with('tor --version') + call_mock.assert_called_once_with('tor_unit --version') - self.assertEqual({'tor': version}, stem.version.VERSION_CACHE) + self.assertEqual(stem.version.VERSION_CACHE['tor_unit'], version) def test_parsing(self): """

1 0

[stem/master] Speed tests and descriptor parsing
by atagar＠torproject.org 30 Jan '17

30 Jan '17

commit 10fc8134065a57f5c2c1d012e70cbe13ba6a700f Merge: d713b29 40fd99d Author: Damian Johnson <atagar(a)torproject.org> Date: Mon Jan 30 09:55:07 2017 -0800 Speed tests and descriptor parsing During my morning commute I've been looking into Stem's test speed. Faster tests mean quicker development cycles, so nice investment for the future. Main changes are... * Greatly sped up descriptor parsing, especially when there's validation. Should help with memory usage too. * When running our tests with the --verbose argument we now show individual test runtimes. This isn't a capability python's unittest module has so providing it in our test_tools util. Unit tests improved quite a bit on my netbook but has no negligible impact on my PC. Integ tests however have improved quite a bit, dropping from 57.0s to 44.7s (22% faster). docs/change_log.rst | 5 +++ run_tests.py | 14 +++++-- stem/descriptor/__init__.py | 46 ++++++++++++----------- stem/descriptor/networkstatus.py | 10 ++--- stem/process.py | 5 ++- stem/util/test_tools.py | 51 ++++++++++++++++++++++++++ test/integ/control/base_controller.py | 29 +++++++-------- test/integ/control/controller.py | 67 ++++++---------------------------- test/integ/descriptor/remote.py | 4 +- test/integ/process.py | 8 ++-- test/integ/socket/control_message.py | 22 ++++++----- test/integ/util/connection.py | 18 ++++----- test/mocking.py | 10 +++++ test/output.py | 28 ++++++++++++++ test/unit/connection/authentication.py | 28 +++++--------- test/unit/control/controller.py | 2 +- test/unit/version.py | 6 +-- test/util.py | 5 +++ 18 files changed, 211 insertions(+), 147 deletions(-)

1 0