tor-commits May 2014

tor-commits@lists.torproject.org

25 participants
1732 discussions

[stem/master] Unit tests for help module
by atagar＠torproject.org 06 May '14

06 May '14

commit a8b48a4c14186f1192132fc0947761215d30da9d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 4 14:32:48 2014 -0700 Unit tests for help module --- stem/interpretor/help.py | 12 ++++-- test/settings.cfg | 1 + test/unit/interpretor/__init__.py | 1 + test/unit/interpretor/help.py | 80 +++++++++++++++++++++++++++++++++++++ 4 files changed, 90 insertions(+), 4 deletions(-) diff --git a/stem/interpretor/help.py b/stem/… [View More]interpretor/help.py index 7f8b878..20439d6 100644 --- a/stem/interpretor/help.py +++ b/stem/interpretor/help.py @@ -31,6 +31,10 @@ def response(controller, arg): # Normalizing inputs first so we can better cache responses. + return _response(controller, _normalize(arg)) + + +def _normalize(arg): arg = arg.upper() # If there's multiple arguments then just take the first. This is @@ -44,7 +48,7 @@ def response(controller, arg): if arg.startswith('/'): arg = arg[1:] - return _response(controller, arg) + return arg @lru_cache() @@ -86,10 +90,10 @@ def _response(controller, arg, config): for i in range(0, len(options), 2): line = '' - for entry in options[i:i + 1]: + for entry in options[i:i + 2]: line += '%-42s' % entry - output += format(line + '\n', *STANDARD_OUTPUT) + output += format(line.rstrip() + '\n', *STANDARD_OUTPUT) elif arg == 'SIGNAL': signal_options = config.get('help.signal.options', {}) @@ -110,7 +114,7 @@ def _response(controller, arg, config): for entry in entries[i:i + 4]: line += '%-20s' % entry - output += format(line + '\n', *STANDARD_OUTPUT) + output += format(line.rstrip() + '\n', *STANDARD_OUTPUT) elif arg == 'USEFEATURE': results = controller.get_info('features/names', None) diff --git a/test/settings.cfg b/test/settings.cfg index cf05541..9ecbcfc 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -185,6 +185,7 @@ test.unit_tests |test.unit.control.controller.TestControl |test.unit.interpretor.arguments.TestArgumentParsing |test.unit.interpretor.autocomplete.TestAutocompletion +|test.unit.interpretor.help.TestHelpResponses |test.unit.doctest.TestDocumentation test.integ_tests diff --git a/test/unit/interpretor/__init__.py b/test/unit/interpretor/__init__.py index 62db05a..c49e07f 100644 --- a/test/unit/interpretor/__init__.py +++ b/test/unit/interpretor/__init__.py @@ -5,4 +5,5 @@ Unit tests for the stem's interpretor prompt. __all__ = [ "arguments", "autocomplete", + "help", ] diff --git a/test/unit/interpretor/help.py b/test/unit/interpretor/help.py new file mode 100644 index 0000000..51123e0 --- /dev/null +++ b/test/unit/interpretor/help.py @@ -0,0 +1,80 @@ +import unittest + +from stem.interpretor.help import response, _normalize + +try: + # added in python 3.3 + from unittest.mock import Mock +except ImportError: + from mock import Mock + +GETINFO_NAMES = """ +info/names -- List of GETINFO options, types, and documentation. +ip-to-country/* -- Perform a GEOIP lookup +md/id/* -- Microdescriptors by ID +""".strip() + +GETCONF_NAMES = """ +ExitNodes RouterList +ExitPolicy LineList +ExitPolicyRejectPrivate Boolean +""".strip() + + +CONTROLLER = Mock() + +CONTROLLER.get_info.side_effect = lambda arg, _: { + 'info/names': GETINFO_NAMES, + 'config/names': GETCONF_NAMES, + 'events/names': 'BW DEBUG INFO NOTICE', + 'features/names': 'VERBOSE_NAMES EXTENDED_EVENTS', +}[arg] + + +class TestHelpResponses(unittest.TestCase): + def test_normalization(self): + self.assertEqual('', _normalize('')) + self.assertEqual('', _normalize(' ')) + + self.assertEqual('GETINFO', _normalize('GETINFO')) + self.assertEqual('GETINFO', _normalize('GetInfo')) + self.assertEqual('GETINFO', _normalize('getinfo')) + self.assertEqual('GETINFO', _normalize('GETINFO version')) + self.assertEqual('GETINFO', _normalize('GETINFO ')) + + self.assertEqual('INFO', _normalize('/info')) + self.assertEqual('INFO', _normalize('/info caerSidi')) + + def test_unrecognized_option(self): + result = response(CONTROLLER, 'FOOBAR') + self.assertEqual("\x1b[1;31mNo help information available for 'FOOBAR'...\x1b[0m", result) + + def test_general_help(self): + result = response(CONTROLLER, '') + self.assertTrue('Interpretor commands include:' in result) + self.assertTrue('\x1b[34;1m GETINFO\x1b[0m\x1b[34m - queries information from tor\x1b[0m\n' in result) + + def test_getinfo_help(self): + result = response(CONTROLLER, 'GETINFO') + self.assertTrue('Queries the tor process for information. Options are...' in result) + self.assertTrue('\x1b[34;1minfo/names \x1b[0m\x1b[34m - List of GETINFO options, types, and documentation.\n' in result) + + def test_getconf_help(self): + result = response(CONTROLLER, 'GETCONF') + self.assertTrue('Provides the current value for a given configuration value. Options include...' in result) + self.assertTrue('\x1b[34mExitNodes ExitPolicy\n' in result) + + def test_signal_help(self): + result = response(CONTROLLER, 'SIGNAL') + self.assertTrue('Issues a signal that tells the tor process to' in result) + self.assertTrue('\x1b[34;1mRELOAD / HUP \x1b[0m\x1b[34m - reload our torrc\n' in result) + + def test_setevents_help(self): + result = response(CONTROLLER, 'SETEVENTS') + self.assertTrue('Sets the events that we will receive.' in result) + self.assertTrue('\x1b[34mBW DEBUG INFO NOTICE\n\x1b[0m' in result) + + def test_usefeature_help(self): + result = response(CONTROLLER, 'USEFEATURE') + self.assertTrue('Customizes the behavior of the control port.' in result) + self.assertTrue('\x1b[34mVERBOSE_NAMES EXTENDED_EVENTS\n\x1b[0m' in result) [View Less]

