[tor-commits] [ooni-probe/master] Outline the Measurements and NetTest classes (#7852)

[isis at torproject.org]

commit f55e52c2b851f386ca3a040590f0f615d237b59e
Author: Arturo Filastò <art at fuffa.org>
Date:   Thu Jan 10 16:16:40 2013 +0100

    Outline the Measurements and NetTest classes (#7852)
    
    These wrap the NetTestCase and implement the failure and retry logic.
    NetTest is responsible for loading the test classes and methods.
    Measurement is responsible for bundling sets of test classes, methods
    and inputs.
---
 ooni/measurements.py |  116 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 116 insertions(+), 0 deletions(-)

diff --git a/ooni/measurements.py b/ooni/measurements.py
new file mode 100644
index 0000000..81338c0
--- /dev/null
+++ b/ooni/measurements.py
@@ -0,0 +1,116 @@
+from .tasks import TaskWithTimeout
+
+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):
+        pass
+
+    def timedOut(self):
+        self.net_test.measurementTimeOut()
+
+    def run(self):
+        d = defer.maybeDeferred(self.test)
+        d.addCallback(self.success)
+        d.addErrback(self.failure)
+        return d
+
+class NetTest(object):
+    manager = None
+
+    def __init__(self, net_test_file, inputs, options):
+        """
+        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
+
+        self.rateLimiter = StaticRateLimiter()
+
+    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 measurementTimedOut(self, measurement):
+        """
+        This gets called when a measurement has timed out. This may or may not
+        trigger a retry inside of MeasurementsTracker.
+        """
+        self.manager.measurementTimedOut(measurement)
+        self.rateLimiter.timedOut(measurement)
+
+    def measurementFailed(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.manager.writeFailure(measurement, failure)
+
+    def measurementSucceeded(self, measurement):
+        """
+        This gets called when a measurement has failed.
+        """
+        self.manager.writeReport(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
+