Issue 2152: Fix the ability of --clean to handle / delete broken
authorstevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Mon, 23 Feb 2009 14:55:04 +0000 (14:55 +0000)
committerstevenknight <stevenknight@fdb21ef1-2011-0410-befe-b5e4ea1792b1>
Mon, 23 Feb 2009 14:55:04 +0000 (14:55 +0000)
symlinks, as well as named pipes.  (Mateusz Gruca)

git-svn-id: http://scons.tigris.org/svn/scons/trunk@4040 fdb21ef1-2011-0410-befe-b5e4ea1792b1

src/CHANGES.txt
src/engine/SCons/Script/Main.py
src/engine/SCons/compat/__init__.py
test/Clean/Option.py [new file with mode: 0644]
test/Clean/basic.py [moved from test/option-c.py with 61% similarity]
test/Clean/function.py [new file with mode: 0644]
test/Clean/mkfifo.py [new file with mode: 0644]
test/Clean/symlinks.py [new file with mode: 0644]

index de5cce8c37825da53c2ae8941402a9daab7ecbbc..0480a0e87fc7ca1fd171f0470c4ac58b5d0289d8 100644 (file)
@@ -32,6 +32,10 @@ RELEASE X.X.X - XXX
     - Set IncludeSearchPath and PreprocessorDefinitions in generated
       Visual Studio 8 project files, to help IntelliSense work.
 
+  From Mateusz Gruca:
+
+    - Fix deletion of broken symlinks by the --clean option.
+
   From Steven Knight:
 
     - Fix the error message when use of a non-existent drive on Windows
index cad241f0dfe84c328bc523efab5015e921751497..883af409c1e3b19979273035c1bb90039e13fcb6 100644 (file)
@@ -305,8 +305,8 @@ class CleanTask(SCons.Taskmaster.AlwaysTask):
     """An SCons clean task."""
     def fs_delete(self, path, pathstr, remove=1):
         try:
-            if os.path.exists(path):
-                if os.path.isfile(path):
+            if os.path.lexists(path):
+                if os.path.isfile(path) or os.path.islink(path):
                     if remove: os.unlink(path)
                     display("Removed " + pathstr)
                 elif os.path.isdir(path) and not os.path.islink(path):
@@ -326,6 +326,11 @@ class CleanTask(SCons.Taskmaster.AlwaysTask):
                     # then delete dir itself
                     if remove: os.rmdir(path)
                     display("Removed directory " + pathstr)
+                else:
+                    errstr = "Path '%s' exists but isn't a file or directory."
+                    raise SCons.Errors.UserError(errstr % (pathstr))
+        except SCons.Errors.UserError, e:
+            print e
         except (IOError, OSError), e:
             print "scons: Could not remove '%s':" % pathstr, e.strerror
 
index 542d31e5f9c9afe74cdc68d95966127e14fccb8b..2a86324269496f3e8b358a7d6834fd9ae2934527 100644 (file)
@@ -167,6 +167,13 @@ except AttributeError:
     elif 'nt' in _names:
         os.devnull = 'nul'
     os.path.devnull = os.devnull
+try:
+    os.path.lexists
+except AttributeError:
+    # Pre-2.4 Python has no os.path.lexists function
+    def lexists(path):
+        return os.path.exists(path) or os.path.islink(path)
+    os.path.lexists = lexists
 
 import shlex
 try:
diff --git a/test/Clean/Option.py b/test/Clean/Option.py
new file mode 100644 (file)
index 0000000..6264428
--- /dev/null
@@ -0,0 +1,86 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that {Set,Get}Option('clean') works correctly to control
+cleaning behavior.
+"""
+
+import os
+
+import TestSCons
+
+_python_ = TestSCons._python_
+
+test = TestSCons.TestSCons()
+
+test.write('build.py', r"""
+import sys
+contents = open(sys.argv[2], 'rb').read()
+file = open(sys.argv[1], 'wb')
+file.write(contents)
+file.close()
+""")
+
+test.write('SConstruct', """
+B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
+env = Environment(BUILDERS = { 'B' : B })
+env.B(target = 'foo.out', source = 'foo.in')
+
+mode = ARGUMENTS.get('MODE')
+if mode == 'not':
+    assert not GetOption('clean')
+if mode == 'set-zero':
+    assert GetOption('clean')
+    SetOption('clean', 0)
+    assert GetOption('clean')
+if mode == 'set-one':
+    assert not GetOption('clean')
+    SetOption('clean', 1)
+    assert GetOption('clean')
+""" % locals())
+
+test.write('foo.in', '"Foo", I say!\n')
+
+test.run(arguments='foo.out MODE=not')
+test.must_match(test.workpath('foo.out'), '"Foo", I say!\n')
+
+test.run(arguments='-c foo.out MODE=set-zero')
+test.must_not_exist(test.workpath('foo.out'))
+
+test.run(arguments='foo.out MODE=none')
+test.must_match(test.workpath('foo.out'), '"Foo", I say!\n')
+
+test.run(arguments='foo.out MODE=set-one')
+test.must_not_exist(test.workpath('foo.out'))
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
similarity index 61%
rename from test/option-c.py
rename to test/Clean/basic.py
index e71c7c2bfdd49e1601fc6fb5999a285d23f46404..74e7711c4f6a42ad488d533da14db619ec6fabc0 100644 (file)
@@ -25,7 +25,7 @@
 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
 
 """