1 0

[stem/master] Help output had an extra newline
by atagar＠torproject.org 06 May '14

06 May '14

commit dcb9576041720573eac88920f84551d6d562a16d Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 17:58:50 2014 -0700 Help output had an extra newline --- stem/interpretor/help.py | 14 +++++++------- test/unit/interpretor/help.py | 10 +++++----- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/stem/interpretor/help.py b/stem/interpretor/help.py index 039bbef..caa64e0 100644 --- a/stem/interpretor/help.py +++ b/stem/interpretor/help.py @@ -… [View More]80,7 +80,7 @@ def _response(controller, arg, config): opt, summary = line.split(' -- ', 1) output += format("%-33s" % opt, *BOLD_OUTPUT) - output += format(" - %s\n" % summary, *STANDARD_OUTPUT) + output += format(" - %s" % summary, *STANDARD_OUTPUT) + '\n' elif arg == 'GETCONF': results = controller.get_info('config/names', None) @@ -93,13 +93,13 @@ def _response(controller, arg, config): for entry in options[i:i + 2]: line += '%-42s' % entry - output += format(line.rstrip() + '\n', *STANDARD_OUTPUT) + output += format(line.rstrip(), *STANDARD_OUTPUT) + '\n' elif arg == 'SIGNAL': signal_options = config.get('help.signal.options', {}) for signal, summary in signal_options.items(): output += format('%-15s' % signal, *BOLD_OUTPUT) - output += format(' - %s\n' % summary, *STANDARD_OUTPUT) + output += format(' - %s' % summary, *STANDARD_OUTPUT) + '\n' elif arg == 'SETEVENTS': results = controller.get_info('events/names', None) @@ -114,17 +114,17 @@ def _response(controller, arg, config): for entry in entries[i:i + 4]: line += '%-20s' % entry - output += format(line.rstrip() + '\n', *STANDARD_OUTPUT) + output += format(line.rstrip(), *STANDARD_OUTPUT) + '\n' elif arg == 'USEFEATURE': results = controller.get_info('features/names', None) if results: - output += format(results + '\n', *STANDARD_OUTPUT) + output += format(results, *STANDARD_OUTPUT) + '\n' elif arg in ('LOADCONF', 'POSTDESCRIPTOR'): # gives a warning that this option isn't yet implemented - output += format(msg('msg.multiline_unimplemented_notice') + '\n', *ERROR_OUTPUT) + output += format(msg('msg.multiline_unimplemented_notice'), *ERROR_OUTPUT) + '\n' - return output + return output.rstrip() def _general_help(): diff --git a/test/unit/interpretor/help.py b/test/unit/interpretor/help.py index ff178a2..e656060 100644 --- a/test/unit/interpretor/help.py +++ b/test/unit/interpretor/help.py @@ -31,24 +31,24 @@ class TestHelpResponses(unittest.TestCase): def test_getinfo_help(self): result = response(CONTROLLER, 'GETINFO') self.assertTrue('Queries the tor process for information. Options are...' in result) - self.assertTrue('\x1b[34;1minfo/names \x1b[0m\x1b[34m - List of GETINFO options, types, and documentation.\n' in result) + self.assertTrue('\x1b[34;1minfo/names \x1b[0m\x1b[34m - List of GETINFO options, types, and documentation.' in result) def test_getconf_help(self): result = response(CONTROLLER, 'GETCONF') self.assertTrue('Provides the current value for a given configuration value. Options include...' in result) - self.assertTrue('\x1b[34mExitNodes ExitPolicy\n' in result) + self.assertTrue('\x1b[34mExitNodes ExitPolicy' in result) def test_signal_help(self): result = response(CONTROLLER, 'SIGNAL') self.assertTrue('Issues a signal that tells the tor process to' in result) - self.assertTrue('\x1b[34;1mRELOAD / HUP \x1b[0m\x1b[34m - reload our torrc\n' in result) + self.assertTrue('\x1b[34;1mRELOAD / HUP \x1b[0m\x1b[34m - reload our torrc' in result) def test_setevents_help(self): result = response(CONTROLLER, 'SETEVENTS') self.assertTrue('Sets the events that we will receive.' in result) - self.assertTrue('\x1b[34mBW DEBUG INFO NOTICE\n\x1b[0m' in result) + self.assertTrue('\x1b[34mBW DEBUG INFO NOTICE\x1b[0m' in result) def test_usefeature_help(self): result = response(CONTROLLER, 'USEFEATURE') self.assertTrue('Customizes the behavior of the control port.' in result) - self.assertTrue('\x1b[34mVERBOSE_NAMES EXTENDED_EVENTS\n\x1b[0m' in result) + self.assertTrue('\x1b[34mVERBOSE_NAMES EXTENDED_EVENTS\x1b[0m' in result) [View Less]

