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

[ooni-probe/master] Work on the Director
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 8ca9928040168b71dbf41ed092c30def4a129e48 Author: Arturo Filastò <art(a)fuffa.org> Date: Sun Jan 13 14:00:00 2013 +0100 Work on the Director Provide glue between Director, Tasks and Managers Director will keep track of the failure rate of measurements --- ooni/director.py | 89 +++++++++++++++++++++++++++++++++++++++++++----------- ooni/managers.py | 29 ++++++++++-------- ooni/reporter.py | 36 ++++++++++++++++++++++ ooni/tasks.py | 7 ++++ 4 files changed, 130 insertions(+), 31 deletions(-) diff --git a/ooni/director.py b/ooni/director.py index 0707664..beb9c3a 100644 --- a/ooni/director.py +++ b/ooni/director.py @@ -1,4 +1,6 @@ -from ooni.managers import ReportingEntryManager, MeasurementManager +from ooni.managers import ReportEntryManager, MeasurementManager +from ooni.reporter import Report + from ooni.nettest import NetTest class Director(object): @@ -45,29 +47,51 @@ class Director(object): """ _scheduledTests = 0 - def __init__(self): + def __init__(self, reporters): self.reporters = reporters self.netTests = [] - self.measurementManager = MeasurementManager(manager=self, - netTests=self.netTests) + self.measurementManager = MeasurementManager() self.measurementManager.director = self - self.reportEntryManager = ReportingEntryManager() + self.reportEntryManager = ReportEntryManager() self.reportEntryManager.director = self - def startTest(self, net_test_file, inputs, options): - """ - Create the Report for the NetTest and start the report NetTest. + self.successfulMeasurements = 0 + self.failedMeasurements = 0 + + self.totalMeasurements = 0 + + # The cumulative runtime of all the measurements + self.totalMeasurementRuntime = 0 + + self.failures = [] + + @property + def measurementSuccessRatio(self): + return self.successfulMeasurements / self.totalMeasurements + + @property + def measurementFailureRatio(self): + return self.failedMeasurements / self.totalMeasurements + + @property + def measurementSuccessRate(self): """ - report = Report() - report.reportEntryManager = self.reportEntryManager + The speed at which tests are succeeding globally. - net_test = NetTest(net_test_file, inputs, options, report) - net_test.director = self + This means that fast tests that perform a lot of measurements will + impact this value quite heavily. + """ + return self.successfulMeasurements / self.totalMeasurementRuntime - self.measurementManager.schedule(net_test.generateMeasurements()) + @property + def measurementFailureRate(self): + """ + The speed at which tests are failing globally. + """ + return self.failedMeasurements / self.totalMeasurementRuntime def measurementTimedOut(self, measurement): """ @@ -76,12 +100,41 @@ class Director(object): """ pass + def measurementStarted(self, measurement): + self.totalMeasurements += 1 + + def measurementSucceeded(self, measurement): + self.totalMeasurementRuntime += measurement.runtime + + self.successfulMeasurements += 1 + def measurementFailed(self, failure, measurement): - pass + self.totalMeasurementRuntime += measurement.runtime - def writeFailure(self, measurement, failure): - pass + self.failedMeasurements += 1 + self.failures.append((failure, measurement)) + + def startTest(self, net_test_file, options): + """ + Create the Report for the NetTest and start the report NetTest. + + Args: + net_test_file: + is either a file path or a file like object that will be used to + generate the test_cases. + + options: + is a dict containing the options to be passed to the chosen net + test. + """ + report = Report(self.reporters) + report.reportEntryManager = self.reportEntryManager + + net_test = NetTest(net_test_file, options, report) + net_test.measurmentManager = self.measurementManager - def writeReport(self, report_write_task): - self.reportingManager.write(report_write_task) + try: + net_test.start() + except Exception, e: + pass diff --git a/ooni/managers.py b/ooni/managers.py index cee6086..dd748ae 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -99,15 +99,22 @@ class TaskManager(object): self._fillSlots() def start(self): + """ + This is called to start the task manager. + """ self.failures = [] - self.tasksDone = defer.Deferred() self._fillSlots() + def started(self, task): + """ + This hook will get called every time a task has been started. + """ + pass + def failed(self, failure, task): """ - This method should be overriden by the subclass and should contains - logic for dealing with a failure that is subclass specific. + This hoook is called every time a task has failed. The default failure handling logic is to reschedule the task up until we reach the maximum number of retries. @@ -115,6 +122,9 @@ class TaskManager(object): raise NotImplemented def succeeded(self, result, task): + """ + This hook is called every time a task has been successfully executed. + """ raise NotImplemented class MeasurementManager(TaskManager): @@ -136,6 +146,9 @@ class MeasurementManager(TaskManager): director = None + def started(self, measurement): + self.director.measurementStarted(measurement) + def succeeded(self, result, measurement): self.director.measurementSucceeded(measurement) @@ -183,16 +196,6 @@ class ReportEntryManager(object): director = None - def __init__(self, manager, netTests=None): - self.netTests = netTests if netTests else [] - self.manager = manager - - def addNetTest(self, netTest): - self.netTests.append(netTest) - - def initializeTaskList(self): - pass - def succeeded(self, result, measurement): pass diff --git a/ooni/reporter.py b/ooni/reporter.py index 728c3f5..637131c 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -373,3 +373,39 @@ class OONIBReporter(OReporter): self.backend_version = parsed_response['backend_version'] log.debug("Created report with id %s" % parsed_response['report_id']) +class Report(object): + reportEntryManager = None + + def __init__(self, reporters): + """ + This will instantiate all the reporters and add them to the list of + available reporters. + + net_test: + is a reference to the net_test to which the report object belongs to. + """ + self.reporters = [] + for r in reporters: + reporter = r() + self.reporters.append(reporter) + + self.createReports() + + def createReports(self): + """ + This will create all the reports that need to be created. + """ + for reporter in self.reporters: + reporter.createReport() + + def write(self, measurement): + """ + This will write to all the reporters, by waiting on the created + callback to fire. + """ + for reporter in self.reporters: + @reporter.created.addCallback + def cb(result): + report_write_task = ReportWrite(reporter, measurement) + self.reportEntryManager.schedule(report_write_task) + diff --git a/ooni/tasks.py b/ooni/tasks.py index 3230732..981f5e1 100644 --- a/ooni/tasks.py +++ b/ooni/tasks.py @@ -1,3 +1,5 @@ +import time + from twisted.internet import defer, reactor class BaseTask(object): @@ -6,6 +8,10 @@ class BaseTask(object): def __init__(self): self.running = False self.failures = 0 + + self.startTime = time.time() + self.runtime = 0 + # This is a deferred that gets called when a test has reached it's # final status, this means: all retries have been attempted or the test # has successfully executed. @@ -17,6 +23,7 @@ class BaseTask(object): return failure def _succeeded(self, result): + self.runtime = time.time() - self.startTime self.succeeded(result) return result

