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

[ooni-probe/master] write failure instances to report
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit b9f52b03465e5f2a68b66b220d3c3d609fb8e456 Author: aagbsn <aagbsn(a)extc.org> Date: Fri Jan 25 21:12:23 2013 +0000 write failure instances to report --- ooni/reporter.py | 9 ++++++--- 1 files changed, 6 insertions(+), 3 deletions(-) diff --git a/ooni/reporter.py b/ooni/reporter.py index 23cca69..638df41 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -16,6 +16,7 @@ from twisted.python.util import untilConcludes from twisted.trial import reporter from twisted.internet import defer, reactor from twisted.internet.error import ConnectionRefusedError +from twisted.python.failure import Failure from ooni.utils import log @@ -201,10 +202,12 @@ class YAMLReporter(OReporter): untilConcludes(self._stream.flush) def writeReportEntry(self, entry): - #XXX: all _write, _writeln inside this call should be atomic log.debug("Writing report with YAML reporter") self._write('---\n') - self._write(safe_dump(entry)) + if isinstance(entry, Failure): + self._write(entry.value) + else: + self._write(safe_dump(entry)) self._write('...\n') def createReport(self): @@ -374,7 +377,7 @@ class Report(object): self.reporters = reporters self.done = defer.Deferred() - self.done.addCallback(self.close) + #self.done.addCallback(self.close) self.reportEntryManager = reportEntryManager

1 0

[ooni-probe/master] Open report in director, not generateMeasurements
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 66f1e0a0e8dd5af78fa783fe99e05802915f9acc Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 26 08:03:09 2013 +0000 Open report in director, not generateMeasurements --- ooni/director.py | 1 + 1 files changed, 1 insertions(+), 0 deletions(-) diff --git a/ooni/director.py b/ooni/director.py index 6717d70..c3ed4ec 100644 --- a/ooni/director.py +++ b/ooni/director.py @@ -184,6 +184,7 @@ class Director(object): net_test = NetTest(net_test_loader, report) net_test.director = self + net_test.report.open() self.measurementManager.schedule(net_test.generateMeasurements())

1 0

[ooni-probe/master] Update MockReporter
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 87c2f1eb28e64f20e095f0912264ce36117da50a Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 26 11:14:22 2013 +0000 Update MockReporter the created deferred should not get called until after createReport is fired --- tests/mocks.py | 8 ++++++-- 1 files changed, 6 insertions(+), 2 deletions(-) diff --git a/tests/mocks.py b/tests/mocks.py index b692b39..c7feceb 100644 --- a/tests/mocks.py +++ b/tests/mocks.py @@ -27,12 +27,16 @@ class MockMeasurementManager(TaskManager): class MockReporter(object): def __init__(self): - self.created = defer.succeed(None) + self.created = defer.Deferred() - def write(self, measurement): + def writeReportEntry(self, entry): pass def createReport(self): + self.created.callback(True) + return self.created + + def finish(self): pass class MockFailure(Exception):

1 0

