March 2013 - tor-commits - lists.torproject.org

[ooni-probe/master] Function that will transform an object into a listiterable
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit c5513ba318ed75a78f010ad32702d55d4e0516e6 Author: Arturo Filastò <art(a)fuffa.org> Date: Sat Jan 12 14:53:13 2013 +0100 Function that will transform an object into a listiterable Will return the iterable if it's an iterable --- ooni/managers.py | 15 ++++++++++++--- 1 files changed, 12 insertions(+), 3 deletions(-) diff --git a/ooni/managers.py b/ooni/managers.py index ec47ca7..c4b4d2a 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -1,7 +1,16 @@ import itertools +from twisted.internet import defer -from .ratelimiting import StaticRateLimiter -from .measurements import Measurement, NetTest +def makeIterable(item): + """ + Takes as argument or an iterable and if it's not an iterable object then it + will return a listiterator. + """ + try: + iterable = iter(item) + except TypeError: + iterable = iter([item]) + return iterable class TaskManager(object): retries = 2

1 0

[ooni-probe/master] Properly rename MeasurementsManager
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit cc36ec077351ecb910cae28d47329c5e215838a0 Author: Arturo Filastò <art(a)fuffa.org> Date: Thu Jan 10 17:10:25 2013 +0100 Properly rename MeasurementsManager --- ooni/managers.py | 6 ++++-- 1 files changed, 4 insertions(+), 2 deletions(-) diff --git a/ooni/managers.py b/ooni/managers.py index 2bffe0f..3383840 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -108,9 +108,11 @@ class OManager(object): self.netTests = [] - self.measurements_tracker = MeasurementsTracker(manager=self, + self.measurementsManager = MeasurementsManager(manager=self, netTests=self.netTests) - self.measurements_tracker.manager = self + self.measurementsManager.manager = self + + self.reportingManager def writeReport(self, measurement): """

1 0

