July 2012 - tor-commits - lists.torproject.org

[vidalia/master] Fold in changes
by chiiph＠torproject.org 10 Jul '12

10 Jul '12

commit 5ff9ab39b16ab03f4c2fcc515e54bd0fe24050a3 Author: Tomás Touceda <chiiph(a)torproject.org> Date: Tue Jul 10 19:46:00 2012 -0300 Fold in changes --- CHANGELOG | 7 +++++++ changes/appendRouterStatus | 1 - changes/bug4337 | 1 - changes/bug5351 | 1 - changes/bug6178 | 1 - 5 files changed, 7 insertions(+), 4 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index 1e027e0..942c027 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,3 +1,10 @@ +0.2.20 09-Jul-2012 + o Append router status information if Tor is using microdescriptors. + o Display paths with their native separators. Resolves ticket 4337. + o Do not ignore the Show on Startup checkbox. Fixes bug 5351. + o Do not add relative root to DataDirectory if it is empty. Fixes + bug 6178. + 0.2.19 30-May-2012 o Disable "Run Vidalia when my system starts" if the BrowserExecutable config option is set. This will avoid issues with diff --git a/changes/appendRouterStatus b/changes/appendRouterStatus deleted file mode 100644 index 7a579d7..0000000 --- a/changes/appendRouterStatus +++ /dev/null @@ -1 +0,0 @@ - o Append router status information if Tor is using microdescriptors. diff --git a/changes/bug4337 b/changes/bug4337 deleted file mode 100644 index f5703d3..0000000 --- a/changes/bug4337 +++ /dev/null @@ -1 +0,0 @@ - o Display paths with their native separators. Resolves ticket 4337. diff --git a/changes/bug5351 b/changes/bug5351 deleted file mode 100644 index b01def8..0000000 --- a/changes/bug5351 +++ /dev/null @@ -1 +0,0 @@ - o Do not ignore the Show on Startup checkbox. Fixes bug 5351. diff --git a/changes/bug6178 b/changes/bug6178 deleted file mode 100644 index e727ed9..0000000 --- a/changes/bug6178 +++ /dev/null @@ -1 +0,0 @@ - o Do not add relative root to DataDirectory if it is empty. Fixes bug 6178.

1 0

[torbutton/master] Add 1506 comments pointed out by Georg.
by mikeperry＠torproject.org 10 Jul '12

10 Jul '12