1 0

[stem/master] Help and event ControlInterpretor unit tests
by atagar＠torproject.org 06 May '14

06 May '14

commit 1ee5d21f16921e2679239839899bacc0d21ccad8 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 4 15:20:45 2014 -0700 Help and event ControlInterpretor unit tests First couple unit tests for the ControlInterpretor class, covering '/help' and '/events'. --- test/settings.cfg | 1 + test/unit/interpretor/__init__.py | 1 + test/unit/interpretor/commands.py | 45 +++++++++++++++++++++++++++++++++++++ 3 files changed, 47 insertions(+)… [View More] diff --git a/test/settings.cfg b/test/settings.cfg index 9ecbcfc..79852b0 100644 --- a/test/settings.cfg +++ b/test/settings.cfg @@ -186,6 +186,7 @@ test.unit_tests |test.unit.interpretor.arguments.TestArgumentParsing |test.unit.interpretor.autocomplete.TestAutocompletion |test.unit.interpretor.help.TestHelpResponses +|test.unit.interpretor.commands.TestInterpretorCommands |test.unit.doctest.TestDocumentation test.integ_tests diff --git a/test/unit/interpretor/__init__.py b/test/unit/interpretor/__init__.py index 8063dfc..702cb92 100644 --- a/test/unit/interpretor/__init__.py +++ b/test/unit/interpretor/__init__.py @@ -5,6 +5,7 @@ Unit tests for the stem's interpretor prompt. __all__ = [ "arguments", "autocomplete", + "commands", "help", ] diff --git a/test/unit/interpretor/commands.py b/test/unit/interpretor/commands.py new file mode 100644 index 0000000..db0a53b --- /dev/null +++ b/test/unit/interpretor/commands.py @@ -0,0 +1,45 @@ +import unittest + +import stem.response + +from stem.interpretor.commands import ControlInterpretor + +from test import mocking +from test.unit.interpretor import CONTROLLER + +EXPECTED_EVENTS_RESPONSE = """\ +\x1b[34mBW 15 25\x1b[0m +\x1b[34mBW 758 570\x1b[0m +\x1b[34mDEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.\x1b[0m +""" + + +class TestInterpretorCommands(unittest.TestCase): + def test_help(self): + interpretor = ControlInterpretor(CONTROLLER) + + self.assertTrue('Interpretor commands include:' in interpretor.run_command('/help')) + self.assertTrue('Queries the tor process for information.' in interpretor.run_command('/help GETINFO')) + self.assertTrue('Queries the tor process for information.' in interpretor.run_command('/help GETINFO version')) + + def test_events(self): + interpretor = ControlInterpretor(CONTROLLER) + + # no received events + + self.assertEqual('\n', interpretor.run_command('/events')) + + # with enqueued events + + event_contents = ( + '650 BW 15 25', + '650 BW 758 570', + '650 DEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.', + ) + + for content in event_contents: + event = mocking.get_message(content) + stem.response.convert('EVENT', event) + interpretor.register_event(event) + + self.assertEqual(EXPECTED_EVENTS_RESPONSE, interpretor.run_command('/events')) [View Less]

1 0

[stem/master] Unit test for /info
by atagar＠torproject.org 06 May '14

06 May '14