[ooni-probe/master] Outline the base class for tasks (#7852)
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit cc4b5f2180c451faf173f23c5213a18413f204a7 Author: Arturo Filastò <art(a)fuffa.org> Date: Thu Jan 10 16:21:50 2013 +0100 Outline the base class for tasks (#7852) Tasks are the jobs that get handled by the managers. --- ooni/tasks.py | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 75 insertions(+), 0 deletions(-) diff --git a/ooni/tasks.py b/ooni/tasks.py new file mode 100644 index 0000000..361dccb --- /dev/null +++ b/ooni/tasks.py @@ -0,0 +1,75 @@ +class BaseTask(object): + _timer = None + + def __init__(self): + self.running = False + self.failures = 0 + + def _failed(self, failure): + self.failures += 1 + self.failed(failure) + return + + def _run(self): + d = self.run() + d.addErrback(self._failed) + d.addCallback(self._succeeded) + return d + + def _succeeded(self, result): + self.succeeded(result) + + def succeeded(self, result): + """ + Place here the logic to handle a successful execution of the task. + """ + pass + + def failed(self, failure): + """ + Place in here logic to handle failure. + """ + pass + + def run(self): + """ + Override this with the logic of your task. + Must return a deferred. + """ + pass + +class TaskTimedOut(Exception): + pass + +class TaskWithTimeout(BaseTask): + timeout = 5 + + def _timedOut(self): + """Internal method for handling timeout failure""" + self.timedOut() + + def _cancelTimer(self): + if self._timer: + self._timer.cancel() + + def _succeeded(self, result): + self._cancelTimer() + BaseTask._succeeded(self, result) + + def _failed(self, failure): + self._cancelTimer() + BaseTask._failed(self, failure) + + def _run(self): + d = BaseTask._run(self) + self._timer = reactor.callLater(self.timeout, self._timedOut) + return d + + def timedOut(self): + """ + Override this with the operations to happen when the task has timed + out. + """ + pass + +

1 0

[ooni-probe/master] Start outlining the unittests for manager (#7852)
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 8913e5fa4b73aaa55561747fa244e1ab5964d6f6 Author: Arturo Filastò <art(a)fuffa.org> Date: Thu Jan 10 16:27:57 2013 +0100 Start outlining the unittests for manager (#7852) This should be split up into further blocks --- tests/test_manager.py | 126 +++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 126 insertions(+), 0 deletions(-) diff --git a/tests/test_manager.py b/tests/test_manager.py new file mode 100644 index 0000000..0ed77b0 --- /dev/null +++ b/tests/test_manager.py @@ -0,0 +1,126 @@ +from StringIO import StringIO +from twisted.trial import unittest + +from ooni.manager import Measurement, Measurements +from ooni.manager import NetTest, OManager +from ooni.manager import BaseTask, TaskWithTimeout + +net_test_file = StringIO() +net_test_file.write(""" +from twisted.python import usage +from ooni.nettest import NetTestCase + +class UsageOptions(usage.Options): + optParameters = [['spam', 's', 'ham']] + +class DummyTestCase(NetTestCase): + usageOptions = UsageOptions + + def test_a(self): + self.report['bar'] = 'bar' + + def test_b(self): + self.report['foo'] = 'foo' +""") + +dummyInputs = range(10) +dummyOptions = {'spam': 'notham'} + +#dummyNetTest = NetTest(net_test_file, inputs, options) + +class DummyMeasurement(BaseTask): + def run(self): + f = open('foo.txt', 'w') + f.write('testing') + f.close() + + return defer.succeed() + +class DummyMeasurementFailOnce(BaseTask): + def run(self): + f = open('dummyTaskFailOnce.txt', 'w') + f.write('fail') + f.close() + if self.failure >= 1: + return defer.succeed() + else: + return defer.fail() + +class DummyNetTest(NetTest): + def generateMeasurements(self): + for i in range(10): + yield DummyTask() + +class DummyManager(object): + def __init__(self): + pass + +class TestNetTest(unittest.TestCase): + def test_load_net_test_from_file(self): + """ + Given a file like object verify that the net test cases are properly + generated. + """ + net_test = NetTest(net_test_file, dummyInputs, dummyOptions) + self.assertEqual([(DummyTestCase, 'test_a'), (DummyTestCase, + 'test_b')], net_test.test_cases) + +class TestMeasurementsTracker(unittest.TestCase): + def setUp(self): + self.mock_mt = MeasurementsTracker(DummyManager()) + self.mock_mt.netTests = [DummyNetTest()] + self.mock_mt.start() + + def test_schedule_measurement(self): + # testing schedule() + # run a single measurement + measurement = DummyMeasurement() + self.mock_mt.schedule(measurement) + + def test_all_slots_full(self): + """ + Test case where active_measurements is full + """ + pass + + def test_populate_active_measurements(self): + """ + Test that populates the full set of active measurements + """ + pass + + def test_fail_and_reschedule(self): + """docstring for test_fail_and_reschedule""" + pass + + def test_fail_timeout_and_reschedule(): + pass + + def test_all_completed(self): + """ + all inputs have been consumed and all tests have a final status. + """ + pass + + def test_measurements_exhausted(): + """ + inputs consumed, but still have running measurements + """ + pass + + + +class TestManager(unittest.TestCase): + def setUp(self): + self.manager = OManager + + def test_successful_measurement(self): + pass + + def test_failing_measurment(self): + pass + + def test_retry_twice_measurement(self): + pass + +

1 0

[ooni-probe/master] Move error handling functionality to the errors module
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 12edd26ab39ebd82b9826ea8105c01ac01bac7b8 Author: Arturo Filastò <art(a)fuffa.org> Date: Sat Jan 12 13:35:39 2013 +0100 Move error handling functionality to the errors module --- ooni/errors.py | 116 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ ooni/nettest.py | 117 +------------------------------------------------------ 2 files changed, 117 insertions(+), 116 deletions(-) diff --git a/ooni/errors.py b/ooni/errors.py new file mode 100644 index 0000000..c7ecfae --- /dev/null +++ b/ooni/errors.py @@ -0,0 +1,116 @@ +from twisted.internet.defer import TimeoutError as DeferTimeoutError +from twisted.web._newclient import ResponseNeverReceived + +from twisted.internet.error import ConnectionRefusedError, TCPTimedOutError +from twisted.internet.error import DNSLookupError +from twisted.internet.error import TimeoutError as GenericTimeoutError + +from txsocksx.errors import SOCKSError +from txsocksx.errors import MethodsNotAcceptedError, AddressNotSupported +from txsocksx.errors import ConnectionError, NetworkUnreachable +from txsocksx.errors import ConnectionLostEarly, ConnectionNotAllowed +from txsocksx.errors import NoAcceptableMethods, ServerFailure +from txsocksx.errors import HostUnreachable, ConnectionRefused +from txsocksx.errors import TTLExpired, CommandNotSupported + +from socket import gaierror + +def handleAllFailures(failure): + """ + Here we make sure to trap all the failures that are supported by the + failureToString function and we return the the string that represents the + failure. + """ + failure.trap(ConnectionRefusedError, gaierror, DNSLookupError, + TCPTimedOutError, ResponseNeverReceived, DeferTimeoutError, + GenericTimeoutError, + SOCKSError, MethodsNotAcceptedError, AddressNotSupported, + ConnectionError, NetworkUnreachable, ConnectionLostEarly, + ConnectionNotAllowed, NoAcceptableMethods, ServerFailure, + HostUnreachable, ConnectionRefused, TTLExpired, CommandNotSupported) + + return failureToString(failure) + +def failureToString(failure): + """ + Given a failure instance return a string representing the kind of error + that occurred. + + Args: + + failure: a :class:twisted.internet.error instance + + Returns: + + A string representing the HTTP response error message. + """ + string = None + if isinstance(failure.value, ConnectionRefusedError): + log.err("Connection refused. The backend may be down") + string = 'connection_refused_error' + + elif isinstance(failure.value, gaierror): + log.err("Address family for hostname not supported") + string = 'address_family_not_supported_error' + + elif isinstance(failure.value, DNSLookupError): + log.err("DNS lookup failure") + string = 'dns_lookup_error' + + elif isinstance(failure.value, TCPTimedOutError): + log.err("TCP Timed Out Error") + string = 'tcp_timed_out_error' + + elif isinstance(failure.value, ResponseNeverReceived): + log.err("Response Never Received") + string = 'response_never_received' + + elif isinstance(failure.value, DeferTimeoutError): + log.err("Deferred Timeout Error") + string = 'deferred_timeout_error' + + elif isinstance(failure.value, GenericTimeoutError): + log.err("Time Out Error") + string = 'generic_timeout_error' + + elif isinstance(failure.value, ServerFailure): + log.err("SOCKS error: ServerFailure") + string = 'socks_server_failure' + + elif isinstance(failure.value, ConnectionNotAllowed): + log.err("SOCKS error: ConnectionNotAllowed") + string = 'socks_connection_not_allowed' + + elif isinstance(failure.value, NetworkUnreachable): + log.err("SOCKS error: NetworkUnreachable") + string = 'socks_network_unreachable' + + elif isinstance(failure.value, HostUnreachable): + log.err("SOCKS error: HostUnreachable") + string = 'socks_host_unreachable' + + elif isinstance(failure.value, ConnectionRefused): + log.err("SOCKS error: ConnectionRefused") + string = 'socks_connection_refused' + + elif isinstance(failure.value, TTLExpired): + log.err("SOCKS error: TTLExpired") + string = 'socks_ttl_expired' + + elif isinstance(failure.value, CommandNotSupported): + log.err("SOCKS error: CommandNotSupported") + string = 'socks_command_not_supported' + + elif isinstance(failure.value, AddressNotSupported): + log.err("SOCKS error: AddressNotSupported") + string = 'socks_address_not_supported' + elif isinstance(failure.value, SOCKSError): + log.err("Generic SOCKS error") + string = 'socks_error' + + else: + log.err("Unknown failure type: %s" % type(failure)) + string = 'unknown_failure %s' % str(failure.value) + + return string + diff --git a/ooni/nettest.py b/ooni/nettest.py index 06ed4cb..538fcf9 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -7,124 +7,9 @@ from twisted.trial import unittest, itrial, util from twisted.internet import defer, utils from twisted.python import usage -from twisted.internet.error import ConnectionRefusedError, TCPTimedOutError -from twisted.internet.error import DNSLookupError -from twisted.internet.error import TimeoutError as GenericTimeoutError - -from twisted.internet.defer import TimeoutError as DeferTimeoutError -from twisted.web._newclient import ResponseNeverReceived - +from ooni.errors import handleAllFailures, failureToString from ooni.utils import log -from txsocksx.errors import SOCKSError -from txsocksx.errors import MethodsNotAcceptedError, AddressNotSupported -from txsocksx.errors import ConnectionError, NetworkUnreachable -from txsocksx.errors import ConnectionLostEarly, ConnectionNotAllowed -from txsocksx.errors import NoAcceptableMethods, ServerFailure -from txsocksx.errors import HostUnreachable, ConnectionRefused -from txsocksx.errors import TTLExpired, CommandNotSupported - - -from socket import gaierror - -def handleAllFailures(failure): - """ - Here we make sure to trap all the failures that are supported by the - failureToString function and we return the the string that represents the - failure. - """ - failure.trap(ConnectionRefusedError, gaierror, DNSLookupError, - TCPTimedOutError, ResponseNeverReceived, DeferTimeoutError, - GenericTimeoutError, - SOCKSError, MethodsNotAcceptedError, AddressNotSupported, - ConnectionError, NetworkUnreachable, ConnectionLostEarly, - ConnectionNotAllowed, NoAcceptableMethods, ServerFailure, - HostUnreachable, ConnectionRefused, TTLExpired, CommandNotSupported) - - return failureToString(failure) - -def failureToString(failure): - """ - Given a failure instance return a string representing the kind of error - that occurred. - - Args: - - failure: a :class:twisted.internet.error instance - - Returns: - - A string representing the HTTP response error message. - """ - string = None - if isinstance(failure.value, ConnectionRefusedError): - log.err("Connection refused. The backend may be down") - string = 'connection_refused_error' - - elif isinstance(failure.value, gaierror): - log.err("Address family for hostname not supported") - string = 'address_family_not_supported_error' - - elif isinstance(failure.value, DNSLookupError): - log.err("DNS lookup failure") - string = 'dns_lookup_error' - - elif isinstance(failure.value, TCPTimedOutError): - log.err("TCP Timed Out Error") - string = 'tcp_timed_out_error' - - elif isinstance(failure.value, ResponseNeverReceived): - log.err("Response Never Received") - string = 'response_never_received' - - elif isinstance(failure.value, DeferTimeoutError): - log.err("Deferred Timeout Error") - string = 'deferred_timeout_error' - - elif isinstance(failure.value, GenericTimeoutError): - log.err("Time Out Error") - string = 'generic_timeout_error' - - elif isinstance(failure.value, ServerFailure): - log.err("SOCKS error: ServerFailure") - string = 'socks_server_failure' - - elif isinstance(failure.value, ConnectionNotAllowed): - log.err("SOCKS error: ConnectionNotAllowed") - string = 'socks_connection_not_allowed' - - elif isinstance(failure.value, NetworkUnreachable): - log.err("SOCKS error: NetworkUnreachable") - string = 'socks_network_unreachable' - - elif isinstance(failure.value, HostUnreachable): - log.err("SOCKS error: HostUnreachable") - string = 'socks_host_unreachable' - - elif isinstance(failure.value, ConnectionRefused): - log.err("SOCKS error: ConnectionRefused") - string = 'socks_connection_refused' - - elif isinstance(failure.value, TTLExpired): - log.err("SOCKS error: TTLExpired") - string = 'socks_ttl_expired' - - elif isinstance(failure.value, CommandNotSupported): - log.err("SOCKS error: CommandNotSupported") - string = 'socks_command_not_supported' - - elif isinstance(failure.value, AddressNotSupported): - log.err("SOCKS error: AddressNotSupported") - string = 'socks_address_not_supported' - elif isinstance(failure.value, SOCKSError): - log.err("Generic SOCKS error") - string = 'socks_error' - - else: - log.err("Unknown failure type: %s" % type(failure)) - string = 'unknown_failure %s' % str(failure.value) - - return string class NoPostProcessor(Exception): pass

1 0

[ooni-probe/master] Work on TaskManager and write tests for it
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit f621794d11c3dda37edbccf82a56db1025e348c7 Author: Arturo Filastò <art(a)fuffa.org> Date: Sat Jan 12 14:58:11 2013 +0100 Work on TaskManager and write tests for it Changes to the API of the MeasurementManager and ReportManager --- ooni/managers.py | 47 +++++++++++++++++++++++------------------------ tests/test_manager.py | 5 +++++ 2 files changed, 28 insertions(+), 24 deletions(-) diff --git a/ooni/managers.py b/ooni/managers.py index f6d4c74..26ac3f9 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -18,9 +18,14 @@ class TaskManager(object): failures = [] concurrency = 10 - _tasks = iter() + _tasks = iter(()) _active_tasks = [] + def _tasksDone(self): + self.tasksDone.callback(None) + + self.tasksDone = defer.Deferred() + def _failed(self, failure, task): """ The has failed to complete, we append it to the end of the task chain @@ -31,9 +36,9 @@ class TaskManager(object): if task.failures < self.retries: self._tasks = itertools.chain(self._tasks, - iter(task)) + makeIterable(task)) - self.fillSlots() + self._fillSlots() self.failed(failure, task) @@ -42,11 +47,12 @@ class TaskManager(object): Called on test completion and schedules measurements to be run for the available slots. """ - for _ in range(self.availableSlots()): + for _ in range(self.availableSlots): try: task = self._tasks.next() self._run(task) except StopIteration: + self._tasksDone() break def _suceeded(self, result, task): @@ -56,7 +62,7 @@ class TaskManager(object): self._active_tasks.remove(task) self.completedTasks += 1 - self.fillSlots() + self._fillSlots() self.suceeded(result, task) @@ -68,13 +74,14 @@ class TaskManager(object): self._active_tasks.append(task) d = task.run() - d.addCallback(self.succeeded) - d.addCallback(self.failed) + d.addCallback(self.succeeded, task) + d.addErrback(self.failed, task) @property def failedMeasurements(self): return len(self.failures) + @property def availableSlots(self): """ Returns the number of available slots for running tests. @@ -86,19 +93,15 @@ class TaskManager(object): Takes as argument a single task or a task iterable and appends it to the task generator queue. """ - self._tasks = itertools.chain(self._tasks, task_or_task_iterator) - def start(self): - self.initializeTaskList() + iterable = makeIterable(task_or_task_iterator) + + self._tasks = itertools.chain(self._tasks, iterable) self._fillSlots() - def initializeTaskList(self): - """ - This should contain all the logic that gets run at first start to - pre-populate the list of tasks to be run and the tasks currently - running. - """ - raise NotImplemented + def start(self): + self.tasksDone = defer.Deferred() + self._fillSlots() def failed(self, failure, task): """ @@ -132,13 +135,6 @@ class MeasurementsManager(TaskManager): director = None - def __init__(self, netTests=None): - self.netTests = netTests if netTests else [] - - def initializeTaskList(self): - for net_test in self.netTests: - self.schedule(net_test.generateMeasurements()) - def suceeded(self, result, measurement): pass @@ -146,6 +142,8 @@ class MeasurementsManager(TaskManager): pass class Report(object): + reportEntryManager = None + def __init__(self, reporters, net_test): """ This will instantiate all the reporters and add them to the list of @@ -178,6 +176,7 @@ class Report(object): @reporter.created.addCallback def cb(result): report_write_task = ReportWrite(reporter, measurement) + self.reportEntryManager.schedule(report_write_task) class ReportEntryManager(object): diff --git a/tests/test_manager.py b/tests/test_manager.py index 0ed77b0..f5ac052 100644 --- a/tests/test_manager.py +++ b/tests/test_manager.py @@ -65,6 +65,11 @@ class TestNetTest(unittest.TestCase): self.assertEqual([(DummyTestCase, 'test_a'), (DummyTestCase, 'test_b')], net_test.test_cases) + def test_net_test_timeout(self): + """Instantiate a test and verify that the timeout works properly when we call it.""" + net_test = NetTest(net_test_file, dummyInputs, dummyOptions) + # Where net_test_file is a test that will take longer than + class TestMeasurementsTracker(unittest.TestCase): def setUp(self): self.mock_mt = MeasurementsTracker(DummyManager())

1 0

[ooni-probe/master] Re-organize module structure
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 83b169fbae5174255d17939464b29782f81d6de8 Author: Arturo Filastò <art(a)fuffa.org> Date: Sat Jan 12 14:56:48 2013 +0100 Re-organize module structure --- ooni/director.py | 87 ++++++++++++++++++++++++++++++++++++++++++++++++++ ooni/managers.py | 77 -------------------------------------------- ooni/measurements.py | 77 -------------------------------------------- ooni/nettest.py | 61 +++++++++++++++++++++++++++++++++++ 4 files changed, 148 insertions(+), 154 deletions(-) diff --git a/ooni/director.py b/ooni/director.py new file mode 100644 index 0000000..cf23269 --- /dev/null +++ b/ooni/director.py @@ -0,0 +1,87 @@ +from ooni.managers import ReportingEntryManager, MeasurementsManager +from ooni.nettest import NetTest + +class Director(object): + """ + Singleton object responsible for coordinating the Measurements Manager and the + Reporting Manager. + + How this all looks like is as follows: + + +------------------------------------------------+ + | Director |<--+ + +------------------------------------------------+ | + ^ ^ | + | Measurement | | + +---------+ [---------] +--------------------+ | + | | | MeasurementManager | | + | NetTest | [---------] +--------------------+ | + | | | [----------------] | | + +---------+ [---------] | [----------------] | | + | | [----------------] | | + | +--------------------+ | + v | + +---------+ ReportEntry | + | | [---------] +--------------------+ | + | Report | | ReportEntryManager | | + | | [---------] +--------------------+ | + +---------+ | [----------------] | | + [---------] | [----------------] |-- + | [----------------] | + +--------------------+ + + [------------] are Tasks + + +------+ + | | are TaskManagers + +------+ + | | + +------+ + + +------+ + | | are general purpose objects + +------+ + + """ + _scheduledTests = 0 + + def __init__(self): + self.reporters = reporters + + self.netTests = [] + + self.measurementsManager = MeasurementsManager(manager=self, + netTests=self.netTests) + self.measurementsManager.director = self + + self.reportEntryManager = ReportingEntryManager() + self.reportEntryManager.director = self + + def startTest(self, net_test_file, inputs, options): + """ + Create the Report for the NetTest and start the report NetTest. + """ + report = Report() + report.reportEntryManager = self.reportEntryManager + + net_test = NetTest(net_test_file, inputs, options, report) + net_test.director = self + + self.measurementsManager.schedule(net_test.generateMeasurements()) + + def measurementTimedOut(self, measurement): + """ + This gets called every time a measurement times out independenty from + the fact that it gets re-scheduled or not. + """ + pass + + def measurementFailed(self, failure, measurement): + pass + + def writeFailure(self, measurement, failure): + pass + + def writeReport(self, report_write_task): + self.reportingManager.write(report_write_task) + diff --git a/ooni/managers.py b/ooni/managers.py index c4b4d2a..f6d4c74 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -199,80 +199,3 @@ class ReportEntryManager(object): def failed(self, failure, measurement): pass -class Director(object): - """ - Singleton object responsible for coordinating the Measurements Manager and the - Reporting Manager. - - How this all looks like is as follows: - - +------------------------------------------------+ - | Director |<--+ - +------------------------------------------------+ | - ^ ^ | - | Measurement | | - +---------+ [---------] +--------------------+ | - | | | MeasurementManager | | - | NetTest | [---------] +--------------------+ | - | | | [----------------] | | - +---------+ [---------] | [----------------] | | - | | [----------------] | | - | +--------------------+ | - v | - +---------+ ReportEntry | - | | [---------] +--------------------+ | - | Report | | ReportEntryManager | | - | | [---------] +--------------------+ | - +---------+ | [----------------] | | - [---------] | [----------------] |-- - | [----------------] | - +--------------------+ - - [------------] are Tasks - - +------+ - | | are TaskManagers - +------+ - | | - +------+ - - +------+ - | | are general purpose objects - +------+ - - """ - _scheduledTests = 0 - - def __init__(self): - self.reporters = reporters - - self.netTests = [] - - self.measurementsManager = MeasurementsManager(manager=self, - netTests=self.netTests) - self.measurementsManager.director = self - - self.reportingManager = ReportingEntryManager() - self.reportingManager.director = self - - def startTest(self, net_test_file, inputs, options): - """ - Create the Report for the NetTest and start the report NetTest. - """ - report = Report() - net_test = NetTest(net_test_file, inputs, options, report) - net_test.director = self - - def measurementTimedOut(self, measurement): - """ - This gets called every time a measurement times out independenty from - the fact that it gets re-scheduled or not. - """ - pass - - def measurementFailed(self, measurement, failure): - pass - - def writeFailure(self, measurement, failure): - pass - diff --git a/ooni/measurements.py b/ooni/measurements.py deleted file mode 100644 index 0ef8ef6..0000000 --- a/ooni/measurements.py +++ /dev/null @@ -1,77 +0,0 @@ -from .tasks import TaskWithTimeout - -class NetTest(object): - director = None - - def __init__(self, net_test_file, inputs, options, report): - """ - net_test_file: - is a file object containing the test to be run. - - inputs: - is a generator containing the inputs to the net test. - - options: - is a dict containing the opitions to be passed to the net test. - """ - self.test_cases = self.loadNetTestFile(net_test_file) - self.inputs = inputs - self.options = options - - def loadNetTestFile(self, net_test_file): - """ - Creates all the necessary test_cases (a list of tuples containing the - NetTestCase (test_class, test_method)) - - example: - [(test_classA, test_method1), - (test_classA, test_method2), - (test_classA, test_method3), - (test_classA, test_method4), - (test_classA, test_method5), - - (test_classB, test_method1), - (test_classB, test_method2)] - - Note: the inputs must be valid for test_classA and test_classB. - - net_test_file: - is a file like object that will be used to generate the test_cases. - """ - # XXX Not implemented - raise NotImplemented - - def timedOut(self, measurement): - """ - This gets called when a measurement has timed out. This may or may not - trigger a retry inside of MeasurementsTracker. - """ - self.director.measurementTimedOut(measurement) - - def failed(self, measurement, failure): - """ - This gets called when a measurement has failed in the sense that all - the retries have failed at successfully running the test. - This means that it's a definitive failure and we will no longer make - any attempts at re-running the measurement. - """ - self.director.measurementFailed(measurement, failure) - - def succeeded(self, measurement): - """ - This gets called when a measurement has failed. - """ - self.report.write(measurement) - - def generateMeasurements(self): - """ - This is a generator that yields measurements and sets their timeout - value and their netTest attribute. - """ - for test_input in self.inputs: - for test_class, test_method in self.test_cases: - measurement = Measurement(test_class, test_method, test_input) - measurement.netTest = self - measurement.timeout = self.rateLimiter.timeout - yield measurement - diff --git a/ooni/nettest.py b/ooni/nettest.py index 538fcf9..2b1c550 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -10,6 +10,67 @@ from twisted.python import usage from ooni.errors import handleAllFailures, failureToString from ooni.utils import log +class NetTest(object): + director = None + + def __init__(self, net_test_file, inputs, options, report): + """ + The NetTest object is responsible for keeping a reference to the + Report and the loading of NetTestCases from test files. + + net_test_file: + is a file object containing the test to be run. + + inputs: + is a generator containing the inputs to the net test. + + options: + is a dict containing the opitions to be passed to the net test. + """ + self.test_cases = self.loadNetTestFile(net_test_file) + self.inputs = inputs + self.options = options + + def loadNetTestFile(self, net_test_file): + """ + Creates all the necessary test_cases (a list of tuples containing the + NetTestCase (test_class, test_method)) + + example: + [(test_classA, test_method1), + (test_classA, test_method2), + (test_classA, test_method3), + (test_classA, test_method4), + (test_classA, test_method5), + + (test_classB, test_method1), + (test_classB, test_method2)] + + Note: the inputs must be valid for test_classA and test_classB. + + net_test_file: + is a file like object that will be used to generate the test_cases. + """ + # XXX Not implemented + raise NotImplemented + + def succeeded(self, measurement): + """ + This gets called when a measurement has failed. + """ + self.report.write(measurement) + + def generateMeasurements(self): + """ + This is a generator that yields measurements and sets their timeout + value and their netTest attribute. + """ + for test_input in self.inputs: + for test_class, test_method in self.test_cases: + measurement = Measurement(test_class, test_method, test_input) + measurement.netTest = self + measurement.timeout = self.rateLimiter.timeout + yield measurement class NoPostProcessor(Exception): pass

1 0

[ooni-probe/master] Write some unittests for NetTest class
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit ac129c6be76d35f6fa4c1ef6ac3d361dd69e1459 Author: aagbsn <aagbsn(a)torproject.org> Date: Sat Jan 12 18:23:50 2013 +0100 Write some unittests for NetTest class --- tests/test_manager.py | 102 +++++++++++++++++++++++++++++++++---------------- 1 files changed, 69 insertions(+), 33 deletions(-) diff --git a/tests/test_manager.py b/tests/test_manager.py index f5ac052..323aa1f 100644 --- a/tests/test_manager.py +++ b/tests/test_manager.py @@ -1,12 +1,13 @@ +from ooni.measurements import Measurement, NetTest +from ooni.managers import Director, MeasurementsManager +from ooni.tasks import BaseTask, TaskWithTimeout +from os import unlink from StringIO import StringIO +from tempfile import TemporaryFile, mkstemp from twisted.trial import unittest +from twisted.internet import defer, reactor -from ooni.manager import Measurement, Measurements -from ooni.manager import NetTest, OManager -from ooni.manager import BaseTask, TaskWithTimeout - -net_test_file = StringIO() -net_test_file.write(""" +net_test_string = """ from twisted.python import usage from ooni.nettest import NetTestCase @@ -21,9 +22,9 @@ class DummyTestCase(NetTestCase): def test_b(self): self.report['foo'] = 'foo' -""") +""" -dummyInputs = range(10) +dummyInputs = range(1) dummyOptions = {'spam': 'notham'} #dummyNetTest = NetTest(net_test_file, inputs, options) @@ -34,7 +35,7 @@ class DummyMeasurement(BaseTask): f.write('testing') f.close() - return defer.succeed() + return defer.succeed(self) class DummyMeasurementFailOnce(BaseTask): def run(self): @@ -47,13 +48,22 @@ class DummyMeasurementFailOnce(BaseTask): return defer.fail() class DummyNetTest(NetTest): + def __init__(self, num_measurements=1): + NetTest.__init__(self, StringIO(net_test_string), dummyInputs, dummyOptions) + self.num_measurements = num_measurements def generateMeasurements(self): - for i in range(10): - yield DummyTask() + for i in range(self.num_measurements): + yield DummyMeasurement() + +class DummyDirector(object): + def __init__(self): + pass -class DummyManager(object): +class DummyReporter(object): def __init__(self): pass + def write(self, result): + pass class TestNetTest(unittest.TestCase): def test_load_net_test_from_file(self): @@ -61,32 +71,62 @@ class TestNetTest(unittest.TestCase): Given a file like object verify that the net test cases are properly generated. """ - net_test = NetTest(net_test_file, dummyInputs, dummyOptions) - self.assertEqual([(DummyTestCase, 'test_a'), (DummyTestCase, - 'test_b')], net_test.test_cases) + __, net_test_file = mkstemp() + with open(net_test_file, 'w') as f: + f.write(net_test_string) + f.close() + + net_test_from_string = NetTest(StringIO(net_test_string), + dummyInputs, dummyOptions, DummyReporter()) + net_test_from_file = NetTest(net_test_file, dummyInputs, + dummyOptions, DummyReporter()) + + # XXX: the returned classes are not the same because the + # module path is not correct, so the test below fails. + # TODO: figure out how to verify that the instantiated + # classes are done so properly. - def test_net_test_timeout(self): - """Instantiate a test and verify that the timeout works properly when we call it.""" - net_test = NetTest(net_test_file, dummyInputs, dummyOptions) - # Where net_test_file is a test that will take longer than + #self.assertEqual(net_test_from_string.test_cases, + # net_test_from_file.test_cases) + unlink(net_test_file) -class TestMeasurementsTracker(unittest.TestCase): +class TestMeasurementsManager(unittest.TestCase): def setUp(self): - self.mock_mt = MeasurementsTracker(DummyManager()) - self.mock_mt.netTests = [DummyNetTest()] - self.mock_mt.start() + self.mock_mm = MeasurementsManager() + self.mock_mm.director = DummyDirector() def test_schedule_measurement(self): # testing schedule() # run a single measurement measurement = DummyMeasurement() - self.mock_mt.schedule(measurement) + self.mock_mm.concurrency = 1 + self.mock_mm.start() + self.mock_mm.schedule(measurement) + d = self.mock_mm.run(measurement) + def f(x): + self.assertEqual(self.mock_mm.completedMeasurements, 1) + d.addCallback(f) + return d def test_all_slots_full(self): """ Test case where active_measurements is full """ - pass + self.mock_mm.concurrency = 1 + self.mock_mm.start() + + dl = [] + for x in xrange(2): + measurement = DummyMeasurement() + dl.append(self.mock_mm.schedule(measurement)) + + def f(z): print self.mock_mm.completedMeasurements + + assert dl is not None + d = defer.DeferredList(dl) + assert d is not None + d.addCallback(f) + return d def test_populate_active_measurements(self): """ @@ -98,7 +138,7 @@ class TestMeasurementsTracker(unittest.TestCase): """docstring for test_fail_and_reschedule""" pass - def test_fail_timeout_and_reschedule(): + def test_fail_timeout_and_reschedule(self): pass def test_all_completed(self): @@ -107,17 +147,15 @@ class TestMeasurementsTracker(unittest.TestCase): """ pass - def test_measurements_exhausted(): + def test_measurements_exhausted(self): """ inputs consumed, but still have running measurements """ pass - - -class TestManager(unittest.TestCase): +class TestDirector(unittest.TestCase): def setUp(self): - self.manager = OManager + self.director = Director() def test_successful_measurement(self): pass @@ -127,5 +165,3 @@ class TestManager(unittest.TestCase): def test_retry_twice_measurement(self): pass - -

1 0

[ooni-probe/master] Add loadNetTest to NetTest
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit c3fcff4e4a68ad98507e2abb18b64790e7239c70 Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 12 12:05:32 2013 +0000 Add loadNetTest to NetTest loadNetTest populates the test_cases from a file on disk or a file-like object like StringIO (cherry picked from commit c1cabc5a0e510cf38a59a5591630c61cb0983978) Conflicts: ooni/measurements.py --- ooni/measurements.py | 161 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 161 insertions(+), 0 deletions(-) diff --git a/ooni/measurements.py b/ooni/measurements.py new file mode 100644 index 0000000..86d6f84 --- /dev/null +++ b/ooni/measurements.py @@ -0,0 +1,161 @@ +from .tasks import TaskWithTimeout +from inspect import getmembers +from ooni.nettest import NetTestCase +from ooni.ratelimiting import StaticRateLimiter +from twisted.python.reflect import prefixedMethodNames +from twisted.trial.runner import filenameToModule +from StringIO import StringIO +from os.path import isfile + +class Measurement(TaskWithTimeout): + def __init__(self, test_class, test_method, test_input, net_test): + """ + test_class: + is the class, subclass of NetTestCase, of the test to be run + + test_method: + is a string representing the test method to be called to perform + this measurement + + test_input: + is the input to the test + """ + self.test_instance = test_class() + self.test_instance.input = test_input + self.test_instance.report = {} + self.test_instance._start_time = time.time() + self.test_instance._setUp() + self.test_instance.setUp() + self.test = getattr(self.test_instance, test_method) + + def succeeded(self): + self.net_test.measurementSuccess() + + def failed(self): + self.net_test.measurementFailed() + + def timedOut(self): + self.net_test.measurementTimeOut() + + def run(self): + d = defer.maybeDeferred(self.test) + d.addCallback(self.succeeded) + d.addErrback(self.failed) + return d + +class NetTest(object): + director = None + method_prefix = 'test' + + def __init__(self, net_test_file, inputs, options, report): + """ + net_test_file: + is a file object containing the test to be run. + + inputs: + is a generator containing the inputs to the net test. + + options: + is a dict containing the options to be passed to the net test. + """ + self.test_cases = self.loadNetTest(net_test_file) + self.inputs = inputs + self.options = options + + def loadNetTest(self, net_test_object): + """ + Creates all the necessary test_cases (a list of tuples containing the + NetTestCase (test_class, test_method)) + + example: + [(test_classA, test_method1), + (test_classA, test_method2), + (test_classA, test_method3), + (test_classA, test_method4), + (test_classA, test_method5), + + (test_classB, test_method1), + (test_classB, test_method2)] + + Note: the inputs must be valid for test_classA and test_classB. + + net_test_object: + is a file like object that will be used to generate the test_cases. + """ + try: + if isfile(net_test_object): + return self._loadNetTestFile(net_test_object) + except TypeError: + if isinstance(net_test_object, StringIO) or \ + isinstance(net_test_object, str): + return self._loadNetTestString(net_test_object) + + def _loadNetTestString(self, net_test_string): + """ + Load NetTest from a string + """ + ns = {} + test_cases = [] + exec net_test_string.read() in ns + for item in ns.itervalues(): + test_cases.extend(self._get_test_methods(item)) + return test_cases + + def _loadNetTestFile(self, net_test_file): + """ + Load NetTest from a file + """ + test_cases = [] + module = filenameToModule(net_test_file) + for __, item in getmembers(module): + test_cases.extend(self._get_test_methods(item)) + return test_cases + + def _get_test_methods(self, item): + """ + Look for test_ methods in subclasses of NetTestCase + """ + test_cases = [] + try: + assert issubclass(item, NetTestCase) + methods = prefixedMethodNames(item, self.method_prefix) + for method in methods: + test_cases.append((item, self.method_prefix + method)) + except (TypeError, AssertionError): + pass + return test_cases + + def timedOut(self, measurement): + """ + This gets called when a measurement has timed out. This may or may not + trigger a retry inside of MeasurementsTracker. + """ + self.director.measurementTimedOut(measurement) + + def failed(self, measurement, failure): + """ + This gets called when a measurement has failed in the sense that all + the retries have failed at successfully running the test. + This means that it's a definitive failure and we will no longer make + any attempts at re-running the measurement. + """ + self.director.measurementFailed(measurement, failure) + + def succeeded(self, measurement): + """ + This gets called when a measurement has failed. + """ + self.report.write(measurement) + + def generateMeasurements(self): + """ + This is a generator that yields measurements and sets their timeout + value and their netTest attribute. + """ + for test_input in self.inputs: + for test_class, test_method in self.test_cases: + measurement = Measurement(test_class, test_method, test_input) + measurement.netTest = self + measurement.timeout = self.rateLimiter.timeout + yield measurement +

1 0

[ooni-probe/master] Fix import inside of nettest
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 649aa4710ee6b180310f4636f41b2561ed6df47e Author: Arturo Filastò <art(a)fuffa.org> Date: Sat Jan 12 18:47:09 2013 +0100 Fix import inside of nettest --- ooni/nettest.py | 24 +++++++----------------- 1 files changed, 7 insertions(+), 17 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 054da9e..ecf7765 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -1,24 +1,13 @@ -import itertools -import traceback -import sys import os -from twisted.trial import unittest, itrial, util -from twisted.internet import defer, utils -from twisted.python import usage +from twisted.trial.runner import filenameToModule +from twisted.python import usage, reflect -from ooni.errors import handleAllFailures, failureToString +from ooni.tasks import Measurement from ooni.utils import log -from .tasks import TaskWithTimeout from inspect import getmembers -from ooni.nettest import NetTestCase -from ooni.ratelimiting import StaticRateLimiter -from twisted.python.reflect import prefixedMethodNames -from twisted.trial.runner import filenameToModule from StringIO import StringIO -from os.path import isfile - class NetTest(object): director = None @@ -39,6 +28,8 @@ class NetTest(object): self.inputs = inputs self.options = options + self.report = report + def loadNetTest(self, net_test_object): """ Creates all the necessary test_cases (a list of tuples containing the @@ -60,7 +51,7 @@ class NetTest(object): is a file like object that will be used to generate the test_cases. """ try: - if isfile(net_test_object): + if os.path.isfile(net_test_object): return self._loadNetTestFile(net_test_object) except TypeError: if isinstance(net_test_object, StringIO) or \ @@ -95,7 +86,7 @@ class NetTest(object): test_cases = [] try: assert issubclass(item, NetTestCase) - methods = prefixedMethodNames(item, self.method_prefix) + methods = reflect.prefixedMethodNames(item, self.method_prefix) for method in methods: test_cases.append((item, self.method_prefix + method)) except (TypeError, AssertionError): @@ -117,7 +108,6 @@ class NetTest(object): for test_class, test_method in self.test_cases: measurement = Measurement(test_class, test_method, test_input) measurement.netTest = self - measurement.timeout = self.rateLimiter.timeout yield measurement class NoPostProcessor(Exception):

1 0