commit 7d14292f14c24bff161bba4dffd4f5fe20163758 Author: Mike Perry <mikeperry-git(a)fscked.org> Date: Tue Jul 10 11:49:10 2012 -0700 Add 1506 comments pointed out by Georg. --- src/chrome/content/contents.rdf | 1 + src/chrome/content/torbutton_util.js | 9 +++++++++ src/chrome/content/torcookie.js | 2 ++ src/chrome/skin/contents.rdf | 1 + src/components/crash-observer.js | 12 ++++++++---- 5 files changed, 21 insertions(+), 4 deletions(-) diff --git a/src/chrome/content/contents.rdf b/src/chrome/content/contents.rdf index 5c91f87..c7afa3a 100644 --- a/src/chrome/content/contents.rdf +++ b/src/chrome/content/contents.rdf @@ -1,3 +1,4 @@ + <?xml version="1.0"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" diff --git a/src/chrome/content/torbutton_util.js b/src/chrome/content/torbutton_util.js index b93162e..b6b4966 100644 --- a/src/chrome/content/torbutton_util.js +++ b/src/chrome/content/torbutton_util.js @@ -1,3 +1,8 @@ +// Bug 1506 P0-P3: These utility functions might be useful, but +// you probably just want to rewrite them or use the underlying +// code directly. I don't see any of them as essential for 1506, +// really. + var m_tb_torlog = Components.classes["@torproject.org/torbutton-logger;1"] .getService(Components.interfaces.nsISupports).wrappedJSObject; @@ -21,6 +26,7 @@ if(versionChecker.compare(appInfo.version, "5.0a1") >= 0) { } +// Bug 1506 P0: Use the log service directly function torbutton_eclog(nLevel, sMsg) { m_tb_torlog.eclog(nLevel, sMsg); return true; @@ -64,6 +70,9 @@ function torbutton_get_prefbranch(branch_name) { return o_branch; } +// Bug 1506 P3: This would be a semi-polite thing to do on uninstall +// for pure Firefox users. The most polite thing would be to save +// all their original prefs.. But meh? function torbutton_reset_browser_prefs() { var o_all_prefs = torbutton_get_prefbranch(''); var prefs = ["network.http.sendSecureXSiteReferrer", diff --git a/src/chrome/content/torcookie.js b/src/chrome/content/torcookie.js index b57a263..fb8b02c 100644 --- a/src/chrome/content/torcookie.js +++ b/src/chrome/content/torcookie.js @@ -1,3 +1,5 @@ +// Bug 1506 P2: I think cookie protections is a neat feature. + var cookiesTree = null; var prefs = null; var cookies = []; diff --git a/src/chrome/skin/contents.rdf b/src/chrome/skin/contents.rdf index ed9b4c9..53bde17 100644 --- a/src/chrome/skin/contents.rdf +++ b/src/chrome/skin/contents.rdf @@ -1,3 +1,4 @@ + <?xml version="1.0"?> <RDF xmlns="http://www.w3.org/1999/02/22-rdf-syntax-ns#" diff --git a/src/components/crash-observer.js b/src/components/crash-observer.js index 96e9bad..776aed5 100644 --- a/src/components/crash-observer.js +++ b/src/components/crash-observer.js @@ -1,4 +1,4 @@ -// Bug 1506 P1-2: This code is mostly hackish remnants of session store +// Bug 1506 P1-3: This code is mostly hackish remnants of session store // support. There are a couple of observer events that *might* be worth // listening to. Search for 1506 in the code. @@ -55,6 +55,8 @@ function CrashObserver() { } if (this.is_ff4) { + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. Components.utils.import("resource://gre/modules/AddonManager.jsm"); this.onEnabling = this.onOperationCancelled; this.onDisabling = this.onUninstalling; @@ -74,6 +76,8 @@ CrashObserver.prototype = { // us somehow, we will leave the browser in a sorry state... Let's hope they // have the sense not to uninstall addons after an improper shutdown/crash // (or at least give us this event again in that case). + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. onUninstalling: function(addon, needsRestart) { if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { this._uninstall = true; @@ -89,6 +93,8 @@ CrashObserver.prototype = { // This is done in the constructor. JS doesn't allow this... //onDisabling: this.onUninstalling, + // Bug 1506 P2/P3: You probably want to register this observer to clean up + // prefs if you're going to support using normal firefox. onOperationCancelled: function(addon) { if (addon.id.toUpperCase() == TORBUTTON_EXTENSION_UUID) { this.logger.log(4, "Uninstall of Torbutton canceled. Hurray!"); @@ -111,8 +117,6 @@ CrashObserver.prototype = { } this._prefs.setBoolPref("extensions.torbutton.normal_exit", false); } else if (topic == "em-action-requested") { - // Bug 1506 P2/P4: You probably want to register this observer to clean up - // prefs if you're going to support using normal firefox. this.logger.log(3, "Uninstall action requested.."); // http://xulsolutions.blogspot.com/2006/07/creating-uninstall-script-for.html subject.QueryInterface(Components.interfaces.nsIUpdateItem); @@ -127,7 +131,7 @@ CrashObserver.prototype = { } } } else if (topic == "quit-application-granted") { - // Bug 1506 P2/P4: You probably want to register this observer to clean up + // Bug 1506 P2/P3: You probably want to register this observer to clean up // prefs if you're going to support using normal firefox. this.logger.log(3, "Got firefox quit event."); var chrome = null;

1 0

[flashproxy/master] Revert "Remove "CircuitBuildTimeout 60"."
by dcf＠torproject.org 10 Jul '12

10 Jul '12

commit 6e3ebf3b1e5ad7c762e940ba35b4f5fd991a4ad1 Author: David Fifield <david(a)bamsoftware.com> Date: Tue Jul 10 10:56:08 2012 -0700 Revert "Remove "CircuitBuildTimeout 60"." This reverts commit 45509aa495e1f9366ca27fc23587940fb3039692. This seems to be more than just a problem with a warning output. https://trac.torproject.org/projects/tor/ticket/6304#comment:2 --- experiments/exercise/exercise.sh | 2 +- torrc | 1 + 2 files changed, 2 insertions(+), 1 deletions(-) diff --git a/experiments/exercise/exercise.sh b/experiments/exercise/exercise.sh index 6a91806..13a6107 100755 --- a/experiments/exercise/exercise.sh +++ b/experiments/exercise/exercise.sh @@ -26,7 +26,7 @@ PIDS_TO_KILL+=($!) sleep 20 -"$TOR" ClientTransportPlugin "websocket socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "websocket 0.0.0.0:1" LearnCircuitBuildTimeout 0 & +"$TOR" ClientTransportPlugin "websocket socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "websocket 0.0.0.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60 & PIDS_TO_KILL+=($!) sleep 60 diff --git a/torrc b/torrc index b04e174..216c292 100644 --- a/torrc +++ b/torrc @@ -8,3 +8,4 @@ UseBridges 1 # The address and port are ignored by the client transport plugin. Bridge websocket 0.0.1.0:1 LearnCircuitBuildTimeout 0 +CircuitBuildTimeout 60

