November 2011 - tor-commits - lists.torproject.org

[translation/vidalia_help] Update translations for vidalia_help
by translation＠torproject.org 14 Nov '11

14 Nov '11

commit 9f060d031b1fa5129380a9d370cfe5a35fca421b Author: Translation commit bot <translation(a)torproject.org> Date: Mon Nov 14 09:15:26 2011 +0000 Update translations for vidalia_help --- de/services.po | 22 +++++++++++++++------- 1 files changed, 15 insertions(+), 7 deletions(-) diff --git a/de/services.po b/de/services.po index 47ed8e3..e85602a 100644 --- a/de/services.po +++ b/de/services.po @@ -8,7 +8,7 @@ msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-… [View More]Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2010-06-26 17:00+0200\n" -"PO-Revision-Date: 2011-11-14 08:44+0000\n" +"PO-Revision-Date: 2011-11-14 09:10+0000\n" "Last-Translator: freedompenguin <sebastian(a)urbach.org>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" @@ -101,6 +101,8 @@ msgid "" "Configure your hidden service, so that Tor relays requests coming from Tor " "users to your local server." msgstr "" +"Konfigurieren Sie den Hidden Service so das Tor Relay Anfragen von Tor-" +"Benutzern zu Ihrem lokalen Server durchgehen." #. type: Content of: <html><body><p> #: en/services.html:50 @@ -108,16 +110,19 @@ msgid "" "There is a fine tutorial on the Tor website (https://www.torproject.org/docs" "/tor-hidden-service.html) that describes these steps in more detail." msgstr "" +"Es gibt eine hervorragende Anleitung auf der Tor Webseite " +"(https://www.torproject.org/docs/tor-hidden-service.html) das die Schritte " +"ausführlich beschreibt." #. type: Content of: <html><body> #: en/services.html:55 msgid "<a name=\"data\"/>" -msgstr "" +msgstr "<a name=\"data\"/>" #. type: Content of: <html><body><h3> #: en/services.html:56 msgid "What data do I need to provide?" -msgstr "" +msgstr "Welche Daten muß ich zur Verfügung stellen ?" #. type: Content of: <html><body><p> #: en/services.html:58 @@ -125,6 +130,8 @@ msgid "" "The services table contains five columns containing data about configured " "hidden services:" msgstr "" +"Die Service-Tabelle beinhaltet 5 Spalten die Daten über die konfigurierten " +"Hidden Services enthalten:" #. type: Content of: <html><body><p><ul><li> #: en/services.html:61 @@ -189,17 +196,18 @@ msgstr "" #. type: Content of: <html><body> #: en/services.html:103 msgid "<a name=\"buttons\"/>" -msgstr "" +msgstr "<a name=\"buttons\"/>" #. type: Content of: <html><body><h3> #: en/services.html:104 msgid "What are the five buttons used for?" -msgstr "" +msgstr "Wofür werden die Buttons benötigt ?" #. type: Content of: <html><body><p><ul><li> #: en/services.html:107 msgid "Add service: Creates a new empty service configuration." msgstr "" +"Service hinzufügen: Erstelle eine neue, leere Service Konfigurations-Datei" #. type: Content of: <html><body><p><ul><li> #: en/services.html:108 @@ -223,7 +231,7 @@ msgstr "" #. type: Content of: <html><body> #: en/services.html:119 msgid "<a name=\"advanced\"/>" -msgstr "" +msgstr "<a name=\"advanced\"/>" #. type: Content of: <html><body><h3> #: en/services.html:120 @@ -251,7 +259,7 @@ msgstr "" #. type: Content of: <html><body> #: en/services.html:135 msgid "<a name=\"client\"/>" -msgstr "" +msgstr "<a name=\"client\"/>" #. type: Content of: <html><body><h3> #: en/services.html:136 [View Less]

1 0

[translation/vidalia_help] Update translations for vidalia_help
by translation＠torproject.org 14 Nov '11

14 Nov '11

commit ea5151ad070047d5589a5e247dacc144215887c0 Author: Translation commit bot <translation(a)torproject.org> Date: Mon Nov 14 08:45:21 2011 +0000 Update translations for vidalia_help --- de/services.po | 17 ++++++++++++++--- 1 files changed, 14 insertions(+), 3 deletions(-) diff --git a/de/services.po b/de/services.po index 134488c..47ed8e3 100644 --- a/de/services.po +++ b/de/services.po @@ -2,13 +2,14 @@ # Translators: # bastik <bastik.tor(a)googlemail.com>, 2011. #… [View More] runasand <runa.sandvik(a)gmail.com>, 2011. +# <sebastian(a)urbach.org>, 2011. msgid "" msgstr "" "Project-Id-Version: The Tor Project\n" "Report-Msgid-Bugs-To: https://trac.torproject.org/projects/tor\n" "POT-Creation-Date: 2010-06-26 17:00+0200\n" -"PO-Revision-Date: 2011-04-16 20:48+0000\n" -"Last-Translator: bastik <bastik.tor(a)googlemail.com>\n" +"PO-Revision-Date: 2011-11-14 08:44+0000\n" +"Last-Translator: freedompenguin <sebastian(a)urbach.org>\n" "Language-Team: LANGUAGE <LL(a)li.org>\n" "MIME-Version: 1.0\n" "Content-Type: text/plain; charset=UTF-8\n" @@ -51,6 +52,10 @@ msgid "" "provide a hidden service is built on top of the same circuits that Tor uses " "for anonymous browsing and roughly has similar anonymity properties." msgstr "" +"Die Option versteckte Dienste bietet die Möglichkeit beliebige TCP-basierte " +"Dienste anzubieten ohne die eigene IP-Adresse zu veröffentlichen. Das " +"Protokoll für diese Dienste ist auf dem TOR-Protokoll aufgebaut das zum " +"anonymen browsen verwendet wird und hat ungefähr die gleichen Eigenschaften." #. type: Content of: <html><body><p> #: en/services.html:35 @@ -59,11 +64,14 @@ msgid "" "Tor's design paper (doc/design-paper/tor-design.pdf) or the Rendezvous " "Specification (doc/spec/rend-spec.txt)." msgstr "" +"Um mehr Informationen zu den Hidden Services zu bekommen sollten Sie Sektion" +" 5 des Tor Design Papiers lesen (doc/design-paper/tor-design.pdf) oder das " +"Papier zum Thema Redenzvous Spezifikationen " #. type: Content of: <html><body> #: en/services.html:40 msgid "<a name=\"provide\"/>" -msgstr "" +msgstr "<a name=\"provide\"/>" #. type: Content of: <html><body><h3> #: en/services.html:41 @@ -83,6 +91,9 @@ msgid "" "Install a web server locally (or a server for whatever service you want to " "provide, e.g. IRC) to listen for local requests." msgstr "" +"Installieren Sie einen lokalen Web-Server (oder einen Server für den " +"entsprechenden Service den Sie anbieten wollen wie z.B. IRC) der auf lokale " +"Verbindungen wartet." #. type: Content of: <html><body><p><ol><li> #: en/services.html:47 [View Less]

1 0

[translation/gettor] Update translations for gettor
by translation＠torproject.org 14 Nov '11

14 Nov '11

commit f27c2d76c13858456c0f9b5f05532aedce28303b Author: Translation commit bot <translation(a)torproject.org> Date: Mon Nov 14 04:15:11 2011 +0000 Update translations for gettor --- ar/gettor.po | 18 +++++++++++++++--- cy/gettor.po | 18 +++++++++++++++--- da/gettor.po | 20 +++++++++++++++----- de/gettor.po | 20 +++++++++++++++----- el/gettor.po | 18 +++++++++++++++--- es/gettor.po | 21 +++++++++++++++------ fa/… [View More]

1 0

[stem/master] Header documentation for the proc and system utils
by atagar＠torproject.org 14 Nov '11

14 Nov '11

commit dbe041ac1bbb775f71f34f0d705d4dd654d74858 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 16:21:09 2011 -0800 Header documentation for the proc and system utils --- stem/util/proc.py | 9 +++++++++ stem/util/system.py | 9 +++++++++ 2 files changed, 18 insertions(+), 0 deletions(-) diff --git a/stem/util/proc.py b/stem/util/proc.py index 79cf92a..32ab920 100644 --- a/stem/util/proc.py +++ b/stem/util/proc.py @@ -11,6 +11,15 @@ https://code.google.… [View More]

1 0

[stem/master] Basic integ test for stem.util.conf
by atagar＠torproject.org 14 Nov '11

14 Nov '11

commit 382bc5627b8d4f29645207628ca224f08f7b6883 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 16:13:33 2011 -0800 Basic integ test for stem.util.conf Adding an integ test for the example given by the conf utility. There's a whole lot more that could be tested in that class (especially parsing and type inferences) but this doesn't seem too worth while so just adding this basic test for now. I might expand it later. --- run_tests.py … [View More] | 2 + test/integ/util/conf.py | 54 +++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 56 insertions(+), 0 deletions(-) diff --git a/run_tests.py b/run_tests.py index 7dcffaf..774c130 100755 --- a/run_tests.py +++ b/run_tests.py @@ -18,6 +18,7 @@ import test.unit.types.version import test.unit.connection.protocolinfo_response import test.unit.util.enum import test.integ.types.control_message +import test.integ.util.conf import test.integ.util.system import stem.util.enum @@ -36,6 +37,7 @@ UNIT_TESTS = (("stem.types.ControlMessage", test.unit.types.control_message.Test ) INTEG_TESTS = (("stem.types.ControlMessage", test.integ.types.control_message.TestControlMessage), + ("stem.util.conf", test.integ.util.conf.TestConf), ("stem.util.system", test.integ.util.system.TestSystem), ) diff --git a/test/integ/util/conf.py b/test/integ/util/conf.py new file mode 100644 index 0000000..03ac4a1 --- /dev/null +++ b/test/integ/util/conf.py @@ -0,0 +1,54 @@ +""" +Integration tests for the stem.util.conf class and functions. +""" + +import os +import tempfile +import unittest + +import stem.util.conf + +CONF_PATH = tempfile.mktemp("-conf-test") +CONF_HEADER = """# Demo configuration for integration tests to run against. Nothing to see here, +# move along, move along. +""" + +EXAMPLE_CONF = """%s +destination.ip 1.2.3.4 +destination.port blarg + +startup.run export PATH=$PATH:~/bin +startup.run alias l=ls +""" % CONF_HEADER + +class TestConf(unittest.TestCase): + def tearDown(self): + # cleans up test configurations we made + if os.path.exists(CONF_PATH): + os.remove(CONF_PATH) + + def test_example(self): + """ + Checks that the pydoc example is correct. + """ + + test_conf_file = open(CONF_PATH, "w") + test_conf_file.write(EXAMPLE_CONF) + test_conf_file.close() + + ssh_config = {"login.user": "atagar", + "login.password": "pepperjack_is_awesome!", + "destination.ip": "127.0.0.1", + "destination.port": 22, + "startup.run": []} + + user_config = stem.util.conf.get_config("integ-ssh_login") + user_config.load(CONF_PATH) + user_config.update(ssh_config) + + self.assertEquals("atagar", ssh_config["login.user"]) + self.assertEquals("pepperjack_is_awesome!", ssh_config["login.password"]) + self.assertEquals("1.2.3.4", ssh_config["destination.ip"]) + self.assertEquals(22, ssh_config["destination.port"]) + self.assertEquals(["export PATH=$PATH:~/bin", "alias l=ls"], ssh_config["startup.run"]) + [View Less]

1 0

[stem/master] Revising enum docs and methods
by atagar＠torproject.org 13 Nov '11

13 Nov '11

commit db7635abc7878d873a989c35e7aea413ecde2f52 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 14:38:56 2011 -0800 Revising enum docs and methods Minor changes including... - standard header documentation - replacing the keys() method with making enums iterable (functionally the same, but a little nicer for callers) - dropping the alternative LEnum - I've never used it --- stem/util/enum.py | 39 +++++++++++++++------------------------… [View More] 1 files changed, 15 insertions(+), 24 deletions(-) diff --git a/stem/util/enum.py b/stem/util/enum.py index d7745ec..6ce54d0 100644 --- a/stem/util/enum.py +++ b/stem/util/enum.py @@ -5,7 +5,7 @@ constructed as simple type listings, ie: >>> insects.ANT 'Ant' >>> insects.values() -['Ant', 'Wasp', 'Ladybug', 'Firefly'] +('Ant', 'Wasp', 'Ladybug', 'Firefly') with overwritten string counterparts: >>> pets = Enum(("DOG", "Skippy"), "CAT", ("FISH", "Nemo")) @@ -14,10 +14,13 @@ with overwritten string counterparts: >>> pets.CAT 'Cat' -or with entirely custom string components as an unordered enum with: ->>> pets = LEnum(DOG="Skippy", CAT="Kitty", FISH="Nemo") ->>> pets.CAT -'Kitty' +to_camel_case - converts a string to camel case +Enum - Provides a basic, ordered enumeration. + |- values - string representation of our enums + |- index_of - indice of an enum value + |- next - provides the enum after a given enum value + |- previous - provides the enum before a given value + +- __iter__ - iterator over our enum keys """ def to_camel_case(label, word_divider = " "): @@ -62,16 +65,6 @@ class Enum: self._keys = tuple(keys) self._values = tuple(values) - def keys(self): - """ - Provides an ordered listing of the enumeration keys in this set. - - Returns: - tuple with our enum keys - """ - - return self._keys - def values(self): """ Provides an ordered listing of the enumerations in this set. @@ -137,14 +130,12 @@ class Enum: prev_index = (self._values.index(value) - 1) % len(self._values) return self._values[prev_index] - -class LEnum(Enum): - """ - Enumeration that accepts custom string mappings. - """ - def __init__(self, **args): - Enum.__init__(self) - self.__dict__.update(args) - self._values = sorted(args.values()) + def __iter__(self): + """ + Provides an ordered listing of the enumeration keys in this set. + """ + + for entry in self._keys: + yield entry [View Less]

1 0

[stem/master] Unit tests for PROTOCOLINFO responses
by atagar＠torproject.org 13 Nov '11

13 Nov '11

commit 2b797d0ba9310a015bef5bc2605020ebe8ffafdd Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 13:15:49 2011 -0800 Unit tests for PROTOCOLINFO responses --- run_tests.py | 2 + stem/connection.py | 10 +- test/unit/connection/__init__.py | 6 + test/unit/connection/protocolinfo_response.py | 144 +++++++++++++++++++++++++ 4 files changed, 158 insertions(+), 4 deletions(-) diff --… [View More]git a/run_tests.py b/run_tests.py index 0b86706..1107a59 100755 --- a/run_tests.py +++ b/run_tests.py @@ -15,6 +15,7 @@ import test.runner import test.unit.types.control_message import test.unit.types.control_line import test.unit.types.version +import test.unit.connection.protocolinfo_response import test.integ.message import test.integ.system @@ -29,6 +30,7 @@ DIVIDER = "=" * 70 UNIT_TESTS = (("stem.types.ControlMessage", test.unit.types.control_message.TestControlMessage), ("stem.types.ControlLine", test.unit.types.control_line.TestControlLine), ("stem.types.Version", test.unit.types.version.TestVerion), + ("stem.connection.ProtocolInfoResponse", test.unit.connection.protocolinfo_response.TestProtocolInfoResponse), ) INTEG_TESTS = (("stem.types.ControlMessage", test.integ.message.TestMessageFunctions), diff --git a/stem/connection.py b/stem/connection.py index d17efde..2b96899 100644 --- a/stem/connection.py +++ b/stem/connection.py @@ -53,7 +53,8 @@ class ProtocolInfoResponse(stem.types.ControlMessage): def convert(control_message): """ - Parses a ControlMessage, converting it into a ProtocolInfoResponse. + Parses a ControlMessage, performing an in-place conversion of it into a + ProtocolInfoResponse. Arguments: control_message (stem.types.ControlMessage) - @@ -61,7 +62,7 @@ class ProtocolInfoResponse(stem.types.ControlMessage): Raises: stem.types.ProtocolError the message isn't a proper PROTOCOLINFO response - ValueError if argument is of the wrong type + TypeError if argument isn't a ControlMessage """ if isinstance(control_message, stem.types.ControlMessage): @@ -69,7 +70,7 @@ class ProtocolInfoResponse(stem.types.ControlMessage): control_message._parse_message() return control_message else: - raise ValueError("Only able to convert stem.types.ControlMessage instances") + raise TypeError("Only able to convert stem.types.ControlMessage instances") convert = staticmethod(convert) @@ -152,7 +153,7 @@ class ProtocolInfoResponse(stem.types.ControlMessage): # parse optional COOKIEFILE mapping (quoted and can have escapes) if line.is_next_mapping("COOKIEFILE", True, True): - self.cookie_file = line.pop_mapping(True, True)[0] + self.cookie_file = line.pop_mapping(True, True)[1] # attempt to expand relative cookie paths if stem.util.system.is_relative_path(self.cookie_file): @@ -286,6 +287,7 @@ class ControlConnection: while self.is_running(): try: + # TODO: this raises a SocketClosed when... well, the socket is closed control_message = stem.types.read_message(self._control_socket_file) if control_message.content()[-1][0] == "650": diff --git a/test/unit/connection/__init__.py b/test/unit/connection/__init__.py new file mode 100644 index 0000000..440773e --- /dev/null +++ b/test/unit/connection/__init__.py @@ -0,0 +1,6 @@ +""" +Unit tests for stem.connection. +""" + +__all__ = ["protocolinfo_response"] + diff --git a/test/unit/connection/protocolinfo_response.py b/test/unit/connection/protocolinfo_response.py new file mode 100644 index 0000000..0dcde95 --- /dev/null +++ b/test/unit/connection/protocolinfo_response.py @@ -0,0 +1,144 @@ +""" +Unit tests for the stem.connection.ProtocolInfoResponse class. +""" + +import unittest +import StringIO +import stem.connection +import stem.types + +NO_AUTH = """250-PROTOCOLINFO 1 +250-AUTH METHODS=NULL +250-VERSION Tor="0.2.1.30" +250 OK +""".replace("\n", "\r\n") + +PASSWORD_AUTH = """250-PROTOCOLINFO 1 +250-AUTH METHODS=HASHEDPASSWORD +250-VERSION Tor="0.2.1.30" +250 OK +""".replace("\n", "\r\n") + +COOKIE_AUTH = r"""250-PROTOCOLINFO 1 +250-AUTH METHODS=COOKIE COOKIEFILE="/tmp/my data\\\"dir//control_auth_cookie" +250-VERSION Tor="0.2.1.30" +250 OK +""".replace("\n", "\r\n") + +MULTIPLE_AUTH = """250-PROTOCOLINFO 1 +250-AUTH METHODS=COOKIE,HASHEDPASSWORD COOKIEFILE="/home/atagar/.tor/control_auth_cookie" +250-VERSION Tor="0.2.1.30" +250 OK +""".replace("\n", "\r\n") + +UNKNOWN_AUTH = """250-PROTOCOLINFO 1 +250-AUTH METHODS=MAGIC,HASHEDPASSWORD,PIXIE_DUST +250-VERSION Tor="0.2.1.30" +250 OK +""".replace("\n", "\r\n") + +MINIMUM_RESPONSE = """250-PROTOCOLINFO 5 +250 OK +""".replace("\n", "\r\n") + +class TestProtocolInfoResponse(unittest.TestCase): + """ + Tests the parsing of ControlMessages for PROTOCOLINFO responses. + """ + + def test_convert(self): + """ + Exercises functionality of the convert method both when it works and + there's an error. + """ + + # working case + control_message = stem.types.read_message(StringIO.StringIO(NO_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + + # now this should be a ProtocolInfoResponse (ControlMessage subclass) + self.assertTrue(isinstance(control_message, stem.types.ControlMessage)) + self.assertTrue(isinstance(control_message, stem.connection.ProtocolInfoResponse)) + + # exercise some of the ControlMessage functionality + self.assertTrue(str(control_message).startswith("PROTOCOLINFO 1")) + self.assertEquals(NO_AUTH, control_message.raw_content()) + + # attempt to convert the wrong type + self.assertRaises(TypeError, stem.connection.ProtocolInfoResponse.convert, "hello world") + + # attempt to convert a different message type + bw_event_control_message = stem.types.read_message(StringIO.StringIO("650 BW 32326 2856\r\n")) + self.assertRaises(stem.types.ProtocolError, stem.connection.ProtocolInfoResponse.convert, bw_event_control_message) + + def test_no_auth(self): + """ + Checks a response when there's no authentication. + """ + + control_message = stem.types.read_message(StringIO.StringIO(NO_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + + self.assertEquals(1, control_message.protocol_version) + self.assertEquals(stem.types.Version("0.2.1.30"), control_message.tor_version) + self.assertEquals((stem.connection.AuthMethod.NONE, ), control_message.auth_methods) + self.assertEquals((), control_message.unknown_auth_methods) + self.assertEquals(None, control_message.cookie_file) + self.assertEquals(None, control_message.socket) + + def test_password_auth(self): + """ + Checks a response with password authentication. + """ + + control_message = stem.types.read_message(StringIO.StringIO(PASSWORD_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + self.assertEquals((stem.connection.AuthMethod.PASSWORD, ), control_message.auth_methods) + + def test_cookie_auth(self): + """ + Checks a response with cookie authentication and a path including escape + characters. + """ + + control_message = stem.types.read_message(StringIO.StringIO(COOKIE_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + self.assertEquals((stem.connection.AuthMethod.COOKIE, ), control_message.auth_methods) + self.assertEquals("/tmp/my data\\\"dir//control_auth_cookie", control_message.cookie_file) + + def test_multiple_auth(self): + """ + Checks a response with multiple authentication methods. + """ + + control_message = stem.types.read_message(StringIO.StringIO(MULTIPLE_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + self.assertEquals((stem.connection.AuthMethod.COOKIE, stem.connection.AuthMethod.PASSWORD), control_message.auth_methods) + self.assertEquals("/home/atagar/.tor/control_auth_cookie", control_message.cookie_file) + + def test_unknown_auth(self): + """ + Checks a response with an unrecognized authtentication method. + """ + + control_message = stem.types.read_message(StringIO.StringIO(UNKNOWN_AUTH)) + stem.connection.ProtocolInfoResponse.convert(control_message) + self.assertEquals((stem.connection.AuthMethod.UNKNOWN, stem.connection.AuthMethod.PASSWORD), control_message.auth_methods) + self.assertEquals(("MAGIC", "PIXIE_DUST"), control_message.unknown_auth_methods) + + def test_minimum_response(self): + """ + Checks a PROTOCOLINFO response that only contains the minimum amount of + information to be a valid response. + """ + + control_message = stem.types.read_message(StringIO.StringIO(MINIMUM_RESPONSE)) + stem.connection.ProtocolInfoResponse.convert(control_message) + + self.assertEquals(5, control_message.protocol_version) + self.assertEquals(None , control_message.tor_version) + self.assertEquals((), control_message.auth_methods) + self.assertEquals((), control_message.unknown_auth_methods) + self.assertEquals(None, control_message.cookie_file) + self.assertEquals(None, control_message.socket) + [View Less]

1 0

[stem/master] Including stem prefix for paths in stem comments
by atagar＠torproject.org 13 Nov '11

13 Nov '11

commit fc562144fd8a333ad517575976328bc2dc3cec5d Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 13:43:59 2011 -0800 Including stem prefix for paths in stem comments --- test/integ/message.py | 4 ++-- test/integ/system.py | 13 +++++++------ test/unit/types/control_line.py | 4 ++-- test/unit/types/control_message.py | 6 +++--- test/unit/types/version.py | 4 ++-- 5 files changed, 16 insertions(+), 15 deletions(… [View More]-) diff --git a/test/integ/message.py b/test/integ/message.py index a562f86..a8e722d 100644 --- a/test/integ/message.py +++ b/test/integ/message.py @@ -1,5 +1,5 @@ """ -Integration tests for the types.ControlMessage class. +Integration tests for the stem.types.ControlMessage class. """ import re @@ -11,7 +11,7 @@ import test.runner class TestMessageFunctions(unittest.TestCase): """ - Exercises the 'types.ControlMessage' class with an actual tor instance. + Exercises the 'stem.types.ControlMessage' class with an actual tor instance. """ def test_unestablished_socket(self): diff --git a/test/integ/system.py b/test/integ/system.py index 09ffd24..32ac892 100644 --- a/test/integ/system.py +++ b/test/integ/system.py @@ -1,5 +1,5 @@ """ -Unit tests for the util.system functions in the context of a tor process. +Unit tests for the stem.util.system functions in the context of a tor process. """ import os @@ -10,12 +10,13 @@ import stem.util.system as system class TestSystemFunctions(unittest.TestCase): """ - Tests the util.system functions against the tor process that we're running. + Tests the stem.util.system functions against the tor process that we're + running. """ def test_is_available(self): """ - Checks the util.system.is_available function. + Checks the stem.util.system.is_available function. """ # since we're running tor it would be kinda sad if this didn't detect it @@ -26,7 +27,7 @@ class TestSystemFunctions(unittest.TestCase): def test_is_running(self): """ - Checks the util.system.is_running function. + Checks the stem.util.system.is_running function. """ self.assertTrue(system.is_running("tor")) @@ -34,7 +35,7 @@ class TestSystemFunctions(unittest.TestCase): def test_get_pid(self): """ - Checks the util.system.get_pid function. + Checks the stem.util.system.get_pid function. """ runner = test.runner.get_runner() @@ -43,7 +44,7 @@ class TestSystemFunctions(unittest.TestCase): def test_get_cwd(self): """ - Checks the util.system.get_cwd function. + Checks the stem.util.system.get_cwd function. """ # tor's pwd will match our process since we started it diff --git a/test/unit/types/control_line.py b/test/unit/types/control_line.py index bacda76..0c324e5 100644 --- a/test/unit/types/control_line.py +++ b/test/unit/types/control_line.py @@ -1,5 +1,5 @@ """ -Unit tests for the types.ControlLine class. +Unit tests for the stem.types.ControlLine class. """ import unittest @@ -15,7 +15,7 @@ PROTOCOLINFO_RESPONSE = ( class TestControlLine(unittest.TestCase): """ - Tests methods of the types.ControlLine class. + Tests methods of the stem.types.ControlLine class. """ def test_pop_examples(self): diff --git a/test/unit/types/control_message.py b/test/unit/types/control_message.py index 5e9b7bc..af8fa00 100644 --- a/test/unit/types/control_message.py +++ b/test/unit/types/control_message.py @@ -1,5 +1,5 @@ """ -Unit tests for the types.ControlMessage parsing and class. +Unit tests for the stem.types.ControlMessage parsing and class. """ import socket @@ -31,7 +31,7 @@ version -- The current version of Tor. class TestControlMessage(unittest.TestCase): """ - Tests methods and functions related to 'types.ControlMessage'. This uses + Tests methods and functions related to 'stem.types.ControlMessage'. This uses StringIO to make 'files' to mock socket input. """ @@ -163,7 +163,7 @@ class TestControlMessage(unittest.TestCase): Performs some basic sanity checks that a reply mirrors its parsed result. Returns: - types.ControlMessage for the given input + stem.types.ControlMessage for the given input """ message = stem.types.read_message(StringIO.StringIO(controller_reply)) diff --git a/test/unit/types/version.py b/test/unit/types/version.py index fb04641..309ee07 100644 --- a/test/unit/types/version.py +++ b/test/unit/types/version.py @@ -1,5 +1,5 @@ """ -Unit tests for the types.Version parsing and class. +Unit tests for the stem.types.Version parsing and class. """ import unittest @@ -7,7 +7,7 @@ import stem.types class TestVerion(unittest.TestCase): """ - Tests methods and functions related to 'types.Version'. + Tests methods and functions related to 'stem.types.Version'. """ def test_parsing(self): [View Less]

1 0

[stem/master] Rearranging conf util to improve usability
by atagar＠torproject.org 13 Nov '11

13 Nov '11

commit f9aeefb2805e2ef9cd63f236c7a27308718575e9 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 14:01:55 2011 -0800 Rearranging conf util to improve usability Adding the standard configuration header (... sooo helpful) and moving the rest of the util's contents around to be more intuitive. --- stem/util/conf.py | 398 +++++++++++++++++++++++++++-------------------------- 1 files changed, 205 insertions(+), 193 deletions(-) diff --git a/stem/util/… [View More]conf.py b/stem/util/conf.py index 7581a98..7ba2f11 100644 --- a/stem/util/conf.py +++ b/stem/util/conf.py @@ -3,73 +3,26 @@ This provides handlers for specially formatted configuration files. Entries are expected to consist of simple key/value pairs, and anything after "#" is stripped as a comment. Excess whitespace is trimmed and empty lines are ignored. For instance: -# This is my sample config -user.name Galen -user.password yabba1234 # here's an inline comment -user.notes takes a fancy to pepperjack chese -blankEntry.example + # This is my sample config + user.name Galen + user.password yabba1234 # here's an inline comment + user.notes takes a fancy to pepperjack chese + blankEntry.example -would be loaded as four entries (the last one's value being an empty string). -If a key's defined multiple times then the last instance of it is used. +would be loaded as four entries, the last one's value being an empty string. -Example usage: - User has a file at '/home/atagar/myConfig' with... - destination.ip 1.2.3.4 - destination.port blarg - - startup.run export PATH=$PATH:~/bin - startup.run alias l=ls - - And they have a script with... - import stem.util.conf - - # Configuration values we'll use in this file. These are mappings of - # configuration keys to the default values we'll use if the user doesn't - # have something different in their config file (or it doesn't match this - # type). - - ssh_config = {"login.user": "atagar", - "login.password": "pepperjack_is_awesome!", - "destination.ip": "127.0.0.1", - "destination.port": 22, - "startup.run": []} - - # Makes an empty config instance with the handle of 'ssh_login'. This is a - # singleton so other classes can fetch this same configuration from this - # handle. - - user_config = stem.util.conf.get_config("ssh_login") - - # Loads the user's configuration file, warning if this fails. - - try: - user_config.load("/home/atagar/myConfig") - except IOError, exc: - print "Unable to load the user's config: %s" % exc - - # Replaces the contents of ssh_config with the values from the user's - # config file if... - # - the key is present in the config file - # - we're able to convert the configuration file's value to the same type - # as what's in the mapping (see the Config.get() method for how these - # type inferences work) - # - # For instance in this case the login values are left alone (because they - # aren't in the user's config file), and the 'destination.port' is also - # left with the value of 22 because we can't turn "blarg" into an integer. - # - # The other values are replaced, so ssh_config now becomes... - # {"login.user": "atagar", - # "login.password": "pepperjack_is_awesome!", - # "destination.ip": "1.2.3.4", - # "destination.port": 22, - # "startup.run": ["export PATH=$PATH:~/bin", "alias l=ls"]} - # - # Information for what values fail to load and why are reported to - # 'stem.util.log'. - - user_config.update(ssh_config) +get_config - Singleton for getting configurations +Config - Custom configuration. + |- load - reads a configuration file + |- clear - empties our loaded configuration contents + |- update - replaces mappings in a dictionary with the config's values + |- keys - provides keys in the loaded configuration + |- unused_keys - provides keys that have never been requested + |- get - provides the value for a given key, with type inference + |- get_value - provides the value for a given key as a string + |- get_str_csv - gets a value as a comma separated list of strings + +- get_int_csv - gets a value as a comma separated list of integers """ import logging @@ -107,6 +60,65 @@ class Config(): """ Handler for easily working with custom configurations, providing persistence to and from files. All operations are thread safe. + + Example usage: + User has a file at '/home/atagar/myConfig' with... + destination.ip 1.2.3.4 + destination.port blarg + + startup.run export PATH=$PATH:~/bin + startup.run alias l=ls + + And they have a script with... + import stem.util.conf + + # Configuration values we'll use in this file. These are mappings of + # configuration keys to the default values we'll use if the user doesn't + # have something different in their config file (or it doesn't match this + # type). + + ssh_config = {"login.user": "atagar", + "login.password": "pepperjack_is_awesome!", + "destination.ip": "127.0.0.1", + "destination.port": 22, + "startup.run": []} + + # Makes an empty config instance with the handle of 'ssh_login'. This is + # a singleton so other classes can fetch this same configuration from + # this handle. + + user_config = stem.util.conf.get_config("ssh_login") + + # Loads the user's configuration file, warning if this fails. + + try: + user_config.load("/home/atagar/myConfig") + except IOError, exc: + print "Unable to load the user's config: %s" % exc + + # Replaces the contents of ssh_config with the values from the user's + # config file if... + # - the key is present in the config file + # - we're able to convert the configuration file's value to the same type + # as what's in the mapping (see the Config.get() method for how these + # type inferences work) + # + # For instance in this case the login values are left alone (because they + # aren't in the user's config file), and the 'destination.port' is also + # left with the value of 22 because we can't turn "blarg" into an + # integer. + # + # The other values are replaced, so ssh_config now becomes... + # {"login.user": "atagar", + # "login.password": "pepperjack_is_awesome!", + # "destination.ip": "1.2.3.4", + # "destination.port": 22, + # "startup.run": ["export PATH=$PATH:~/bin", "alias l=ls"]} + # + # Information for what values fail to load and why are reported to + # 'stem.util.log'. + + user_config.update(ssh_config) """ def __init__(self): @@ -124,35 +136,116 @@ class Config(): # keys that have been requested (used to provide unused config contents) self._requested_keys = set() - def get_value(self, key, default = None, multiple = False): + def load(self, path): """ - This provides the currently value associated with a given key. + Reads in the contents of the given path, adding its configuration values + to our current contents. Arguments: - key (str) - config setting to be fetched - default (object) - value provided if no such key exists - multiple (bool) - provides back a list of all values if true, otherwise - this returns the last loaded configuration value + path (str) - file path to be loaded - Returns: - string or list of string configuration values associated with the given - key, providing the default if no such key exists + Raises: + IOError if we fail to read the file (it doesn't exist, insufficient + permissions, etc) """ + config_file = open(path, "r") + read_contents = config_file.readlines() + config_file.close() + self._contents_lock.acquire() + self._raw_contents = read_contents - if key in self._contents: - val = self._contents[key] - if not multiple: val = val[-1] - self._requested_keys.add(key) - else: - msg = "config entry '%s' not found, defaulting to '%s'" % (key, default) - LOGGER.debug(msg) - val = default + for line in self._raw_contents: + # strips any commenting or excess whitespace + comment_start = line.find("#") + if comment_start != -1: line = line[:comment_start] + line = line.strip() + + # parse the key/value pair + if line: + if " " in line: + key, value = line.split(" ", 1) + value = value.strip() + else: + key, value = line, "" + + if key in self._contents: self._contents[key].append(value) + else: self._contents[key] = [value] + self._path = path self._contents_lock.release() + + def clear(self): + """ + Drops the configuration contents and reverts back to a blank, unloaded + state. + """ - return val + self._contents_lock.acquire() + self._path = None + self._contents.clear() + self._raw_contents = [] + self._requested_keys = set() + self._contents_lock.release() + + def update(self, conf_mappings, limits = None): + """ + This takes a dictionary of 'config_key => default_value' mappings and + changes the values to reflect our current configuration. This will leave + the previous values alone if... + + a. we don't have a value for that config_key + b. we can't convert our value to be the same type as the default_value + + For more information about how we convert types see our get() method. + + Arguments: + conf_mappings (dict) - configuration key/value mappings to be revised + limits (dict) - mappings of limits on numeric values, expected to + be of the form "configKey -> min" or "configKey -> + (min, max)" + """ + + if limits == None: limits = {} + + for entry in conf_mappings.keys(): + val = self.get(entry, conf_mappings[entry]) + + # if this was a numeric value then apply constraints + if entry in limits and (isinstance(val, int) or isinstance(val, float)): + if isinstance(limits[entry], tuple): + val = max(val, limits[entry][0]) + val = min(val, limits[entry][1]) + else: val = max(val, limits[entry]) + + # only use this value if it wouldn't change the type of the mapping (this + # will only fail if the type isn't either a string or one of the types + # recognized by the get method) + + if type(val) == type(conf_mappings[entry]): + conf_mappings[entry] = val + + def keys(self): + """ + Provides all keys in the currently loaded configuration. + + Returns: + list if strings for the configuration keys we've loaded + """ + + return self._contents.keys() + + def unused_keys(self): + """ + Provides the configuration keys that have never been provided to a caller + via the get, get_value, or update methods. + + Returns: + set of configuration keys we've loaded but have never been requested + """ + + return set(self.get_keys()).difference(self._requested_keys) def get(self, key, default = None): """ @@ -242,6 +335,36 @@ class Config(): return val + def get_value(self, key, default = None, multiple = False): + """ + This provides the currently value associated with a given key. + + Arguments: + key (str) - config setting to be fetched + default (object) - value provided if no such key exists + multiple (bool) - provides back a list of all values if true, otherwise + this returns the last loaded configuration value + + Returns: + string or list of string configuration values associated with the given + key, providing the default if no such key exists + """ + + self._contents_lock.acquire() + + if key in self._contents: + val = self._contents[key] + if not multiple: val = val[-1] + self._requested_keys.add(key) + else: + msg = "config entry '%s' not found, defaulting to '%s'" % (key, default) + LOGGER.debug(msg) + val = default + + self._contents_lock.release() + + return val + def get_str_csv(self, key, default = None, count = None): """ Fetches the given key as a comma separated value. @@ -319,115 +442,4 @@ class Config(): LOGGER.info(error_msg) return default else: return [int(val) for val in conf_comp] - - def update(self, conf_mappings, limits = None): - """ - This takes a dictionary of 'config_key => default_value' mappings and - changes the values to reflect our current configuration. This will leave - the previous values alone if... - - a. we don't have a value for that config_key - b. we can't convert our value to be the same type as the default_value - - For more information about how we convert types see our get() method. - - Arguments: - conf_mappings (dict) - configuration key/value mappings to be revised - limits (dict) - mappings of limits on numeric values, expected to - be of the form "configKey -> min" or "configKey -> - (min, max)" - """ - - if limits == None: limits = {} - - for entry in conf_mappings.keys(): - val = self.get(entry, conf_mappings[entry]) - - # if this was a numeric value then apply constraints - if entry in limits and (isinstance(val, int) or isinstance(val, float)): - if isinstance(limits[entry], tuple): - val = max(val, limits[entry][0]) - val = min(val, limits[entry][1]) - else: val = max(val, limits[entry]) - - # only use this value if it wouldn't change the type of the mapping (this - # will only fail if the type isn't either a string or one of the types - # recognized by the get method) - - if type(val) == type(conf_mappings[entry]): - conf_mappings[entry] = val - - def keys(self): - """ - Provides all keys in the currently loaded configuration. - - Returns: - list if strings for the configuration keys we've loaded - """ - - return self._contents.keys() - - def unused_keys(self): - """ - Provides the configuration keys that have never been provided to a caller - via the get, get_value, or update methods. - - Returns: - set of configuration keys we've loaded but have never been requested - """ - - return set(self.get_keys()).difference(self._requested_keys) - - def reset(self): - """ - Drops the configuration contents and reverts back to a blank, unloaded - state. - """ - - self._contents_lock.acquire() - self._path = None - self._contents.clear() - self._raw_contents = [] - self._requested_keys = set() - self._contents_lock.release() - - def load(self, path): - """ - Reads in the contents of the given path, adding its configuration values - to our current contents. - - Arguments: - path (str) - file path to be loaded - - Raises: - IOError if we fail to read the file (it doesn't exist, insufficient - permissions, etc) - """ - - config_file = open(path, "r") - read_contents = config_file.readlines() - config_file.close() - - self._contents_lock.acquire() - self._raw_contents = read_contents - - for line in self._raw_contents: - # strips any commenting or excess whitespace - comment_start = line.find("#") - if comment_start != -1: line = line[:comment_start] - line = line.strip() - - # parse the key/value pair - if line: - if " " in line: - key, value = line.split(" ", 1) - value = value.strip() - else: - key, value = line, "" - - if key in self._contents: self._contents[key].append(value) - else: self._contents[key] = [value] - - self._path = path - self._contents_lock.release() [View Less]

1 0

[stem/master] Unit tests for enum
by atagar＠torproject.org 13 Nov '11

13 Nov '11

commit d30e229c325bc243697d1d015a7bda03082c9756 Author: Damian Johnson <atagar(a)torproject.org> Date: Sun Nov 13 15:02:47 2011 -0800 Unit tests for enum --- run_tests.py | 2 + test/unit/util/__init__.py | 6 ++++ test/unit/util/enum.py | 59 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 67 insertions(+), 0 deletions(-) diff --git a/run_tests.py b/run_tests.py index 1107a59..530466a 100755 --- a/run_tests.py +++ b/run_tests.py @@ -16,6 +… [View More]16,7 @@ import test.unit.types.control_message import test.unit.types.control_line import test.unit.types.version import test.unit.connection.protocolinfo_response +import test.unit.util.enum import test.integ.message import test.integ.system @@ -31,6 +32,7 @@ UNIT_TESTS = (("stem.types.ControlMessage", test.unit.types.control_message.Test ("stem.types.ControlLine", test.unit.types.control_line.TestControlLine), ("stem.types.Version", test.unit.types.version.TestVerion), ("stem.connection.ProtocolInfoResponse", test.unit.connection.protocolinfo_response.TestProtocolInfoResponse), + ("stem.util.enum", test.unit.util.enum.TestEnum), ) INTEG_TESTS = (("stem.types.ControlMessage", test.integ.message.TestMessageFunctions), diff --git a/test/unit/util/__init__.py b/test/unit/util/__init__.py new file mode 100644 index 0000000..84f12bf --- /dev/null +++ b/test/unit/util/__init__.py @@ -0,0 +1,6 @@ +""" +Unit tests for stem.util.* contents. +""" + +__all__ = ["enum"] + diff --git a/test/unit/util/enum.py b/test/unit/util/enum.py new file mode 100644 index 0000000..abdff06 --- /dev/null +++ b/test/unit/util/enum.py @@ -0,0 +1,59 @@ +""" +Unit tests for the stem.util.enum class and functions. +""" + +import unittest +import stem.util.enum + +class TestEnum(unittest.TestCase): + """ + Tests the stem.util.enum contents. + """ + + def test_to_camel_case(self): + """ + Checks the stem.util.enum.to_camel_case function. + """ + + # test the pydoc example + self.assertEquals("I Like Pepperjack!", stem.util.enum.to_camel_case("I_LIKE_PEPPERJACK!")) + + # check a few edge cases + self.assertEquals("", stem.util.enum.to_camel_case("")) + self.assertEquals("Hello", stem.util.enum.to_camel_case("hello")) + self.assertEquals("Hello", stem.util.enum.to_camel_case("HELLO")) + self.assertEquals("Hello World", stem.util.enum.to_camel_case("hello__world")) + self.assertEquals("Hello\tworld", stem.util.enum.to_camel_case("hello\tWORLD")) + self.assertEquals("Hello\t\tWorld", stem.util.enum.to_camel_case("hello__world", "\t")) + + def test_enum_examples(self): + """ + Checks that the pydoc examples are accurate. + """ + + insects = stem.util.enum.Enum("ANT", "WASP", "LADYBUG", "FIREFLY") + self.assertEquals("Ant", insects.ANT) + self.assertEquals(("Ant", "Wasp", "Ladybug", "Firefly"), insects.values()) + + pets = stem.util.enum.Enum(("DOG", "Skippy"), "CAT", ("FISH", "Nemo")) + self.assertEquals("Skippy", pets.DOG) + self.assertEquals("Cat", pets.CAT) + + def test_enum_methods(self): + """ + Exercises enumeration methods. + """ + + insects = stem.util.enum.Enum("ANT", "WASP", "LADYBUG", "FIREFLY") + + # next method + self.assertEquals(insects.WASP, insects.next(insects.ANT)) + self.assertEquals(insects.ANT, insects.next(insects.FIREFLY)) + + # previous method + self.assertEquals(insects.FIREFLY, insects.previous(insects.ANT)) + self.assertEquals(insects.LADYBUG, insects.previous(insects.FIREFLY)) + + # __iter__ method + self.assertEquals(("ANT", "WASP", "LADYBUG", "FIREFLY"), tuple(insects)) + [View Less]

1 0