1 0

[ooni-probe/master] Prevent divide by zero bug
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 442a51799ca892e4dcacd410be386418a754531b Author: Arturo Filastò <art(a)fuffa.org> Date: Sun Jan 13 20:18:34 2013 +0100 Prevent divide by zero bug --- ooni/director.py | 12 ++++++++++++ 1 files changed, 12 insertions(+), 0 deletions(-) diff --git a/ooni/director.py b/ooni/director.py index beb9c3a..1ef5aab 100644 --- a/ooni/director.py +++ b/ooni/director.py @@ -70,10 +70,16 @@ class Director(object): @property def measurementSuccessRatio(self): + if self.totalMeasurements == 0: + return 0 + return self.successfulMeasurements / self.totalMeasurements @property def measurementFailureRatio(self): + if self.totalMeasurements == 0: + return 0 + return self.failedMeasurements / self.totalMeasurements @property @@ -84,6 +90,9 @@ class Director(object): This means that fast tests that perform a lot of measurements will impact this value quite heavily. """ + if self.totalMeasurementRuntime == 0: + return 0 + return self.successfulMeasurements / self.totalMeasurementRuntime @property @@ -91,6 +100,9 @@ class Director(object): """ The speed at which tests are failing globally. """ + if self.totalMeasurementRuntime == 0: + return 0 + return self.failedMeasurements / self.totalMeasurementRuntime def measurementTimedOut(self, measurement):

1 0

[ooni-probe/master] Use a Mediator pattern to keep track of which tests have failed
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit e10008eb9d9f1df1d1ff9b3f7c69092e101c7716 Author: Arturo Filastò <art(a)fuffa.org> Date: Sun Jan 13 20:21:02 2013 +0100 Use a Mediator pattern to keep track of which tests have failed --- ooni/managers.py | 47 +++++------------------------------------ ooni/nettest.py | 24 ++++++++++++++++++-- ooni/reporter.py | 16 +++++++++++++- ooni/tasks.py | 61 ++++++++++++++++++++++++++++++++++++++++++++++-------- 4 files changed, 94 insertions(+), 54 deletions(-) diff --git a/ooni/managers.py b/ooni/managers.py index dd748ae..3983705 100644 --- a/ooni/managers.py +++ b/ooni/managers.py @@ -63,7 +63,6 @@ class TaskManager(object): self._fillSlots() task.done.callback(result) - self.succeeded(result, task) def _run(self, task): @@ -155,50 +154,16 @@ class MeasurementManager(TaskManager): def failed(self, failure, measurement): self.director.measurementFailed(failure, measurement) -class Report(object): - reportEntryManager = None - - def __init__(self, reporters, net_test): - """ - This will instantiate all the reporters and add them to the list of - available reporters. - - net_test: - is a reference to the net_test to which the report object belongs to. - """ - self.netTest = net_test - self.reporters = [] - for r in reporters: - reporter = r() - self.reporters.append(reporter) - - self.createReports() - - def createReports(self): - """ - This will create all the reports that need to be created. - """ - for reporter in self.reporters: - reporter.createReport() - - def write(self, measurement): - """ - This will write to all the reporters, by waiting on the created - callback to fire. - """ - for reporter in self.reporters: - @reporter.created.addCallback - def cb(result): - report_write_task = ReportWrite(reporter, measurement) - self.reportEntryManager.schedule(report_write_task) - -class ReportEntryManager(object): +class ReportEntryManager(TaskManager): director = None - def succeeded(self, result, measurement): + def started(self, task): pass - def failed(self, failure, measurement): + def succeeded(self, result, task): + pass + + def failed(self, failure, task): pass diff --git a/ooni/nettest.py b/ooni/nettest.py index 01dde72..31f2956 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -1,9 +1,10 @@ import os +from twisted.internet import defer, reactor from twisted.trial.runner import filenameToModule from twisted.python import usage, reflect -from ooni.tasks import Measurement +from ooni.tasks import Measurement, TaskMediator from ooni.utils import log, checkForRoot, NotRootError from inspect import getmembers @@ -28,6 +29,18 @@ class NetTest(object): self.report = report self.test_cases = self.loadNetTest(net_test_file) + self.allMeasurementsDone = defer.Deferred() + self.allReportsDone = defer.Deferred() + + # This should fire when all the measurements have been completed and + # all the reports are done. Done means that they have either completed + # successfully or all the possible retries have been reached. + # self.done = defer.DeferredList([self.allMeasurementsDone, + # self.allReportsDone]) + + # XXX Fire the done when also all the reporting tasks have been completed. + self.done = self.allMeasurementsDone + def start(self): """ Set up tests and start running. @@ -36,6 +49,8 @@ class NetTest(object): self.setUpNetTestCases() self.measurementManager.schedule(self.generateMeasurements()) + return self.done + def loadNetTest(self, net_test_file): """ Creates all the necessary test_cases (a list of tuples containing the @@ -111,7 +126,7 @@ class NetTest(object): def succeeded(self, measurement): """ - This gets called when a measurement has failed. + This gets called when a measurement has succeeded. """ self.report.write(measurement) @@ -120,12 +135,15 @@ class NetTest(object): This is a generator that yields measurements and sets their timeout value and their netTest attribute. """ + + task_mediator = TaskMediator(self.allMeasurementsDone) for test_class, test_method in self.test_cases: for test_input in test_class.inputs: measurement = Measurement(test_class, test_method, - test_input, self) + test_input, self, task_mediator) measurement.netTest = self yield measurement + task_mediator.allTasksScheduled() def setUpNetTestCases(self): """ diff --git a/ooni/reporter.py b/ooni/reporter.py index 637131c..b3a7244 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -31,6 +31,8 @@ from ooni.utils.net import BodyReceiver, StringProducer, userAgents from ooni import config +from ooni.tasks import ReportEntry, TaskMediator + def createPacketReport(packet_list): """ Takes as input a packet a list. @@ -391,6 +393,11 @@ class Report(object): self.createReports() + self.done = defer.Deferred() + self.done.addCallback(self.finish) + + self.report_mediator = TaskMediator(self.done) + def createReports(self): """ This will create all the reports that need to be created. @@ -406,6 +413,13 @@ class Report(object): for reporter in self.reporters: @reporter.created.addCallback def cb(result): - report_write_task = ReportWrite(reporter, measurement) + report_write_task = ReportEntry(reporter, measurement, + self.report_mediator) self.reportEntryManager.schedule(report_write_task) + def finish(self): + for reporter in self.reporters: + d = defer.maybeDeferred(reporter.finish) + dl.append(d) + return defer.DeferredList(dl) + diff --git a/ooni/tasks.py b/ooni/tasks.py index 981f5e1..3fdf083 100644 --- a/ooni/tasks.py +++ b/ooni/tasks.py @@ -5,7 +5,11 @@ from twisted.internet import defer, reactor class BaseTask(object): _timer = None - def __init__(self): + def __init__(self, mediator=None): + """ + If you want to schedule a task multiple times, remember to create fresh + instances of it. + """ self.running = False self.failures = 0 @@ -16,6 +20,9 @@ class BaseTask(object): # final status, this means: all retries have been attempted or the test # has successfully executed. self.done = defer.Deferred() + if mediator: + mediator.created() + self.done.addCallback(mediator.taskDone) def _failed(self, failure): self.failures += 1 @@ -90,7 +97,8 @@ class TaskWithTimeout(BaseTask): pass class Measurement(TaskWithTimeout): - def __init__(self, test_class, test_method, test_input, net_test): + def __init__(self, test_class, test_method, test_input, net_test, + mediator): """ test_class: is the class, subclass of NetTestCase, of the test to be run @@ -115,24 +123,59 @@ class Measurement(TaskWithTimeout): self.netTest = net_test - def succeeded(self): - self.net_test.succeeded(self) + TaskWithTimeout.__init__(self, mediator) - def failed(self): + def succeeded(self, result): + return self.netTest.succeeded(self) + + def failed(self, failure): pass def timedOut(self): - self.net_test.timedOut() + self.netTest.timedOut() def run(self): - return defer.maybeDeferred(self.test) + d = defer.maybeDeferred(self.test) + return d class ReportEntry(TaskWithTimeout): - def __init__(self, reporter, measurement): + def __init__(self, reporter, measurement, task_mediator): self.reporter = reporter self.measurement = measurement - TaskWithTimeout.__init__(self) + + TaskWithTimeout.__init__(self, task_mediator) def run(self): return self.reporter.writeReportEntry(self.measurement) + +class TaskMediator(object): + def __init__(self, allTasksDone): + """ + This implements a Mediator/Observer pattern to keep track of when Tasks + that are logically linked together have all reached a final done stage. + + Args: + allTasksDone is a deferred that will get fired once all the tasks + have been completed. + """ + self.doneTasks = 0 + self.tasks = 0 + + self.completedScheduling = False + + self.allTasksDone = allTasksDone + + def created(self): + self.tasks += 1 + + def taskDone(self, result): + self.doneTasks += 1 + if self.completedScheduling and \ + self.doneTasks == self.tasks: + self.allTasksDone.callback(None) + + def allTasksScheduled(self): + self.completedScheduling = True + +