1 0

[flashproxy/master] Do another 0.0.0.0 → 0.0.1.0 missed in fdcb2d13.
by dcf＠torproject.org 10 Jul '12

10 Jul '12

commit 38c97d409ed7bd1253546104fbbd4eab2db8ea9d Author: David Fifield <david(a)bamsoftware.com> Date: Tue Jul 10 10:57:24 2012 -0700 Do another 0.0.0.0 → 0.0.1.0 missed in fdcb2d13. --- experiments/exercise/exercise.sh | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/experiments/exercise/exercise.sh b/experiments/exercise/exercise.sh index 13a6107..91ab3d7 100755 --- a/experiments/exercise/exercise.sh +++ b/experiments/exercise/exercise.sh @@ -26,7 +26,7 @@ PIDS_TO_KILL+=($!) sleep 20 -"$TOR" ClientTransportPlugin "websocket socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "websocket 0.0.0.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60 & +"$TOR" ClientTransportPlugin "websocket socks4 127.0.0.1:$LOCAL_PORT" UseBridges 1 Bridge "websocket 0.0.1.0:1" LearnCircuitBuildTimeout 0 CircuitBuildTimeout 60 & PIDS_TO_KILL+=($!) sleep 60

1 0

[flashproxy/master] Increase version to 0.2.
by dcf＠torproject.org 10 Jul '12

10 Jul '12

commit 2169199df9718642a7c8acb1f6562eb5a9b201d3 Author: David Fifield <david(a)bamsoftware.com> Date: Tue Jul 10 10:58:04 2012 -0700 Increase version to 0.2. --- Makefile | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/Makefile b/Makefile index cbe5344..a4fcd18 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,7 @@ PREFIX = /usr/local BINDIR = $(PREFIX)/bin -VERSION = 0.1 +VERSION = 0.2 CLIENT_DIST_FILES = flashproxy-client.py flashproxy-reg-http.py README torrc

1 0

[flashproxy/master] Use an iframe attribute called frameborder not frameBorder.
by dcf＠torproject.org 10 Jul '12

10 Jul '12

commit 154bcc1c9dc34c657448498a708a8097c870f856 Author: David Fifield <david(a)bamsoftware.com> Date: Tue Jul 10 09:47:03 2012 -0700 Use an iframe attribute called frameborder not frameBorder. I got a notice from Joseph Long that our iframe code didn't validate as XHTML because of the frameBorder element. (XHTML 1.0 doesn't even have the iframe element, but XHTML 1.0 Transitional and XHTML 1.0 Frameset do.) It turns out that the attribute name must be all lower-case: http://www.w3.org/TR/xhtml1/#h-4.2 http://www.w3.org/TR/1999/xhtml-modularization-19990406/DTD/doc/xhtml1-f.el… I think I originally had the capital B because it's required by some versions of IE: http://stackoverflow.com/questions/65034/remove-border-from-iframe/65052#65… Apparently setting the CSS "border" property to 0 also has problems with some versions of IE: http://stackoverflow.com/questions/65034/remove-border-from-iframe/8437926#… --- README | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) diff --git a/README b/README index e096a3f..b8b2f5c 100644 --- a/README +++ b/README @@ -126,7 +126,7 @@ Add this line to torrc to make the relay use the external proxy: Paste in this HTML where you want the badge to appear: -<iframe src="//crypto.stanford.edu/flashproxy/embed.html" width="80" height="15" frameBorder="0" scrolling="no"></iframe> +<iframe src="//crypto.stanford.edu/flashproxy/embed.html" width="80" height="15" frameborder="0" scrolling="no"></iframe> == For developers

1 0

[stem/master] Implement convenience method for handling SAVECONF requests
by atagar＠torproject.org 10 Jul '12

10 Jul '12

