Changeset 27098

Timestamp:

07/07/2009 07:20:40 PM (14 months ago)

Author:

thijs

Message:

Merge trial-tmp-marker-3481: Trial now drops a marker file into _trial_temp and
refuses to delete and re-create any directory that doesn't have the marker.

Author: jonathanj, thijs
Reviewer: glyph
Fixes: #3481

Location:

trunk/twisted/trial

Files:

• runner.py (modified) (7 diffs)
• test/test_runner.py (modified) (2 diffs)

trunk/twisted/trial/runner.py

@@ -1 +1 @@
 # -*- test-case-name: twisted.trial.test.test_runner -*-
-# Copyright (c) 2001-2008 Twisted Matrix Laboratories.
+# Copyright (c) 2001-2009 Twisted Matrix Laboratories.
 # See LICENSE for details.
 
@@ -10 +10 @@
 
 
-import pdb, shutil
+import pdb
 import os, types, warnings, sys, inspect, imp
 import random, doctest, time
 
-from twisted.python import reflect, log, failure, modules
+from twisted.python import reflect, log, failure, modules, filepath
 from twisted.python.util import dsu
 from twisted.python.compat import set
@@ -37 +37 @@
     A working directory was specified to the runner, but another test run is
     currently using that directory.
+    """
+
+
+
+class _NoTrialMarker(Exception):
+    """
+    No trial marker file could be found.
+
+    Raised when trial attempts to remove a trial temporary working directory
+    that does not contain a marker file.
     """
 
@@ -66 +76 @@
     """
     return os.path.abspath(filename1) == os.path.abspath(filename2)
+
 
 def filenameToModule(fn):
@@ -698 +709 @@
 
     def _removeSafely(self, path):
+        """
+        Safely remove a path, recursively.
+
+        If C{path} does not contain a node named C{_trial_marker}, a
+        L{_NoTrialmarker} exception is raised and the path is not removed.
+        """
+        if not path.child('_trial_marker').exists():
+            raise _NoTrialMarker(
+                '%r is not a trial temporary path, refusing to remove it'
+                % (path,))
+
         try:
-            shutil.rmtree(path)
+            path.remove()
         except OSError, e:
             print ("could not remove %r, caught OSError [Errno %s]: %s"
-                   % (path, e.errno,e.strerror))
+                   % (path, e.errno, e.strerror))
             try:
-                os.rename(path,
-                          os.path.abspath("_trial_temp_old%s"
-                                          % random.randint(0, 99999999)))
+                newPath = FilePath('_trial_temp_old%s'
+                                   % random.randint(0, 99999999))
+                path.moveTo(newPath)
             except OSError, e:
                 print ("could not rename path, caught OSError [Errno %s]: %s"
@@ -716 +738 @@
         self._tearDownLogFile()
         currentDir = os.getcwd()
-        base = os.path.normpath(os.path.abspath(self.workingDirectory))
+        base = filepath.FilePath(self.workingDirectory)
         counter = 0
         while True:
             if counter:
-                testdir = '%s-%d' % (base, counter)
+                testdir = base.sibling('%s-%d' % (base.basename(), counter))
             else:
                 testdir = base
 
-            self._testDirLock = FilesystemLock(testdir + '.lock')
+            self._testDirLock = FilesystemLock(testdir.path + '.lock')
             if self._testDirLock.lock():
                 # It is not in use
-                if os.path.exists(testdir):
+                if testdir.exists():
                     # It exists though - delete it
                     self._removeSafely(testdir)
@@ -738 +760 @@
                     raise _WorkingDirectoryBusy()
 
-        os.mkdir(testdir)
-        os.chdir(testdir)
+        testdir.makedirs()
+        os.chdir(testdir.path)
+        file('_trial_marker', 'w').close()
         return currentDir
 

trunk/twisted/trial/test/test_runner.py

@@ -1 @@
-# Copyright (c) 2005-2008 Twisted Matrix Laboratories.
+# Copyright (c) 2005-2009 Twisted Matrix Laboratories.
 # See LICENSE for details.
 #
@@ -476 +476 @@
         self.assertEqual(self.standardReport, result._calls)
         self.assertEqual(['runcall'], debugger._calls)
+
+
+    def test_noMarker(self):
+        """
+        Specifying a temp directory that does not have a trial marker results
+        in an exception and does not remove the specified directory.
+        """
+        tempPath = self.mktemp()
+        # Create our working directory outside of trial.
+        os.mkdir(tempPath)
+        self.parseOptions(['--temp-directory', tempPath,
+                           'twisted.trial.test.sample'])
+        myRunner = self.getRunner()
+        loader = runner.TestLoader()
+        suite = loader.loadByName('twisted.trial.test.sample', True)
+        self.assertRaises(runner._NoTrialMarker, myRunner.run, suite)
+        self.assertTrue(os.path.exists(tempPath))