- tor-commits - lists.torproject.org

[stem/master] Implement use_feature wrapper method
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 9a70131cf2bf0b25f89faa89c62fb70d5e891ee1 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Tue Jul 3 01:34:46 2012 +0530 Implement use_feature wrapper method --- stem/control.py | 38 ++++++++++++++++++++++++++++++++++++++ stem/version.py | 1 + test/integ/control/controller.py | 19 +++++++++++++++++++ 3 files changed, 58 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index dd5f812..f2eb47a 100644 --- a/stem/control.py +++ b/stem/control.py @@ -24,6 +24,7 @@ interacting at a higher level. |- set_options - sets or resets the values of multiple configuration options |- load_conf - loads configuration information as if it was in the torrc |- save_conf - saves configuration information to the torrc + |- enable_feature - enables control protocol features that have been disabled by default |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -962,6 +963,43 @@ class Controller(BaseController): raise stem.socket.OperationFailed(response.code, response.message) else: raise stem.socket.ProtocolError("SAVECONF returned unexpected response code") + + def enable_feature(self, features): + """ + Enables features that are disabled by default to maintain backward + compatibility. Once enabled, a feature cannot be disabled and a new + control connection must be opened to get a connection with the feature + disabled. Feature names are case-insensitive. + + The following features are currently accepted: + * EXTENDED_EVENTS - Requests the extended event syntax. Has the same + effect as calling SETEVENTS with EXTENDED. Introduced in + 0.1.2.3-alpha, always-on since Tor 0.2.2.1-alpha + * VERBOSE_NAMES - Replaces ServerID with LongName in events and GETINFO + results. LongName provides a Fingerprint for all routers, an indication + of Named status, and a Nickname if one is known. LongName is strictly + more informative than ServerID, which only provides either a Fingerprint + or a Nickname. Introduced in 0.1.2.2-alpha, always-on since Tor + 0.2.2.1-alpha. + + :param str,list features: a single feature or a list of features to be enabled + + :raises: + :class:`stem.socket.ControllerError` if the call fails + :class:`stem.socket.InvalidArguments` if features passed were invalid + """ + + if type(features) == str: features = [features] + response = self.msg("USEFEATURE %s" % " ".join(features)) + stem.response.convert("SINGLELINE", response) + + if not response.is_ok(): + if response.code == "552": + invalid_feature = [] + if response.message.startswith("Unrecognized feature \""): + invalid_feature = [response.message[22:response.message.find("\"", 22)]] + raise stem.socket.InvalidArguments(response.code, response.message, invalid_feature) + raise stem.socket.ProtocolError("USEFEATURE returned invalid response code") def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/version.py b/stem/version.py index 08f5ca2..e17d63b 100644 --- a/stem/version.py +++ b/stem/version.py @@ -249,5 +249,6 @@ Requirement = stem.util.enum.Enum( ("LOADCONF", Version("0.2.1.1")), ("TORRC_CONTROL_SOCKET", Version("0.2.0.30")), ("TORRC_DISABLE_DEBUGGER_ATTACHMENT", Version("0.2.3.9")), + ("FEATURE_VERBOSENAMES", Version("0.1.2.2-alpha")), ) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 54f2626..88ef642 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -316,4 +316,23 @@ class TestController(unittest.TestCase): finally: controller.load_conf(oldconf) controller.save_conf() + + def test_enable_feature(self): + """ + Test Controller.enable_feature with valid and invalid inputs. + """ + + if test.runner.require_control(self): return + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + if test.runner.require_version(self, stem.version.Requirement.FEATURE_VERBOSENAMES): + controller.enable_feature("VERBOSE_NAMES") + self.assertRaises(stem.socket.InvalidArguments, controller.enable_feature, ["NOT", "A", "FEATURE"]) + try: + controller.enable_feature(["NOT", "A", "FEATURE"]) + except stem.socket.InvalidArguments, exc: + self.assertEqual(["NOT"], exc.arguments) + else: self.fail()

1 0