-Test various uses of the -c (clean) option.
+Test various basic uses of the -c (clean) option.
 """
 
 import os
@@ -177,144 +177,8 @@ test.must_match(test.workpath('foo4.out'), "foo4.in\n")
 test.must_exist(test.workpath('touch1.out'))
 test.must_exist(test.workpath('touch2.out'))
 
-
-expect1 = "scons: Could not remove 'foo1.out': Permission denied\n"
-expect2 = "scons: Could not remove 'foo1.out': The process cannot access the file because it is being used by another process\n"
-
-expect = [
-    test.wrap_stdout(expect1, cleaning=1),
-    test.wrap_stdout(expect2, cleaning=1),
-]
-
-test.writable('.', 0)
-f = open(test.workpath('foo1.out'))
-test.run(arguments = '-c foo1.out')
-stdout = test.stdout()
-matched = None
-for e in expect:
-    if stdout == e:
-        matched = 1
-        break
-if not matched:
-    print stdout
-    test.fail_test()
-test.must_exist(test.workpath('foo1.out'))
-f.close()
-test.writable('.', 1)
-
-test.subdir('subd')
-test.write(['subd', 'foon.in'], "foon.in\n")
-test.write(['subd', 'foox.in'], "foox.in\n")
-test.write('aux1.x', "aux1.x\n")
-test.write('aux2.x', "aux2.x\n")
-test.write('SConstruct', """
-B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
-env = Environment(BUILDERS = { 'B' : B }, FOO = 'foo2')
-env.B(target = 'foo1.out', source = 'foo1.in')
-env.B(target = 'foo2.out', source = 'foo2.xxx')
-foo2_xxx = env.B(target = 'foo2.xxx', source = 'foo2.in')
-env.B(target = 'foo3.out', source = 'foo3.in')
-SConscript('subd/SConscript')
-Clean(foo2_xxx, ['aux1.x'])
-env.Clean(['${FOO}.xxx'], ['aux2.x'])
-Clean('.', ['subd'])
-""" % locals())
-
-test.write(['subd', 'SConscript'], """
-Clean('.', 'foox.in')
-""")
-
-expect = test.wrap_stdout("""Removed foo2.xxx
-Removed aux1.x
-Removed aux2.x
-""", cleaning=1)
-test.run(arguments = '-c foo2.xxx', stdout=expect)
-test.must_match(test.workpath('foo1.out'), "foo1.in\n")
-test.must_not_exist(test.workpath('foo2.xxx'))
-test.must_match(test.workpath('foo2.out'), "foo2.in\n")
-test.must_match(test.workpath('foo3.out'), "foo3.in\n")
-
-expect = test.wrap_stdout("Removed %s\n" % os.path.join('subd', 'foox.in'),
-                          cleaning = 1)
-test.run(arguments = '-c subd', stdout=expect)
-test.must_not_exist(test.workpath('foox.in'))
-
-expect = test.wrap_stdout("""Removed foo1.out
-Removed foo2.xxx
-Removed foo2.out
-Removed foo3.out
-Removed %s
-Removed %s
-Removed directory subd
-""" % (os.path.join('subd','SConscript'), os.path.join('subd', 'foon.in')),
-                          cleaning = 1)
-test.run(arguments = '-c -n .', stdout=expect)
-
-expect = test.wrap_stdout("""Removed foo1.out
-Removed foo2.out
-Removed foo3.out
-Removed %s
-Removed %s
-Removed directory subd
-""" % (os.path.join('subd','SConscript'), os.path.join('subd', 'foon.in')),
-                          cleaning = 1)
-test.run(arguments = '-c .', stdout=expect)
-test.must_not_exist(test.workpath('subdir', 'foon.in'))
-test.must_not_exist(test.workpath('subdir'))
-
-
-# Ensure that Set/GetOption('clean') works correctly:
-test.write('SConstruct', """
-B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
-env = Environment(BUILDERS = { 'B' : B })
-env.B(target = 'foo.out', source = 'foo.in')
-
-assert not GetOption('clean')
-""" % locals())
-
-test.write('foo.in', '"Foo", I say!\n')
-
-test.run(arguments='foo.out')
-test.must_match(test.workpath('foo.out'), '"Foo", I say!\n')
-
-test.write('SConstruct', """
-B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
-env = Environment(BUILDERS = { 'B' : B })
-env.B(target = 'foo.out', source = 'foo.in')
-
-assert GetOption('clean')
-SetOption('clean', 0)
-assert GetOption('clean')
-""" % locals())
-
-test.run(arguments='-c foo.out')
-test.must_not_exist(test.workpath('foo.out'))
-
-test.write('SConstruct', """
-B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
-env = Environment(BUILDERS = { 'B' : B })
-env.B(target = 'foo.out', source = 'foo.in')
-""" % locals())
-
-test.run(arguments='foo.out')
-test.must_match(test.workpath('foo.out'), '"Foo", I say!\n')
-
-test.write('SConstruct', """
-B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
-env = Environment(BUILDERS = { 'B' : B })
-env.B(target = 'foo.out', source = 'foo.in')
-
-assert not GetOption('clean')
-SetOption('clean', 1)
-assert GetOption('clean')
-""" % locals())
-
-test.run(arguments='foo.out')
-test.must_not_exist(test.workpath('foo.out'))
-
 test.pass_test()
 
-
 # Local Variables:
 # tab-width:4
 # indent-tabs-mode:nil
diff --git a/test/Clean/function.py b/test/Clean/function.py
new file mode 100644 (file)
index 0000000..aa53a35
--- /dev/null
@@ -0,0 +1,121 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify use of the Clean() function.
+"""
+
+import os
+
+import TestSCons
+
+_python_ = TestSCons._python_
+
+test = TestSCons.TestSCons()
+
+test.write('build.py', r"""
+import sys
+contents = open(sys.argv[2], 'rb').read()
+file = open(sys.argv[1], 'wb')
+file.write(contents)
+file.close()
+""")
+
+test.subdir('subd')
+
+subd_SConscript = os.path.join('subd', 'SConscript')
+subd_foon_in = os.path.join('subd', 'foon.in')
+subd_foox_in = os.path.join('subd', 'foox.in')
+
+test.write('SConstruct', """
+B = Builder(action = r'%(_python_)s build.py $TARGETS $SOURCES')
+env = Environment(BUILDERS = { 'B' : B }, FOO = 'foo2')
+env.B(target = 'foo1.out', source = 'foo1.in')
+env.B(target = 'foo2.out', source = 'foo2.xxx')
+foo2_xxx = env.B(target = 'foo2.xxx', source = 'foo2.in')
+env.B(target = 'foo3.out', source = 'foo3.in')
+SConscript('subd/SConscript')
+Clean(foo2_xxx, ['aux1.x'])
+env.Clean(['${FOO}.xxx'], ['aux2.x'])
+Clean('.', ['subd'])
+""" % locals())
+
+test.write(['subd', 'SConscript'], """
+Clean('.', 'foox.in')
+""")
+
+test.write('foo1.in', "foo1.in\n")
+test.write('foo2.in', "foo2.in\n")
+test.write('foo3.in', "foo3.in\n")
+test.write(['subd', 'foon.in'], "foon.in\n")
+test.write(['subd', 'foox.in'], "foox.in\n")
+test.write('aux1.x', "aux1.x\n")
+test.write('aux2.x', "aux2.x\n")
+
+test.run()
+
+expect = test.wrap_stdout("""Removed foo2.xxx
+Removed aux1.x
+Removed aux2.x
+""", cleaning=1)
+test.run(arguments = '-c foo2.xxx', stdout=expect)
+test.must_match(test.workpath('foo1.out'), "foo1.in\n")
+test.must_not_exist(test.workpath('foo2.xxx'))
+test.must_match(test.workpath('foo2.out'), "foo2.in\n")
+test.must_match(test.workpath('foo3.out'), "foo3.in\n")
+
+expect = test.wrap_stdout("Removed %s\n" % subd_foox_in, cleaning = 1)
+test.run(arguments = '-c subd', stdout=expect)
+test.must_not_exist(test.workpath('foox.in'))
+
+expect = test.wrap_stdout("""Removed foo1.out
+Removed foo2.xxx
+Removed foo2.out
+Removed foo3.out
+Removed %(subd_SConscript)s
+Removed %(subd_foon_in)s
+Removed directory subd
+""" % locals(), cleaning = 1)
+test.run(arguments = '-c -n .', stdout=expect)
+
+expect = test.wrap_stdout("""Removed foo1.out
+Removed foo2.out
+Removed foo3.out
+Removed %(subd_SConscript)s
+Removed %(subd_foon_in)s
+Removed directory subd
+""" % locals(), cleaning = 1)
+test.run(arguments = '-c .', stdout=expect)
+test.must_not_exist(test.workpath('subdir', 'foon.in'))
+test.must_not_exist(test.workpath('subdir'))
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
diff --git a/test/Clean/mkfifo.py b/test/Clean/mkfifo.py
new file mode 100644 (file)
index 0000000..4cdb8fa
--- /dev/null
@@ -0,0 +1,67 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify that SCons reports an error when cleaning up a target directory
+containing a named pipe created with o.mkfifo().
+"""
+
+import os
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+if not hasattr(os, 'mkfifo'):
+    test.skip_test('No os.mkfifo() function; skipping test\n')
+
+test.write('SConstruct', """\
+Execute(Mkdir("testdir"))
+dir = Dir("testdir")
+Clean(dir, 'testdir')
+""")
+
+test.run(arguments='-Q -q', stdout='Mkdir("testdir")\n')
+
+os.mkfifo('testdir/namedpipe')
+
+expect = """\
+Mkdir("testdir")
+Path '%s' exists but isn't a file or directory.
+scons: Could not remove 'testdir': Directory not empty
+""" % os.path.join('testdir', 'namedpipe')
+
+test.run(arguments='-c -Q -q', stdout=expect)
+test.must_exist(test.workpath('testdir/namedpipe'))
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4:
diff --git a/test/Clean/symlinks.py b/test/Clean/symlinks.py
new file mode 100644 (file)
index 0000000..142398d
--- /dev/null
@@ -0,0 +1,64 @@
+#!/usr/bin/env python
+#
+# __COPYRIGHT__
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be included
+# in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+#
+
+__revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
+
+"""
+Verify correct deletion of broken symlinks.
+"""
+
+import os
+
+import TestSCons
+
+test = TestSCons.TestSCons()
+
+if not hasattr(os, 'symlink'):
+    test.skip_test('No os.symlink() function; skipping test\n')
+
+test.write('SConstruct', """\
+Execute(Mkdir("testdir"))
+dir = Dir("testdir")
+Clean(dir, 'testdir')
+""")
+
+test.run(arguments = '-Q -q', stdout='Mkdir("testdir")\n')
+
+os.symlink('testdir/symlinksrc', 'testdir/symlinkdst')
+
+expect = """\
+Mkdir("testdir")
+Removed %s
+Removed directory testdir
+""" % os.path.join('testdir', 'symlinkdst')
+
+test.run(arguments = '-c -Q -q', stdout=expect)
+
+test.pass_test()
+
+# Local Variables:
+# tab-width:4
+# indent-tabs-mode:nil
+# End:
+# vim: set expandtab tabstop=4 shiftwidth=4: