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

[ooni-probe/master] Cleaning up test abort and skip code.
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit 673aaa698a0cce371ef404ca4868dae21d3365e6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 5 20:38:58 2012 +0000 Cleaning up test abort and skip code. * Using log.catch in the form log.catch(func, *args, **kwargs) somehow causes '_catch' to be registered as a test_method, so calls in this manner have been removed. * Cleaned up excessive calls to reactor.run() and reactor.stop(). reactor.stop() should only be called if reactor.running is True. --- nettests/bridge_reachability/tcpsyn.py | 2 +- ooni/nettest.py | 13 +++-- ooni/oonicli.py | 3 +- ooni/reporter.py | 15 +++--- ooni/runner.py | 81 ++++++++++++++++---------------- 5 files changed, 59 insertions(+), 55 deletions(-) diff --git a/nettests/bridge_reachability/tcpsyn.py b/nettests/bridge_reachability/tcpsyn.py index f92ab09..548fc0e 100644 --- a/nettests/bridge_reachability/tcpsyn.py +++ b/nettests/bridge_reachability/tcpsyn.py @@ -73,7 +73,7 @@ class TCPFlagTest(nettest.NetTestCase): setattr(self, key, value) if not self.interface: try: - iface = log.catch(net.getDefaultIface()) + iface = net.getDefaultIface() except net.IfaceError, ie: log.warn("Could not find a working network interface!") log.fail(ie) diff --git a/ooni/nettest.py b/ooni/nettest.py index 9aa7a70..1d1477d 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -200,12 +200,15 @@ class NetTestCase(object): category=DeprecationWarning) return txtrutil.DEFAULT_TIMEOUT_DURATION - def _abort(self, reason, obj=None): + def _abort(self, reason): """ - Abort running an input, test_method, or test_class. If called with only - one argument, assume we're going to ignore the current input. Otherwise, - the name of the method or class in relation to the test_instance, - i.e. "self" should be given as value for the keyword argument "obj". + + Abort running the current input. Raises + :class:`twisted.trial.test.skipping.SkipTest <SkipTest>` test_method, + or test_class. If called with only one argument, assume we're going to + ignore the current input. Otherwise, the name of the method or class + in relation to the test_instance, i.e. "self" should be given as value + for the keyword argument "obj". XXX call oreporter.allDone() from parent stack frame """ diff --git a/ooni/oonicli.py b/ooni/oonicli.py index 9c2b4e6..3362d06 100644 --- a/ooni/oonicli.py +++ b/ooni/oonicli.py @@ -134,5 +134,6 @@ def run(): cmd_line_options, yamloo_filename) tests_d.addBoth(testsEnded) - reactor.run() + ## it appears that tests run without this? + #reactor.run() diff --git a/ooni/reporter.py b/ooni/reporter.py index aec1e1b..193d056 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -130,13 +130,14 @@ class OReporter(object): return self.writeReportEntry(report) def allDone(self): - log.debug("allDone: Finished running all tests") - try: - log.debug("Stopping the reactor") - reactor.stop() - except: - log.debug("Unable to stop the reactor") - pass + log.debug("Running pending timed reactor calls") + reactor.runUntilCurrent() + if reactor.running: + log.debug("Reactor running. Stopping the reactor...") + try: + reactor.stop() + except: + log.debug("Unable to stop the reactor") return None class YAMLReporter(OReporter): diff --git a/ooni/runner.py b/ooni/runner.py index 1895d8b..2b41d59 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -21,6 +21,7 @@ from twisted.trial.runner import filenameToModule from twisted.trial import util as txtrutil from twisted.trial import reporter as txreporter from twisted.trial.unittest import utils as txtrutils +from twisted.trial.unittest import SkipTest from twisted.internet import reactor, threads from ooni.inputunit import InputUnitFactory @@ -75,7 +76,7 @@ def processTest(obj, cmd_line_options): obj.localOptions = options if input_file and options: - log.debug("Got input file") + log.debug("Added input file to options list") obj.inputFile = options[input_file[0]] try: @@ -181,80 +182,78 @@ def runTestWithInput(test_class, test_method, test_input, oreporter): """ log.debug("Running %s with %s" % (test_method, test_input)) - def test_abort_single_input(reason, test_instance, test_name): - pass - def test_timeout(d): - err = defer.TimeoutError("%s test for %s timed out after %s seconds" - % (test_name, test_instance.input, - test_instance.timeout)) - fail = failure.Failure(err) + timeout_error = defer.TimeoutError( + "%s test for %s timed out after %s seconds" + % (test_name, test_instance.input, test_instance.timeout)) + timeout_fail = failure.Failure(err) try: - d.errback(fail) + d.errback(timeout_fail) except defer.AlreadyCalledError: # if the deferred has already been called but the *back chain is # still unfinished, crash the reactor and report the timeout reactor.crash() test_instance._timedOut = True # see test_instance._wait - # XXX result is TestResult utils? test_instance._test_result.addExpectedFailure(test_instance, fail) test_timeout = txtrutils.suppressWarnings( test_timeout, txtrutil.suppress(category=DeprecationWarning)) def test_done(result, test_instance, test_name): - log.debug("runTestWithInput: concluded %s" % test_name) + log.debug("Concluded %s with inputs %s" + % (test_name, test_instance.input)) return oreporter.testDone(test_instance, test_name) def test_error(error, test_instance, test_name): - log.exception(error) + if isinstance(error, SkipTest): + log.info("%s" % error.message) + else: + log.exception(error) test_instance = test_class() test_instance.input = test_input test_instance.report = {} - log.debug("Processing %s" % test_instance.name) + # XXX TODO + # the twisted.trial.reporter.TestResult is expected by test_timeout(), + # but we should eventually replace it with a stub class + test_instance._test_result = txreporter.TestResult() # use this to keep track of the test runtime test_instance._start_time = time.time() test_instance.timeout = test_instance._getTimeout() - test_instance._test_result = txreporter.TestResult() # call setups on the test test_instance._setUp() test_instance.setUp() - test_ignored = txtrutil.acquireAttribute(test_instance._parents, - 'skip', None) - - test = getattr(test_instance, test_method) - - # check if we've aborted - test_skip = test_instance._getSkip() - if test_skip is not None: - log.debug("%s.getSkip() returned %s" % (str(test_class), - str(test_skip)) ) - - abort_reason, abort_what = getattr(test_instance, 'abort', ('input', None)) - if abort_reason is not None: - do_abort = abortTestWasCalled(abort_reason, abort_what, test_class, - test_instance, test_method, test_input, - oreporter) - return defer.maybeDeferred(do_abort) + + # check that we haven't inherited a skip + test_ignored = txtrutil.acquireAttribute( + test_instance._parents, 'skip', None) + if test_ignored is not None: + # XXX we'll need to do something more than warn + log.warn("test_skip is %s" % test_ignored) + + # now check our instance for test_methods set to be skipped: + skip_list = test_instance._getSkip() + if skip_list is not None: + log.debug("%s marked these tests to be skipped: %s" + % (test_instance.name, skip_list)) else: + log.debug("No tests marked as skip") + skip_list = [skip_list] + + if not test_method in skip_list: + test = getattr(test_instance, test_method) d = defer.maybeDeferred(test) # register the timer with the reactor - call = reactor.callLater(test_timeout, test_timed_out, d) + call = reactor.callLater(test_instance.timeout, test_timeout, d) d.addBoth(lambda x: call.active() and call.cancel() or x) - - # XXX check if test called test_abort... - d.addCallbacks(test_abort, - test_error, - callbackArgs=(test_instance, test_method), - errbackArgs=(test_instance, test_method) ) + d.addCallback(test_done, test_instance, test_method) d.addErrback(test_error, test_instance, test_method) log.debug("returning %s input" % test_method) + else: + d = defer.Deferred() - ignored = d.getSkip() - - return d + return d def runTestWithInputUnit(test_class, test_method, input_unit, oreporter): """

