Merge lp:~lifeless/testtools/time into lp:~testtools-committers/testtools/trunk

[Robert Collins]

[Robert Collins (lifeless)]

This rounds out some existing time support and doing so makes TextTestResult easier to write and test.

[Jonathan Lange (jml)]

Hey Rob,

This patch looks clean and potentially useful. Thanks for explaining possible uses in the docs for time().

jml

review: Approve

=== modified file 'MANUAL'
--- MANUAL	2009-11-20 09:25:20 +0000
+++ MANUAL	2009-11-20 09:25:20 +0000
@@ -116,6 +116,14 @@
 exists. It is used as a hook point to allow clean disconnection of network
 resources and similar concerns.
 
+TestResult.time
+~~~~~~~~~~~~~~~
+
+This method controls the time used by a TestResult, permitting accurate
+timing of test results gathered on different machines or in different threads.
+See pydoc testtools.TestResult.time for more details.
+
+
 ThreadsafeForwardingResult
 ~~~~~~~~~~~~~~~~~~~~~~~~~~
 

=== modified file 'testtools/testresult.py'
--- testtools/testresult.py	2009-11-17 08:35:36 +0000
+++ testtools/testresult.py	2009-11-20 09:25:20 +0000
@@ -10,6 +10,7 @@
     'ThreadsafeForwardingResult',
     ]
 
+import datetime
 import unittest
 
 
@@ -33,6 +34,7 @@
     def __init__(self):
         super(TestResult, self).__init__()
         self.skip_reasons = {}
+        self.__now = None
         # -- Start: As per python 2.7 --
         self.expectedFailures = []
         self.unexpectedSuccesses = []
@@ -109,6 +111,18 @@
             return self._exc_info_to_string(err, test)
         return _details_to_str(details)
 
+    def _now(self):
+        """Return the current 'test time'.
+        
+        If the time() method has not been called, this is equivalent to
+        datetime.now(), otherwise its the last supplied datestamp given to the
+        time() method.
+        """
+        if self.__now is None:
+            return datetime.datetime.now()
+        else:
+            return self.__now
+
     def startTestRun(self):
         """Called before a test run starts.
 
@@ -121,6 +135,21 @@
         New in python 2.7
         """
 
+    def time(self, a_datetime):
+        """Provide a timestamp to represent the current time.
+
+        This is useful when test activity is time delayed, or happening
+        concurrently and getting the system time between API calls will not
+        accurately represent the duration of tests (or the whole run).
+
+        Calling time() sets the datetime used by the TestResult object. 
+        Time is permitted to go backwards when using this call.
+
+        :param a_datetime: A datetime.datetime object with TZ information or
+            None to reset the TestResult to gathering time from the system.
+        """
+        self.__now = a_datetime
+
     def done(self):
         """Called when the test runner is done.
         

=== modified file 'testtools/tests/test_testresult.py'
--- testtools/tests/test_testresult.py	2009-10-31 10:45:26 +0000
+++ testtools/tests/test_testresult.py	2009-11-20 09:25:20 +0000
@@ -4,6 +4,7 @@
 
 __metaclass__ = type
 
+import datetime
 import sys
 import threading
 
@@ -13,6 +14,7 @@
     TestCase,
     TestResult,
     ThreadsafeForwardingResult,
+    testresult,
     )
 from testtools.content import Content, ContentType
 from testtools.tests.helpers import (
@@ -120,6 +122,32 @@
             u"Skipped for another reason":[self]},
             result.skip_reasons)
 
+    def test_now_datetime_now(self):
+        result = self.makeResult()
+        olddatetime = testresult.datetime
+        def restore():
+            testresult.datetime = olddatetime
+        self.addCleanup(restore)
+        class Module:
+            pass
+        now = datetime.datetime.now()
+        stubdatetime = Module()
+        stubdatetime.datetime = Module()
+        stubdatetime.datetime.now = lambda:now
+        testresult.datetime = stubdatetime
+        self.assertEqual(now, result._now())
+        # Set an explicit datetime, then go back to looking it up.
+        result.time(datetime.datetime.now())
+        self.assertNotEqual(now, result._now())
+        result.time(None)
+        self.assertEqual(now, result._now())
+
+    def test_now_datetime_time(self):
+        result = self.makeResult()
+        now = datetime.datetime.now()
+        result.time(now)
+        self.assertEqual(now, result._now())
+
 
 class TestWithFakeExceptions(TestCase):