[stem/master] Fix documentation formatting
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 51a00e9a3a2f2fa10277759616582d4acd2942a3 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 00:05:10 2012 +0530 Fix documentation formatting --- stem/control.py | 34 +++++++++++++++++----------------- 1 files changed, 17 insertions(+), 17 deletions(-) diff --git a/stem/control.py b/stem/control.py index 8d59682..84a9df1 100644 --- a/stem/control.py +++ b/stem/control.py @@ -553,8 +553,8 @@ class Controller(BaseController): * default if one was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the 'param' requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the 'param' requested was invalid """ start_time = time.time() @@ -691,8 +691,8 @@ class Controller(BaseController): * default if one was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid """ # Config options are case insensitive and don't contain whitespace. Using @@ -743,8 +743,8 @@ class Controller(BaseController): * default if one was provided and our call failed :raises: - :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response - :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid + * :class:`stem.socket.ControllerError` if the call fails and we weren't provided a default response + * :class:`stem.socket.InvalidArguments` if the configuration option requested was invalid """ start_time = time.time() @@ -829,9 +829,9 @@ class Controller(BaseController): :param str,list value: value to set the parameter to :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ self.set_options({param: value}, False) @@ -843,9 +843,9 @@ class Controller(BaseController): :param str params: configuration option to be reset :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ self.set_options(dict([(entry, None) for entry in params]), True) @@ -875,9 +875,9 @@ class Controller(BaseController): :param bool reset: issues a RESETCONF, returning None values to their defaults if True :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.InvalidArguments` if configuration options requested was invalid - :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.InvalidArguments` if configuration options requested was invalid + * :class:`stem.socket.InvalidRequest` if the configuration setting is impossible or if there's a syntax error in the configuration values """ start_time = time.time() @@ -952,8 +952,8 @@ class Controller(BaseController): Saves the current configuration options into the active torrc file. :raises: - :class:`stem.socket.ControllerError` if the call fails - :class:`stem.socket.OperationFailed` if the client is unable to save the configuration file + * :class:`stem.socket.ControllerError` if the call fails + * :class:`stem.socket.OperationFailed` if the client is unable to save the configuration file """ response = self.msg("SAVECONF")

1 0

[stem/master] Collapsing SIGNAL documentation
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 4f8b48ba3a7ee34a5725c9df242a961da9e7da01 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 23 22:01:31 2012 -0700 Collapsing SIGNAL documentation Shortening the pydocs for the signal() method. Might as well list both signal aliases on the same line. --- stem/control.py | 22 +++++++++------------- 1 files changed, 9 insertions(+), 13 deletions(-) diff --git a/stem/control.py b/stem/control.py index adf1d8a..247969e 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1033,18 +1033,13 @@ class Controller(BaseController): Sends a signal to the Tor client. :param str signal: type of signal to be sent. Must be one of the following... - * HUP - Reload configuration - * INT - If server is an OP, exit immediately. If it's an OR, close listeners and exit after ShutdownWaitLength seconds - * USR1 - Dump log information about open connections and circuits - * USR2 - Switch all open logs to loglevel debug - * TERM - Clean up and exit immediately - * RELOAD - equivalent to HUP - * SHUTDOWN - equivalent to INT - * DUMP - . equivalent to USR1 - * DEBUG - . equivalent to USR2 - * HALT - . equivalent to TERM - * NEWNYM - Switch to clean circuits, so new application requests don't share any circuits with old ones and clear the client-side dns cache - * CLEARDNSCACHE - Forget the client-side cached IPs for all hostnames + * RELOAD or HUP - reload configuration + * SHUTDOWN or INT - shut down, waiting ShutdownWaitLength first if we're a relay + * DUMP or USR1 - dump log information about open connections and circuits + * DEBUG or USR2 - switch logging to the DEBUG runlevel + * HALT or TERM - exit immediately + * NEWNYM - switch to new circuits, so new application requests don't share any circuits with old ones (this also clears our DNS cache) + * CLEARDNSCACHE - clears cached DNS results :raises: :class:`stem.socket.InvalidArguments` if signal provided wasn't recognized. """ @@ -1055,7 +1050,8 @@ class Controller(BaseController): if not response.is_ok(): if response.code == "552": raise stem.socket.InvalidArguments(response.code, response.message, [signal]) - raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code") + + raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code: %s" % response.code) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """

1 0

