- tor-commits - lists.torproject.org

[vidalia/master] Remove the last changes file
by chiiph＠torproject.org 29 Jan '12

29 Jan '12

commit fd8c007a0b1504e89a768853b87a91d0109d0e2c Author: Tomás Touceda <chiiph(a)torproject.org> Date: Sun Jan 29 11:43:11 2012 -0300 Remove the last changes file --- changes/bug4833 | 2 -- 1 files changed, 0 insertions(+), 2 deletions(-) diff --git a/changes/bug4833 b/changes/bug4833 deleted file mode 100644 index 2b31765..0000000 --- a/changes/bug4833 +++ /dev/null @@ -1,2 +0,0 @@ - o Sets __ReloadTorrcOnSIGHUP to 0 if SAVECONF failed, which means - the user can't write the torrc file. Fixes bug 4833. \ No newline at end of file

1 0

[vidalia/master] Add a changes file
by chiiph＠torproject.org 29 Jan '12

29 Jan '12

commit 624451f698a7ebca872ef86f910f75d391659547 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Mon Jan 23 11:10:23 2012 -0300 Add a changes file --- changes/bug4833 | 2 ++ 1 files changed, 2 insertions(+), 0 deletions(-) diff --git a/changes/bug4833 b/changes/bug4833 new file mode 100644 index 0000000..2b31765 --- /dev/null +++ b/changes/bug4833 @@ -0,0 +1,2 @@ + o Sets __ReloadTorrcOnSIGHUP to 0 if SAVECONF failed, which means + the user can't write the torrc file. Fixes bug 4833. \ No newline at end of file

1 0

r25359: {website} put the diagram at the top; fix a typo; get rid of the clien (website/trunk/projects/en)
by Roger Dingledine 29 Jan '12

29 Jan '12

Author: arma Date: 2012-01-29 13:35:00 +0000 (Sun, 29 Jan 2012) New Revision: 25359 Modified: website/trunk/projects/en/obfsproxy-instructions.wml Log: put the diagram at the top; fix a typo; get rid of the client-side log window since it didn't show anything. Modified: website/trunk/projects/en/obfsproxy-instructions.wml =================================================================== --- website/trunk/projects/en/obfsproxy-instructions.wml 2012-01-29 13:34:15 UTC (rev 25358) +++ website/trunk/projects/en/obfsproxy-instructions.wml 2012-01-29 13:35:00 UTC (rev 25359) @@ -16,6 +16,8 @@ <h1 id="instructions">Obfsproxy Instructions</h1> + <img src="$(IMGROOT)/obfsproxy_diagram.png" alt="client torrc"></a> + <h3>Step 1: Install dependencies, obfsproxy, and Tor</h3> <br> @@ -59,7 +61,8 @@ <br> <p> - Add the appropriate lines to your tor configuration file: + Add the appropriate lines to your <a href="<page docs/faq>#torrc">tor + configuration file</a>: </p> <p> @@ -69,19 +72,10 @@ </p> <p> - Don't forget to replace <em>192.0.2.34</em> with the IP address of - the bridge you wish to use, and <em>34545</em> with the port - obfpsroxy is listening on. + Don't forget to replace <em>192.0.2.34:34545</em> with the IP address + and port that the bridge's obfsproxy is listening on. </p> - <p> - Launch Tor using this configuration file. You can do this by using - your favorite init script, or by pointing the Tor binary to the - torrc file: - </p> - - <img src="$(IMGROOT)/obfs-spawn_tor_client.png" alt="spawn tor" height="101" width="882"> - <p> <br> <img src="$(IMGROOT)/sidenav-arrow.png"> <strong>Congratulations!</strong> Your traffic should now be @@ -98,7 +92,8 @@ <br> <p> - Add the appropriate lines to your tor configuration file: + Add the appropriate lines to your <a href="<page docs/faq>#torrc">tor + configuration file</a>: </p> <p>

1 0

r25358: {website} there is no 'obfsproxy' download yet (website/trunk/projects/en)
by Roger Dingledine 29 Jan '12

29 Jan '12

Author: arma Date: 2012-01-29 13:34:15 +0000 (Sun, 29 Jan 2012) New Revision: 25358 Modified: website/trunk/projects/en/obfsproxy.wml Log: there is no 'obfsproxy' download yet Modified: website/trunk/projects/en/obfsproxy.wml =================================================================== --- website/trunk/projects/en/obfsproxy.wml 2012-01-28 14:08:25 UTC (rev 25357) +++ website/trunk/projects/en/obfsproxy.wml 2012-01-29 13:34:15 UTC (rev 25358) @@ -47,8 +47,6 @@ <h2><a class="anchor" href="<page projects/obfsproxy-instructions>#instructions">Installation Instructions</a></h2> - <h2><a href="https://gitweb.torproject.org/obfsproxy.git">Download</a></h2> - <p> Please open a <a href="https://trac.torproject.org/projects/tor/query?status=accepted&status=assig…">ticket</a>

1 0