commit e68adb7fdd465e1780bc4ee1243e0c226add77d9 Author: Ravi Chandra Padmala <neenaoffline(a)gmail.com> Date: Wed Jun 27 18:34:15 2012 +0530 Implement convenience method for handling SAVECONF requests This also changes the Exception structure a bit. I have added an InsatisfiableRequest class which will be raised when a valid request couldn't be satisfied by Tor. I've also added a super class for non-socket non-protocol errors called OperationFailed. Any error that was raised by an error response returned by Tor (i.e., one with an error code & a message) should subclass this. The exceptions now look like ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. |- OperationFailed - Tor was unable to successfully complete the operation. | |- UnsatisfiableRequest - Tor was unable to satisfy a valid request. | +- InvalidRequest - Invalid request. | +- InvalidArguments - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. --- stem/control.py | 20 ++++++++++++++++++++ stem/socket.py | 28 ++++++++++++++++++++-------- test/integ/control/controller.py | 20 ++++++++++++++++++++ 3 files changed, 60 insertions(+), 8 deletions(-) diff --git a/stem/control.py b/stem/control.py index 51804cc..e2bf282 100644 --- a/stem/control.py +++ b/stem/control.py @@ -20,6 +20,7 @@ interacting at a higher level. |- reset_conf - reverts configuration options to their default values |- 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 |- get_version - convenience method to get tor version |- authenticate - convenience method to authenticate the controller +- protocolinfo - convenience method to get the protocol info @@ -777,6 +778,25 @@ class Controller(BaseController): raise stem.socket.InvalidRequest(response.code, response.message) elif not response.is_ok(): raise stem.socket.ProtocolError("+LOADCONF Received unexpected response\n%s" % str(response)) + + def save_conf(self): + """ + 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 + """ + + response = self.msg("SAVECONF") + stem.response.convert("SINGLELINE", response) + + if response.is_ok(): + return True + elif response.code == "551": + raise stem.socket.OperationFailed(response.code, response.message) + else: + raise stem.socket.ProtocolError("SAVECONF returned unexpected response code") def _case_insensitive_lookup(entries, key, default = UNDEFINED): """ diff --git a/stem/socket.py b/stem/socket.py index 7d40056..5492e30 100644 --- a/stem/socket.py +++ b/stem/socket.py @@ -28,8 +28,10 @@ as instances of the :class:`stem.response.ControlMessage` class. ControllerError - Base exception raised when using the controller. |- ProtocolError - Malformed socket data. - |- InvalidRequest - Invalid request. - | +- InvalidArguments - Invalid request parameters. + |- OperationFailed - Tor was unable to successfully complete the operation. + | |- UnsatisfiableRequest - Tor was unable to satisfy a valid request. + | +- InvalidRequest - Invalid request. + | +- InvalidArguments - Invalid request parameters. +- SocketError - Communication with the socket failed. +- SocketClosed - Socket has been shut down. """ @@ -550,9 +552,9 @@ class ControllerError(Exception): class ProtocolError(ControllerError): "Malformed content from the control socket." -class InvalidRequest(ControllerError): +class OperationFailed(ControllerError): """ - Base Exception class for invalid requests + Base exception class for failed operations that return an error code :var str code: error code returned by Tor :var str message: error message returned by Tor or a human readable error message @@ -560,21 +562,31 @@ class InvalidRequest(ControllerError): def __init__(self, code = None, message = None): """ - Initializes an InvalidRequest object. + Initializes an OperationFailed object. :param str code: error code returned by Tor :param str message: error message returned by Tor or a human readable error message - :returns: object of InvalidRequest class + :returns: object of OperationFailed class """ - super(InvalidRequest, self).__init__() + super(ControllerError, self).__init__() self.code = code self.message = message +class UnsatisfiableRequest(OperationFailed): + """ + Exception raised if Tor was unable to process our request. + """ + +class InvalidRequest(OperationFailed): + """ + Exception raised when the request was invalid or malformed. + """ + class InvalidArguments(InvalidRequest): """ - Exception class for invalid requests which contain invalid arguments. + Exception class for requests which had invalid arguments. :var str code: error code returned by Tor :var str message: error message returned by Tor or a human readable error message diff --git a/test/integ/control/controller.py b/test/integ/control/controller.py index 857799d..54f2626 100644 --- a/test/integ/control/controller.py +++ b/test/integ/control/controller.py @@ -296,4 +296,24 @@ class TestController(unittest.TestCase): finally: # reload original valid config controller.load_conf(oldconf) + + def test_saveconf(self): + + if test.runner.require_control(self): return + + runner = test.runner.get_runner() + + # only testing for success, since we need to run out of disk space to test + # for failure + with runner.get_tor_controller() as controller: + oldconf = runner.get_torrc_contents() + + try: + controller.set_conf("ContactInfo", "confsaved") + controller.save_conf() + with file(runner.get_torrc_path()) as torrcfile: + self.assertTrue("\nContactInfo confsaved\n" in torrcfile.read()) + finally: + controller.load_conf(oldconf) + controller.save_conf()

1 0

[ooni-probe/master] Write some docstrings and minor refactor
by art＠torproject.org 10 Jul '12

10 Jul '12

