Changeset 21138

Timestamp:

08/21/2007 12:42:40 PM (3 years ago)

Author:

therve

Message:

Merge trial-memory-2275

Author: therve
Reviewers: jml, exarkun
Fixes #2275

Add two optmizations to trial to reduce its memory footprint: add a new
DestructiveTestSuite, used by default, that don't keep a reference to test
instances after run, and replace the storage of successfull result by a counter.
This allows the garbage collector to clean a lot of objects, and also speed up
the whole suite.

Location:

trunk/twisted

Files:

• scripts/trial.py (modified) (2 diffs)
• trial/reporter.py (modified) (5 diffs)
• trial/runner.py (modified) (4 diffs)
• trial/test/test_doctest.py (modified) (1 diff)
• trial/test/test_runner.py (modified) (3 diffs)
• trial/test/test_script.py (modified) (4 diffs)
• trial/test/test_tests.py (modified) (3 diffs)

trunk/twisted/scripts/trial.py

@@ -1 +1 @@
 # -*- test-case-name: twisted.trial.test.test_script -*-
 
-# Copyright (c) 2001-2004 Twisted Matrix Laboratories.
+# Copyright (c) 2001-2007 Twisted Matrix Laboratories.
 # See LICENSE for details.
 
@@ -311 +311 @@
     if config['force-gc']:
         loader.forceGarbageCollection = True
+    if not config['until-failure']:
+        loader.suiteFactory = runner.DestructiveTestSuite
     return loader
 

trunk/twisted/trial/reporter.py

@@ -1 +1 @@
 # -*- test-case-name: twisted.trial.test.test_reporter -*-
 #
-# Copyright (c) 2001-2004 Twisted Matrix Laboratories.
+# Copyright (c) 2001-2007 Twisted Matrix Laboratories.
 # See LICENSE for details.
 #
 # Maintainer: Jonathan Lange <jml@twistedmatrix.com>
 
-"""Defines classes that handle the results of tests.
+"""
+Defines classes that handle the results of tests.
 
 API Stability: Unstable
@@ -45 +46 @@
 
 class TestResult(pyunit.TestResult, object):
-    """Accumulates the results of several L{twisted.trial.unittest.TestCase}s.
+    """
+    Accumulates the results of several L{twisted.trial.unittest.TestCase}s.
+
+    @ivar successes: count the number of successes achieved by the test run.
+    @type successes: C{int}
     """
 
@@ -53 +58 @@
         self.expectedFailures = []
         self.unexpectedSuccesses = []
-        self.successes = []
+        self.successes = 0
         self._timings = []
 
@@ -145 +150 @@
         @type test: L{pyunit.TestCase}
         """
-        self.successes.append((test,))
+        self.successes += 1
 
     def upDownError(self, method, error, warn, printStatus):
@@ -311 +316 @@
         summaries = []
         for stat in ("skips", "expectedFailures", "failures", "errors",
-                     "unexpectedSuccesses", "successes"):
+                     "unexpectedSuccesses"):
             num = len(getattr(self, stat))
             if num:
                 summaries.append('%s=%d' % (stat, num))
+        if self.successes:
+           summaries.append('successes=%d' % (self.successes,))
         summary = (summaries and ' ('+', '.join(summaries)+')') or ''
         if not self.wasSuccessful():

trunk/twisted/trial/runner.py

@@ -12 +12 @@
 
 
-from __future__ import generators
 import pdb, shutil, sets
 import os, types, warnings, sys, inspect, imp
@@ -127 +126 @@
 
 
+
 class TestSuite(pyunit.TestSuite):
     """
@@ -147 +147 @@
             if result.shouldStop:
                 break
+            test(result)
+        return result
+
+
+
+class DestructiveTestSuite(TestSuite):
+    """
+    A test suite which remove the tests once run, to minimize memory usage.
+    """
+
+    def run(self, result):
+        """
+        Almost the same as L{TestSuite.run}, but with C{self._tests} being
+        empty at the end.
+        """
+        while self._tests:
+            if result.shouldStop:
+                break
+            test = self._tests.pop(0)
             test(result)
         return result
@@ -820 +839 @@
                 break
         return result
+

trunk/twisted/trial/test/test_doctest.py

@@ -35 +35 @@
         result = reporter.TestResult()
         suite.run(result)
-        self.assertEqual(5, len(result.successes))
+        self.assertEqual(5, result.successes)
         # doctest reports failures as errors in 2.3
         self.assertEqual(2, len(result.errors) + len(result.failures))

trunk/twisted/trial/test/test_runner.py

@@ -1 @@
-# -*- test-case-name: twisted.trial.test.test_runner -*-
-
 # Copyright (c) 2005-2007 Twisted Matrix Laboratories.
 # See LICENSE for details.
@@ -464 +462 @@
         self.holder = runner.ErrorHolder(self.description, error)
 
+
+
 class TestMalformedMethod(unittest.TestCase):
     """