commit ee2f739ab1b5d14661193543ac58f17e471d2ae3 Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 13:52:42 2014 -0700 Unit test for /info --- stem/interpretor/commands.py | 31 +++++++++++------------------- test/unit/interpretor/commands.py | 38 +++++++++++++++++++++++++++++++++++++ 2 files changed, 49 insertions(+), 20 deletions(-) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index faf9509..b2ffdb9 100644 --- a/stem/… [View More]interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -150,26 +150,18 @@ class ControlInterpretor(object): else: exit_policy_label = 'Unknown' - output = '%s (%s)\n' % (ns_desc.nickname, fingerprint) - - output += format('address: ', *BOLD_OUTPUT) - output += '%s:%s%s\n' % (ns_desc.address, ns_desc.or_port, locale_label) - - output += format('published: ', *BOLD_OUTPUT) - output += ns_desc.published.strftime('%H:%M:%S %d/%m/%Y') + '\n' + lines = [ + '%s (%s)' % (ns_desc.nickname, fingerprint), + format('address: ', *BOLD_OUTPUT) + '%s:%s%s' % (ns_desc.address, ns_desc.or_port, locale_label), + format('published: ', *BOLD_OUTPUT) + ns_desc.published.strftime('%H:%M:%S %d/%m/%Y'), + ] if server_desc: - output += format('os: ', *BOLD_OUTPUT) - output += server_desc.platform.decode('utf-8', 'replace') + '\n' - - output += format('version: ', *BOLD_OUTPUT) - output += str(server_desc.tor_version) + '\n' - - output += format('flags: ', *BOLD_OUTPUT) - output += ', '.join(ns_desc.flags) + '\n' + lines.append(format('os: ', *BOLD_OUTPUT) + server_desc.platform.decode('utf-8', 'replace')) + lines.append(format('version: ', *BOLD_OUTPUT) + str(server_desc.tor_version)) - output += format('exit policy: ', *BOLD_OUTPUT) - output += exit_policy_label + '\n' + lines.append(format('flags: ', *BOLD_OUTPUT) + ', '.join(ns_desc.flags)) + lines.append(format('exit policy: ', *BOLD_OUTPUT) + exit_policy_label) if server_desc: contact = server_desc.contact @@ -182,10 +174,9 @@ class ControlInterpretor(object): for alias in (' dot ', ' DOT '): contact = contact.replace(alias, '.') - output += format('contact: ', *BOLD_OUTPUT) - output += contact + '\n' + lines.append(format('contact: ', *BOLD_OUTPUT) + contact) - return output.strip() + return '\n'.join(lines) def run_command(self, command): """ diff --git a/test/unit/interpretor/commands.py b/test/unit/interpretor/commands.py index 1517e3a..a99f4f2 100644 --- a/test/unit/interpretor/commands.py +++ b/test/unit/interpretor/commands.py @@ -1,7 +1,9 @@ +import datetime import unittest import stem import stem.response +import stem.version from stem.interpretor.commands import ControlInterpretor, _get_fingerprint @@ -20,6 +22,17 @@ EXPECTED_EVENTS_RESPONSE = """\ \x1b[34mDEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.\x1b[0m """ +EXPECTED_INFO_RESPONSE = """\ +moria1 (9695DFC35FFEB861329B9F1AB04C46397020CE31) +\x1b[34;1maddress: \x1b[0m128.31.0.34:9101 (us) +\x1b[34;1mpublished: \x1b[0m05:52:05 05/05/2014 +\x1b[34;1mos: \x1b[0mLinux +\x1b[34;1mversion: \x1b[0m0.2.5.3-alpha-dev +\x1b[34;1mflags: \x1b[0mAuthority, Fast, Guard, HSDir, Named, Running, Stable, V2Dir, Valid +\x1b[34;1mexit policy: \x1b[0mreject 1-65535 +\x1b[34;1mcontact: \x1b[0m1024D/28988BF5 arma mit edu +""" + FINGERPRINT = '9695DFC35FFEB861329B9F1AB04C46397020CE31' @@ -105,3 +118,28 @@ class TestInterpretorCommands(unittest.TestCase): interpretor.register_event(event) self.assertEqual(EXPECTED_EVENTS_RESPONSE, interpretor.run_command('/events')) + + def test_info(self): + controller, server_desc, ns_desc = Mock(), Mock(), Mock() + + controller.get_microdescriptor.return_value = None + controller.get_server_descriptor.return_value = server_desc + controller.get_network_status.return_value = ns_desc + + controller.get_info.side_effect = lambda arg, _: { + 'ip-to-country/128.31.0.34': 'us', + }[arg] + + ns_desc.address = '128.31.0.34' + ns_desc.or_port = 9101 + ns_desc.published = datetime.datetime(2014, 5, 5, 5, 52, 5) + ns_desc.nickname = 'moria1' + ns_desc.flags = ['Authority', 'Fast', 'Guard', 'HSDir', 'Named', 'Running', 'Stable', 'V2Dir', 'Valid'] + + server_desc.exit_policy.summary.return_value = 'reject 1-65535' + server_desc.platform = 'Linux' + server_desc.tor_version = stem.version.Version('0.2.5.3-alpha-dev') + server_desc.contact = '1024D/28988BF5 arma mit edu' + + interpretor = ControlInterpretor(controller) + self.assertEqual(EXPECTED_INFO_RESPONSE, interpretor.run_command('/info ' + FINGERPRINT)) [View Less]

1 0

[stem/master] Unit tests for interpretor commands
by atagar＠torproject.org 06 May '14

06 May '14

commit 1fab359f84b3c462f0b0fea1baeb4230be39ccab Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 17:47:12 2014 -0700 Unit tests for interpretor commands Tests for issuing commands to the interpretor prompt. --- stem/interpretor/commands.py | 8 +++++ test/unit/interpretor/commands.py | 71 +++++++++++++++++++++++++++++++++++++ 2 files changed, 79 insertions(+) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index b2ffdb9.… [View More].8e94f93 100644 --- a/stem/interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -236,6 +236,14 @@ class ControlInterpretor(object): output = format('\n'.join(response.values()), *STANDARD_OUTPUT) except stem.ControllerError as exc: output = format(str(exc), *ERROR_OUTPUT) + elif cmd == 'GETCONF': + try: + response = self._controller.get_conf_map(arg.split()) + + for arg in response: + output += format(arg, *BOLD_OUTPUT) + format(' => ' + ', '.join(response[arg]), *STANDARD_OUTPUT) + '\n' + except stem.ControllerError as exc: + output = format(str(exc), *ERROR_OUTPUT) elif cmd in ('SETCONF', 'RESETCONF'): # arguments can either be '<param>', '<param>=<value>', or # '<param>="<value>"' entries diff --git a/test/unit/interpretor/commands.py b/test/unit/interpretor/commands.py index a99f4f2..9ed7a92 100644 --- a/test/unit/interpretor/commands.py +++ b/test/unit/interpretor/commands.py @@ -1,3 +1,4 @@ +import collections import datetime import unittest @@ -33,6 +34,11 @@ moria1 (9695DFC35FFEB861329B9F1AB04C46397020CE31) \x1b[34;1mcontact: \x1b[0m1024D/28988BF5 arma mit edu """ +EXPECTED_GETCONF_RESPONSE = """\ +\x1b[34;1mlog\x1b[0m\x1b[34m => notice stdout\x1b[0m +\x1b[34;1maddress\x1b[0m\x1b[34m => \x1b[0m +""" + FINGERPRINT = '9695DFC35FFEB861329B9F1AB04C46397020CE31' @@ -86,9 +92,17 @@ class TestInterpretorCommands(unittest.TestCase): def test_get_fingerprint_for_unrecognized_inputs(self): self.assertRaises(ValueError, _get_fingerprint, 'blarg!', Mock()) + def test_when_disconnected(self): + controller = Mock() + controller.is_alive.return_value = False + + interpretor = ControlInterpretor(controller) + self.assertRaises(stem.SocketClosed, interpretor.run_command, '/help') + def test_quit(self): interpretor = ControlInterpretor(CONTROLLER) self.assertRaises(stem.SocketClosed, interpretor.run_command, '/quit') + self.assertRaises(stem.SocketClosed, interpretor.run_command, 'QUIT') def test_help(self): interpretor = ControlInterpretor(CONTROLLER) @@ -143,3 +157,60 @@ class TestInterpretorCommands(unittest.TestCase): interpretor = ControlInterpretor(controller) self.assertEqual(EXPECTED_INFO_RESPONSE, interpretor.run_command('/info ' + FINGERPRINT)) + + def test_unrecognized_interpretor_command(self): + interpretor = ControlInterpretor(CONTROLLER) + + expected = "\x1b[1;31m'/unrecognized' isn't a recognized command\x1b[0m\n" + self.assertEqual(expected, interpretor.run_command('/unrecognized')) + + def test_getinfo(self): + controller, getinfo = Mock(), collections.OrderedDict() + controller.get_info.return_value = getinfo + + interpretor = ControlInterpretor(controller) + + getinfo['version'] = '0.2.5.1-alpha-dev (git-245ecfff36c0cecc)' + self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\x1b[0m', interpretor.run_command('GETINFO version')) + controller.get_info.assert_called_with(['version']) + + getinfo['process/user'] = 'atagar' + self.assertEqual('\x1b[34m0.2.5.1-alpha-dev (git-245ecfff36c0cecc)\natagar\x1b[0m', interpretor.run_command('getinfo version process/user')) + controller.get_info.assert_called_with(['version', 'process/user']) + + controller.get_info.side_effect = stem.ControllerError('kaboom!') + self.assertEqual('\x1b[1;31mkaboom!\x1b[0m', interpretor.run_command('getinfo process/user')) + + def test_getconf(self): + controller, getconf = Mock(), collections.OrderedDict() + controller.get_conf_map.return_value = getconf + + interpretor = ControlInterpretor(controller) + + getconf['log'] = ['notice stdout'] + getconf['address'] = [''] + + self.assertEqual(EXPECTED_GETCONF_RESPONSE, interpretor.run_command('GETCONF log address')) + controller.get_conf_map.assert_called_with(['log', 'address']) + + def test_setconf(self): + controller = Mock() + interpretor = ControlInterpretor(controller) + + self.assertEqual('', interpretor.run_command('SETCONF ControlPort=9051')) + controller.set_options.assert_called_with([('ControlPort', '9051')], False) + + def test_setevents(self): + controller = Mock() + interpretor = ControlInterpretor(controller) + + self.assertEqual('\x1b[34mListing for BW events\n\x1b[0m', interpretor.run_command('SETEVENTS BW')) + controller.add_event_listener.assert_called_with(interpretor.register_event, 'BW') + + def test_raw_commands(self): + controller = Mock() + controller.msg.return_value = 'response' + interpretor = ControlInterpretor(controller) + + self.assertEqual('\x1b[34mresponse\x1b[0m', interpretor.run_command('NEW_COMMAND spiffyness')) + controller.msg.assert_called_with('NEW_COMMAND spiffyness') [View Less]

1 0

[stem/master] Helper function for resolution of inputs to fingerprints
by atagar＠torproject.org 06 May '14

06 May '14

commit fb6962ed28463a56d100c9cac7cc7517879dec99 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun May 4 19:14:35 2014 -0700 Helper function for resolution of inputs to fingerprints Splitting a big chunk of do_info() into a helper. Much better for both readability and testability. --- stem/interpretor/commands.py | 199 ++++++++++++++++++++----------------- stem/interpretor/help.py | 2 +- test/unit/interpretor/commands.py | 64 +++++++++++- … [View More] 3 files changed, 170 insertions(+), 95 deletions(-) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index 2a9d402..faf9509 100644 --- a/stem/interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -13,6 +13,70 @@ from stem.interpretor import STANDARD_OUTPUT, BOLD_OUTPUT, ERROR_OUTPUT, msg from stem.util.term import format +def _get_fingerprint(arg, controller): + """ + Resolves user input into a relay fingerprint. This accepts... + + * Fingerprints + * Nicknames + * IPv4 addresses, either with or without an ORPort + * Empty input, which is resolved to ourselves if we're a relay + + :param str arg: input to be resolved to a relay fingerprint + :param stem.control.Controller controller: tor control connection + + :returns: **str** for the relay fingerprint + + :raises: **ValueError** if we're unable to resolve the input to a relay + """ + + if not arg: + try: + return controller.get_info('fingerprint') + except: + raise ValueError("We aren't a relay, no information to provide") + elif stem.util.tor_tools.is_valid_fingerprint(arg): + return arg + elif stem.util.tor_tools.is_valid_nickname(arg): + try: + return controller.get_network_status(arg).fingerprint + except: + raise ValueError("Unable to find a relay with the nickname of '%s'" % arg) + elif ':' in arg or stem.util.connection.is_valid_ipv4_address(arg): + if ':' in arg: + address, port = arg.split(':', 1) + + if not stem.util.connection.is_valid_ipv4_address(address): + raise ValueError("'%s' isn't a valid IPv4 address" % address) + elif port and not stem.util.connection.is_valid_port(port): + raise ValueError("'%s' isn't a valid port" % port) + + port = int(port) + else: + address, port = arg, None + + matches = {} + + for desc in controller.get_network_statuses(): + if desc.address == address: + if not port or desc.or_port == port: + matches[desc.or_port] = desc.fingerprint + + if len(matches) == 0: + raise ValueError('No relays found at %s' % arg) + elif len(matches) == 1: + return matches.values()[0] + else: + response = "There's multiple relays at %s, include a port to specify which.\n\n" % arg + + for i, or_port in enumerate(matches): + response += " %i. %s:%s, fingerprint: %s\n" % (i + 1, address, or_port, matches[or_port]) + + raise ValueError(response) + else: + raise ValueError("'%s' isn't a fingerprint, nickname, or IP address" % arg) + + class ControlInterpretor(object): """ Handles issuing requests and providing nicely formed responses, with support @@ -60,117 +124,66 @@ class ControlInterpretor(object): pretty fashion. """ - output, fingerprint = '', None + try: + fingerprint = _get_fingerprint(arg, self._controller) + except ValueError as exc: + return format(str(exc), *ERROR_OUTPUT) - # determines the fingerprint, leaving it unset and adding an error message - # if unsuccessful + micro_desc = self._controller.get_microdescriptor(fingerprint, None) + server_desc = self._controller.get_server_descriptor(fingerprint, None) + ns_desc = self._controller.get_network_status(fingerprint, None) - if not arg: - # uses our fingerprint if we're a relay, otherwise gives an error + # We'll mostly rely on the router status entry. Either the server + # descriptor or microdescriptor will be missing, so we'll treat them as + # being optional. - fingerprint = self._controller.get_info('fingerprint', None) + if not ns_desc: + return format("Unable to find consensus information for %s" % fingerprint, *ERROR_OUTPUT) - if not fingerprint: - output += format("We aren't a relay, no information to provide", *ERROR_OUTPUT) - elif stem.util.tor_tools.is_valid_fingerprint(arg): - fingerprint = arg - elif stem.util.tor_tools.is_valid_nickname(arg): - desc = self._controller.get_network_status(arg, None) + locale = self._controller.get_info('ip-to-country/%s' % ns_desc.address, None) + locale_label = ' (%s)' % locale if locale else '' - if desc: - fingerprint = desc.fingerprint - else: - return format("Unable to find a relay with the nickname of '%s'" % arg, *ERROR_OUTPUT) - elif ':' in arg or stem.util.connection.is_valid_ipv4_address(arg): - # we got an address, so looking up the fingerprint - - if ':' in arg: - address, port = arg.split(':', 1) - - if not stem.util.connection.is_valid_ipv4_address(address): - return format("'%s' isn't a valid IPv4 address" % address, *ERROR_OUTPUT) - elif port and not stem.util.connection.is_valid_port(port): - return format("'%s' isn't a valid port" % port, *ERROR_OUTPUT) - - port = int(port) - else: - address, port = arg, None - - matches = {} - - for desc in self._controller.get_network_statuses(): - if desc.address == address: - if not port or desc.or_port == port: - matches[desc.or_port] = desc.fingerprint - - if len(matches) == 0: - output += format('No relays found at %s' % arg, *ERROR_OUTPUT) - elif len(matches) == 1: - fingerprint = matches.values()[0] - else: - output += format("There's multiple relays at %s, include a port to specify which.\n\n" % arg, *ERROR_OUTPUT) - - for i, or_port in enumerate(matches): - output += format(" %i. %s:%s, fingerprint: %s\n" % (i + 1, address, or_port, matches[or_port]), *ERROR_OUTPUT) + if server_desc: + exit_policy_label = server_desc.exit_policy.summary() + elif micro_desc: + exit_policy_label = micro_desc.exit_policy.summary() else: - return format("'%s' isn't a fingerprint, nickname, or IP address" % arg, *ERROR_OUTPUT) - - if fingerprint: - micro_desc = self._controller.get_microdescriptor(fingerprint, None) - server_desc = self._controller.get_server_descriptor(fingerprint, None) - ns_desc = self._controller.get_network_status(fingerprint, None) - - # We'll mostly rely on the router status entry. Either the server - # descriptor or microdescriptor will be missing, so we'll treat them as - # being optional. - - if not ns_desc: - return format("Unable to find consensus information for %s" % fingerprint, *ERROR_OUTPUT) - - locale = self._controller.get_info('ip-to-country/%s' % ns_desc.address, None) - locale_label = ' (%s)' % locale if locale else '' - - if server_desc: - exit_policy_label = server_desc.exit_policy.summary() - elif micro_desc: - exit_policy_label = micro_desc.exit_policy.summary() - else: - exit_policy_label = 'Unknown' + exit_policy_label = 'Unknown' - output += '%s (%s)\n' % (ns_desc.nickname, fingerprint) + output = '%s (%s)\n' % (ns_desc.nickname, fingerprint) - output += format('address: ', *BOLD_OUTPUT) - output += '%s:%s%s\n' % (ns_desc.address, ns_desc.or_port, locale_label) + output += format('address: ', *BOLD_OUTPUT) + output += '%s:%s%s\n' % (ns_desc.address, ns_desc.or_port, locale_label) - output += format('published: ', *BOLD_OUTPUT) - output += ns_desc.published.strftime('%H:%M:%S %d/%m/%Y') + '\n' + output += format('published: ', *BOLD_OUTPUT) + output += ns_desc.published.strftime('%H:%M:%S %d/%m/%Y') + '\n' - if server_desc: - output += format('os: ', *BOLD_OUTPUT) - output += server_desc.platform.decode('utf-8', 'replace') + '\n' + if server_desc: + output += format('os: ', *BOLD_OUTPUT) + output += server_desc.platform.decode('utf-8', 'replace') + '\n' - output += format('version: ', *BOLD_OUTPUT) - output += str(server_desc.tor_version) + '\n' + output += format('version: ', *BOLD_OUTPUT) + output += str(server_desc.tor_version) + '\n' - output += format('flags: ', *BOLD_OUTPUT) - output += ', '.join(ns_desc.flags) + '\n' + output += format('flags: ', *BOLD_OUTPUT) + output += ', '.join(ns_desc.flags) + '\n' - output += format('exit policy: ', *BOLD_OUTPUT) - output += exit_policy_label + '\n' + output += format('exit policy: ', *BOLD_OUTPUT) + output += exit_policy_label + '\n' - if server_desc: - contact = server_desc.contact + if server_desc: + contact = server_desc.contact - # clears up some highly common obscuring + # clears up some highly common obscuring - for alias in (' at ', ' AT '): - contact = contact.replace(alias, '@') + for alias in (' at ', ' AT '): + contact = contact.replace(alias, '@') - for alias in (' dot ', ' DOT '): - contact = contact.replace(alias, '.') + for alias in (' dot ', ' DOT '): + contact = contact.replace(alias, '.') - output += format('contact: ', *BOLD_OUTPUT) - output += contact + '\n' + output += format('contact: ', *BOLD_OUTPUT) + output += contact + '\n' return output.strip() diff --git a/stem/interpretor/help.py b/stem/interpretor/help.py index 20439d6..039bbef 100644 --- a/stem/interpretor/help.py +++ b/stem/interpretor/help.py @@ -23,7 +23,7 @@ def response(controller, arg): """ Provides our /help response. - :param stem.Controller controller: tor control connection + :param stem.control.Controller controller: tor control connection :param str arg: controller or interpretor command to provide help output for :returns: **str** with our help response diff --git a/test/unit/interpretor/commands.py b/test/unit/interpretor/commands.py index db0a53b..1517e3a 100644 --- a/test/unit/interpretor/commands.py +++ b/test/unit/interpretor/commands.py @@ -1,20 +1,82 @@ import unittest +import stem import stem.response -from stem.interpretor.commands import ControlInterpretor +from stem.interpretor.commands import ControlInterpretor, _get_fingerprint from test import mocking from test.unit.interpretor import CONTROLLER +try: + # added in python 3.3 + from unittest.mock import Mock +except ImportError: + from mock import Mock + EXPECTED_EVENTS_RESPONSE = """\ \x1b[34mBW 15 25\x1b[0m \x1b[34mBW 758 570\x1b[0m \x1b[34mDEBUG connection_edge_process_relay_cell(): Got an extended cell! Yay.\x1b[0m """ +FINGERPRINT = '9695DFC35FFEB861329B9F1AB04C46397020CE31' + class TestInterpretorCommands(unittest.TestCase): + def test_get_fingerprint_for_ourselves(self): + controller = Mock() + + controller.get_info.side_effect = lambda arg: { + 'fingerprint': FINGERPRINT, + }[arg] + + self.assertEqual(FINGERPRINT, _get_fingerprint('', controller)) + + controller.get_info.side_effect = stem.ControllerError + self.assertRaises(ValueError, _get_fingerprint, '', controller) + + def test_get_fingerprint_for_fingerprint(self): + self.assertEqual(FINGERPRINT, _get_fingerprint(FINGERPRINT, Mock())) + + def test_get_fingerprint_for_nickname(self): + controller, descriptor = Mock(), Mock() + descriptor.fingerprint = FINGERPRINT + + controller.get_network_status.side_effect = lambda arg: { + 'moria1': descriptor, + }[arg] + + self.assertEqual(FINGERPRINT, _get_fingerprint('moria1', controller)) + + controller.get_network_status.side_effect = stem.ControllerError + self.assertRaises(ValueError, _get_fingerprint, 'moria1', controller) + + def test_get_fingerprint_for_address(self): + controller = Mock() + + self.assertRaises(ValueError, _get_fingerprint, '127.0.0.1:-1', controller) + self.assertRaises(ValueError, _get_fingerprint, '127.0.0.901:80', controller) + + descriptor = Mock() + descriptor.address = '127.0.0.1' + descriptor.or_port = 80 + descriptor.fingerprint = FINGERPRINT + + controller.get_network_statuses.return_value = [descriptor] + + self.assertEqual(FINGERPRINT, _get_fingerprint('127.0.0.1', controller)) + self.assertEqual(FINGERPRINT, _get_fingerprint('127.0.0.1:80', controller)) + self.assertRaises(ValueError, _get_fingerprint, '127.0.0.1:81', controller) + self.assertRaises(ValueError, _get_fingerprint, '127.0.0.2', controller) + + def test_get_fingerprint_for_unrecognized_inputs(self): + self.assertRaises(ValueError, _get_fingerprint, 'blarg!', Mock()) + + def test_quit(self): + interpretor = ControlInterpretor(CONTROLLER) + self.assertRaises(stem.SocketClosed, interpretor.run_command, '/quit') + def test_help(self): interpretor = ControlInterpretor(CONTROLLER) [View Less]

1 0

[stem/master] Always include an empty line before the next prompt
by atagar＠torproject.org 06 May '14

06 May '14

commit f2cabcdf9618af85005e830e2aa0d72a4e369a3f Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 18:02:40 2014 -0700 Always include an empty line before the next prompt --- stem/interpretor/commands.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/stem/interpretor/commands.py b/stem/interpretor/commands.py index 8e94f93..ecea859 100644 --- a/stem/interpretor/commands.py +++ b/stem/interpretor/commands.py @@ -225,8 +225,6 @@ class … [View More]

1 0

[stem/master] Interpretor prompt
by atagar＠torproject.org 06 May '14

06 May '14

commit 1b21c24d1a6ba02fe1eea191379eb6c9811657fe Merge: 0d357a9 f2cabcd Author: Damian Johnson <atagar(a)torproject.org> Date: Mon May 5 18:03:46 2014 -0700 Interpretor prompt Arm's 1.4.5 release included an interpretor panel that allowed raw control port access with usability improvements like... * tab completion * history by pressing up/down * terminal coloring to improve readability * irc-style functions such as '/help' and '/info' … [View More]

1 0

[stem/master] Adding stem.connection.connect()
by atagar＠torproject.org 06 May '14

06 May '14

commit 448ab2717223508044a4293b366c3ae0cf3e3638 Merge: 872b1e1 be37a4f Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 13 11:52:27 2014 -0700 Adding stem.connection.connect() Replacing our connect_port() and connect_socket_file() methods with a simpler, better connect() function. docs/change_log.rst | 1 + docs/faq.rst | 7 +- stem/connection.py | 207 ++++++++++++++++++++++++++++++++++---- stem/… [View More]

1 0

[stem/master] Basic interpretor prompt
by atagar＠torproject.org 06 May '14

06 May '14

commit eed49b22e06b9a0ea549c68a23e3cb60a4ad7e8d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Apr 6 13:46:56 2014 -0700 Basic interpretor prompt Passing raw input to the control port and presenting the result. --- stem/interpretor/__init__.py | 24 +++++++++++++++++++++++- stem/interpretor/arguments.py | 14 +++++++++----- 2 files changed, 32 insertions(+), 6 deletions(-) diff --git a/stem/interpretor/__init__.py b/stem/interpretor/__init__.py index … [View More]ffe0012..72711c0 100644 --- a/stem/interpretor/__init__.py +++ b/stem/interpretor/__init__.py @@ -12,8 +12,23 @@ import sys import stem.connection import stem.interpretor.arguments +import stem.prereq + +from stem.util.term import Attr, Color, format + +# We can only present a color prompt with python 2.7 or later... +# +# http://bugs.python.org/issue12972 + +if stem.prereq.is_python_27(): + PROMPT = format(">>> ", Color.GREEN, Attr.BOLD) +else: + PROMPT = ">>> " + def main(): + import readline + try: args = stem.interpretor.arguments.parse(sys.argv[1:]) except ValueError as exc: @@ -30,10 +45,17 @@ def main(): controller = stem.connection.connect( control_port = control_port, control_socket = control_socket, + password_prompt = True, ) if controller is None: sys.exit(1) with controller: - print controller.get_version() + while True: + try: + user_input = raw_input(PROMPT) + print controller.msg(user_input) + except KeyboardInterrupt as exc: + print # move cursor to the following line + break diff --git a/stem/interpretor/arguments.py b/stem/interpretor/arguments.py index f7feac4..bd6655d 100644 --- a/stem/interpretor/arguments.py +++ b/stem/interpretor/arguments.py @@ -8,7 +8,9 @@ Commandline argument parsing for arm. import collections import getopt -DEFAULT_ARGS = { +import stem.util.connection + +DEFAULT_ARGS = { 'control_address': '127.0.0.1', 'control_port': 9051, 'user_provided_port': False, @@ -19,7 +21,7 @@ DEFAULT_ARGS = { OPT = 'i:s:h' -OPT_EXPANDED = [ +OPT_EXPANDED = [ 'interface=', 'socket=', 'help', @@ -39,6 +41,7 @@ prompt -i 1643 attach to control port 1643 prompt -s ~/.tor/socket attach to a control socket in your home directory """ + def parse(argv): """ Parses our arguments, providing a named tuple with their values. @@ -55,7 +58,7 @@ def parse(argv): try: getopt_results = getopt.getopt(argv, OPT, OPT_EXPANDED)[0] except getopt.GetoptError as exc: - raise ValueError(msg('usage.invalid_arguments', error = exc)) + raise ValueError('%s (for usage provide --help)' % exc) for opt, arg in getopt_results: if opt in ('-i', '--interface'): @@ -66,12 +69,12 @@ def parse(argv): if address is not None: if not stem.util.connection.is_valid_ipv4_address(address): - raise ValueError(msg('usage.not_a_valid_address', address_input = address)) + raise ValueError("'%s' isn't a valid IPv4 address" % address) args['control_address'] = address if not stem.util.connection.is_valid_port(port): - raise ValueError(msg('usage.not_a_valid_port', port_input = port)) + raise ValueError("'%s' isn't a valid port number" % port) args['control_port'] = int(port) args['user_provided_port'] = True @@ -86,6 +89,7 @@ def parse(argv): Args = collections.namedtuple('Args', args.keys()) return Args(**args) + def get_help(): """ Provides our --help usage information. [View Less]

1 0

Jump to page:

2025

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

tor-commits May 2014