[stem/master] Providing higher test runtime accuracy if low
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit 9b5e2295a2217081cf772ce3b0f24f88eb3dac34 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 12:06:29 2012 -0800 Providing higher test runtime accuracy if low It looks kinda odd to say that the unit testing runtime is "0 seconds", so raising the accuracy when the runtime is less than a second. --- run_tests.py | 4 +++- 1 files changed, 3 insertions(+), 1 deletions(-) diff --git a/run_tests.py b/run_tests.py index 8467e2f..755eda3 100755 --- a/run_tests.py +++ b/run_tests.py @@ -314,7 +314,9 @@ if __name__ == '__main__': # TODO: note unused config options afterward? - runtime_label = "(%i seconds)" % (time.time() - start_time) + runtime = time.time() - start_time + if runtime < 1: runtime_label = "(%0.1f seconds)" % runtime + else: runtime_label = "(%i seconds)" % runtime if error_tracker.has_error_occured(): test.output.print_line("TESTING FAILED %s" % runtime_label, term.Color.RED, term.Attr.BOLD)

1 0

[stem/master] Enum constructor function for capitalized values
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit db9d695f16dc2f2ec409be40aa69d7d13cf24826 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 11:22:38 2012 -0800 Enum constructor function for capitalized values On occasion we want enumerations where the values are capitalized (for instance logging runlevels and integ targets). This could be done in a succinct fasion via a bit of python hackery but it wasn't pretty. Providing a function to do this instead. --- run_tests.py | 4 ++-- stem/util/enum.py | 23 ++++++++++++++++++++++- stem/util/log.py | 5 +---- test/unit/util/enum.py | 9 +++++++++ 4 files changed, 34 insertions(+), 7 deletions(-) diff --git a/run_tests.py b/run_tests.py index d4d2fd6..8467e2f 100755 --- a/run_tests.py +++ b/run_tests.py @@ -51,7 +51,7 @@ CONFIG = stem.util.conf.config_dict("test", { "target.torrc": {}, }) -Target = stem.util.enum.Enum(*[(v, v) for v in ( +Target = stem.util.enum.UppercaseEnum( "ONLINE", "RELATIVE", "RUN_NONE", @@ -63,7 +63,7 @@ Target = stem.util.enum.Enum(*[(v, v) for v in ( "RUN_SCOOKIE", "RUN_PTRACE", "RUN_ALL", -)]) +) DEFAULT_RUN_TARGET = Target.RUN_OPEN diff --git a/stem/util/enum.py b/stem/util/enum.py index c750352..ccc9590 100644 --- a/stem/util/enum.py +++ b/stem/util/enum.py @@ -15,11 +15,13 @@ with overwritten string counterparts: 'Cat' to_camel_case - converts a string to camel case +UppercaseEnum - Provides an enum instance with capitalized values. Enum - Provides a basic, ordered enumeration. - |- values - string representation of our enums + |- keys - string representation of our enum keys |- index_of - indice of an enum value |- next - provides the enum after a given enum value |- previous - provides the enum before a given value + |- __getitem__ - provides the value for an enum key +- __iter__ - iterator over our enum keys """ @@ -42,6 +44,25 @@ def to_camel_case(label, word_divider = " "): return word_divider.join(words) +def UppercaseEnum(*args): + """ + Provides an Enum instance where the values are identical to the keys. Since + the keys are uppercase by convention this means the values are too. For + instance... + + >>> runlevels = UppercaseEnum("DEBUG", "INFO", "NOTICE", "WARN", "ERROR") + >>> runlevels.DEBUG + 'DEBUG' + + Arguments: + args (str) - list of enum keys to initialize with + + Returns: + stem.util.Enum instance with the given keys + """ + + return Enum(*[(v, v) for v in args]) + class Enum: """ Basic enumeration. diff --git a/stem/util/log.py b/stem/util/log.py index 65d5659..a25e3fd 100644 --- a/stem/util/log.py +++ b/stem/util/log.py @@ -36,10 +36,7 @@ import stem.util.enum # Logging runlevels. These are *very* commonly used so including shorter # aliases (so they can be referenced as log.DEBUG, log.WARN, etc). -Runlevel = stem.util.enum.Enum( - ("TRACE", "TRACE"), ("DEBUG", "DEBUG"), ("INFO", "INFO"), - ("NOTICE", "NOTICE"), ("WARN", "WARN"), ("ERROR", "ERROR")) - +Runlevel = stem.util.enum.UppercaseEnum("TRACE", "DEBUG", "INFO", "NOTICE", "WARN", "ERROR") TRACE, DEBUG, INFO, NOTICE, WARN, ERR = list(Runlevel) # mapping of runlevels to the logger module's values, TRACE and DEBUG aren't diff --git a/test/unit/util/enum.py b/test/unit/util/enum.py index b688a27..5a28f62 100644 --- a/test/unit/util/enum.py +++ b/test/unit/util/enum.py @@ -35,6 +35,15 @@ class TestEnum(unittest.TestCase): self.assertEquals("Skippy", pets.DOG) self.assertEquals("Cat", pets.CAT) + def test_uppercase_enum_example(self): + """ + Checks that the pydoc example for the UppercaseEnum constructor function is + accurate. + """ + + runlevels = stem.util.enum.UppercaseEnum("DEBUG", "INFO", "NOTICE", "WARN", "ERROR") + self.assertEquals("DEBUG", runlevels.DEBUG) + def test_enum_methods(self): """ Exercises enumeration methods.

1 0