[ooni-probe/master] Clean up NetTest tests
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit bc62ec09ab0b62a92364c019797a2c44e41991f2 Author: aagbsn <aagbsn(a)extc.org> Date: Fri Jan 25 14:15:08 2013 +0000 Clean up NetTest tests --- tests/test_nettest.py | 143 +++++++++++++++++++++++++----------------------- 1 files changed, 74 insertions(+), 69 deletions(-) diff --git a/tests/test_nettest.py b/tests/test_nettest.py index a029fae..ee571e7 100644 --- a/tests/test_nettest.py +++ b/tests/test_nettest.py @@ -4,9 +4,10 @@ from tempfile import TemporaryFile, mkstemp from twisted.trial import unittest from twisted.internet import defer, reactor +from twisted.python.usage import UsageError from ooni.nettest import NetTest, InvalidOption, MissingRequiredOption -from ooni.nettest import FailureToLoadNetTest +from ooni.nettest import NetTestLoader, FailureToLoadNetTest from ooni.tasks import BaseTask from ooni.utils import NotRootError @@ -17,6 +18,7 @@ from ooni.managers import TaskManager from tests.mocks import MockMeasurement, MockMeasurementFailOnce from tests.mocks import MockNetTest, MockDirector, MockReporter from tests.mocks import MockMeasurementManager +defer.setDebugging(True) net_test_string = """ from twisted.python import usage @@ -84,9 +86,13 @@ class DummyTestCase(NetTestCase): """ dummyInputs = range(1) -dummyOptions = {'spam': 'notham'} -dummyInvalidOptions = {'cram': 'jam'} -dummyOptionsWithRequiredOptions = {'foo':'moo', 'bar':'baz'} +dummyArgs = ('--spam', 'notham') +dummyOptions = {'spam':'notham'} +dummyInvalidArgs = ('--cram', 'jam') +dummyInvalidOptions= {'cram':'jam'} +dummyArgsWithRequiredOptions = ('--foo', 'moo', '--bar', 'baz') +dummyRequiredOptions = {'foo':'moo', 'bar':'baz'} +dummyArgsWithFile = ('--spam', 'notham', '--file', 'dummyInputFile.txt') class TestNetTest(unittest.TestCase): timeout = 1 @@ -108,11 +114,11 @@ class TestNetTest(unittest.TestCase): f.write(net_test_string) f.close() - net_test_from_file = NetTest(net_test_file, - dummyOptions, MockReporter()) + ntl = NetTestLoader(net_test_file, + dummyArgs) test_methods = set() - for test_class, test_method in net_test_from_file.test_cases: + for test_class, test_method in ntl.testCases: instance = test_class() c = getattr(instance, test_method) self.assertCallable(c) @@ -128,11 +134,11 @@ class TestNetTest(unittest.TestCase): Given a file like object verify that the net test cases are properly generated. """ - net_test_from_string = NetTest(net_test_string, - dummyOptions, MockReporter()) + ntl = NetTestLoader(net_test_string, + dummyArgs) test_methods = set() - for test_class, test_method in net_test_from_string.test_cases: + for test_class, test_method in ntl.testCases: instance = test_class() c = getattr(instance, test_method) self.assertCallable(c) @@ -146,11 +152,11 @@ class TestNetTest(unittest.TestCase): Given a file like object verify that the net test cases are properly generated. """ - net_test_from_string = NetTest(StringIO(net_test_string), - dummyOptions, MockReporter()) + ntl = NetTestLoader(StringIO(net_test_string), + dummyArgs) test_methods = set() - for test_class, test_method in net_test_from_string.test_cases: + for test_class, test_method in ntl.testCases: instance = test_class() c = getattr(instance, test_method) self.assertCallable(c) @@ -160,95 +166,94 @@ class TestNetTest(unittest.TestCase): self.assertEqual(set(['test_a', 'test_b']), test_methods) def test_load_with_option(self): - net_test = NetTest(StringIO(net_test_string), - dummyOptions, None) - self.assertIsInstance(net_test, NetTest) - net_test.setUpNetTestCases() - for test_klass, test_meth in net_test.test_cases: + ntl = NetTestLoader(StringIO(net_test_string), + dummyArgs) + self.assertIsInstance(ntl, NetTestLoader) + for test_klass, test_meth in ntl.testCases: for option in dummyOptions.keys(): self.assertIn(option, test_klass.usageOptions()) def test_load_with_invalid_option(self): try: - net_test = NetTest(StringIO(net_test_string), dummyInvalidOptions, None) - net_test.setUpNetTestCases() - except InvalidOption: + ntl = NetTestLoader(StringIO(net_test_string), dummyInvalidArgs) + ntl.checkOptions() + raise Exception + except UsageError: pass def test_load_with_required_option(self): - net_test = NetTest(StringIO(net_test_with_required_option), - dummyOptionsWithRequiredOptions, None) - net_test.setUpNetTestCases() - self.assertIsInstance(net_test, NetTest) + net_test = NetTestLoader(StringIO(net_test_with_required_option), + dummyArgsWithRequiredOptions) + self.assertIsInstance(net_test, NetTestLoader) def test_load_with_missing_required_option(self): try: - net_test = NetTest(StringIO(net_test_with_required_option), - dummyOptions, None) - net_test.setUpNetTestCases() + net_test = NetTestLoader(StringIO(net_test_with_required_option), + dummyArgs) except MissingRequiredOption: pass def test_net_test_inputs(self): - dummyOptionsWithFile = dict(dummyOptions) - dummyOptionsWithFile['file'] = 'dummyInputFile.txt' - - net_test = NetTest(StringIO(net_test_string_with_file), - dummyOptionsWithFile, None) - net_test.setUpNetTestCases() - - for test_class, test_method in net_test.test_cases: - self.assertEqual(len(list(test_class.inputs)), 10) + ntl = NetTestLoader(StringIO(net_test_string_with_file), + dummyArgsWithFile) + ntl.checkOptions() + + # XXX: if you use the same test_class twice you will have consumed all + # of its inputs! + tested = set([]) + for test_class, test_method in ntl.testCases: + if test_class not in tested: + tested.update([test_class]) + self.assertEqual(len(list(test_class.inputs)), 10) def test_setup_local_options_in_test_cases(self): - net_test = NetTest(StringIO(net_test_string), - dummyOptions, None) - net_test.setUpNetTestCases() + ntl = NetTestLoader(StringIO(net_test_string), + dummyArgs) + ntl.checkOptions() - for test_class, test_method in net_test.test_cases: + for test_class, test_method in ntl.testCases: self.assertEqual(test_class.localOptions, dummyOptions) def test_generate_measurements_size(self): - dummyOptionsWithFile = dict(dummyOptions) - dummyOptionsWithFile['file'] = 'dummyInputFile.txt' - net_test = NetTest(StringIO(net_test_string_with_file), - dummyOptionsWithFile, None) - net_test.setUpNetTestCases() + ntl = NetTestLoader(StringIO(net_test_string_with_file), + dummyArgsWithFile) + ntl.checkOptions() + net_test = NetTest(ntl, None) + measurements = list(net_test.generateMeasurements()) self.assertEqual(len(measurements), 20) def test_net_test_completed_callback(self): - dummyOptionsWithFile = dict(dummyOptions) - dummyOptionsWithFile['file'] = 'dummyInputFile.txt' + ntl = NetTestLoader(StringIO(net_test_string_with_file), + dummyArgsWithFile) + ntl.checkOptions() + director = Director() - net_test = NetTest(StringIO(net_test_string_with_file), - dummyOptionsWithFile, MockReporter()) - net_test.measurementManager = MockMeasurementManager() - net_test.director = Director() + d = director.startNetTest('', ntl, [MockReporter()]) - d = net_test.start() @d.addCallback def complete(result): - self.assertEqual(result, None) + #XXX: why is the return type (True, None) ? + self.assertEqual(result, [(True,None)]) + self.assertEqual(director.successfulMeasurements, 20) return d - #def test_require_root_succeed(self): - # #XXX: will require root to run - # n = NetTest(StringIO(net_test_root_required), - # dummyOptions, None) - # for test_class, method in n.test_cases: - # self.assertTrue(test_class.requiresRoot) - - def test_require_root_failed(self): - #XXX: will fail if you run as root - try: - net_test = NetTest(StringIO(net_test_root_required), - dummyOptions, None) - net_test.setUpNetTestCases() - except NotRootError: - pass + def test_require_root_succeed(self): + #XXX: will require root to run + ntl = NetTestLoader(StringIO(net_test_root_required), + dummyArgs) + for test_class, method in ntl.testCases: + self.assertTrue(test_class.requiresRoot) + + #def test_require_root_failed(self): + # #XXX: will fail if you run as root + # try: + # net_test = NetTestLoader(StringIO(net_test_root_required), + # dummyArgs) + # except NotRootError: + # pass #def test_create_report_succeed(self): # pass