[stem/master] Implement Controller.extend_circuit
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit fea0a43ded650b78d9453c1bc2ce15fdb99e394f Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 22:07:01 2012 -0700 Implement Controller.extend_circuit --- stem/control.py | 57 ++++++++++++++++++++++++++++++++++++++ test/integ/control/controller.py | 17 ++++++++++- 2 files changed, 73 insertions(+), 1 deletions(-) diff --git a/stem/control.py b/stem/control.py index 247969e..2f0c773 100644 --- a/stem/control.py +++ b/stem/control.py @@ -27,6 +27,8 @@ interacting at a higher level. |- is_feature_enabled - checks if a given controller feature is enabled |- enable_feature - enables a controller feature that has been disabled by default |- signal - sends a signal to the tor client + |- new_circuit - create new circuits + |- extend_circuit - create new circuits and extend existing ones |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -1052,6 +1054,61 @@ class Controller(BaseController): raise stem.socket.InvalidArguments(response.code, response.message, [signal]) raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code: %s" % response.code) + + def new_circuit(self, relays = None, purpose = None): + """ + Requests Tor to build a new circuit. + + If the path isn't provided, one is automatically selected. If the purpose + isn't provided, "general" circuits are built. + + :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param str purpose: "general" or "controller" + + :returns: Circuit id of the newly created circuit + """ + + return self.extend_circuit(0, relays, purpose) + + def extend_circuit(self, circuit=0, relays = None, purpose = None): + """ + Requests Tor to build a new circuit or extend an existing circuit. + + When called without any arguments, a new general purpose circuit is created. + If circuit is zero, a new circuit is created. If circuit is non-zero, Tor + extends the existing circuit with that id . If the path isn't provided, one + is automatically selected. If the purpose isn't provided, "general" circuits + are built. + + :param int circuit: id of the circuit which needs extending + :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param str purpose: "general" or "controller" + + :returns: Circuit id of the created/extended circuit + + :raises: :class:`stem.socket.InvalidRequest` if one of the parameters were invalid + """ + + args = [str(circuit)] + if type(relays) == str: relays = [relays] + if relays: args.append(",".join(relays)) + if purpose: args.append("purpose=%s" % purpose) + + response = self.msg("EXTENDCIRCUIT %s" % " ".join(args)) + stem.response.convert("SINGLELINE", response) + + if response.is_ok(): + try: + extended, new_circuit = response.message.split(" ") + assert extended == "EXTENDED" + except: + raise stem.socket.ProtocolError("EXTENDCIRCUIT response invalid:\n%s", str(response)) + elif response.code == '552': + raise stem.socket.InvalidRequest(response.code, response.message) + else: + raise stem.socket.ProtocolError("EXTENDCIRCUIT returned unexpected response code: %s" % response.code) + + return int(new_circuit) def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 450d219..9a64d36 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -299,7 +299,6 @@ class TestController(unittest.TestCase): controller.load_conf(oldconf) def test_saveconf(self): - if test.runner.require_control(self): return runner = test.runner.get_runner() @@ -364,4 +363,20 @@ class TestController(unittest.TestCase): controller.signal("INT") self.assertRaises(stem.socket.SocketClosed, controller.msg, "GETINFO version") + + def test_extendcircuit(self): + if test.runner.require_control(self): return + + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + circ_id = controller.extend_circuit(0) + # check if our circuit was created + self.assertTrue(filter(lambda x: int(x.split()[0]) == circ_id, controller.get_info('circuit-status').splitlines())) + circ_id = controller.new_circuit() + self.assertTrue(filter(lambda x: int(x.split()[0]) == circ_id, controller.get_info('circuit-status').splitlines())) + + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, "foo") + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, 0, "thisroutershouldntexistbecausestemexists!@##$%#") + self.assertRaises(stem.socket.InvalidRequest, controller.extend_circuit, 0, "thisroutershouldntexistbecausestemexists!@##$%#", "foo")

1 0

[stem/master] Implement wrapper method for Controller to handle SIGNAL requests
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit aeb39b813961d02509a9c3e4e3db585b4190cac1 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Thu Aug 23 21:52:01 2012 -0700 Implement wrapper method for Controller to handle SIGNAL requests --- stem/control.py | 31 +++++++++++++++++++++++++++++++ test/integ/control/controller.py | 16 ++++++++++++++++ 2 files changed, 47 insertions(+), 0 deletions(-) diff --git a/stem/control.py b/stem/control.py index 7edd7bf..adf1d8a 100644 --- a/stem/control.py +++ b/stem/control.py @@ -26,6 +26,7 @@ interacting at a higher level. |- save_conf - saves configuration information to the torrc |- is_feature_enabled - checks if a given controller feature is enabled |- enable_feature - enables a controller feature that has been disabled by default + |- signal - sends a signal to the tor client |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -1026,6 +1027,35 @@ class Controller(BaseController): raise stem.socket.ProtocolError("USEFEATURE provided an invalid response code: %s" % response.code) self.enabled_features += [entry.upper() for entry in features] + + def signal(self, signal): + """ + Sends a signal to the Tor client. + + :param str signal: type of signal to be sent. Must be one of the following... + * HUP - Reload configuration + * INT - If server is an OP, exit immediately. If it's an OR, close listeners and exit after ShutdownWaitLength seconds + * USR1 - Dump log information about open connections and circuits + * USR2 - Switch all open logs to loglevel debug + * TERM - Clean up and exit immediately + * RELOAD - equivalent to HUP + * SHUTDOWN - equivalent to INT + * DUMP - . equivalent to USR1 + * DEBUG - . equivalent to USR2 + * HALT - . equivalent to TERM + * NEWNYM - Switch to clean circuits, so new application requests don't share any circuits with old ones and clear the client-side dns cache + * CLEARDNSCACHE - Forget the client-side cached IPs for all hostnames + + :raises: :class:`stem.socket.InvalidArguments` if signal provided wasn't recognized. + """ + + response = self.msg("SIGNAL %s" % signal) + stem.response.convert("SINGLELINE", response) + + if not response.is_ok(): + if response.code == "552": + raise stem.socket.InvalidArguments(response.code, response.message, [signal]) + raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code") def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ @@ -1053,3 +1083,4 @@ def _case_insensitive_lookup(entries, key, default = UNDEFINED): if default != UNDEFINED: return default else: raise ValueError("key '%s' doesn't exist in dict: %s" % (key, entries)) + diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 2723e27..450d219 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -348,4 +348,20 @@ class TestController(unittest.TestCase): except stem.socket.InvalidArguments, exc: self.assertEqual(["NOT"], exc.arguments) else: self.fail() + + def test_signal(self): + """ + Test controller.signal with valid and invalid signals. + """ + runner = test.runner.get_runner() + + with runner.get_tor_controller() as controller: + # valid signal + controller.signal("CLEARDNSCACHE") + + # invalid signals + self.assertRaises(stem.socket.InvalidArguments, controller.signal, "FOOBAR") + + controller.signal("INT") + self.assertRaises(stem.socket.SocketClosed, controller.msg, "GETINFO version")

1 0

[stem/master] Adding methods for SIGNAL and EXTENDCIRCUIT
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 3df65c080072d11d77664e2738652f3c0c08134e Merge: 4f6a16c 74ba2e9 Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 24 12:51:00 2012 -0700 Adding methods for SIGNAL and EXTENDCIRCUIT Feature additions by Ravi. cr atagar (https://trac.torproject.org/6659 and https://trac.torproject.org/6666) stem/control.py | 79 ++++++++++++++++++++++++++++++++++++++ test/integ/control/controller.py | 34 +++++++++++++++- test/runner.py | 15 +++++++ 3 files changed, 125 insertions(+), 3 deletions(-)

1 0

[stem/master] Revisions for EXTENDCIRCUIT addition
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 74ba2e9db42508a2bc2873dd078ae5bf2cbd140e Author: Damian Johnson <atagar(a)torproject.org> Date: Fri Aug 24 12:38:20 2012 -0700 Revisions for EXTENDCIRCUIT addition Couple minor changes: * The EXTENDCIRCUIT integ tests fails if we don't have an internet connection. Making it dependent on the ONLINE testing target. * Revising the pydocs a bit. For instance, there's no point in saying "If the purpose isn't provided, "general" circuits are built." when we can simply provide a default for the argument. ;) However, there's still a couple mysteries... * When I was offline I got the following stacktrace... ====================================================================== ERROR: test_extendcircuit ---------------------------------------------------------------------- Traceback: File "/home/atagar/Desktop/stem/test/integ/control/controller.py", line 373, in test_extendcircuit circ_id = controller.extend_circuit(0) File "/home/atagar/Desktop/stem/stem/control.py", line 1109, in extend_circuit raise stem.socket.ProtocolError("EXTENDCIRCUIT returned unexpected response code: %s" % response.code) ProtocolError: EXTENDCIRCUIT returned unexpected response code: 512 ---------------------------------------------------------------------- However, according to the control-spec the 512 response code is for "Syntax error in command argument". That doesn't make sense if we're failing because we lack a connection. * Is the 'path' argument for EXTENDCIRCUIT the circuits that we build through, or the relays to be chosen from when building a single hop? The EXTENDCIRCUIT description doesn't say, which seems to me to be a weakness in the spec. --- stem/control.py | 37 ++++++++++++++++--------------------- test/integ/control/controller.py | 11 ++++------- test/runner.py | 15 +++++++++++++++ 3 files changed, 35 insertions(+), 28 deletions(-) diff --git a/stem/control.py b/stem/control.py index 2f0c773..ece7f03 100644 --- a/stem/control.py +++ b/stem/control.py @@ -1055,43 +1055,39 @@ class Controller(BaseController): raise stem.socket.ProtocolError("SIGNAL response contained unrecognized status code: %s" % response.code) - def new_circuit(self, relays = None, purpose = None): + def new_circuit(self, path = None, purpose = "general"): """ - Requests Tor to build a new circuit. + Requests a new circuit. If the path isn't provided, one is automatically + selected. - If the path isn't provided, one is automatically selected. If the purpose - isn't provided, "general" circuits are built. - - :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param list,str path: one or more relays to make a circuit through :param str purpose: "general" or "controller" - :returns: Circuit id of the newly created circuit + :returns: int of the circuit id of the newly created circuit """ - return self.extend_circuit(0, relays, purpose) + return self.extend_circuit(0, path, purpose) - def extend_circuit(self, circuit=0, relays = None, purpose = None): + def extend_circuit(self, circuit = 0, path = None, purpose = "general"): """ - Requests Tor to build a new circuit or extend an existing circuit. + Either requests a new circuit or extend an existing one. - When called without any arguments, a new general purpose circuit is created. - If circuit is zero, a new circuit is created. If circuit is non-zero, Tor - extends the existing circuit with that id . If the path isn't provided, one - is automatically selected. If the purpose isn't provided, "general" circuits - are built. + When called with a circuit value of zero (the default) a new circuit is + created, and when non-zero the circuit with that id is extended. If the + path isn't provided, one is automatically selected. - :param int circuit: id of the circuit which needs extending - :param list,str relays: list of relay nicknames/longnames or a single nickname/longname + :param int circuit: id of a circuit to be extended + :param list,str path: one or more relays to make a circuit through :param str purpose: "general" or "controller" - :returns: Circuit id of the created/extended circuit + :returns: int of the circuit id of the created or extended circuit :raises: :class:`stem.socket.InvalidRequest` if one of the parameters were invalid """ args = [str(circuit)] - if type(relays) == str: relays = [relays] - if relays: args.append(",".join(relays)) + if type(path) == str: path = [path] + if path: args.append(",".join(path)) if purpose: args.append("purpose=%s" % purpose) response = self.msg("EXTENDCIRCUIT %s" % " ".join(args)) @@ -1136,4 +1132,3 @@ def _case_insensitive_lookup(entries, key, default = UNDEFINED): if default != UNDEFINED: return default else: raise ValueError("key '%s' doesn't exist in dict: %s" % (key, entries)) - diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 9a64d36..e1e24d8 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -336,8 +336,7 @@ class TestController(unittest.TestCase): # the orconn-status results will be empty if we don't have a connection if orconn_output == '': - test.runner.skip(self, "(no tor connections)") - return + if test.runner.require_online(self): return self.assertTrue(re.match("\$[0-9a-fA-F]{40}[~=].*", controller.get_info('orconn-status').split()[0])) self.assertTrue("VERBOSE_NAMES" in controller.enabled_features) @@ -352,9 +351,8 @@ class TestController(unittest.TestCase): """ Test controller.signal with valid and invalid signals. """ - runner = test.runner.get_runner() - with runner.get_tor_controller() as controller: + with test.runner.get_runner().get_tor_controller() as controller: # valid signal controller.signal("CLEARDNSCACHE") @@ -366,10 +364,9 @@ class TestController(unittest.TestCase): def test_extendcircuit(self): if test.runner.require_control(self): return + elif test.runner.require_online(self): return - runner = test.runner.get_runner() - - with runner.get_tor_controller() as controller: + with test.runner.get_runner().get_tor_controller() as controller: circ_id = controller.extend_circuit(0) # check if our circuit was created self.assertTrue(filter(lambda x: int(x.split()[0]) == circ_id, controller.get_info('circuit-status').splitlines())) diff --git a/test/runner.py b/test/runner.py index 0d7ba2f..cc8cf7b 100644 --- a/test/runner.py +++ b/test/runner.py @@ -11,6 +11,7 @@ about the tor test instance they're running against. skip - skips the current test if we can require_control - skips the test unless tor provides a controller endpoint require_version - skips the test unless we meet a tor version requirement + require_online - skips unless targets allow for online tests exercise_controller - basic sanity check that a controller connection can be used get_runner - Singleton for fetching our runtime context. @@ -141,6 +142,20 @@ def require_version(test_case, req_version): skip(test_case, "(requires %s)" % req_version) return True +def require_online(test_case): + """ + Skips the test if we weren't started with the ONLINE target, which indicates + that tests requiring network connectivity should run. + + :param unittest.TestCase test_case: test being ran + + :returns: True if test should be skipped, False otherwise + """ + + if not CONFIG["integ.target.online"]: + skip(test_case, "(requires online target)") + return True + def only_run_once(test_case, test_name): """ Skips the test if it has ran before. If it hasn't then flags it as being ran.