1 0

[ooni-probe/master] Updated .gitignore from copy of old repo
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit ac95afc153037a804dbcaf8a510176b7517e76fe Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 6 17:59:26 2012 +0000 Updated .gitignore from copy of old repo --- .gitignore | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/.gitignore b/.gitignore index d1015ab..4cb0775 100644 --- a/.gitignore +++ b/.gitignore @@ -19,3 +19,4 @@ pcaps/ report*.yaml docs/build/* data/*.dat +ooniprobe.conf

1 0

[ooni-probe/master] Fixed error with reporting results for tcp flags tests, and cleaned up test
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit 9688f83110a7d8986e20d665b93f4acbf6ba40f6 Author: Isis Lovecruft <isis(a)torproject.org> Date: Sun Dec 9 23:13:42 2012 +0000 Fixed error with reporting results for tcp flags tests, and cleaned up test abort code. --- nettests/bridge_reachability/tcpsyn.py | 156 ++++++++++++++------------------ ooni/nettest.py | 77 +++++++--------- ooni/reporter.py | 3 +- ooni/runner.py | 62 ++++++++----- 4 files changed, 140 insertions(+), 158 deletions(-) diff --git a/nettests/bridge_reachability/tcpsyn.py b/nettests/bridge_reachability/tcpsyn.py index 6a4b8db..79b8e52 100644 --- a/nettests/bridge_reachability/tcpsyn.py +++ b/nettests/bridge_reachability/tcpsyn.py @@ -16,32 +16,29 @@ import os import sys -from ipaddr import IPAddress from twisted.python import usage from twisted.python.failure import Failure -from twisted.internet import reactor, defer, address +from twisted.internet import reactor, defer from ooni import nettest, config from ooni.utils import net, log from ooni.utils.otime import timestamp try: - from scapy.all import TCP, IP + from scapy.all import TCP, IP, sr from ooni.utils import txscapy except: log.msg("This test requires scapy, see www.secdev.org/projects/scapy") -class TCPFlagOptions(usage.Options): +class TCPFlagsOptions(usage.Options): """Options for TCPTest.""" optParameters = [ ['dst', 'd', None, 'Host IP to ping'], ['port', 'p', None, 'Host port'], - ['flags', 's', None, 'Comma separated flags to set [S|A|F]'], + ['flags', 's', 'S', 'Comma separated flags to set, eg. "SA"'], ['count', 'c', 3, 'Number of SYN packets to send', int], ['interface', 'i', None, 'Network interface to use'], - ['hexdump', 'x', False, 'Show hexdump of responses'], - ['pdf', 'y', False, - 'Create pdf of visual representation of packet conversations']] + ['hexdump', 'x', False, 'Show hexdump of responses']] class TCPFlagsTest(nettest.NetTestCase): """ @@ -57,29 +54,28 @@ class TCPFlagsTest(nettest.NetTestCase): version = '0.1.1' requiresRoot = True - usageOptions = TCPFlagOptions + usageOptions = TCPFlagsOptions inputFile = ['file', 'f', None, 'File of list of IP:PORTs to ping'] + destinations = {} + def setUp(self, *a, **kw): """Configure commandline parameters for TCPSynTest.""" - self.report = {} - self.packets = {'results': [], 'unanswered': []} - if self.localOptions: for key, value in self.localOptions.items(): setattr(self, key, value) if not self.interface: try: iface = net.getDefaultIface() - except net.IfaceError, ie: - log.warn("Could not find a working network interface!") - log.fail(ie) - else: self.interface = iface + except net.IfaceError: + self.abortClass("Could not find a working network interface!") + if self.flags: + self.flags = self.flags.split(',') if config.advanced.debug: defer.setDebugging('on') - def addToDestinations(self, addr='0.0.0.0', port='443'): + def addToDestinations(self, addr=None, port='443'): """ Validate and add an IP address and port to the dictionary of destinations to send to. If the host's IP is already in the @@ -89,12 +85,16 @@ class TCPFlagsTest(nettest.NetTestCase): @param port: A string representing a port number. @returns: A 2-tuple containing the address and port. """ + if addr is None: + return (None, None) # do we want to return SkipTest? + dst, dport = net.checkIPandPort(addr, port) - if not dst in self.report.keys(): - self.report[dst] = {'dst': dst, 'dport': [dport]} + if not dst in self.destinations.keys(): + self.destinations[dst] = {'dst': dst, + 'dport': [dport]} else: log.debug("Got additional port for destination.") - self.report[dst]['dport'].append(dport) + self.destinations[dst]['dport'].append(dport) return (dst, dport) def inputProcessor(self, input_file=None): @@ -118,7 +118,7 @@ class TCPFlagsTest(nettest.NetTestCase): raw_ip, raw_port = one.rsplit(':', 1) yield self.addToDestinations(raw_ip, raw_port) - def tcp_flags(self, flags=None): + def test_tcp_flags(self): """ Generate, send, and listen for responses to, a list of TCP/IP packets to an address and port pair taken from the current input, and a string @@ -128,11 +128,14 @@ class TCPFlagsTest(nettest.NetTestCase): A string representing the TCP flags to be set, i.e. "SA" or "F". Defaults to "S". """ - def build_packets(addr, port, flags=None, count=3): + def build_packets(addr, port): """Construct a list of packets to send out.""" packets = [] - for x in xrange(count): - packets.append( IP(dst=addr)/TCP(dport=port, flags=flags) ) + for flag in self.flags: + log.debug("Generating packets with %s flags for %s:%d..." + % (flag, addr, port)) + for x in xrange(self.count): + packets.append( IP(dst=addr)/TCP(dport=port, flags=flag) ) return packets def process_packets(packet_list): @@ -144,72 +147,45 @@ class TCPFlagsTest(nettest.NetTestCase): @param packet_list: A :class:scapy.plist.PacketList """ + log.msg("Processing received packets...") results, unanswered = packet_list - self.packets['results'].append([r for r in results]) - self.packets['unanswered'].append([u for u in unanswered]) - + for (q, r) in results: - request_data = {'dst': q.dst, - 'dport': q.dport, - 'summary': q.summary(), - 'command': q.command(), - 'hexdump': None, - 'sent_time': q.time} - response_data = {'src': r['IP'].src, - 'flags': r['IP'].flags, - 'summary': r.summary(), - 'command': r.command(), - 'hexdump': None, - 'recv_time': r.time, - 'delay': r.time - q.time} + request = {'dst': q.dst, + 'dport': q.dport, + 'summary': q.summary(), + 'hexdump': None, + 'sent_time': q.time} + response = {'src': r['IP'].src, + 'flags': r['IP'].flags, + 'summary': r.summary(), + 'hexdump': None, + 'recv_time': r.time, + 'delay': r.time - q.time} if self.hexdump: - request_data.update('hexdump', q.hexdump()) - response_data.update('hexdump', r.hexdump()) - - for dest, data in self.report.items(): - if data['dst'] == response_data['src']: - if not 'reachable' in data: - if self.hexdump: - log.msg("%s\n%s" % (q.hexdump(), r.hexdump())) - else: - log.msg(" Received response:\n%s ==> %s" - % (q.mysummary(), r.mysummary())) - data.update( {'reachable': True, - 'request': request_data, - 'response': response_data} ) - self.report[response_data['src']['data'].update(data) - - if unanswered is not None and len(unanswered) > 0: - log.msg("Waiting on responses from\n%s" % - '\n'.join( [unans.summary() for unans in unanswered] )) - log.msg("Writing response packet information to report...") - - (addr, port) = self.input - packets = build_packets(addr, port, str(flags), self.count) - d = txscapy.sr(packets, iface=self.interface) - #d.addCallbacks(process_packets, log.exception) - #d.addCallbacks(process_unanswered, log.exception) - d.addCallback(process_packets) - d.addErrback(process_unanswered) - - return d - - @log.catch - def createPDF(self): - pdfname = self.name + '_' + timestamp() - self.packets['results'].pdfdump(pdfname) - log.msg("Visual packet conversation saved to %s.pdf" % pdfname) - - def test_tcp_flags(self): - """Send packets with given TCP flags to an address:port pair.""" - flag_list = self.flags.split(',') - - dl = [] - for flag in flag_list: - dl.append(self.tcp_flags(flag)) - d = defer.DeferredList(dl) - - if self.pdf: - d.addCallback(self.createPDF) - - return d + request['hexdump'] = q.hexdump() + response['hexdump'] = r.hexdump() + + for dest, data in self.destinations.items(): + if response['src'] == data['dst']: + log.msg(" Received response from %s:\n%s ==> %s" % ( + response['src'], q.mysummary(), r.mysummary())) + if self.hexdump: + log.msg("%s\n%s" % (q.hexdump(), r.hexdump())) + + self.report['request'] = request + self.report['response'] = response + + if unanswered is not None: + unans = [un.summary() for un in unanswered] + log.msg(" Waiting on responses from:\n%s" % '\n'.join(unans)) + self.report['unanswered'] = unans + + try: + self.report = {} + (addr, port) = self.input + pkts = build_packets(addr, port) + d = process_packets(sr(pkts, iface=self.interface, timeout=5)) + return d + except Exception, ex: + log.exception(ex) diff --git a/ooni/nettest.py b/ooni/nettest.py index bd6ef9b..29ced70 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -12,9 +12,11 @@ import sys import os import itertools import traceback +import inspect from twisted.trial import unittest, itrial from twisted.trial import util as txtrutil +from twisted.trial.test import skipping from twisted.internet import defer, utils from twisted.python import usage @@ -171,59 +173,46 @@ class NetTestCase(object): def __repr__(self): return "<%s inputs=%s>" % (self.__class__, self.inputs) - def _abort(self, reason): - """ - - Abort running the current input. Raises - :class:`twisted.trial.test.skipping.SkipTest <SkipTest>` test_method, - or test_class. If called with only one argument, assume we're going to - ignore the current input. Otherwise, the name of the method or class - in relation to the test_instance, i.e. "self" should be given as value - for the keyword argument "obj". + def _abortMethod(self, reason, method=None): + if method is None: + test_method = self._testMethod + else: + test_method = getattr(self.__class__, method, False) - XXX call oreporter.allDone() from parent stack frame - """ - reason = str(reason) - raise SkipTest("%s\n%s" % (str(reason), str(self.input)) ) - - def _abortMethod(self, reason, method): - if inspect.ismethod(method): - abort = getattr(self.__class__, method, False) - log.debug("Aborting remaining inputs for %s" % str(abort.func_name)) - setattr(abort, 'skip', reason) + if inspect.ismethod(test_method): + method_name = test_method.im_func.func_name + setattr(test_method, 'skip', reason) + raise skipping.SkipTest("Aborting %s for reason: %s" + % (method_name, reason) ) else: - log.debug("abortMethod(): could not find method %s" % str(method)) + log.debug("_abortMethod(): could not find method %s" % test_method) - @log.catch - def _abortClass(self, reason, cls): - if not inspect.isclass(obj) or not isTestCase(obj): - log.debug("_abortClass() could not find class %s" % str(cls)) - return - abort = getattr(obj, '__class__', self.__class__) - log.debug("Aborting %s test" % str(abort.name)) - setattr(abort, 'skip', reason) - - def abortCurrentInput(self, reason): + def abortInput(self, reason): """ Abort the current input. @param reason: A string explaining why this test is being skipped. + @raises: A :class:`twisted.trial.test.skipping.SkipTest <SkipTest>` """ - return self._abort(reason) - - def abortInput(self, reason): - return self._abort(reason) + raise skipping.SkipTest(" Reason: %s\nCurrent input: %s" + % (reason, self.input)) + def abortMethod(self, reason, test_method=None): + """ + Abort all remaining inputs for the current test method. -# This needs to be here so that NetTestCase.abort() can call it, since we -# cannot import runner because runner imports NetTestCase. -def isTestCase(obj): - """ - Return True if obj is a subclass of NetTestCase, false if otherwise. - """ - try: - return issubclass(obj, NetTestCase) - except TypeError: - return False + @param reason: A string explaining why the current test_method is + being skipped. + @param test_method: (optional) The test_method to skip, defaults to + the currently running test_method. + """ + return self._abortMethod(reason, test_method) + def abortClass(self, reason='unspecified'): + """ + Abort the entire NetTestCase class. + @param reason: A string explaining why the class is being skipped. + """ + log.msg("Aborting %s: %s" % (self.__class__.name, reason)) + setattr(self.__class__, 'skip', reason) diff --git a/ooni/reporter.py b/ooni/reporter.py index 6fdc142..133b98d 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -218,7 +218,8 @@ class OONIBReporter(OReporter): response = yield self.agent.request("PUT", url, bodyProducer=bodyProducer) except: - # XXX we must trap this in the runner and make sure to report the data later. + # XXX we must trap this in the runner and make sure to report the + # data later. raise OONIBReportUpdateFailed #parsed_response = json.loads(backend_response) diff --git a/ooni/runner.py b/ooni/runner.py index 4214360..5969dd5 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -16,7 +16,7 @@ import traceback import itertools from twisted.python import reflect, usage, failure -from twisted.internet import defer +from twisted.internet import defer, reactor from twisted.trial.runner import filenameToModule from twisted.trial import reporter as txreporter from twisted.trial import util as txtrutil @@ -28,6 +28,15 @@ from ooni.inputunit import InputUnitFactory from ooni import reporter, nettest from ooni.utils import log, checkForRoot, PermissionsError +def isTestCase(obj): + """ + Return True if obj is a subclass of NetTestCase, false if otherwise. + """ + try: + return issubclass(obj, nettest.NetTestCase) + except TypeError: + return False + def processTest(obj, cmd_line_options): """ Process the parameters and :class:`twisted.python.usage.Options` of a @@ -112,7 +121,7 @@ def findTestClassesFromConfig(cmd_line_options): module = filenameToModule(filename) for name, val in inspect.getmembers(module): - if nettest.isTestCase(val): + if isTestCase(val): classes.append(processTest(val, cmd_line_options)) return classes @@ -185,13 +194,19 @@ def runTestWithInput(test_class, test_method, test_input, oreporter): d.errback(timeout_fail) except defer.AlreadyCalledError: # if the deferred has already been called but the *back chain is - # still unfinished, crash the reactor and report the timeout + # still unfinished, safely crash the reactor and report the timeout reactor.crash() test_instance._timedOut = True # see test_instance._wait test_instance._test_result.addExpectedFailure(test_instance, fail) test_timeout = txtrutils.suppressWarnings( test_timeout, txtrutil.suppress(category=DeprecationWarning)) + def test_skip_class(reason): + try: + d.errback(failure.Failure(SkipTest("%s" % reason))) + except defer.AlreadyCalledError: + pass # XXX not sure what to do here... + def test_done(result, test_instance, test_name): log.debug("Concluded %s with inputs %s" % (test_name, test_instance.input)) @@ -199,10 +214,7 @@ def runTestWithInput(test_class, test_method, test_input, oreporter): def test_error(error, test_instance, test_name): if isinstance(error, SkipTest): - if len(error.args) > 0: - skip_what = error.args[1] - # XXX we'll need to handle methods and classes - log.info("%s" % error.message) + log.warn("%s" % error.message) else: log.exception(error) @@ -219,26 +231,30 @@ def runTestWithInput(test_class, test_method, test_input, oreporter): test_instance._setUp() test_instance.setUp() - test_skip = txtrutil.acquireAttribute( - test_instance._parents, 'skip', None) - if test_skip is not None: - # XXX we'll need to do something more than warn + test_skip = txtrutil.acquireAttribute(test_instance._parents, 'skip', None) + if test_skip: log.warn("%s marked these tests to be skipped: %s" - % (test_instance.name, test_skip)) + % (test_instance.name, test_skip)) skip_list = [test_skip] - if not test_method in skip_list: - test = getattr(test_instance, test_method) - d = defer.maybeDeferred(test) + test = getattr(test_instance, test_method) + test_instance._testMethod = test + + d = defer.maybeDeferred(test) + + # register the timer with the reactor + call_timeout = reactor.callLater(test_instance.timeout, test_timeout, d) + d.addBoth(lambda x: call_timeout.active() and call_timeout.cancel() or x) + + # check if the class has been aborted + if hasattr(test_instance.__class__, 'skip'): + reason = getattr(test_instance.__class__, 'skip') + call_skip = reactor.callLater(0, test_skip_class, reason) + d.addBoth(lambda x: call_skip.active() and call_skip.cancel() or x) + + d.addCallback(test_done, test_instance, test_method) + d.addErrback(test_error, test_instance, test_method) - # register the timer with the reactor - call = reactor.callLater(test_instance.timeout, test_timeout, d) - d.addBoth(lambda x: call.active() and call.cancel() or x) - - d.addCallback(test_done, test_instance, test_method) - d.addErrback(test_error, test_instance, test_method) - else: - d = defer.Deferred() return d def runTestWithInputUnit(test_class, test_method, input_unit, oreporter):

1 0

[ooni-probe/master] Merge remote-tracking branch 'tpo-common/master'
by isis＠torproject.org 18 Dec '12

18 Dec '12

1 0

[ooni-probe/master] Cleaned up a couple of the comments in ooniprobe.conf.sample explaining the
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit 252988c853ca5fd90a50efec7de539f84f184297 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 12 15:52:07 2012 +0000 Cleaned up a couple of the comments in ooniprobe.conf.sample explaining the config options. --- ooniprobe.conf.sample | 4 ++-- 1 files changed, 2 insertions(+), 2 deletions(-) diff --git a/ooniprobe.conf.sample b/ooniprobe.conf.sample index 7031ba1..67da610 100644 --- a/ooniprobe.conf.sample +++ b/ooniprobe.conf.sample @@ -22,9 +22,9 @@ advanced: # /path/to/ooni-probe/data/ geoip_data_dir: /usr/share/GeoIP/ debug: true - # If we're including the client's IP address, how long should we wait for - # the connection to complete before timing out? + # How many seconds should we wait for connections before timing out?: checktimeout: 15 + # Location where Tor is installed: tor_binary: '/usr/sbin/tor' # For auto detection interface: auto

1 0

[ooni-probe/master] Fixed a bug where ooni.runner.processTest() expected an unnecessary
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit fef56442ae930470c7160006dac72339c4af98fa Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 12 19:14:45 2012 +0000 Fixed a bug where ooni.runner.processTest() expected an unnecessary parameter. Also fixed a TypeError due to string formatting in runTestCasesWithInputUnit(), and a couple typos for method calls. * Fixed an "except NoPostProcessor" which should have been "except nettest.NoPostProcessor". --- ooni/runner.py | 14 +++++++------- 1 files changed, 7 insertions(+), 7 deletions(-) diff --git a/ooni/runner.py b/ooni/runner.py index 4724d3d..6f03e56 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -21,7 +21,7 @@ from twisted.internet import defer, reactor, threads from twisted.trial import reporter as txreporter from twisted.trial import util as txutil from twisted.trial.runner import filenameToModule -from twisted.trial.unittest import utils as txtrutils +from twisted.trial.unittest import utils as txutils from twisted.trial.unittest import SkipTest from txtorcon import TorProtocolFactory, TorConfig @@ -70,7 +70,7 @@ def checkRequiredOptions(test_instance): if not test_instance.localOptions[required_option]: raise usage.UsageError("%s not specified!" % required_option) -def processTest(obj, cmd_line_options): +def processTest(obj): """ Process the parameters and :class:`twisted.python.usage.Options` of a :class:`ooni.nettest.Nettest`. @@ -249,8 +249,8 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, reactor.crash() test_instance._timedOut = True # see test_instance._wait test_instance._test_result.addExpectedFailure(test_instance, fail) - test_timeout = txtrutils.suppressWarnings( - test_timeout, txtrutil.suppress(category=DeprecationWarning)) + test_timeout = txutils.suppressWarnings( + test_timeout, txutil.suppress(category=DeprecationWarning)) def test_skip_class(reason): try: @@ -289,7 +289,7 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, d1 = oonib_reporter.testDone(test_instance, 'summary') d2 = yaml_reporter.testDone(test_instance, 'summary') return defer.DeferredList([d1, d2]) - except NoPostProcessor: + except nettest.NoPostProcessor: log.debug("No post processor configured") return @@ -329,7 +329,7 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, else: reason = txutil.acquireAttribute(test_instance._parents, 'skip', None) log.warn("%s marked some tests to be skipped. Reason: %s" - % (test_instance.name, test_skip)) + % (test_instance.name, reason)) if reason is not None: call_skip = reactor.callLater(0, test_skip_class, reason) d.addBoth(lambda x: call_skip.active() and call_skip.cancel() or x) @@ -361,7 +361,7 @@ def runTestCasesWithInputUnit(test_cases, input_unit, yaml_reporter, """ dl = [] for test_input in input_unit: - log.debug("Running test with this input %s" % test_input) + log.debug("Running test with this input %s" % str(test_input)) d = runTestCasesWithInput(test_cases, test_input, yaml_reporter, oonib_reporter) dl.append(d)

1 0

[ooni-probe/master] Cleaned up logic for the reactor to callback to test_skip_class() in
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit e5d1a84030ca5267015e3c8e33d6b3a419da2727 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 12 18:08:16 2012 +0000 Cleaned up logic for the reactor to callback to test_skip_class() in ooni.runner.runTestCaseWithInput(). * Moved Exceptions classes to beginning of file. * Fixed a raise statement which called an Exception that doesn't exist anymore. * Cleaned up documentation, imports, code style, and indentation. --- ooni/runner.py | 145 ++++++++++++++++++++++++++++--------------------------- 1 files changed, 74 insertions(+), 71 deletions(-) diff --git a/ooni/runner.py b/ooni/runner.py index 58ec188..306c1d9 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -18,9 +18,9 @@ import yaml from twisted.python import reflect, usage, failure from twisted.internet import defer, reactor, threads -from twisted.trial.runner import filenameToModule from twisted.trial import reporter as txreporter -from twisted.trial import util as txtrutil +from twisted.trial import util as txutil +from twisted.trial.runner import filenameToModule from twisted.trial.unittest import utils as txtrutils from twisted.trial.unittest import SkipTest @@ -28,16 +28,28 @@ from txtorcon import TorProtocolFactory, TorConfig from txtorcon import TorState, launch_tor from ooni import config, nettest, reporter -from ooni.reporter import OONIBReporter, YAMLReporter, OONIBReportError from ooni.inputunit import InputUnitFactory +from ooni.reporter import OONIBReporter, YAMLReporter, OONIBReportError from ooni.utils import log, checkForRoot from ooni.utils import PermissionsError, Storage from ooni.utils.net import randomFreePort + +class NoTestCasesFound(Exception): + pass + +class InvalidResumeFile(Exception): + pass + +class noResumeSession(Exception): + pass + +class InvalidConfigFile(Exception): + message = "Invalid setting in ooniprobe.conf: " + + def isTestCase(obj): - """ - Return True if obj is a subclass of NetTestCase, false if otherwise. - """ + """Return True if obj is a subclass of NetTestCase, False otherwise.""" try: return issubclass(obj, nettest.NetTestCase) except TypeError: @@ -55,14 +67,7 @@ def processTest(obj, cmd_line_options): :param cmd_line_options: A configured and instantiated :class:`twisted.python.usage.Options` class. - """ - if not hasattr(obj.usageOptions, 'optParameters'): - obj.usageOptions.optParameters = [] - - if obj.inputFile: - obj.usageOptions.optParameters.append(obj.inputFile) - if obj.requiresRoot: try: checkForRoot() @@ -70,37 +75,40 @@ def processTest(obj, cmd_line_options): log.err("%s requires root to run" % obj.name) sys.exit(1) + if not hasattr(obj.usageOptions, 'optParameters'): + obj.usageOptions.optParameters = [] + if obj.baseParameters: for parameter in obj.baseParameters: obj.usageOptions.optParameters.append(parameter) - if obj.baseFlags: if not hasattr(obj.usageOptions, 'optFlags'): obj.usageOptions.optFlags = [] for flag in obj.baseFlags: obj.usageOptions.optFlags.append(flag) + if obj.inputFile: # inputFile is the optParameters list + obj.usageOptions.optParameters.append(obj.inputFile) options = obj.usageOptions() - options.parseOptions(config.cmd_line_options['subargs']) + obj.localOptions = options - if obj.inputFile: + if obj.inputFile: # inputFilename is the actual filename obj.inputFilename = options[obj.inputFile[0]] try: - log.debug("processing options") + log.debug("Parsing commandline options") tmp_test_case_object = obj() tmp_test_case_object._checkRequiredOptions() - - except usage.UsageError, e: - test_name = tmp_test_case_object.name - log.err("There was an error in running %s!" % test_name) - log.err("%s" % e) + except usage.UsageError, ue: + log.err("%s" % ue) options.opt_help() - raise usage.UsageError("Error in parsing command line args for %s" % test_name) - return obj + raise usage.UsageError("Error parsing command line args for %s" + % tmp_test_case_object.name) + else: + return obj def findTestClassesFromFile(filename): """ @@ -131,9 +139,6 @@ def makeTestCases(klass, tests, method_prefix): cases.append((klass, method_prefix+test)) return cases -class NoTestCasesFound(Exception): - pass - def loadTestsAndOptions(classes, cmd_line_options): """ Takes a list of test classes and returns their testcases and options. @@ -155,31 +160,43 @@ def loadTestsAndOptions(classes, cmd_line_options): return test_cases, options -def getTimeout(test_instance, test_method): +def getTestTimeout(test_instance, test_method): """ + Returns the timeout value set on this test. Check on the instance first, the the class, then the module, then package. As soon as it finds - something with a timeout attribute, returns that. Returns - twisted.trial.util.DEFAULT_TIMEOUT_DURATION if it cannot find anything. + something with a timeout attribute, returns that. Returns the value set in + ooniprobe.conf, :attr:`ooni.config.advanced.default_timeout + <default_timeout>` if it cannot find anything. See twisted.trial.unittest.TestCase docstring for more details. + + @param test_instance: + The instance of a :class:`ooni.nettest.NetTestCase` currently running. + @param test_method: + The test_instance.test_method currently being processed. """ + default = config.advanced.default_timeout + try: - testMethod = getattr(test_instance, test_method) + tm = getattr(test_instance, test_method) except: - log.debug("_getTimeout couldn't find self.methodName!") - return txtrutil.DEFAULT_TIMEOUT_DURATION + log.debug("runner.getTestTimeout() couldn't find %s.%s!" + % (test_instance, test_method)) + try: + return float(default) + except (ValueError, TypeError): + raise InvalidConfigFile("'default_timeout' must be a number!") else: - test_instance._parents = [testMethod, test_instance] - test_instance._parents.extend(txtrutil.getPythonContainers(testMethod)) - timeout = txtrutil.acquireAttribute(test_instance._parents, 'timeout', - txtrutil.DEFAULT_TIMEOUT_DURATION) + test_instance._parents = [tm, test_instance] + test_instance._parents.extend(txutil.getPythonContainers(tm)) + timeout = txutil.acquireAttribute( + test_instance._parents, 'timeout', default) try: return float(timeout) except (ValueError, TypeError): - warnings.warn("'timeout' attribute needs to be a number.", - category=DeprecationWarning) - return txtrutil.DEFAULT_TIMEOUT_DURATION + log.warn("'timeout' attribute must be a number!") + return float(default_timeout) def runTestCasesWithInput(test_cases, test_input, yaml_reporter, oonib_reporter=None): @@ -204,7 +221,6 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, this is set to none then we will only report to the YAML reporter. """ - # This is used to store a copy of all the test reports tests_report = {} @@ -267,31 +283,24 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, dl = [] for test_case in test_cases: - log.debug("Processing %s" % test_case[1]) test_class = test_case[0] test_method = test_case[1] + log.debug("%s: Setting up: %s" % (test_class.name, test_method)) + test_instance = test_class() test_instance.input = test_input test_instance.report = {} - # XXX TODO the twisted.trial.reporter.TestResult is expected by - # test_timeout(), but we should eventually replace it with a stub class + # XXX txreporter.TestResult is expected by test_timeout(), but we + # should eventually replace it with a stub class test_instance._test_result = txreporter.TestResult() - # use this to keep track of the test runtime test_instance._start_time = time.time() - test_instance.timeout = getTimeout(test_instance, test_method) - # call setups on the test test_instance._setUp() test_instance.setUp() - - # check if we're inherited from anything marked to be skipped - test_skip = txtrutil.acquireAttribute(test_instance._parents, 'skip', None) - if test_skip: - log.warn("%s marked these tests to be skipped: %s" - % (test_instance.name, test_skip)) - skip_list = [test_skip] + # get the timeout and _parents, in case it was set in setUp() + test_instance.timeout = getTestTimeout(test_instance, test_method) test = getattr(test_instance, test_method) test_instance._testMethod = test @@ -302,9 +311,14 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, call_timeout = reactor.callLater(test_instance.timeout, test_timeout, d) d.addBoth(lambda x: call_timeout.active() and call_timeout.cancel() or x) - # check if the class has been aborted + # check if anything has been aborted or marked as 'skip' if hasattr(test_instance.__class__, 'skip'): reason = getattr(test_instance.__class__, 'skip') + else: + reason = txutil.acquireAttribute(test_instance._parents, 'skip', None) + log.warn("%s marked some tests to be skipped. Reason: %s" + % (test_instance.name, test_skip)) + if reason is not None: call_skip = reactor.callLater(0, test_skip_class, reason) d.addBoth(lambda x: call_skip.active() and call_skip.cancel() or x) @@ -316,8 +330,8 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, test_methods_d.addCallback(tests_done, test_cases[0][0]) return test_methods_d -def runTestCasesWithInputUnit(test_cases, input_unit, yaml_reporter, - oonib_reporter): +def runTestCasesWithInputUnit(test_cases, input_unit, yaml_reporter, + oonib_reporter): """ Runs the Test Cases that are given as input parallely. A Test Case is a subclass of ooni.nettest.NetTestCase and a list of @@ -341,12 +355,6 @@ def runTestCasesWithInputUnit(test_cases, input_unit, yaml_reporter, dl.append(d) return defer.DeferredList(dl) -class InvalidResumeFile(Exception): - pass - -class noResumeSession(Exception): - pass - def loadResumeFile(): """ Sets the singleton stateDict object to the content of the resume file. @@ -355,7 +363,6 @@ def loadResumeFile(): Raises: :class:ooni.runner.InvalidResumeFile if the resume file is not valid - """ if not config.stateDict: try: @@ -391,7 +398,6 @@ def resumeTest(test_filename, input_unit_factory): :class:ooni.inputunit.InputUnitFactory that is at the index of the previous test run. - """ try: idx = config.stateDict[test_filename] @@ -412,7 +418,7 @@ def resumeTest(test_filename, input_unit_factory): @defer.inlineCallbacks def updateResumeFile(test_filename): """ - update the resume file with the current stateDict state. + Update the resume file with the current stateDict state. """ log.debug("Acquiring lock for %s" % test_filename) yield config.resume_lock.acquire() @@ -434,16 +440,13 @@ def increaseInputUnitIdx(test_filename): including the .py extension. input_unit_idx (int): the current input unit index for the test. - """ config.stateDict[test_filename] += 1 yield updateResumeFile(test_filename) def updateProgressMeters(test_filename, input_unit_factory, - test_case_number): - """ - Update the progress meters for keeping track of test state. - """ + test_case_number): + """Update the progress meters for keeping track of test state.""" log.msg("Setting up progress meters") if not config.state.test_filename: config.state[test_filename] = Storage()

1 0

[ooni-probe/master] Started fixing a bug in oonicli.updateStatusBar() and runner.runTestList()
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit a6bc4d53d3288b85b9d4a2712f94f4a4c3e4862d Author: Isis Lovecruft <isis(a)torproject.org> Date: Thu Dec 13 02:20:01 2012 +0000 Started fixing a bug in oonicli.updateStatusBar() and runner.runTestList() where the status bar hangs at 100%. It needs to be changed to use twisted.internet.task.Cooperator and t.i.t.CooperativeTask, which means that oonicli.updateStatusBar() still needs to be changed to be an iterator. --- ooni/oonicli.py | 54 ++++++++++++++++++++++++++++++++++++++++-------------- ooni/runner.py | 21 +++++++++------------ 2 files changed, 49 insertions(+), 26 deletions(-) diff --git a/ooni/oonicli.py b/ooni/oonicli.py index 9d4f783..0bf4d55 100644 --- a/ooni/oonicli.py +++ b/ooni/oonicli.py @@ -42,13 +42,14 @@ class Options(usage.Options): optFlags = [["help", "h"], ["resume", "r"]] - optParameters = [["reportfile", "o", None, "report file name"], - ["testdeck", "i", None, - "Specify as input a test deck: a yaml file containig the tests to run an their arguments"], - ["collector", "c", None, - "Address of the collector of test results. (example: http://127.0.0.1:8888)"], - ["logfile", "l", None, "log file name"], - ["pcapfile", "p", None, "pcap file name"]] + optParameters = [ + ["reportfile", "o", None, "report file name"], + ["testdeck", "i", None, + "Specify a test deck: a yaml file containing tests and their arguments"], + ["collector", "c", None, + "Address of the collector of test results. (e.g.: http://127.0.0.1:8888)"], + ["logfile", "l", None, "log file name"], + ["pcapfile", "p", None, "pcap file name"]] compData = usage.Completions( extraActions=[usage.CompleteFiles( @@ -81,14 +82,34 @@ class Options(usage.Options): except: raise usage.UsageError("No test filename specified!") -def updateStatusBar(): +class CooperativeTimer(object): + """ + A simple timer for the callback to functions on + :class:`twisted.internet.task.Cooperator <t.i.t.Cooperator>`. see + :meth:`oonicli.runTestList <runTestList>`. + + @param seconds: + An integer specifying the second to wait in between updating the + status and ETA bars. + """ + def __init__(self, seconds=5): + self.max_timer_interval = float(seconds) + self.end = time.time() + self.max_timer_interval + + def __call__(self): + return time.time() >= self.end + +def updateStatusBar(stop_func): for test_filename in config.state.keys(): # The ETA is not updated so we we will not print it out for the # moment. eta = config.state[test_filename].eta() progress = config.state[test_filename].progress() - progress_bar_frmt = "[%s] %s%%" % (test_filename, progress) - print progress_bar_frmt + while progress is not None: + print "[%s] %s%%" % (test_filename, progress) + else: + print "[%s] All tests in file completed." % test_filename + stop_func() def testsEnded(*arg, **kw): """You can place here all the post shutdown tasks.""" @@ -102,7 +123,7 @@ def startSniffing(): from ooni.utils.txscapy import ScapyFactory, ScapySniffer try: checkForRoot() - except NotRootError: + except PermissionsError: print "[!] Includepcap options requires root priviledges to run" print " you should run ooniprobe as root or disable the options in ooniprobe.conf" sys.exit(1) @@ -130,9 +151,14 @@ def runTestList(none, test_list): d2 = defer.DeferredList(deck_dl) d2.addBoth(testsEnded) - # Print every 5 second the list of current tests running - l = task.LoopingCall(updateStatusBar) - l.start(5.0) + try: + # Print every 5 second the list of current tests running + coop = task.Cooperator(started=False) + coop.cooperate(updateStatusBar) #this will need a .next() method + coop.start() + except StopIteration: + return d2 + return d2 def errorRunningTests(failure): diff --git a/ooni/runner.py b/ooni/runner.py index 6f03e56..19dc171 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -328,9 +328,9 @@ def runTestCasesWithInput(test_cases, test_input, yaml_reporter, reason = getattr(test_instance.__class__, 'skip') else: reason = txutil.acquireAttribute(test_instance._parents, 'skip', None) + if reason is not None: log.warn("%s marked some tests to be skipped. Reason: %s" % (test_instance.name, reason)) - if reason is not None: call_skip = reactor.callLater(0, test_skip_class, reason) d.addBoth(lambda x: call_skip.active() and call_skip.cancel() or x) @@ -456,14 +456,14 @@ def increaseInputUnitIdx(test_filename): config.stateDict[test_filename] += 1 yield updateResumeFile(test_filename) -def updateProgressMeters(test_filename, input_unit_factory, - test_case_number): +def updateProgressMeters(test_filename, input_unit_factory, test_case_number): """Update the progress meters for keeping track of test state.""" log.msg("Setting up progress meters") if not config.state.test_filename: config.state[test_filename] = Storage() - config.state[test_filename].per_item_average = 2.0 + per_item_avg = float(2) + config.state[test_filename].per_item_average = per_item_avg input_unit_idx = float(config.stateDict[test_filename]) input_unit_items = float(len(input_unit_factory) + 1) @@ -471,27 +471,24 @@ def updateProgressMeters(test_filename, input_unit_factory, total_iterations = input_unit_items * test_case_number current_iteration = input_unit_idx * test_case_number - log.debug("input_unit_items: %s" % input_unit_items) - log.debug("test_case_number: %s" % test_case_number) - + log.debug("Total InputUnits: %s" % input_unit_items) log.debug("Test case number: %s" % test_case_number) log.debug("Total iterations: %s" % total_iterations) log.debug("Current iteration: %s" % current_iteration) def progress(): - return (current_iteration / total_iterations) * 100.0 - + current_progress = (current_iteration / total_iterations) * 100.0 + while float(current_progress) < float(100): + return current_progress config.state[test_filename].progress = progress def eta(): - return (total_iterations - current_iteration) \ - * config.state[test_filename].per_item_average + return (total_iterations - current_iteration) * per_item_avg config.state[test_filename].eta = eta config.state[test_filename].input_unit_idx = input_unit_idx config.state[test_filename].input_unit_items = input_unit_items - @defer.inlineCallbacks def runTestCases(test_cases, options, cmd_line_options): """

1 0

[ooni-probe/master] Removed an import line from ooni/reporter.py which tried to import classes
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit 017f249efc57650510ca6e3eba2c9aa12c3bc7a5 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 12 15:56:16 2012 +0000 Removed an import line from ooni/reporter.py which tried to import classes which are now contained in ooni/reporter.py. --- ooni/reporter.py | 1 - 1 files changed, 0 insertions(+), 1 deletions(-) diff --git a/ooni/reporter.py b/ooni/reporter.py index fc41960..37cf9d1 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -27,7 +27,6 @@ from twisted.internet.error import ConnectionRefusedError from ooni import config, otime from ooni.utils import log, geodata -from ooni.utils.hacks import OSafeRepresenter, OSafeDumper from ooni.utils.net import BodyReceiver, StringProducer, userAgents try:

1 0

[ooni-probe/master] Moved method NetTestCase._checkRequiredOptions() logic into a function in
by isis＠torproject.org 18 Dec '12

18 Dec '12

commit d476d8c9c25c432170a0542bb4c3b3e43ad081e7 Author: Isis Lovecruft <isis(a)torproject.org> Date: Wed Dec 12 18:29:03 2012 +0000 Moved method NetTestCase._checkRequiredOptions() logic into a function in ooni/runner.py, because it was unnecessary and also more lines of code to put in nettest.py. * Also removed an extraneous call to _checkRequiredOptions. * Moved another exception to the top of ooni/runner.py. --- ooni/nettest.py | 14 +++----------- ooni/runner.py | 29 +++++++++++++++++++---------- 2 files changed, 22 insertions(+), 21 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 8fc29c3..cff5c62 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -180,12 +180,6 @@ class NetTestCase(object): else: pass - def _checkRequiredOptions(self): - for required_option in self.requiredOptions: - log.debug("Checking if %s is present" % required_option) - if not self.localOptions[required_option]: - raise usage.UsageError("%s not specified!" % required_option) - def _processOptions(self): if self.inputFilename: inputProcessor = self.inputProcessor @@ -199,11 +193,9 @@ class NetTestCase(object): return inputProcessor(inputFilename) self.inputs = inputProcessorIterator() - self._checkRequiredOptions() - - return {'inputs': self.inputs, - 'name': self.name, 'version': self.version - } + return {'inputs': self.inputs, + 'name': self.name, + 'version': self.version} def __repr__(self): return "<%s inputs=%s>" % (self.__class__, self.inputs) diff --git a/ooni/runner.py b/ooni/runner.py index 306c1d9..4724d3d 100644 --- a/ooni/runner.py +++ b/ooni/runner.py @@ -47,6 +47,9 @@ class noResumeSession(Exception): class InvalidConfigFile(Exception): message = "Invalid setting in ooniprobe.conf: " +class UnableToStartTor(Exception): + pass + def isTestCase(obj): """Return True if obj is a subclass of NetTestCase, False otherwise.""" @@ -55,6 +58,18 @@ def isTestCase(obj): except TypeError: return False +def checkRequiredOptions(test_instance): + """ + If test_instance has an attribute 'requiredOptions', then check that + those options were utilised on the commandline. + """ + required = getattr(test_instance, 'requiredOptions', None) + if required: + for required_option in required: + log.debug("Checking if %s is present" % required_option) + if not test_instance.localOptions[required_option]: + raise usage.UsageError("%s not specified!" % required_option) + def processTest(obj, cmd_line_options): """ Process the parameters and :class:`twisted.python.usage.Options` of a @@ -91,7 +106,6 @@ def processTest(obj, cmd_line_options): options = obj.usageOptions() options.parseOptions(config.cmd_line_options['subargs']) - obj.localOptions = options if obj.inputFile: # inputFilename is the actual filename @@ -99,12 +113,11 @@ def processTest(obj, cmd_line_options): try: log.debug("Parsing commandline options") - tmp_test_case_object = obj() - tmp_test_case_object._checkRequiredOptions() + tmp_test_instance = obj() + checkRequiredOptions(tmp_test_instance) except usage.UsageError, ue: log.err("%s" % ue) options.opt_help() - raise usage.UsageError("Error parsing command line args for %s" % tmp_test_case_object.name) else: @@ -162,7 +175,6 @@ def loadTestsAndOptions(classes, cmd_line_options): def getTestTimeout(test_instance, test_method): """ - Returns the timeout value set on this test. Check on the instance first, the the class, then the module, then package. As soon as it finds something with a timeout attribute, returns that. Returns the value set in @@ -199,7 +211,7 @@ def getTestTimeout(test_instance, test_method): return float(default_timeout) def runTestCasesWithInput(test_cases, test_input, yaml_reporter, - oonib_reporter=None): + oonib_reporter=None): """ Runs in parallel all the test methods that are inside of the specified test case. Reporting happens every time a Test Method has concluded running. @@ -552,9 +564,6 @@ def runTestCases(test_cases, options, cmd_line_options): except Exception: log.exception("Problem in running test") -class UnableToStartTor(Exception): - pass - def startTor(): @defer.inlineCallbacks def state_complete(state): @@ -617,7 +626,7 @@ def startSniffing(): from ooni.utils.txscapy import ScapyFactory, ScapySniffer try: checkForRoot() - except NotRootError: + except PermissionsError: print "[!] Includepcap options requires root priviledges to run" print " you should run ooniprobe as root or disable the options in ooniprobe.conf" sys.exit(1)

1 0