@@ -508 +508 @@
         self._test('test_spam')
 
+
+
+class DestructiveTestSuiteTestCase(unittest.TestCase):
+    """
+    Test for L{runner.DestructiveTestSuite}.
+    """
+
+    def test_basic(self):
+        """
+        Thes destructive test suite should run the tests normally.
+        """
+        called = []
+        class MockTest(unittest.TestCase):
+            def test_foo(test):
+                called.append(True)
+        test = MockTest('test_foo')
+        result = reporter.TestResult()
+        suite = runner.DestructiveTestSuite([test])
+        self.assertEquals(called, [])
+        suite.run(result)
+        self.assertEquals(called, [True])
+        self.assertEquals(suite.countTestCases(), 0)
+
+
+    def test_shouldStop(self):
+        """
+        Test the C{shouldStop} management: raising a C{KeyboardInterrupt} must
+        interrupt the suite.
+        """
+        called = []
+        class MockTest(unittest.TestCase):
+            def test_foo1(test):
+                called.append(1)
+            def test_foo2(test):
+                raise KeyboardInterrupt()
+            def test_foo3(test):
+                called.append(2)
+        result = reporter.TestResult()
+        loader = runner.TestLoader()
+        loader.suiteFactory = runner.DestructiveTestSuite
+        suite = loader.loadClass(MockTest)
+        self.assertEquals(called, [])
+        suite.run(result)
+        self.assertEquals(called, [1])
+        # The last test shouldn't have been run
+        self.assertEquals(suite.countTestCases(), 1)
+
+
+    def test_cleanup(self):
+        """
+        Checks that the test suite cleanups its tests during the run, so that
+        it ends empty.
+        """
+        class MockTest(unittest.TestCase):
+            def test_foo(test):
+                pass
+        test = MockTest('test_foo')
+        result = reporter.TestResult()
+        suite = runner.DestructiveTestSuite([test])
+        self.assertEquals(suite.countTestCases(), 1)
+        suite.run(result)
+        self.assertEquals(suite.countTestCases(), 0)
+

trunk/twisted/trial/test/test_script.py

@@ +1 @@
+# Copyright (c) 2001-2007 Twisted Matrix Laboratories.
+# See LICENSE for details.
+
 import StringIO, sys, sets
 from twisted.trial import unittest, runner
@@ -33 +36 @@
         loader = trial._getLoader(self.config)
         self.assertEqual(False, loader.forceGarbageCollection)
+
+
+
+class TestSuiteUsed(unittest.TestCase):
+    """
+    Check the category of tests suite used by the loader.
+    """
+
+    def setUp(self):
+        """
+        Create a trial configuration object.
+        """
+        self.config = trial.Options()
+
+
+    def test_defaultSuite(self):
+        """
+        By default, the loader should use L{runner.DestructiveTestSuite}
+        """
+        loader = trial._getLoader(self.config)
+        self.assertEquals(loader.suiteFactory, runner.DestructiveTestSuite)
+
+
+    def test_untilFailureSuite(self):
+        """
+        The C{until-failure} configuration uses the L{runner.TestSuite} to keep
+        instances alive across runs.
+        """
+        self.config['until-failure'] = True
+        loader = trial._getLoader(self.config)
+        self.assertEquals(loader.suiteFactory, runner.TestSuite)
+
 
 
@@ -162 +197 @@
                               'twisted.trial.test.test_tests'},
                              localVars)
-        
+
     def test_parseLocalVariables(self):
-        declaration = ('-*- test-case-name: twisted.trial.test.test_tests; ' 
+        declaration = ('-*- test-case-name: twisted.trial.test.test_tests; '
                        'foo: bar -*-')
         localVars = trial._parseLocalVariables(declaration)
@@ -197 +232 @@
                               'twisted.trial.test.test_test_visitor'},
                              localVars)
-        
+
     def test_noVariablesInFile(self):
         localVars = trial.loadLocalVariables(sibpath('novars.py'))

trunk/twisted/trial/test/test_tests.py

@@ -6 +6 @@
 """
 
-import gc, StringIO, sys
+import gc, StringIO, sys, weakref
 
 from twisted.internet import defer, reactor
@@ -48 +48 @@
 
     def assertSuccessful(self, test, result):
-        self.assertEqual(result.successes,  [(test,)])
+        self.assertEqual(result.successes, 1)
         self.assertEqual(result.failures, [])
         self.assertEqual(result.errors, [])
@@ -74 +74 @@
         test.run(self.result)
         self.assertSuccessful(test, self.result)
+
+
+    def test_noReference(self):
+        """
+        Test that no reference is kept on a successful test.
+        """
+        test = TestSuccess('test_successful')
+        ref = weakref.ref(test)
+        test.run(self.result)
+        self.assertSuccessful(test, self.result)
+        del test
+        gc.collect()
+        self.assertIdentical(ref(), None)