1 0

[ooni-probe/master] Cancel tasks on timeout
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 8a63d6d03cb2d50f45d63a8bf6023c19f66a02c5 Author: aagbsn <aagbsn(a)extc.org> Date: Fri Feb 15 17:53:55 2013 +0100 Cancel tasks on timeout Deferred.cancel() swallows AlreadyCalled exceptions. --- ooni/tasks.py | 6 ++++-- 1 files changed, 4 insertions(+), 2 deletions(-) diff --git a/ooni/tasks.py b/ooni/tasks.py index a73ce11..c17a5c1 100644 --- a/ooni/tasks.py +++ b/ooni/tasks.py @@ -62,13 +62,15 @@ class TaskTimedOut(Exception): pass class TaskWithTimeout(BaseTask): - timeout = 5 + timeout = 30 # So that we can test the callLater calls clock = reactor def _timedOut(self): """Internal method for handling timeout failure""" - self._running.errback(TaskTimedOut) + if not self._running.called: + self._running.cancel() + self._failed(TaskTimedOut) def _cancelTimer(self): #import pdb; pdb.set_trace()

1 0

[ooni-probe/master] Clean up Director tests
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit eca15ac53d2217e1d6a86cc36b9aefbaa94d46d3 Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 26 11:17:02 2013 +0000 Clean up Director tests --- tests/test_director.py | 11 +++++++---- 1 files changed, 7 insertions(+), 4 deletions(-) diff --git a/tests/test_director.py b/tests/test_director.py index 365c11f..484cb21 100644 --- a/tests/test_director.py +++ b/tests/test_director.py @@ -2,6 +2,7 @@ from twisted.internet import defer, base from twisted.trial import unittest from ooni.director import Director +from ooni.nettest import NetTestLoader from tests.mocks import MockReporter base.DelayedCall.debug = True @@ -25,7 +26,7 @@ class DummyTestCase(NetTestCase): """ -dummyOptions = {'spam': 1, 'file': 'dummyInputFile.txt'} +dummyArgs = ('--spam', 1, '--file', 'dummyInputFile.txt') class TestDirector(unittest.TestCase): timeout = 1 @@ -34,14 +35,16 @@ class TestDirector(unittest.TestCase): for i in range(10): f.write("%s\n" % i) - reporters = [MockReporter] - self.director = Director(reporters) + self.reporters = [MockReporter()] + self.director = Director() def tearDown(self): pass def test_start_net_test(self): - d = self.director.startTest(net_test_string, dummyOptions) + net_test_loader = NetTestLoader(net_test_string, dummyArgs) + net_test_loader.checkOptions() + d = self.director.startNetTest('', net_test_loader, self.reporters) @d.addCallback def done(result):

1 0

[ooni-probe/master] Remove dependency of NetTest on Director and Reporter
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit baefdaec6da774ada4c04ee270a510ae3614ce82 Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 26 11:19:25 2013 +0000 Remove dependency of NetTest on Director and Reporter --- ooni/nettest.py | 14 +++++++++----- 1 files changed, 9 insertions(+), 5 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index bd019cc..61e6270 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -319,12 +319,16 @@ class NetTest(object): measurement = Measurement(test_class, test_method, test_input) measurement.netTest = self - measurement.done.addCallback(self.director.measurementSucceeded) - measurement.done.addErrback(self.director.measurementFailed, measurement) + if self.director: + measurement.done.addCallback(self.director.measurementSucceeded) + measurement.done.addErrback(self.director.measurementFailed, measurement) + + if self.report: + measurement.done.addBoth(self.report.write) + + if self.report and self.director: + measurement.done.addBoth(self.doneReport) - measurement.done.addBoth(self.report.write) - # here we are dealing with a deferred list - measurement.done.addBoth(self.doneReport) return measurement def generateMeasurements(self):

1 0

[ooni-probe/master] Refactor test_case loader so that test methods share an input set
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit e07558f035ee50e597d30ee82f1d4f3b7c25aabd Author: aagbsn <aagbsn(a)extc.org> Date: Sat Jan 26 11:49:57 2013 +0000 Refactor test_case loader so that test methods share an input set --- ooni/nettest.py | 21 +++++++++++---------- tests/test_nettest.py | 44 +++++++++++++------------------------------- 2 files changed, 24 insertions(+), 41 deletions(-) diff --git a/ooni/nettest.py b/ooni/nettest.py index 61e6270..9e86ab4 100644 --- a/ooni/nettest.py +++ b/ooni/nettest.py @@ -202,8 +202,11 @@ class NetTestLoader(object): try: assert issubclass(item, NetTestCase) methods = reflect.prefixedMethodNames(item, self.method_prefix) + test_methods = [] for method in methods: - test_cases.append((item, self.method_prefix + method)) + test_methods.append(self.method_prefix + method) + if test_methods: + test_cases.append((item, test_methods)) except (TypeError, AssertionError): pass return test_cases @@ -336,15 +339,13 @@ class NetTest(object): This is a generator that yields measurements and registers the callbacks for when a measurement is successful or has failed. """ - self.report.open() - for test_class, test_method in self.testCases: - log.debug("Running %s %s" % (test_class, test_method)) - for test_input in test_class.inputs: - measurement = self.makeMeasurement(test_class, test_method, - test_input) - - self.state.taskCreated() - yield measurement + for test_class, test_methods in self.testCases: + for input in test_class.inputs: + for method in test_methods: + log.debug("Running %s %s" % (test_class, method)) + measurement = self.makeMeasurement(test_class, method, input) + self.state.taskCreated() + yield measurement self.state.allTasksScheduled() diff --git a/tests/test_nettest.py b/tests/test_nettest.py index ee571e7..5645dbf 100644 --- a/tests/test_nettest.py +++ b/tests/test_nettest.py @@ -104,6 +104,16 @@ class TestNetTest(unittest.TestCase): def assertCallable(self, thing): self.assertIn('__call__', dir(thing)) + def verifyMethods(self, testCases): + uniq_test_methods = set() + for test_class, test_methods in testCases: + instance = test_class() + for test_method in test_methods: + c = getattr(instance, test_method) + self.assertCallable(c) + uniq_test_methods.add(test_method) + self.assertEqual(set(['test_a', 'test_b']), uniq_test_methods) + def test_load_net_test_from_file(self): """ Given a file verify that the net test cases are properly @@ -116,17 +126,7 @@ class TestNetTest(unittest.TestCase): ntl = NetTestLoader(net_test_file, dummyArgs) - - test_methods = set() - for test_class, test_method in ntl.testCases: - instance = test_class() - c = getattr(instance, test_method) - self.assertCallable(c) - - test_methods.add(test_method) - - self.assertEqual(set(['test_a', 'test_b']), test_methods) - + self.verifyMethods(ntl.testCases) os.unlink(net_test_file) def test_load_net_test_from_str(self): @@ -136,16 +136,7 @@ class TestNetTest(unittest.TestCase): """ ntl = NetTestLoader(net_test_string, dummyArgs) - - test_methods = set() - for test_class, test_method in ntl.testCases: - instance = test_class() - c = getattr(instance, test_method) - self.assertCallable(c) - - test_methods.add(test_method) - - self.assertEqual(set(['test_a', 'test_b']), test_methods) + self.verifyMethods(ntl.testCases) def test_load_net_test_from_StringIO(self): """ @@ -154,16 +145,7 @@ class TestNetTest(unittest.TestCase): """ ntl = NetTestLoader(StringIO(net_test_string), dummyArgs) - - test_methods = set() - for test_class, test_method in ntl.testCases: - instance = test_class() - c = getattr(instance, test_method) - self.assertCallable(c) - - test_methods.add(test_method) - - self.assertEqual(set(['test_a', 'test_b']), test_methods) + self.verifyMethods(ntl.testCases) def test_load_with_option(self): ntl = NetTestLoader(StringIO(net_test_string),

1 0

[ooni-probe/master] Fix race condition bug in reporter
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit 90fe8296e78ff48f93c2aaf4e0e03949f5f00960 Author: aagbsn <aagbsn(a)extc.org> Date: Fri Feb 22 20:01:28 2013 +0100 Fix race condition bug in reporter Fixed a race where the report.reporters list got modified during iteration and clean up reporter failure handling. --- ooni/reporter.py | 65 +++++++++++++++++++++++++++++++++++++---------------- 1 files changed, 45 insertions(+), 20 deletions(-) diff --git a/ooni/reporter.py b/ooni/reporter.py index 638df41..f89d5bd 100644 --- a/ooni/reporter.py +++ b/ooni/reporter.py @@ -222,6 +222,7 @@ class YAMLReporter(OReporter): self._writeln("###########################################") self.writeReportEntry(self.testDetails) + self.created.callback(self) def finish(self): self._stream.close() @@ -355,6 +356,7 @@ class OONIBReporter(OReporter): self.reportID = parsed_response['report_id'] self.backendVersion = parsed_response['backend_version'] log.debug("Created report with id %s" % parsed_response['report_id']) + self.created.callback(self) class ReportClosed(Exception): pass @@ -377,8 +379,6 @@ class Report(object): self.reporters = reporters self.done = defer.Deferred() - #self.done.addCallback(self.close) - self.reportEntryManager = reportEntryManager def open(self): @@ -386,12 +386,15 @@ class Report(object): This will create all the reports that need to be created and fires the created callback of the reporter whose report got created. """ - for reporter in self.reporters: + l = [] + for reporter in self.reporters[:]: + reporter.createReport() reporter.created.addErrback(self.failedOpeningReport, reporter) - d = defer.maybeDeferred(reporter.createReport) - d.addCallback(reporter.created.callback) - d.addErrback(reporter.created.callback) - + l.append(reporter.created) + log.debug("Reporters created: %s" % l) + # Should we consume errors silently? + dl = defer.DeferredList(l) + return dl def failedOpeningReport(self, failure, reporter): """ @@ -401,9 +404,13 @@ class Report(object): remove the reporter from the list of reporters to write to. """ log.err("Failed to open %s reporter, giving up..." % reporter) + log.err("Reporter %s failed, removing from report..." % reporter) self.reporters.remove(reporter) - failure.reporter = reporter - return failure + # Don't forward the exception unless there are no more reporters + if len(self.reporters) == 0: + log.err("Removed last reporter %s" % reporter) + failure.reporter = reporter + return failure def write(self, measurement): """ @@ -423,18 +430,36 @@ class Report(object): been written. """ l = [] - for reporter in self.reporters: - def writeReportEntry(result): - report_write_task = ReportEntry(reporter, measurement) + for reporter in self.reporters[:]: + report_write_task = ReportEntry(reporter, measurement) + def scheduleWriteReportEntry(result): self.reportEntryManager.schedule(report_write_task) - return report_write_task.done - - d = reporter.created.addBoth(writeReportEntry) - # Give up on writing to the reporter if the task fails X times - d.addErrback(self.failedOpeningReport, reporter) - l.append(d) - dl = defer.DeferredList(l) + # delay scheduling the task until after the report is created + log.debug("Adding report entry task %s" % report_write_task) + reporter.created.addCallback(scheduleWriteReportEntry) + + # if the write task fails n times, kill the reporter + report_write_task.done.addErrback(self.failedOpeningReport, reporter) + l.append(report_write_task.done) + + # XXX: This seems a bit fragile. + # failedOpeningReport will forward the errback if the remaining + # reporter has failed. If we fireOnOneErrback, this means that + # the caller of report.write is responsible for attaching an + # errback to the returned deferred and handle this case. That + # probably means stopping the net test. + + # Here, fireOnOneErrback means to call the deferredlists errback + # as soon as any of the deferreds return a failure. consumeErrors + # is used to prevent any uncaught failures from raising an + # exception. Alternately we could attach a logger to the errback + # of each deferred and it would have the same effect + + # Probably the better thing to do here would be to add a callback + # to the deferredlist that checks to see if any reporters are left + # and raise an exception if there are no remaining reporters + dl = defer.DeferredList(l,fireOnOneErrback=True, consumeErrors=True) return dl def close(self, _): @@ -447,7 +472,7 @@ class Report(object): """ l = [] - for reporter in self.reporters: + for reporter in self.reporters[:]: d = defer.maybeDeferred(reporter.finish) l.append(d) dl = defer.DeferredList(l)

1 0

[ooni-probe/master] Implement Report unit tests
by isis＠torproject.org 10 Mar '13

10 Mar '13

commit aca4ed4fde29d004cb466aa0288846dc9614b5f5 Author: aagbsn <aagbsn(a)extc.org> Date: Mon Feb 18 19:32:27 2013 +0100 Implement Report unit tests --- tests/mocks.py | 35 ++++++++-- tests/test_reporter.py | 169 +++++++++++++++++++++++++++++++++++++++++++---- 2 files changed, 182 insertions(+), 22 deletions(-) diff --git a/tests/mocks.py b/tests/mocks.py index c7feceb..fed683e 100644 --- a/tests/mocks.py +++ b/tests/mocks.py @@ -10,9 +10,9 @@ class MockMeasurementFailOnce(BaseTask): f.write('fail') f.close() if self.failure >= 1: - return defer.succeed() + return defer.succeed(self) else: - return defer.fail() + return defer.fail(failure.Failure) class MockMeasurementManager(TaskManager): def __init__(self): @@ -33,8 +33,7 @@ class MockReporter(object): pass def createReport(self): - self.created.callback(True) - return self.created + self.created.callback(self) def finish(self): pass @@ -93,7 +92,7 @@ class MockMeasurement(TaskWithTimeout): self.netTest = net_test def succeeded(self, result): - return self.netTest.succeeded(self) + return self.netTest.succeeded(42) class MockSuccessMeasurement(MockMeasurement): def run(self): @@ -126,13 +125,35 @@ class MockOReporter(object): self.created = defer.Deferred() def writeReportEntry(self, entry): - pass + return defer.succeed(42) def finish(self): pass def createReport(self): - pass + from ooni.utils import log + log.debug("Creating report with %s" % self) + self.created.callback(self) + +class MockOReporterThatFailsWrite(MockOReporter): + def writeReportEntry(self, entry): + raise MockFailure + +class MockOReporterThatFailsOpen(MockOReporter): + def createReport(self): + self.created.errback(failure.Failure(MockFailure())) + +class MockOReporterThatFailsWriteOnce(MockOReporter): + def __init__(self): + self.failure = 0 + MockOReporter.__init__(self) + + def writeReportEntry(self, entry): + if self.failure >= 1: + return defer.succeed(42) + else: + self.failure += 1 + raise MockFailure class MockTaskManager(TaskManager): def __init__(self): diff --git a/tests/test_reporter.py b/tests/test_reporter.py index e99debb..d2fcc4e 100644 --- a/tests/test_reporter.py +++ b/tests/test_reporter.py @@ -8,25 +8,164 @@ from ooni.nettest import NetTest, NetTestState from ooni.tasks import TaskWithTimeout from tests.mocks import MockOReporter, MockTaskManager from tests.mocks import MockMeasurement, MockNetTest +from tests.mocks import MockOReporterThatFailsWrite +from tests.mocks import MockOReporterThatFailsWriteOnce +from tests.mocks import MockOReporterThatFailsOpen -mockReportOptions = {'name':'foo_test', 'version': '0.1'} - -class MockState(NetTestState): - pass +from twisted.python import failure class TestReport(unittest.TestCase): def setUp(self): - self.taskManager = MockTaskManager() - self.report = Report([MockOReporter], self.taskManager) - self.state = MockState() + pass + def tearDown(self): + pass + def test_create_report_with_no_reporter(self): + report = Report([],ReportEntryManager()) + self.assertIsInstance(report, Report) + + def test_create_report_with_single_reporter(self): + report = Report([MockOReporter()], ReportEntryManager()) + self.assertIsInstance(report, Report) + + def test_create_report_with_multiple_reporters(self): + report = Report([MockOReporter() for x in xrange(3)], + ReportEntryManager()) + self.assertIsInstance(report, Report) + + def test_report_open_with_single_reporter(self): + report = Report([MockOReporter()],ReportEntryManager()) + d = report.open() + return d + + def test_report_open_with_multiple_reporter(self): + report = Report([MockOReporter() for x in xrange(3)], + ReportEntryManager()) + d = report.open() + return d + + def test_fail_to_open_report_with_single_reporter(self): + report = Report([MockOReporterThatFailsOpen()], + ReportEntryManager()) + d = report.open() + def f(x): + self.assertEquals(len(report.reporters), 0) + d.addCallback(f) + return d + + def test_fail_to_open_single_report_with_multiple_reporter(self): + report = Report([MockOReporterThatFailsOpen(), MockOReporter(), + MockOReporter()], ReportEntryManager()) + d = report.open() + def f(x): + self.assertEquals(len(report.reporters),2) + d.addCallback(f) + return d + + def test_fail_to_open_all_reports_with_multiple_reporter(self): + report = Report([MockOReporterThatFailsOpen() for x in xrange(3)], + ReportEntryManager()) + d = report.open() + def f(x): + self.assertEquals(len(report.reporters),0) + d.addCallback(f) + return d + + def test_write_report_with_single_reporter_and_succeed(self): + #XXX: verify that the MockOReporter writeReportEntry succeeds + report = Report([MockOReporter()], ReportEntryManager()) + report.open() + d = report.write(MockMeasurement(MockNetTest())) + return d + + def test_write_report_with_single_reporter_and_fail_after_timeout(self): + report = Report([MockOReporterThatFailsWrite()], ReportEntryManager()) + report.open() + d = report.write(MockMeasurement(MockNetTest())) + def f(err): + self.assertEquals(len(report.reporters),0) + d.addBoth(f) + return d + + def test_write_report_with_single_reporter_and_succeed_after_timeout(self): + report = Report([MockOReporterThatFailsWriteOnce()], ReportEntryManager()) + report.open() + d = report.write(MockMeasurement(MockNetTest())) + return d + + def test_write_report_with_multiple_reporter_and_succeed(self): + report = Report([MockOReporter() for x in xrange(3)], ReportEntryManager()) + report.open() + d = report.write(MockMeasurement(MockNetTest())) + return d + + def test_write_report_with_multiple_reporter_and_fail_a_single_reporter(self): + report = Report([MockOReporter(), MockOReporter(), MockOReporterThatFailsWrite()], ReportEntryManager()) + d = report.open() + + self.assertEquals(len(report.reporters),3) + d = report.write(MockMeasurement(MockNetTest())) + + def f(x): + # one of the reporters should have been removed + self.assertEquals(len(report.reporters), 2) + d.addBoth(f) + return d - def test_report_alltasksdone_callback_fires(self): - for m in range(10): - measurement = MockMeasurement(MockNetTest()) - self.report.write(measurement) + def test_write_report_with_multiple_reporter_and_fail_all_reporter(self): + report = Report([MockOReporterThatFailsWrite() for x in xrange(3)], ReportEntryManager()) + report.open() + d = report.write(MockMeasurement(MockNetTest())) + def f(err): + self.assertEquals(len(report.reporters),0) + d.addErrback(f) + return d - @self.report.done.addCallback - def done(reporters): - self.assertEqual(len(reporters), 1) +#class TestYAMLReporter(unittest.TestCase): +# def setUp(self): +# pass +# def tearDown(self): +# pass +# def test_create_yaml_reporter(self): +# raise NotImplementedError +# def test_open_yaml_report_and_succeed(self): +# raise NotImplementedError +# def test_open_yaml_report_and_fail(self): +# raise NotImplementedError +# def test_write_yaml_report_entry(self): +# raise NotImplementedError +# def test_write_multiple_yaml_report_entry(self): +# raise NotImplementedError +# def test_close_yaml_report(self): +# raise NotImplementedError +# def test_write_yaml_report_after_close(self): +# raise NotImplementedError +# def test_write_yaml_report_before_open(self): +# raise NotImplementedError +# def test_close_yaml_report_after_task_complete(self): +# raise NotImplementedError - return self.report.done +#class TestOONIBReporter(unittest.TestCase): +# def setUp(self): +# pass +# def tearDown(self): +# pass +# def test_create_oonib_reporter(self): +# raise NotImplementedError +# def test_open_oonib_report_and_succeed(self): +# raise NotImplementedError +# def test_open_oonib_report_and_fail(self): +# raise NotImplementedError +# def test_write_oonib_report_entry_and_succeed(self): +# raise NotImplementedError +# def test_write_oonib_report_entry_and_succeed_after_timeout(self): +# raise NotImplementedError +# def test_write_oonib_report_entry_and_fail_after_timeout(self): +# raise NotImplementedError +# def test_write_oonib_report_after_close(self): +# raise NotImplementedError +# def test_write_oonib_report_before_open(self): +# raise NotImplementedError +# def test_close_oonib_report_and_succeed(self): +# raise NotImplementedError +# def test_close_oonib_report_and_fail(self): +# raise NotImplementedError

1 0