1 0

[stem/master] Adding a method for USEFEATURE
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 4f6a16c9526b45d3772abb797df2771bed6f884f Merge: 92a0bf0 6d1f362 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 23 21:44:33 2012 -0700 Adding a method for USEFEATURE Methods to enable a feature and check if a feature is on. cr atagar (https://trac.torproject.org/6417) stem/control.py | 98 +++++++++++++++++++++++++++++++------- stem/version.py | 2 + test/integ/control/controller.py | 34 +++++++++++++- 3 files changed, 116 insertions(+), 18 deletions(-)

1 0

[stem/master] Minor revisions for USEFEATURE
by atagar＠torproject.org 26 Aug '12

26 Aug '12

commit 6d1f3625710eb382a810907a49b481ca14762783 Author: Damian Johnson <atagar(a)torproject.org> Date: Thu Aug 23 21:32:36 2012 -0700 Minor revisions for USEFEATURE Few very minor tweaks... * 'GETINFO orconn-status' provides empty results when we don't have a connection, causing the test to fail. * Making is_feature_enabled() case insensitive. * Short circuiting is_feature_enabled() checks if it's in enabled_features. * The enabled_features attribute is simply used for an existance check, so we don't need to be too careful about deduplicaion. That said, we *do* need to be careful about the case of its entries. * Renamed the version constants since I'm trying to list their category at the start, to make a sort of namespace. --- stem/control.py | 29 ++++++++++++++++++----------- stem/version.py | 4 ++-- test/integ/control/controller.py | 11 ++++++++++- 3 files changed, 30 insertions(+), 14 deletions(-) diff --git a/stem/control.py b/stem/control.py index 84a9df1..7edd7bf 100644 --- a/stem/control.py +++ b/stem/control.py @@ -24,8 +24,8 @@ interacting at a higher level. |- set_options - sets or resets the values of multiple configuration options |- load_conf - loads configuration information as if it was in the torrc |- save_conf - saves configuration information to the torrc - |- is_feature_enabled - returns true if a given control connection feature is enabled - |- enable_feature - enables control protocol features that have been disabled by default + |- is_feature_enabled - checks if a given controller feature is enabled + |- enable_feature - enables a controller feature that has been disabled by default |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -976,16 +976,22 @@ class Controller(BaseController): :returns: True if feature is enabled, False otherwise """ - defaulted_version = None + feature = feature.upper() - if feature == "EXTENDED_EVENTS": - defaulted_version = stem.version.Requirement.EXTENDED_EVENTS_DEFAULTED - elif feature == "VERBOSE_NAMES": - defaulted_version = stem.version.Requirement.VERBOSE_NAMES_DEFAULTED - - if defaulted_version and self.get_version().meets_requirements(defaulted_version): + if feature in self.enabled_features: return True else: + # check if this feature is on by default + defaulted_version = None + + if feature == "EXTENDED_EVENTS": + defaulted_version = stem.version.Requirement.FEATURE_EXTENDED_EVENTS + elif feature == "VERBOSE_NAMES": + defaulted_version = stem.version.Requirement.FEATURE_VERBOSE_NAMES + + if defaulted_version and self.get_version().meets_requirements(defaulted_version): + self.enabled_features.append(feature) + return feature in self.enabled_features def enable_feature(self, features): @@ -1016,9 +1022,10 @@ class Controller(BaseController): if response.message.startswith("Unrecognized feature \""): invalid_feature = [response.message[22:response.message.find("\"", 22)]] raise stem.socket.InvalidArguments(response.code, response.message, invalid_feature) - raise stem.socket.ProtocolError("USEFEATURE returned invalid response code") + + raise stem.socket.ProtocolError("USEFEATURE provided an invalid response code: %s" % response.code) - self.enabled_features = list(set(self.enabled_features).union(features)) + self.enabled_features += [entry.upper() for entry in features] def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/version.py b/stem/version.py index 90cc997..342c400 100644 --- a/stem/version.py +++ b/stem/version.py @@ -249,7 +249,7 @@ Requirement = stem.util.enum.Enum( ("LOADCONF", Version("0.2.1.1")), ("TORRC_CONTROL_SOCKET", Version("0.2.0.30")), ("TORRC_DISABLE_DEBUGGER_ATTACHMENT", Version("0.2.3.9")), - ("VERBOSE_NAMES_DEFAULTED", Version("0.2.2.1-alpha")), - ("EXTENDED_EVENTS_DEFAULTED", Version("0.2.2.1-alpha")), + ("FEATURE_VERBOSE_NAMES", Version("0.2.2.1-alpha")), + ("FEATURE_EXTENDED_EVENTS", Version("0.2.2.1-alpha")), ) diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index ea91c8c..2723e27 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -330,8 +330,17 @@ class TestController(unittest.TestCase): with runner.get_tor_controller() as controller: if not test.runner.require_version(self, stem.version.Version("0.1.2.2-alpha")): controller.enable_feature("VERBOSE_NAMES") - self.assertTrue(re.match("\$[0-9a-fA-F]{40}[~=].*", controller.get_info('orconn-status').split()[0])) + self.assertTrue(controller.is_feature_enabled("VERBOSE_NAMES")) + + orconn_output = controller.get_info('orconn-status') + + # the orconn-status results will be empty if we don't have a connection + if orconn_output == '': + test.runner.skip(self, "(no tor connections)") + return + + self.assertTrue(re.match("\$[0-9a-fA-F]{40}[~=].*", controller.get_info('orconn-status').split()[0])) self.assertTrue("VERBOSE_NAMES" in controller.enabled_features) self.assertRaises(stem.socket.InvalidArguments, controller.enable_feature, ["NOT", "A", "FEATURE"]) try:

1 0

[compass/master] Don't display * for CC or AS if there's only one choice.
by karsten＠torproject.org 26 Aug '12

26 Aug '12

commit 78ab0521a84dd3b41007dffb4276fdc81233f311 Author: Karsten Loesing <karsten.loesing(a)gmx.net> Date: Sun Aug 26 18:08:04 2012 +0200 Don't display * for CC or AS if there's only one choice. Fixes #6693. --- compass.py | 14 ++++++++------ 1 files changed, 8 insertions(+), 6 deletions(-) diff --git a/compass.py b/compass.py index a3bdd9c..a62fb3c 100755 --- a/compass.py +++ b/compass.py @@ -232,7 +232,7 @@ class RelayStats(object): self._relays[key] = [] self._relays[key].append(relay) - def format_and_sort_groups(self, grouped_relays, by_country=False, by_as_number=False, links=False): + def format_and_sort_groups(self, grouped_relays, country=None, ases=None, by_country=False, by_as_number=False, links=False): formatted_groups = {} for group in grouped_relays.values(): group_weights = (0, 0, 0, 0, 0) @@ -257,11 +257,11 @@ class RelayStats(object): fingerprint = "*" exit = "*" guard = "*" - if by_country and not by_as_number: - as_number = "*" - as_name = "*" - if by_as_number and not by_country: - country = "*" + if not by_as_number and not ases: + as_number = "*" + as_name = "*" + if not by_country and not country: + country = "*" if links: format_string = "%8.4f%% %8.4f%% %8.4f%% %8.4f%% %8.4f%% %-19s %-78s %-4s %-5s %-2s %-9s %s" else: @@ -383,6 +383,8 @@ if '__main__' == __name__: parser.error("Did not find details.json. Re-run with --download.") stats = RelayStats(options) sorted_groups = stats.format_and_sort_groups(stats.relays, + country=options.country, + ases=options.ases, by_country=options.by_country, by_as_number=options.by_as, links=options.links)

1 0