1 0

[ooni-probe/master] Work in progress on Reporter and NetTest
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 2d0dc1b57f0e1f407749d6f3c22f233f43e618b3 Author: Arturo Filastò <art(a)fuffa.org> Date: Mon Jan 14 18:25:00 2013 +0100 Work in progress on Reporter and NetTest --- ooni/nettest.py | 13 +++++++++---- ooni/reporter.py | 15 +++++++++++---- tests/test_director.py | 1 + 3 files changed, 21 insertions(+), 8 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 31f2956..67a793d 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -35,11 +35,11 @@ class NetTest(object): # This should fire when all the measurements have been completed and # all the reports are done. Done means that they have either completed # successfully or all the possible retries have been reached. - # self.done = defer.DeferredList([self.allMeasurementsDone, - # self.allReportsDone]) + self.done = defer.DeferredList([self.allMeasurementsDone, + self.allReportsDone]) # XXX Fire the done when also all the reporting tasks have been completed. - self.done = self.allMeasurementsDone + # self.done = self.allMeasurementsDone def start(self): """ @@ -135,7 +135,6 @@ class NetTest(object): This is a generator that yields measurements and sets their timeout value and their netTest attribute. """ - task_mediator = TaskMediator(self.allMeasurementsDone) for test_class, test_method in self.test_cases: for test_input in test_class.inputs: @@ -145,6 +144,12 @@ class NetTest(object): yield measurement task_mediator.allTasksScheduled() + # Once all the MeasurementsTasks have been completed all the report + # tasks will have been scheduled. + @task_mediator.allTasksDone.addCallback + def done(result): + self.report.report_mediator.allTasksScheduled() + def setUpNetTestCases(self): """ Call processTest and processOptions methods of each NetTestCase diff --git a/ooni/reporter.py b/ooni/reporter.py index b3a7244..38e83c3 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -375,6 +375,9 @@ class OONIBReporter(OReporter): self.backend_version = parsed_response['backend_version'] log.debug("Created report with id %s" % parsed_response['report_id']) +class ReportClosed(Exception): + pass + class Report(object): reportEntryManager = None @@ -407,14 +410,18 @@ class Report(object): def write(self, measurement): """ - This will write to all the reporters, by waiting on the created - callback to fire. + This is a lazy call that will write to all the reporters by waiting on + the created callback to fire. + + The report_write_task is created before we attach the callback so that + the report mediator is aware of the total number of created reportEntry + tasks. """ for reporter in self.reporters: + report_write_task = ReportEntry(reporter, measurement, + self.report_mediator) @reporter.created.addCallback def cb(result): - report_write_task = ReportEntry(reporter, measurement, - self.report_mediator) self.reportEntryManager.schedule(report_write_task) def finish(self): diff --git a/tests/test_director.py b/tests/test_director.py index fa13d9e..0721a2d 100644 --- a/tests/test_director.py +++ b/tests/test_director.py @@ -40,6 +40,7 @@ class MockReporter(object): pass class TestDirector(unittest.TestCase): + timeout = 1 def setUp(self): with open('dummyInputFile.txt', 'w') as f: for i in range(10):