commit 3f9714d942656c552ad71e8172c83d55016a8c73 Author: Arturo Filastò <art(a)torproject.org> Date: Tue Jul 10 07:09:35 2012 +0200 Write some docstrings and minor refactor --- ooni/plugins/captiveportal.py | 6 +--- ooni/plugoo/tests.py | 44 +++++++++++++++++++++++++++++++++++++++++ ooni/plugoo/work.py | 27 +++++++++++++++++++++++++ 3 files changed, 73 insertions(+), 4 deletions(-) diff --git a/ooni/plugins/captiveportal.py b/ooni/plugins/captiveportal.py index 9b7bee3..1f13431 100644 --- a/ooni/plugins/captiveportal.py +++ b/ooni/plugins/captiveportal.py @@ -93,14 +93,12 @@ class CaptivePortal(OONITest): if fuzzy: pattern = re.compile(control_result) match = pattern.search(response_content) + log.msg("Fuzzy HTTP content comparison for experiment URL") + log.msg("'%s'" % experimental_url) if not match: - log.msg("Fuzzy HTTP content comparison for experiment URL") - log.msg("'%s'" % experimental_url) log.msg("does not match!") return False, response_code, response_headers else: - log.msg("Fuzzy HTTP content comparison of experiment URL") - log.msg("'%s'" % experimental_url) log.msg("and the expected control result yielded a match.") return True, response_code, response_headers else: diff --git a/ooni/plugoo/tests.py b/ooni/plugoo/tests.py index a3e9150..47bb135 100644 --- a/ooni/plugoo/tests.py +++ b/ooni/plugoo/tests.py @@ -15,11 +15,21 @@ from ooni.plugoo.interface import ITest class OONITest(object): + """ + This is the base class for writing OONI Tests. + + It should be used in conjunction with the ITest Interface. It allows the + developer to benefit from OONIs reporting system and command line argument + parsing system. + """ + # By default we set this to False, meaning that we don't block blocking = False def __init__(self, local_options, global_options, report, ooninet=None, reactor=None): + # These are the options that are read through the tests suboptions self.local_options = local_options + # These are the options global to all of OONI self.global_options = global_options self.assets = self.load_assets() self.report = report @@ -29,6 +39,10 @@ class OONITest(object): self.result = {} def initialize(self): + """ + Override this method if you are interested in having some extra + behavior when your test class is instantiated. + """ pass def load_assets(self): @@ -43,6 +57,10 @@ class OONITest(object): self.assets) def finished(self, control): + """ + The Test has finished running, we must now calculate the test runtime + and add all time data to the report. + """ #self.ooninet.report(result) self.end_time = date.now() result = self.result @@ -55,6 +73,13 @@ class OONITest(object): return result def _do_experiment(self, args): + """ + A wrapper around the launch of experiment. + If we are running a blocking test experiment will be run in a thread if + not we expect it to return a Deferred. + + @param args: the asset line(s) that we are working on. + """ if self.blocking: self.d = threads.deferToThread(self.experiment, args) else: @@ -65,6 +90,13 @@ class OONITest(object): return self.d def control(self, result, args): + """ + Run the control. + + @param result: what was returned by experiment. + + @param args: the asset(s) lines that we are working on. + """ log.msg("Doing control") if self.blocking: @@ -77,11 +109,23 @@ class OONITest(object): return d def experiment(self, args): + """ + Run the experiment. This sample implementation returns a deferred, + making it a non-blocking test. + + @param args: the asset(s) lines that we are working on. + """ log.msg("Doing experiment") d = defer.Deferred() return d def startTest(self, args): + """ + This method is invoked by the worker to start the test with one line of + the asset file. + + @param args: the asset(s) lines that we are working on. + """ self.start_time = date.now() log.msg("Starting test %s" % self.__class__) return self._do_experiment(args) diff --git a/ooni/plugoo/work.py b/ooni/plugoo/work.py index fc338d7..a8b6595 100644 --- a/ooni/plugoo/work.py +++ b/ooni/plugoo/work.py @@ -25,11 +25,23 @@ class Worker(object): runs them concurrently. """ def __init__(self, maxconcurrent=10): + """ + @param maxconcurrent: how many test instances should be run + concurrently. + """ self.maxconcurrent = maxconcurrent self._running = 0 self._queued = [] def _run(self, r): + """ + Check if we should start another test because we are below maximum + concurrency. + + This function is called every time a test finishes running. + + @param r: the return value of a previous test. + """ self._running -= 1 if self._running < self.maxconcurrent and self._queued: workunit, d = self._queued.pop(0) @@ -38,6 +50,7 @@ class Worker(object): actuald = test.startTest(asset).addBoth(self._run) if isinstance(r, failure.Failure): + # XXX probably we should be doing something to retry test running r.trap() if self._running == 0 and not self._queued: @@ -46,6 +59,15 @@ class Worker(object): return r def push(self, workunit): + """ + Add a test to the test queue and run it if we are not maxed out on + concurrency. + + @param workunit: a tuple containing the (asset, test, idx), where asset + is the line of the asset(s) we are working on, test + is an instantiated test and idx is the index we are + currently at. + """ if self._running < self.maxconcurrent: asset, test, idx = workunit self._running += 1 @@ -83,6 +105,11 @@ class WorkGenerator(object): return self def skip(self, start): + """ + Skip the first x number of lines of the asset. + + @param start: int how many items we should skip. + """ for j in xrange(0, start-1): for i in xrange(0, self.size): self.assetGenerator.next()