[stem/master] Renaming assert_message_parses to be private
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit 7fb7946939ed4801cfe79adbd6f9a0702f4464b2 Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 11:04:11 2012 -0800 Renaming assert_message_parses to be private Very minor correction to the ControlMessage unit tests. --- test/unit/socket/control_message.py | 18 +++++++++--------- 1 files changed, 9 insertions(+), 9 deletions(-) diff --git a/test/unit/socket/control_message.py b/test/unit/socket/control_message.py index 37f1cc0..6d246e4 100644 --- a/test/unit/socket/control_message.py +++ b/test/unit/socket/control_message.py @@ -35,7 +35,7 @@ class TestControlMessage(unittest.TestCase): Checks the basic 'OK' response that we get for most commands. """ - message = self.assert_message_parses(OK_REPLY) + message = self._assert_message_parses(OK_REPLY) self.assertEquals("OK", str(message)) contents = message.content() @@ -48,7 +48,7 @@ class TestControlMessage(unittest.TestCase): """ # BW event - message = self.assert_message_parses(EVENT_BW) + message = self._assert_message_parses(EVENT_BW) self.assertEquals("BW 32326 2856", str(message)) contents = message.content() @@ -57,7 +57,7 @@ class TestControlMessage(unittest.TestCase): # few types of CIRC events for circ_content in (EVENT_CIRC_TIMEOUT, EVENT_CIRC_LAUNCHED, EVENT_CIRC_EXTENDED): - message = self.assert_message_parses(circ_content) + message = self._assert_message_parses(circ_content) self.assertEquals(circ_content[4:-2], str(message)) contents = message.content() @@ -70,7 +70,7 @@ class TestControlMessage(unittest.TestCase): """ # GETINFO version (basic single-line results) - message = self.assert_message_parses(GETINFO_VERSION) + message = self._assert_message_parses(GETINFO_VERSION) self.assertEquals(2, len(list(message))) self.assertEquals(2, len(str(message).splitlines())) @@ -81,7 +81,7 @@ class TestControlMessage(unittest.TestCase): self.assertEquals(("250", " ", "OK"), contents[1]) # GETINFO info/names (data entry) - message = self.assert_message_parses(GETINFO_INFONAMES) + message = self._assert_message_parses(GETINFO_INFONAMES) self.assertEquals(2, len(list(message))) self.assertEquals(8, len(str(message).splitlines())) @@ -119,7 +119,7 @@ class TestControlMessage(unittest.TestCase): # sanity check the above test isn't broken due to leaving infonames_lines # with invalid data - self.assert_message_parses("".join(infonames_lines)) + self._assert_message_parses("".join(infonames_lines)) def test_malformed_prefix(self): """ @@ -140,8 +140,8 @@ class TestControlMessage(unittest.TestCase): self.assertRaises(stem.socket.ProtocolError, stem.socket.recv_message, StringIO.StringIO(replacement_test_input)) else: # otherwise the data will be malformed, but this goes undetected - self.assert_message_parses(removal_test_input) - self.assert_message_parses(replacement_test_input) + self._assert_message_parses(removal_test_input) + self._assert_message_parses(replacement_test_input) def test_disconnected_socket(self): """ @@ -153,7 +153,7 @@ class TestControlMessage(unittest.TestCase): control_socket_file = control_socket.makefile() self.assertRaises(stem.socket.SocketClosed, stem.socket.recv_message, control_socket_file) - def assert_message_parses(self, controller_reply): + def _assert_message_parses(self, controller_reply): """ Performs some basic sanity checks that a reply mirrors its parsed result.

1 0

[stem/master] Integ check for value of get_system_tor_version()
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit dbf8663cf9b5ca1e31f516109b019045ec63a04c Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 13:14:28 2012 -0800 Integ check for value of get_system_tor_version() We had basic verification tests for get_system_tor_version() but it didn't check the value. This was a refactoring mistake, iirc it once checked the value but since we can run with an arbitrary tor binary I removed that, forgetting that get_system_tor_version() could optionally take that binary path. Making this a separate test since it relies on the tor instance being accessible (which isn't the case with all targets). --- test/integ/version.py | 14 ++++++++++++++ test/runner.py | 13 ++++++++++++- 2 files changed, 26 insertions(+), 1 deletions(-) diff --git a/test/integ/version.py b/test/integ/version.py index 616ae57..e344ef8 100644 --- a/test/integ/version.py +++ b/test/integ/version.py @@ -29,6 +29,20 @@ class TestVersion(unittest.TestCase): # try running against a command that doesn't exist self.assertRaises(IOError, stem.version.get_system_tor_version, "blarg") + def test_get_system_tor_version_value(self): + """ + Checks that the get_system_tor_version() provides the same value as our + test instance provides. + """ + + runner = test.runner.get_runner() + + if not runner.is_accessible(): + self.skipTest("(no connection)") + + system_tor_version = stem.version.get_system_tor_version(runner.get_tor_command()) + self.assertEquals(runner.get_tor_version(), system_tor_version) + def test_getinfo_version_parsing(self): """ Issues a 'GETINFO version' query to our test instance and makes sure that diff --git a/test/runner.py b/test/runner.py index d3c6143..0e71ade 100644 --- a/test/runner.py +++ b/test/runner.py @@ -21,7 +21,8 @@ Runner - Runtime context for our integration tests. |- get_torrc_contents - contents of our tor instance's torrc |- get_pid - process id of our tor process |- get_tor_socket - provides a socket to the tor instance - +- get_tor_version - provides the version of tor we're running against + |- get_tor_version - provides the version of tor we're running against + +- get_tor_command - provides the command used to start tor """ import os @@ -115,6 +116,7 @@ class Runner: # runtime attributes, set by the start method self._test_dir = "" + self._tor_cmd = None self._tor_cwd = "" self._torrc_contents = "" self._custom_opts = None @@ -160,6 +162,7 @@ class Runner: os.chdir(tor_cwd) data_dir_path = "./%s" % os.path.basename(self._test_dir) + self._tor_cmd = tor_cmd self._custom_opts = extra_torrc_opts self._torrc_contents = BASE_TORRC % data_dir_path @@ -197,6 +200,7 @@ class Runner: shutil.rmtree(self._test_dir, ignore_errors = True) self._test_dir = "" + self._tor_cmd = None self._tor_cwd = "" self._torrc_contents = "" self._custom_opts = None @@ -393,6 +397,13 @@ class Runner: tor_version = list(version_response)[0][8:] return stem.version.Version(tor_version) + def get_tor_command(self): + """ + Provides the command used to run our tor instance. + """ + + return self._get("_tor_cmd") + def _get(self, attr): """ Fetches one of our attributes in a thread safe manner, raising if we aren't