1 0

[ooni-probe/master] Import base test_reporter from aagbsn's repo
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit f0a8eead84d2356f89adb930b5934188f82e7580 Author: Arturo Filastò <art(a)fuffa.org> Date: Mon Jan 14 18:25:41 2013 +0100 Import base test_reporter from aagbsn's repo --- tests/test_reporter.py | 76 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 76 insertions(+), 0 deletions(-) diff --git a/tests/test_reporter.py b/tests/test_reporter.py new file mode 100644 index 0000000..cfa0afd --- /dev/null +++ b/tests/test_reporter.py @@ -0,0 +1,76 @@ +from twisted.trial import unittest +from ooni.reporter import Report, YAMLReporter, OONIBReporter +from ooni.managers import ReportEntryManager +from ooni.nettest import NetTest +from ooni.tasks import TaskMediator + +mockReportOptions = {'name':'foo_test', 'version': '0.1'} + +class TestYAMLReporter(unittest.TestCase): + def setUp(self): + pass + + def test_create_yaml_reporter(self): + + YAMLReporter.reportFilePrefix = "spam" + YAMLReporter.options = mockReportOptions + report = Report([YAMLReporter]) + #XXX: calls createReport on init. is that what we want? + report.reportEntryManager = ReportEntryManager() + allTasksDone = defer.Deferred() + report.taskmediator = TaskMediator() + + #def test_create_yaml_report(self): + # # should create a YAML report + # raise NotImplementedError + + def test_write_yaml_report(self): + YAMLReporter.reportFilePrefix = "spam" + YAMLReporter.options = mockReportOptions + report = Report([YAMLReporter]) + #XXX: fire createReport on init. is that what we want? + report.reportEntryManager = ReportEntryManager() + report.write("HAI") + + def test_write_yaml_report_before_create(self): + # should write to YAML report before it has been created + # the write should not occur until after the created callback has fired + raise NotImplementedError + + def test_yaml_report_completed(self): + # should test that a report will complete successfully + # it should fire a callback after the report.finish method is called, + # XXX: a report should not be finalized until after all pending + # writes have completed + raise NotImplementedError + + def test_write_after_completed(self): + # try to call write after a report is completed/finalized. it must fail + # it should also fail in the sense that as long as the finalize-report has + # been called no additional reports entries can be added, but + # existing/pending entries should be completed before the report + # finalized callback is fired + raise NotImplementedError + + +#class OONIBReporter(unittest.TestCase): +# def setUp(self): +# #XXX set up a dummy OONIB backend +# pass +# +# def test_create_oonib_reporter(self): +# # should instance a OONIB reporter +# raise NotImplementedError +# +# def test_create_oonib_report(self): +# # should create a YAML report +# raise NotImplementedError +# +# def test_write_oonib_report(self): +# # should write to YAML report +# raise NotImplementedError +# +# def test_write_oonib_report_before_create(self): +# # should write to YAML report before it has been created +# # the write should not occur until after the created callback has fired +# raise NotImplementedError