1 0

[ooni-probe/master] Minor refactoring of CaptivePortal tests
by art＠torproject.org 10 Jul '12

10 Jul '12

commit d5be93592dd12d7aea584cbc9bc26c55def4e271 Author: Arturo Filastò <art(a)torproject.org> Date: Tue Jul 10 07:24:04 2012 +0200 Minor refactoring of CaptivePortal tests (Flat is better than nested.) --- ooni/plugins/captiveportal.py | 73 +++++++++++++++++++--------------------- 1 files changed, 35 insertions(+), 38 deletions(-) diff --git a/ooni/plugins/captiveportal.py b/ooni/plugins/captiveportal.py index 1f13431..4ed00b3 100644 --- a/ooni/plugins/captiveportal.py +++ b/ooni/plugins/captiveportal.py @@ -89,45 +89,41 @@ class CaptivePortal(OONITest): response, response_headers = self.http_fetch(experimental_url, headers) response_content = response.read() response_code = response.code - if response_content is not None: - if fuzzy: - pattern = re.compile(control_result) - match = pattern.search(response_content) - log.msg("Fuzzy HTTP content comparison for experiment URL") - log.msg("'%s'" % experimental_url) - if not match: - log.msg("does not match!") - return False, response_code, response_headers - else: - log.msg("and the expected control result yielded a match.") - return True, response_code, response_headers + if response_content is None: + log.warn("HTTP connection appears to have failed.") + return False, False, False + + if fuzzy: + pattern = re.compile(control_result) + match = pattern.search(response_content) + log.msg("Fuzzy HTTP content comparison for experiment URL") + log.msg("'%s'" % experimental_url) + if not match: + log.msg("does not match!") + return False, response_code, response_headers else: - if str(response_content) != str(control_result): - log.msg("HTTP content comparison of experiment URL") - log.msg("'%s'" % experimental_url) - log.msg("and the expected control result do not match.") - return False, response_code, response_headers - else: - return True, response_code, response_headers + log.msg("and the expected control result yielded a match.") + return True, response_code, response_headers else: - log.warn("HTTP connection appears to have failed.") - return False, False, False + if str(response_content) != str(control_result): + log.msg("HTTP content comparison of experiment URL") + log.msg("'%s'" % experimental_url) + log.msg("and the expected control result do not match.") + return False, response_code, response_headers + else: + return True, response_code, response_headers def http_status_code_match(self, experiment_code, control_code): """ Compare two HTTP status codes, returns True if they match. """ - if int(experiment_code) != int(control_code): - return False - return True + return int(experiment_code) == int(control_code) def http_status_code_no_match(self, experiment_code, control_code): """ Compare two HTTP status codes, returns True if they do not match. """ - if self.http_status_code_match(experiment_code, control_code): - return False - return True + return int(experiment_code) != int(control_code) def dns_resolve(self, hostname, nameserver=None): """ @@ -163,9 +159,10 @@ class CaptivePortal(OONITest): log.msg("DNS resolution for %s returned NXDOMAIN" % hn) response.append('NXDOMAIN') finally: - if answer: - for addr in answer: - response.append(addr.address) + if not answer: + return response + for addr in answer: + response.append(addr.address) return response def dns_resolve_match(self, experiment_hostname, control_address): @@ -176,17 +173,17 @@ class CaptivePortal(OONITest): returns False and experiment_address. """ experiment_address = self.dns_resolve(experiment_hostname) - if experiment_address: - if len(set(experiment_address) & set([control_address])) > 0: - return True, experiment_address - else: - log.msg("DNS comparison of control '%s' does not" % control_address) - log.msg("match experiment response '%s'" % experiment_address) - return False, experiment_address - else: + if not experiment_address: log.debug("dns_resolve() for %s failed" % experiment_hostname) return None, experiment_address + if len(set(experiment_address) & set([control_address])) > 0: + return True, experiment_address + else: + log.msg("DNS comparison of control '%s' does not" % control_address) + log.msg("match experiment response '%s'" % experiment_address) + return False, experiment_address + def get_auth_nameservers(self, hostname): """ Many CPs set a nameserver to be used. Let's query that

1 0

[ooni-probe/master] Write unit tests for all the OONI plugins
by art＠torproject.org 10 Jul '12

10 Jul '12

commit 6aa7ca883a500eb2b909b21386d03f9bd29e5384 Author: Arturo Filastò <art(a)torproject.org> Date: Tue Jul 10 09:50:33 2012 +0200 Write unit tests for all the OONI plugins * Refactor some code --- ooni/log.py | 5 ++++- ooni/ooniprobe.py | 31 +++++++++++++++++++++---------- ooni/plugins/blocking.py | 7 +++++-- ooni/plugins/tcpconnect.py | 3 +-- ooni/plugoo/tests.py | 12 +++--------- ooni/protocols/http.py | 5 +---- tests/assets/ipports.txt | 2 ++ tests/assets/urllist.txt | 3 +++ tests/test_plugins.py | 40 ++++++++++++++++++++++++++++++++++++++++ tests/test_tests.py | 17 +++++++++-------- 10 files changed, 89 insertions(+), 36 deletions(-) diff --git a/ooni/log.py b/ooni/log.py index f1b7839..3dc52dd 100644 --- a/ooni/log.py +++ b/ooni/log.py @@ -34,7 +34,10 @@ def start(logfile=None, loglevel=None, logstdout=True): msg("Started OONI") def msg(message, level=INFO, **kw): - log.msg(message, **kw) + log.msg(message, logLevel=level, **kw) def err(message, **kw): log.err(message, **kw) + +def debug(message, **kw): + log.msg(message, logLevel=DEBUG, **kw) diff --git a/ooni/ooniprobe.py b/ooni/ooniprobe.py index 3eb70f6..22299ac 100755 --- a/ooni/ooniprobe.py +++ b/ooni/ooniprobe.py @@ -55,8 +55,17 @@ def retrieve_plugoo(): plugoo = retrieve_plugoo() -def runTest(test, options, global_options): +def runTest(test, options, global_options, reactor=None): + """ + Run an OONI probe test by name. + + @param test: a string specifying the test name as specified inside of + shortName. + @param options: the local options to be passed to the test. + + @param global_options: the global options for OONI + """ parallelism = int(global_options['parallelism']) worker = work.Worker(parallelism) test_class = plugoo[test].__class__ @@ -64,6 +73,8 @@ def runTest(test, options, global_options): log.start(global_options['log'], 1) resume = 0 + if not options: + options = {} if 'resume' in options: resume = options['resume'] @@ -74,7 +85,6 @@ def runTest(test, options, global_options): for x in wgen: worker.push(x) - reactor.run() class Options(usage.Options): tests = plugoo.keys() @@ -111,14 +121,15 @@ class Options(usage.Options): return getlogo() + '\n' + self.getSynopsis() + '\n' + \ self.getUsage(width=None).replace("Commands:", "Tests:") -config = Options() -config.parseOptions() - -if not config.subCommand: - print "Error! No Test Specified." - config.opt_help() - sys.exit(1) +if __name__ == "__main__": + config = Options() + config.parseOptions() -runTest(config.subCommand, config.subOptions, config) + if not config.subCommand: + print "Error! No Test Specified." + config.opt_help() + sys.exit(1) + runTest(config.subCommand, config.subOptions, config) + reactor.run() diff --git a/ooni/plugins/blocking.py b/ooni/plugins/blocking.py index 6ac3c91..6ddb5a4 100644 --- a/ooni/plugins/blocking.py +++ b/ooni/plugins/blocking.py @@ -27,8 +27,11 @@ class BlockingTest(OONITest): def experiment(self, args): import urllib - url = 'https://torproject.org/' if not 'asset' in args else args['asset'] - req = urllib.urlopen(url) + url = 'http://torproject.org/' if not 'asset' in args else args['asset'] + try: + req = urllib.urlopen(url) + except: + return {'error': 'Connection failed!'} return {'page': req.readlines()} diff --git a/ooni/plugins/tcpconnect.py b/ooni/plugins/tcpconnect.py index 27df08d..7c04994 100644 --- a/ooni/plugins/tcpconnect.py +++ b/ooni/plugins/tcpconnect.py @@ -6,7 +6,6 @@ Safe hacking :). from zope.interface import implements from twisted.python import usage from twisted.plugin import IPlugin -from twisted.internet import reactor from twisted.internet.protocol import Factory, Protocol from twisted.internet.endpoints import TCP4ClientEndpoint @@ -48,7 +47,7 @@ class tcpconnectTest(OONITest): return {'result': False, 'target': [host, port]} # What you return here gets handed as input to control - point = TCP4ClientEndpoint(reactor, host, int(port)) + point = TCP4ClientEndpoint(self.reactor, host, int(port)) d = point.connect(DummyFactory()) d.addCallback(gotProtocol) d.addErrback(gotError) diff --git a/ooni/plugoo/tests.py b/ooni/plugoo/tests.py index 47bb135..42294d6 100644 --- a/ooni/plugoo/tests.py +++ b/ooni/plugoo/tests.py @@ -79,6 +79,8 @@ class OONITest(object): not we expect it to return a Deferred. @param args: the asset line(s) that we are working on. + + returns a deferred. """ if self.blocking: self.d = threads.deferToThread(self.experiment, args) @@ -98,15 +100,7 @@ class OONITest(object): @param args: the asset(s) lines that we are working on. """ log.msg("Doing control") - - if self.blocking: - return result - - def end(cb): - return result - d = defer.Deferred() - d.addCallback(end) - return d + return result def experiment(self, args): """ diff --git a/ooni/protocols/http.py b/ooni/protocols/http.py index 835735b..1dd2261 100644 --- a/ooni/protocols/http.py +++ b/ooni/protocols/http.py @@ -41,13 +41,10 @@ class HTTPTest(OONITest): """ randomize_ua = True - def initialize(self, reactor=None): + def initialize(self): from twisted.web.client import Agent import yaml - if not self.reactor: - from twisted.internet import reactor - self.reactor = reactor self.agent = Agent(self.reactor) self.request = {} self.response = {} diff --git a/tests/assets/ipports.txt b/tests/assets/ipports.txt new file mode 100644 index 0000000..ade757f --- /dev/null +++ b/tests/assets/ipports.txt @@ -0,0 +1,2 @@ +127.0.0.1:80 +8.8.8.8:53 diff --git a/tests/assets/urllist.txt b/tests/assets/urllist.txt new file mode 100644 index 0000000..dc38e22 --- /dev/null +++ b/tests/assets/urllist.txt @@ -0,0 +1,3 @@ +http://google.com/ +http://127.0.0.1/ +http://dio.it/ diff --git a/tests/test_plugins.py b/tests/test_plugins.py new file mode 100644 index 0000000..26bee51 --- /dev/null +++ b/tests/test_plugins.py @@ -0,0 +1,40 @@ +from twisted.internet import defer, reactor +from twisted.trial import unittest + +from ooni.ooniprobe import retrieve_plugoo, runTest, Options +from ooni.plugoo import work, tests + +def asset_file(filename): + import os + file_dir = os.path.normpath(os.path.join(__file__, '..')) + return os.path.join(file_dir, 'assets', filename) + +class PluginsTestCase(unittest.TestCase): + def test_plugin_blocking(self): + suboptions = {'asset': asset_file('urllist.txt')} + runTest('blocking', suboptions, Options(), reactor) + return + + def test_plugin_tcpconnect(self): + suboptions = {'asset': asset_file('ipports.txt')} + runTest('tcpconnect', suboptions, Options(), reactor) + return + + + def test_plugin_captivep(self): + runTest('blocking', None, Options(), reactor) + return + + + def test_plugin_httphost(self): + suboptions = {'asset': asset_file('urllist.txt')} + runTest('httphost', suboptions, Options(), reactor) + return + + + def test_plugin_httpt(self): + suboptions = {'urls': asset_file('urllist.txt')} + runTest('httpt', suboptions, Options(), reactor) + return + + diff --git a/tests/test_tests.py b/tests/test_tests.py index bed5922..d0cc88c 100644 --- a/tests/test_tests.py +++ b/tests/test_tests.py @@ -13,9 +13,7 @@ class TestsTestCase(unittest.TestCase): self.errbackResults = None def _callback(self, *args, **kw): - print "BBB" - print args, kw - print "CCCC" + #print args, kw self.callbackResults = args, kw def _errback(self, *args, **kw): @@ -31,14 +29,17 @@ class TestsTestCase(unittest.TestCase): class DummyTest(tests.OONITest): blocking = False def experiment(self, args): - def cb(aaa): + def bla(a): + print a return test_dict - d = defer.Deferred() - d.addCallback(cb) - d.callback(None) - return d + d2 = defer.Deferred() + d2.addCallback(bla) + from twisted.internet import reactor + reactor.callLater(0.1, d2.callback, None) + return d2 test = DummyTest(None, None, self.dummyreport) yield test.startTest(None).addCallback(self._callback) self.assertEqual(self.callbackResults[0][0]['control'], test_dict) + return

1 0