1 0

[stem/master] Rewriting authentication integ tests
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit a73be509009942b4b2711b49a3b30e3c3f6e609b Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 17:06:36 2012 -0800 Rewriting authentication integ tests Excessive testing helper functions are bad. They hurt test readability and makes the code a pita to trace through. This cleans up the authentication integration tests to collapse the helper functions into just the few that make life better. Much more maintainable now. \o/ --- stem/socket.py | 6 + test/integ/connection/authentication.py | 276 ++++++++++++------------------- 2 files changed, 116 insertions(+), 166 deletions(-) diff --git a/stem/socket.py b/stem/socket.py index f3aeaf8..889713d 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -217,6 +217,12 @@ class ControlSocket: self._send_cond.release() self._recv_cond.release() + def __enter__(self): + return self + + def __exit__(self, type, value, traceback): + self.close() + def _make_socket(self): """ Constructs and connects new socket. This is implemented by subclasses. diff --git a/test/integ/connection/authentication.py b/test/integ/connection/authentication.py index bc94ead..cc36c66 100644 --- a/test/integ/connection/authentication.py +++ b/test/integ/connection/authentication.py @@ -5,7 +5,6 @@ stem.connection.authenticate* functions. import os import unittest -import functools import test.runner import stem.connection @@ -23,6 +22,60 @@ MULTIPLE_AUTH_FAIL = "Authentication failed: Password did not match HashedContro INCORRECT_COOKIE_FAIL = "Authentication failed: Authentication cookie did not match expected value." INCORRECT_PASSWORD_FAIL = "Authentication failed: Password did not match HashedControlPassword value from configuration" +def _can_authenticate(auth_type): + """ + Checks if a given authentication method can authenticate to our control + socket. + + Arguments: + auth_type (stem.connection.AuthMethod) - authentication method to check + + Returns: + bool that's True if we should be able to authenticate and False otherwise + """ + + tor_options = test.runner.get_runner().get_options() + password_auth = test.runner.Torrc.PASSWORD in tor_options + cookie_auth = test.runner.Torrc.COOKIE in tor_options + + if not password_auth and not cookie_auth: return True # open socket + elif auth_type == stem.connection.AuthMethod.PASSWORD: return password_auth + elif auth_type == stem.connection.AuthMethod.COOKIE: return cookie_auth + else: return False + +def _get_auth_failure_message(auth_type): + """ + Provides the message that tor will respond with if our current method of + authentication fails. Note that this test will need to be updated if tor + changes its rejection reponse. + + Arguments: + auth_type (stem.connection.AuthMethod) - authentication method to check + + Returns: + string with the rejection message that tor would provide + """ + + tor_options = test.runner.get_runner().get_options() + password_auth = test.runner.Torrc.PASSWORD in tor_options + cookie_auth = test.runner.Torrc.COOKIE in tor_options + + if cookie_auth and password_auth: + return MULTIPLE_AUTH_FAIL + elif cookie_auth: + if auth_type == stem.connection.AuthMethod.COOKIE: + return INCORRECT_COOKIE_FAIL + else: + return COOKIE_AUTH_FAIL + elif password_auth: + if auth_type == stem.connection.AuthMethod.PASSWORD: + return INCORRECT_PASSWORD_FAIL + else: + return PASSWORD_AUTH_FAIL + else: + # shouldn't happen, if so then the test has a bug + raise ValueError("No methods of authentication. If this is an open socket then auth shoulnd't fail.") + class TestAuthenticate(unittest.TestCase): def setUp(self): # none of these tests apply if there's no control connection @@ -34,10 +87,9 @@ class TestAuthenticate(unittest.TestCase): Tests that the authenticate function can authenticate to our socket. """ - control_socket = test.runner.get_runner().get_tor_socket(False) - stem.connection.authenticate(control_socket, test.runner.CONTROL_PASSWORD) - test.runner.exercise_socket(self, control_socket) - control_socket.close() + with test.runner.get_runner().get_tor_socket(False) as control_socket: + stem.connection.authenticate(control_socket, test.runner.CONTROL_PASSWORD) + test.runner.exercise_socket(self, control_socket) def test_authenticate_general_example(self): """ @@ -87,34 +139,25 @@ class TestAuthenticate(unittest.TestCase): is_password_only = test.runner.Torrc.PASSWORD in tor_options and not test.runner.Torrc.COOKIE in tor_options # tests without a password - control_socket = runner.get_tor_socket(False) - auth_function = functools.partial(stem.connection.authenticate, control_socket) - - if is_password_only: - self.assertRaises(stem.connection.MissingPassword, auth_function) - else: - auth_function() - test.runner.exercise_socket(self, control_socket) - - control_socket.close() + with runner.get_tor_socket(False) as control_socket: + if is_password_only: + self.assertRaises(stem.connection.MissingPassword, stem.connection.authenticate, control_socket) + else: + stem.connection.authenticate(control_socket) + test.runner.exercise_socket(self, control_socket) # tests with the incorrect password - control_socket = runner.get_tor_socket(False) - auth_function = functools.partial(stem.connection.authenticate, control_socket, "blarg") - - if is_password_only: - self.assertRaises(stem.connection.IncorrectPassword, auth_function) - else: - auth_function() - test.runner.exercise_socket(self, control_socket) - - control_socket.close() + with runner.get_tor_socket(False) as control_socket: + if is_password_only: + self.assertRaises(stem.connection.IncorrectPassword, stem.connection.authenticate, control_socket, "blarg") + else: + stem.connection.authenticate(control_socket, "blarg") + test.runner.exercise_socket(self, control_socket) # tests with the right password - control_socket = runner.get_tor_socket(False) - stem.connection.authenticate(control_socket, test.runner.CONTROL_PASSWORD) - test.runner.exercise_socket(self, control_socket) - control_socket.close() + with runner.get_tor_socket(False) as control_socket: + stem.connection.authenticate(control_socket, test.runner.CONTROL_PASSWORD) + test.runner.exercise_socket(self, control_socket) def test_authenticate_none(self): """ @@ -122,11 +165,11 @@ class TestAuthenticate(unittest.TestCase): """ auth_type = stem.connection.AuthMethod.NONE - if self._can_authenticate(auth_type): + + if _can_authenticate(auth_type): self._check_auth(auth_type) else: self.assertRaises(stem.connection.OpenAuthRejected, self._check_auth, auth_type) - self._assert_auth_rejected_msg(auth_type) def test_authenticate_password(self): """ @@ -136,26 +179,24 @@ class TestAuthenticate(unittest.TestCase): auth_type = stem.connection.AuthMethod.PASSWORD auth_value = test.runner.CONTROL_PASSWORD - if self._can_authenticate(auth_type): + if _can_authenticate(auth_type): self._check_auth(auth_type, auth_value) else: self.assertRaises(stem.connection.PasswordAuthRejected, self._check_auth, auth_type, auth_value) - self._assert_auth_rejected_msg(auth_type, auth_value) # Check with an empty, invalid, and quoted password. These should work if # we have no authentication, and fail otherwise. for auth_value in ("", "blarg", "this has a \" in it"): - if self._can_authenticate(stem.connection.AuthMethod.NONE): + if _can_authenticate(stem.connection.AuthMethod.NONE): self._check_auth(auth_type, auth_value) else: - if self._can_authenticate(stem.connection.AuthMethod.PASSWORD): + if _can_authenticate(stem.connection.AuthMethod.PASSWORD): exc_type = stem.connection.IncorrectPassword else: exc_type = stem.connection.PasswordAuthRejected self.assertRaises(exc_type, self._check_auth, auth_type, auth_value) - self._assert_auth_rejected_msg(auth_type, auth_value) def test_authenticate_cookie(self): """ @@ -173,11 +214,10 @@ class TestAuthenticate(unittest.TestCase): # missing file. self.assertRaises(stem.connection.UnreadableCookieFile, self._check_auth, auth_type, auth_value) - elif self._can_authenticate(auth_type): + elif _can_authenticate(auth_type): self._check_auth(auth_type, auth_value) else: self.assertRaises(stem.connection.CookieAuthRejected, self._check_auth, auth_type, auth_value) - self._assert_auth_rejected_msg(auth_type, auth_value) def test_authenticate_cookie_invalid(self): """ @@ -193,17 +233,16 @@ class TestAuthenticate(unittest.TestCase): fake_cookie.write("0" * 32) fake_cookie.close() - if self._can_authenticate(stem.connection.AuthMethod.NONE): + if _can_authenticate(stem.connection.AuthMethod.NONE): # authentication will work anyway self._check_auth(auth_type, auth_value) else: - if self._can_authenticate(auth_type): + if _can_authenticate(auth_type): exc_type = stem.connection.IncorrectCookieValue else: exc_type = stem.connection.CookieAuthRejected self.assertRaises(exc_type, self._check_auth, auth_type, auth_value) - self._assert_auth_rejected_msg(auth_type, auth_value) os.remove(auth_value) @@ -215,7 +254,7 @@ class TestAuthenticate(unittest.TestCase): auth_type = stem.connection.AuthMethod.COOKIE auth_value = "/if/this/exists/then/they're/asking/for/a/failure" - self.assertRaises(stem.connection.UnreadableCookieFile, self._check_auth, auth_type, auth_value) + self.assertRaises(stem.connection.UnreadableCookieFile, self._check_auth, auth_type, auth_value, False) def test_authenticate_cookie_wrong_size(self): """ @@ -231,139 +270,44 @@ class TestAuthenticate(unittest.TestCase): # Weird coincidence? Fail so we can pick another file to check against. self.fail("Our torrc is 32 bytes, preventing the test_authenticate_cookie_wrong_size test from running.") else: - self.assertRaises(stem.connection.IncorrectCookieSize, self._check_auth, auth_type, auth_value) - - def _get_socket_auth(self): - """ - Provides the types of authentication that our current test socket accepts. - - Returns: - bool tuple of the form (password_auth, cookie_auth) - """ - - tor_options = test.runner.get_runner().get_options() - password_auth = test.runner.Torrc.PASSWORD in tor_options - cookie_auth = test.runner.Torrc.COOKIE in tor_options - - return password_auth, cookie_auth - - def _can_authenticate(self, auth_type): - """ - Checks if the given authentication type should be able to authenticate to - our current socket. - - Arguments: - auth_type (stem.connection.AuthMethod) - authentication method to check - - Returns: - bool that's True if we should be able to authenticate and False otherwise - """ - - password_auth, cookie_auth = self._get_socket_auth() - - # If the control socket is open then all authentication methods will be - # accepted. Otherwise check if our auth type matches what the socket - # accepts. - - if not password_auth and not cookie_auth: return True - elif auth_type == stem.connection.AuthMethod.PASSWORD: return password_auth - elif auth_type == stem.connection.AuthMethod.COOKIE: return cookie_auth - else: return False - - def _get_auth_function(self, control_socket, auth_type, *auth_args): - """ - Constructs a functor that performs the given authentication without - additional arguments. - - Arguments: - control_socket (stem.socket.ControlSocket) - socket for the function to - authenticate to - auth_type (stem.connection.AuthMethod) - method by which we should - authentiate to the control socket - auth_args (str) - arguments to be passed to the authentication function - """ - - if auth_type == stem.connection.AuthMethod.NONE: - auth_function = stem.connection.authenticate_none - elif auth_type == stem.connection.AuthMethod.PASSWORD: - auth_function = stem.connection.authenticate_password - elif auth_type == stem.connection.AuthMethod.COOKIE: - auth_function = stem.connection.authenticate_cookie - else: - raise ValueError("unexpected auth type: %s" % auth_type) - - if auth_args: - return functools.partial(auth_function, control_socket, *auth_args) - else: - return functools.partial(auth_function, control_socket) - - def _assert_auth_rejected_msg(self, auth_type, *auth_args): - """ - This asserts that authentication will fail with the rejection message given - by tor. Note that this test will need to be updated if tor changes its - rejection reponse. - - Arguments: - auth_type (stem.connection.AuthMethod) - method by which we should - authentiate to the control socket - auth_args (str) - arguments to be passed to the authentication function - """ - - control_socket = test.runner.get_runner().get_tor_socket(False) - auth_function = self._get_auth_function(control_socket, auth_type, *auth_args) - password_auth, cookie_auth = self._get_socket_auth() - - if cookie_auth and password_auth: - failure_msg = MULTIPLE_AUTH_FAIL - elif cookie_auth: - if auth_type == stem.connection.AuthMethod.COOKIE: - failure_msg = INCORRECT_COOKIE_FAIL - else: - failure_msg = COOKIE_AUTH_FAIL - elif password_auth: - if auth_type == stem.connection.AuthMethod.PASSWORD: - failure_msg = INCORRECT_PASSWORD_FAIL - else: - failure_msg = PASSWORD_AUTH_FAIL - else: - # shouldn't happen, if so then the test has a bug - raise ValueError("No methods of authentication. If this is an open socket then auth shoulnd't fail.") - - try: - auth_function() - control_socket.close() - self.fail() - except stem.connection.AuthenticationFailure, exc: - self.assertTrue(control_socket.is_alive()) - self.assertEqual(failure_msg, str(exc)) - control_socket.close() + self.assertRaises(stem.connection.IncorrectCookieSize, self._check_auth, auth_type, auth_value, False) - def _check_auth(self, auth_type, *auth_args): + def _check_auth(self, auth_type, auth_arg = None, check_message = True): """ - Attempts to use the given authentication function against our connection. - If this works then checks that we can use the connection. If not then this - raises the exception. + Attempts to use the given type of authentication against tor's control + socket. If it succeeds then we check that the socket can then be used. If + not then we check that this gives a message that we'd expect then raises + the exception. Arguments: auth_type (stem.connection.AuthMethod) - method by which we should authentiate to the control socket - auth_args (str) - arguments to be passed to the authentication function + auth_arg (str) - argument to be passed to the authentication function + check_message (bool) - checks that failure messages are what we'd expect Raises: stem.connection.AuthenticationFailure if the authentication fails """ - control_socket = test.runner.get_runner().get_tor_socket(False) - auth_function = self._get_auth_function(control_socket, auth_type, *auth_args) - - # run the authentication, re-raising if there's a problem - try: - auth_function() - except stem.connection.AuthenticationFailure, exc: - self.assertTrue(control_socket.is_alive()) - control_socket.close() - raise exc - - test.runner.exercise_socket(self, control_socket) - control_socket.close() + with test.runner.get_runner().get_tor_socket(False) as control_socket: + # run the authentication, re-raising if there's a problem + try: + if auth_type == stem.connection.AuthMethod.NONE: + stem.connection.authenticate_none(control_socket) + elif auth_type == stem.connection.AuthMethod.PASSWORD: + stem.connection.authenticate_password(control_socket, auth_arg) + elif auth_type == stem.connection.AuthMethod.COOKIE: + stem.connection.authenticate_cookie(control_socket, auth_arg) + + test.runner.exercise_socket(self, control_socket) + except stem.connection.AuthenticationFailure, exc: + # authentication functions should re-attach on failure + self.assertTrue(control_socket.is_alive()) + + # check that we got the failure message that we'd expect + if check_message: + failure_msg = _get_auth_failure_message(auth_type) + self.assertEqual(failure_msg, str(exc)) + + raise exc