1 0

[ooni-probe/master] Test if the done callback will fire when all tasks have been completed
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 77fe44bd5dd5a50f7707c2e2e5a9354339e60d68 Author: Arturo Filastò <art(a)fuffa.org> Date: Sun Jan 13 20:21:34 2013 +0100 Test if the done callback will fire when all tasks have been completed --- tests/test_managers.py | 1 + tests/test_nettest.py | 32 ++++++++++++++++++++++++++++++++ 2 files changed, 33 insertions(+), 0 deletions(-) diff --git a/tests/test_managers.py b/tests/test_managers.py index d24ee5e..9bc0698 100644 --- a/tests/test_managers.py +++ b/tests/test_managers.py @@ -52,6 +52,7 @@ class MockTaskManager(TaskManager): self.successes.append((result, task)) class TestTaskManager(unittest.TestCase): + timeout = 1 def setUp(self): self.measurementManager = MockTaskManager() self.measurementManager.concurrency = 10 diff --git a/tests/test_nettest.py b/tests/test_nettest.py index a23d16b..b7bd365 100644 --- a/tests/test_nettest.py +++ b/tests/test_nettest.py @@ -10,6 +10,8 @@ from ooni.nettest import FailureToLoadNetTest from ooni.tasks import BaseTask from ooni.utils import NotRootError +from ooni.managers import TaskManager + net_test_string = """ from twisted.python import usage from ooni.nettest import NetTestCase @@ -116,7 +118,22 @@ class DummyReporter(object): def write(self, result): pass +class MockMeasurementManager(TaskManager): + def __init__(self): + self.successes = [] + + def failed(self, failure, task): + pass + + def succeeded(self, result, task): + self.successes.append((result, task)) + +class MockReporter(object): + def write(self, measurement): + pass + class TestNetTest(unittest.TestCase): + timeout = 1 def setUp(self): with open('dummyInputFile.txt', 'w') as f: for i in range(10): @@ -245,6 +262,21 @@ class TestNetTest(unittest.TestCase): measurements = list(net_test.generateMeasurements()) self.assertEqual(len(measurements), 20) + def test_net_test_completed_callback(self): + dummyOptionsWithFile = dict(dummyOptions) + dummyOptionsWithFile['file'] = 'dummyInputFile.txt' + + net_test = NetTest(StringIO(net_test_string_with_file), + dummyOptionsWithFile, MockReporter()) + net_test.measurementManager = MockMeasurementManager() + + d = net_test.start() + @d.addCallback + def complete(result): + self.assertEqual(result, None) + + return d + #def test_require_root_succeed(self): # #XXX: will require root to run # n = NetTest(StringIO(net_test_root_required),

1 0

[ooni-probe/master] Basic testing and implementation of reporting task manager
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 725f9ee90fb10997f57a5c1a5313ae7a84b68249 Author: Arturo Filastò <art(a)fuffa.org> Date: Mon Jan 14 20:42:31 2013 +0100 Basic testing and implementation of reporting task manager --- ooni/nettest.py | 6 ++- ooni/reporter.py | 7 ++- ooni/tasks.py | 27 +++++++++-- tests/test_reporter.py | 118 ++++++++++++++++++++--------------------------- 4 files changed, 81 insertions(+), 77 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 67a793d..d6cadc3 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -144,10 +144,12 @@ class NetTest(object): yield measurement task_mediator.allTasksScheduled() - # Once all the MeasurementsTasks have been completed all the report - # tasks will have been scheduled. @task_mediator.allTasksDone.addCallback def done(result): + """ + Once all the MeasurementsTasks have been completed all the report + tasks will have been scheduled. + """ self.report.report_mediator.allTasksScheduled() def setUpNetTestCases(self): diff --git a/ooni/reporter.py b/ooni/reporter.py index 38e83c3..d24edcc 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -177,6 +177,7 @@ class OReporter(object): pass def testDone(self, test, test_name): + # XXX log.msg("Finished running %s" % test_name) test_report = dict(test.report) @@ -406,7 +407,8 @@ class Report(object): This will create all the reports that need to be created. """ for reporter in self.reporters: - reporter.createReport() + d = defer.maybeDeferred(reporter.createReport) + d.addCallback(reporter.created.callback) def write(self, measurement): """ @@ -424,7 +426,8 @@ class Report(object): def cb(result): self.reportEntryManager.schedule(report_write_task) - def finish(self): + def finish(self, result): + dl = [] for reporter in self.reporters: d = defer.maybeDeferred(reporter.finish) dl.append(d) diff --git a/ooni/tasks.py b/ooni/tasks.py index 3fdf083..f2a9bae 100644 --- a/ooni/tasks.py +++ b/ooni/tasks.py @@ -35,7 +35,7 @@ class BaseTask(object): return result def start(self): - self.running = self.run() + self.running = defer.maybeDeferred(self.run) self.running.addErrback(self._failed) self.running.addCallback(self._succeeded) return self.running @@ -163,19 +163,36 @@ class TaskMediator(object): self.tasks = 0 self.completedScheduling = False - self.allTasksDone = allTasksDone def created(self): self.tasks += 1 - def taskDone(self, result): - self.doneTasks += 1 + def checkAllTasksDone(self): if self.completedScheduling and \ self.doneTasks == self.tasks: - self.allTasksDone.callback(None) + self.allTasksDone.callback(self.doneTasks) + + def taskDone(self, result): + """ + This is called every time a task has finished running. + """ + self.doneTasks += 1 + self.checkAllTasksDone() def allTasksScheduled(self): + """ + This should be called once all the tasks that need to run have been + scheduled. + + XXX this is ghetto. + The reason for which we are calling allTasksDone inside of the + allTasksScheduled method is called after all tasks are done, then we + will run into a race condition. The race is that we don't end up + checking that all the tasks are complete because no task is to be + scheduled. + """ self.completedScheduling = True + self.checkAllTasksDone() diff --git a/tests/test_reporter.py b/tests/test_reporter.py index cfa0afd..1754ad0 100644 --- a/tests/test_reporter.py +++ b/tests/test_reporter.py @@ -1,76 +1,58 @@ +from twisted.internet import defer from twisted.trial import unittest + from ooni.reporter import Report, YAMLReporter, OONIBReporter -from ooni.managers import ReportEntryManager +from ooni.managers import ReportEntryManager, TaskManager from ooni.nettest import NetTest -from ooni.tasks import TaskMediator + +from ooni.tasks import TaskMediator, TaskWithTimeout mockReportOptions = {'name':'foo_test', 'version': '0.1'} -class TestYAMLReporter(unittest.TestCase): - def setUp(self): +class MockOReporter(object): + def __init__(self): + self.created = defer.Deferred() + + def writeReportEntry(self, entry): + pass + + def finish(self): + pass + + def createReport(self): + pass + +class MockMeasurement(TaskWithTimeout): + def __init__(self): + TaskWithTimeout.__init__(self) + + def succeeded(self, result): pass - def test_create_yaml_reporter(self): - - YAMLReporter.reportFilePrefix = "spam" - YAMLReporter.options = mockReportOptions - report = Report([YAMLReporter]) - #XXX: calls createReport on init. is that what we want? - report.reportEntryManager = ReportEntryManager() - allTasksDone = defer.Deferred() - report.taskmediator = TaskMediator() - - #def test_create_yaml_report(self): - # # should create a YAML report - # raise NotImplementedError - - def test_write_yaml_report(self): - YAMLReporter.reportFilePrefix = "spam" - YAMLReporter.options = mockReportOptions - report = Report([YAMLReporter]) - #XXX: fire createReport on init. is that what we want? - report.reportEntryManager = ReportEntryManager() - report.write("HAI") - - def test_write_yaml_report_before_create(self): - # should write to YAML report before it has been created - # the write should not occur until after the created callback has fired - raise NotImplementedError - - def test_yaml_report_completed(self): - # should test that a report will complete successfully - # it should fire a callback after the report.finish method is called, - # XXX: a report should not be finalized until after all pending - # writes have completed - raise NotImplementedError - - def test_write_after_completed(self): - # try to call write after a report is completed/finalized. it must fail - # it should also fail in the sense that as long as the finalize-report has - # been called no additional reports entries can be added, but - # existing/pending entries should be completed before the report - # finalized callback is fired - raise NotImplementedError - - -#class OONIBReporter(unittest.TestCase): -# def setUp(self): -# #XXX set up a dummy OONIB backend -# pass -# -# def test_create_oonib_reporter(self): -# # should instance a OONIB reporter -# raise NotImplementedError -# -# def test_create_oonib_report(self): -# # should create a YAML report -# raise NotImplementedError -# -# def test_write_oonib_report(self): -# # should write to YAML report -# raise NotImplementedError -# -# def test_write_oonib_report_before_create(self): -# # should write to YAML report before it has been created -# # the write should not occur until after the created callback has fired -# raise NotImplementedError +class MockTaskManager(TaskManager): + def __init__(self): + self.successes = [] + + def failed(self, failure, task): + pass + + def succeeded(self, result, task): + self.successes.append((result, task)) + +class TestReport(unittest.TestCase): + def setUp(self): + self.report = Report([MockOReporter]) + self.report.reportEntryManager = MockTaskManager() + + def test_report_alltasksdone_callback_fires(self): + for m in range(10): + measurement = MockMeasurement() + self.report.write(measurement) + + self.report.report_mediator.allTasksScheduled() + + @self.report.done.addCallback + def done(reporters): + self.assertEqual(len(reporters), 1) + + return self.report.done