1 0

[stem/master] Tidying the stem.util.system unit tests
by atagar＠torproject.org 29 Jan '12

29 Jan '12

commit 6f70bd329ab215754241ea56479a1c9490ab2dce Author: Damian Johnson <atagar(a)torproject.org> Date: Sat Jan 28 12:55:26 2012 -0800 Tidying the stem.util.system unit tests Improving the mock call function, clarifying usage in its pydocs and bundling it with the partial call. I'm kinda impressed how much this simple change helps the readability of these tests... --- test/unit/util/system.py | 80 +++++++++++++++++++++++++++------------------- 1 files changed, 47 insertions(+), 33 deletions(-) diff --git a/test/unit/util/system.py b/test/unit/util/system.py index 836b11b..8ad63a0 100644 --- a/test/unit/util/system.py +++ b/test/unit/util/system.py @@ -7,9 +7,9 @@ system running the tests. import functools import unittest -import test.mocking import stem.util.proc import stem.util.system as system +import test.mocking as mocking # Base responses for the get_pid_by_name tests. The 'success' and # 'multiple_results' entries are filled in by tests. @@ -50,35 +50,49 @@ GET_PID_BY_PORT_LSOF_RESULTS = [ "tor 1745 atagar 6u IPv4 14229 0t0 TCP 127.0.0.1:9051 (LISTEN)", "apache 329 atagar 6u IPv4 14229 0t0 TCP 127.0.0.1:80 (LISTEN)"] -def mock_call(base_cmd, responses, command): +def mock_call(base_cmd, responses): """ - Template mock function for testing a series of test inputs. Test functions - make a partial with the first two values filled out, then the system's call - method provides the 'command' argument. + Provides mocking for the system module's call function. There are a couple + ways of using this... + + - Simple usage is for base_cmd is the system call we want to respond to and + responses is a list containing the respnose. For instance... + + mock_call("ls my_dir", ["file1", "file2", "file3"]) + + - The base_cmd can be a formatted string and responses are a dictionary of + completions for tat string to the responses. For instance... + + mock_call("ls %s", {"dir1": ["file1", "file2"], "dir2": ["file3", "file4"]}) Arguments: base_cmd (str) - command to match against responses (list, dict) - either list with the response, or mapping of base_cmd formatted string completions to responses - command (str) - system call being mocked + + Returns: + functor to override stem.util.system.call with """ - if isinstance(responses, list): - if base_cmd == command: return responses - else: return None - else: - for cmd_completion in responses: - if command == base_cmd % cmd_completion: - return responses[cmd_completion] + def _mock_call(base_cmd, responses, command): + if isinstance(responses, list): + if base_cmd == command: return responses + else: return None + else: + for cmd_completion in responses: + if command == base_cmd % cmd_completion: + return responses[cmd_completion] + + return functools.partial(_mock_call, base_cmd, responses) class TestSystem(unittest.TestCase): def setUp(self): - test.mocking.mock(stem.util.proc.is_available, test.mocking.return_false()) - test.mocking.mock(system.is_available, test.mocking.return_true()) - test.mocking.mock(system.call, test.mocking.return_none()) + mocking.mock(stem.util.proc.is_available, mocking.return_false()) + mocking.mock(system.is_available, mocking.return_true()) + mocking.mock(system.call, mocking.return_none()) def tearDown(self): - test.mocking.revert_mocking() + mocking.revert_mocking() def test_is_running(self): """ @@ -89,7 +103,7 @@ class TestSystem(unittest.TestCase): running_commands = ["irssi", "moc", "tor", "ps", " firefox "] for ps_cmd in (system.IS_RUNNING_PS_LINUX, system.IS_RUNNING_PS_BSD): - test.mocking.mock(system.call, functools.partial(mock_call, ps_cmd, running_commands)) + mocking.mock(system.call, mock_call(ps_cmd, running_commands)) self.assertTrue(system.is_running("irssi")) self.assertTrue(system.is_running("moc")) @@ -99,7 +113,7 @@ class TestSystem(unittest.TestCase): self.assertEqual(False, system.is_running("something_else")) # mock both calls failing - test.mocking.mock(system.call, test.mocking.return_none()) + mocking.mock(system.call, mocking.return_none()) self.assertFalse(system.is_running("irssi")) self.assertEquals(None, system.is_running("irssi")) @@ -111,7 +125,7 @@ class TestSystem(unittest.TestCase): responses = dict(GET_PID_BY_NAME_BASE_RESULTS) responses["success"] = ["1111"] responses["multiple_results"] = ["123", "456", "789"] - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_NAME_PGREP, responses)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_NAME_PGREP, responses)) for test_input in responses: expected_response = 1111 if test_input == "success" else None @@ -125,7 +139,7 @@ class TestSystem(unittest.TestCase): responses = dict(GET_PID_BY_NAME_BASE_RESULTS) responses["success"] = ["1111"] responses["multiple_results"] = ["123 456 789"] - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_NAME_PIDOF, responses)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_NAME_PIDOF, responses)) for test_input in responses: expected_response = 1111 if test_input == "success" else None @@ -136,11 +150,11 @@ class TestSystem(unittest.TestCase): Tests the get_pid_by_name function with the linux variant of ps. """ - test.mocking.mock(system.is_bsd, test.mocking.return_false()) + mocking.mock(system.is_bsd, mocking.return_false()) responses = dict(GET_PID_BY_NAME_BASE_RESULTS) responses["success"] = ["PID", " 1111"] responses["multiple_results"] = ["PID", " 123", " 456", " 789"] - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_NAME_PS_LINUX, responses)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_NAME_PS_LINUX, responses)) for test_input in responses: expected_response = 1111 if test_input == "success" else None @@ -151,8 +165,8 @@ class TestSystem(unittest.TestCase): Tests the get_pid_by_name function with the bsd variant of ps. """ - test.mocking.mock(system.is_bsd, test.mocking.return_true()) - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_NAME_PS_BSD, GET_PID_BY_NAME_PS_BSD)) + mocking.mock(system.is_bsd, mocking.return_true()) + mocking.mock(system.call, mock_call(system.GET_PID_BY_NAME_PS_BSD, GET_PID_BY_NAME_PS_BSD)) self.assertEquals(1, system.get_pid_by_name("launchd")) self.assertEquals(11, system.get_pid_by_name("DirectoryService")) self.assertEquals(None, system.get_pid_by_name("blarg")) @@ -165,7 +179,7 @@ class TestSystem(unittest.TestCase): responses = dict(GET_PID_BY_NAME_BASE_RESULTS) responses["success"] = ["1111"] responses["multiple_results"] = ["123", "456", "789"] - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_NAME_LSOF, responses)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_NAME_LSOF, responses)) for test_input in responses: expected_response = 1111 if test_input == "success" else None @@ -176,7 +190,7 @@ class TestSystem(unittest.TestCase): Tests the get_pid_by_port function with a netstat response. """ - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_PORT_NETSTAT, GET_PID_BY_PORT_NETSTAT_RESULTS)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_PORT_NETSTAT, GET_PID_BY_PORT_NETSTAT_RESULTS)) self.assertEquals(1641, system.get_pid_by_port(9051)) self.assertEquals(1641, system.get_pid_by_port("9051")) self.assertEquals(None, system.get_pid_by_port(631)) @@ -187,7 +201,7 @@ class TestSystem(unittest.TestCase): Tests the get_pid_by_port function with a sockstat response. """ - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_PORT_SOCKSTAT % 9051, GET_PID_BY_PORT_SOCKSTAT_RESULTS)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_PORT_SOCKSTAT % 9051, GET_PID_BY_PORT_SOCKSTAT_RESULTS)) self.assertEquals(4397, system.get_pid_by_port(9051)) self.assertEquals(4397, system.get_pid_by_port("9051")) self.assertEquals(None, system.get_pid_by_port(123)) @@ -197,7 +211,7 @@ class TestSystem(unittest.TestCase): Tests the get_pid_by_port function with a lsof response. """ - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_PID_BY_PORT_LSOF, GET_PID_BY_PORT_LSOF_RESULTS)) + mocking.mock(system.call, mock_call(system.GET_PID_BY_PORT_LSOF, GET_PID_BY_PORT_LSOF_RESULTS)) self.assertEquals(1745, system.get_pid_by_port(9051)) self.assertEquals(1745, system.get_pid_by_port("9051")) self.assertEquals(329, system.get_pid_by_port(80)) @@ -209,7 +223,7 @@ class TestSystem(unittest.TestCase): """ lsof_query = system.GET_PID_BY_FILE_LSOF % "/tmp/foo" - test.mocking.mock(system.call, functools.partial(mock_call, lsof_query, ["4762"])) + mocking.mock(system.call, mock_call(lsof_query, ["4762"])) self.assertEquals(4762, system.get_pid_by_open_file("/tmp/foo")) self.assertEquals(None, system.get_pid_by_open_file("/tmp/somewhere_else")) @@ -225,7 +239,7 @@ class TestSystem(unittest.TestCase): "7878": None, } - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_CWD_PWDX, responses)) + mocking.mock(system.call, mock_call(system.GET_CWD_PWDX, responses)) for test_input in responses: expected_response = "/home/atagar" if test_input == "3799" else None @@ -242,7 +256,7 @@ class TestSystem(unittest.TestCase): "7878": None, } - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_CWD_LSOF, responses)) + mocking.mock(system.call, mock_call(system.GET_CWD_LSOF, responses)) for test_input in responses: expected_response = "/Users/atagar/tor/src/or" if test_input == "75717" else None @@ -262,7 +276,7 @@ class TestSystem(unittest.TestCase): "6666": None } - test.mocking.mock(system.call, functools.partial(mock_call, system.GET_BSD_JAIL_ID_PS, responses)) + mocking.mock(system.call, mock_call(system.GET_BSD_JAIL_ID_PS, responses)) for test_input in responses: expected_response = 1 if test_input == "1111" else 0

1 0