1 0

[ooni-probe/master] Move NetTest Mocks into mocks.py
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 30d8b172d335062ad535fdbb9889fb4895fe6bc5 Author: aagbsn <aagbsn(a)extc.org> Date: Tue Jan 15 11:28:56 2013 +0000 Move NetTest Mocks into mocks.py --- tests/mocks.py | 49 ++++++++++++++++++++++++++++++++++++++++ tests/test_nettest.py | 60 +++++------------------------------------------- 2 files changed, 56 insertions(+), 53 deletions(-) diff --git a/tests/mocks.py b/tests/mocks.py new file mode 100644 index 0000000..eae3fad --- /dev/null +++ b/tests/mocks.py @@ -0,0 +1,49 @@ +from ooni.tasks import BaseTask +from ooni.nettest import NetTest +from ooni.managers import TaskManager + +class MockMeasurement(BaseTask): + def run(self): + f = open('foo.txt', 'w') + f.write('testing') + f.close() + + return defer.succeed(self) + +class MockMeasurementFailOnce(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 MockNetTest(NetTest): + def __init__(self, num_measurements=1): + NetTest.__init__(self, StringIO(net_test_string), dummyOptions) + self.num_measurements = num_measurements + def generateMeasurements(self): + for i in range(self.num_measurements): + yield MockMeasurement() + +class MockDirector(object): + def __init__(self): + pass + +class MockMeasurementManager(TaskManager): + def __init__(self): + self.successes = [] + + def failed(self, failure, task): + pass + + def succeeded(self, result, task): + self.successes.append((result, task)) + +class MockReporter(object): + def write(self, measurement): + pass + + diff --git a/tests/test_nettest.py b/tests/test_nettest.py index b7bd365..3c7bdf6 100644 --- a/tests/test_nettest.py +++ b/tests/test_nettest.py @@ -12,6 +12,10 @@ from ooni.utils import NotRootError from ooni.managers import TaskManager +from tests.mocks import MockMeasurement, MockMeasurementFailOnce +from tests.mocks import MockNetTest, MockDirector, MockReporter +from tests.mocks import MockMeasurementManager + net_test_string = """ from twisted.python import usage from ooni.nettest import NetTestCase @@ -82,56 +86,6 @@ dummyOptions = {'spam': 'notham'} dummyInvalidOptions = {'cram': 'jam'} dummyOptionsWithRequiredOptions = {'foo':'moo', 'bar':'baz'} -class DummyMeasurement(BaseTask): - def run(self): - f = open('foo.txt', 'w') - f.write('testing') - f.close() - - return defer.succeed(self) - -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 __init__(self, num_measurements=1): - NetTest.__init__(self, StringIO(net_test_string), dummyOptions) - self.num_measurements = num_measurements - def generateMeasurements(self): - for i in range(self.num_measurements): - yield DummyMeasurement() - -class DummyDirector(object): - def __init__(self): - pass - -class DummyReporter(object): - def __init__(self): - pass - def write(self, result): - pass - -class MockMeasurementManager(TaskManager): - def __init__(self): - self.successes = [] - - def failed(self, failure, task): - pass - - def succeeded(self, result, task): - self.successes.append((result, task)) - -class MockReporter(object): - def write(self, measurement): - pass - class TestNetTest(unittest.TestCase): timeout = 1 def setUp(self): @@ -153,7 +107,7 @@ class TestNetTest(unittest.TestCase): f.close() net_test_from_file = NetTest(net_test_file, - dummyOptions, DummyReporter()) + dummyOptions, MockReporter()) test_methods = set() for test_class, test_method in net_test_from_file.test_cases: @@ -173,7 +127,7 @@ class TestNetTest(unittest.TestCase): generated. """ net_test_from_string = NetTest(net_test_string, - dummyOptions, DummyReporter()) + dummyOptions, MockReporter()) test_methods = set() for test_class, test_method in net_test_from_string.test_cases: @@ -191,7 +145,7 @@ class TestNetTest(unittest.TestCase): generated. """ net_test_from_string = NetTest(StringIO(net_test_string), - dummyOptions, DummyReporter()) + dummyOptions, MockReporter()) test_methods = set() for test_class, test_method in net_test_from_string.test_cases:

1 0

[ooni-probe/master] Move Reporter Mocks into mocks.py
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit 6cbbfb206624f4d399a7cca06cb8997a63dafd46 Author: aagbsn <aagbsn(a)extc.org> Date: Tue Jan 15 12:31:24 2013 +0000 Move Reporter Mocks into mocks.py --- tests/mocks.py | 25 +++++++++++++++++++++++++ tests/test_reporter.py | 34 +++------------------------------- 2 files changed, 28 insertions(+), 31 deletions(-) diff --git a/tests/mocks.py b/tests/mocks.py index 687e247..60727e5 100644 --- a/tests/mocks.py +++ b/tests/mocks.py @@ -114,3 +114,28 @@ class MockDirector(object): def measurementSucceeded(self, measurement): self.successes.append(measurement) + +## from test_reporter.py +class MockOReporter(object): + def __init__(self): + self.created = defer.Deferred() + + def writeReportEntry(self, entry): + pass + + def finish(self): + pass + + def createReport(self): + pass + + +class MockTaskManager(TaskManager): + def __init__(self): + self.successes = [] + + def failed(self, failure, task): + pass + + def succeeded(self, result, task): + self.successes.append((result, task)) diff --git a/tests/test_reporter.py b/tests/test_reporter.py index 1754ad0..e1c7fca 100644 --- a/tests/test_reporter.py +++ b/tests/test_reporter.py @@ -6,39 +6,11 @@ from ooni.managers import ReportEntryManager, TaskManager from ooni.nettest import NetTest from ooni.tasks import TaskMediator, TaskWithTimeout +from tests.mocks import MockOReporter, MockTaskManager +from tests.mocks import MockMeasurement, MockNetTest mockReportOptions = {'name':'foo_test', 'version': '0.1'} -class MockOReporter(object): - def __init__(self): - self.created = defer.Deferred() - - def writeReportEntry(self, entry): - pass - - def finish(self): - pass - - def createReport(self): - pass - -class MockMeasurement(TaskWithTimeout): - def __init__(self): - TaskWithTimeout.__init__(self) - - def succeeded(self, result): - pass - -class MockTaskManager(TaskManager): - def __init__(self): - self.successes = [] - - def failed(self, failure, task): - pass - - def succeeded(self, result, task): - self.successes.append((result, task)) - class TestReport(unittest.TestCase): def setUp(self): self.report = Report([MockOReporter]) @@ -46,7 +18,7 @@ class TestReport(unittest.TestCase): def test_report_alltasksdone_callback_fires(self): for m in range(10): - measurement = MockMeasurement() + measurement = MockMeasurement(MockNetTest()) self.report.write(measurement) self.report.report_mediator.allTasksScheduled()

1 0

[ooni-probe/master] tests needs to be a module for mocks to import
by isis＠torproject.org 09 Mar '13

09 Mar '13

commit d77cc9075ec140e52cfb18100852acdb3e1da228 Author: aagbsn <aagbsn(a)extc.org> Date: Tue Jan 15 12:40:52 2013 +0000 tests needs to be a module for mocks to import --- 0 files changed, 0 insertions(+), 0 deletions(-) diff --git a/tests/__init__.py b/tests/__init__.py new file mode 100644 index 0000000..e69de29

1 0