bpo-9949: Enable symlink traversal for ntpath.realpath (GH-15287)
diff --git a/Lib/test/test_ntpath.py b/Lib/test/test_ntpath.py
index 92d85ec..74dc8c3 100644
--- a/Lib/test/test_ntpath.py
+++ b/Lib/test/test_ntpath.py
@@ -7,6 +7,7 @@
from test import support, test_genericpath
from tempfile import TemporaryFile
+
try:
import nt
except ImportError:
@@ -14,6 +15,14 @@
# but for those that require it we import here.
nt = None
+try:
+ ntpath._getfinalpathname
+except AttributeError:
+ HAVE_GETFINALPATHNAME = False
+else:
+ HAVE_GETFINALPATHNAME = True
+
+
def tester(fn, wantResult):
fn = fn.replace("\\", "\\\\")
gotResult = eval(fn)
@@ -194,6 +203,189 @@
tester("ntpath.normpath('\\\\.\\NUL')", r'\\.\NUL')
tester("ntpath.normpath('\\\\?\\D:/XY\\Z')", r'\\?\D:/XY\Z')
+ def test_realpath_curdir(self):
+ expected = ntpath.normpath(os.getcwd())
+ tester("ntpath.realpath('.')", expected)
+ tester("ntpath.realpath('./.')", expected)
+ tester("ntpath.realpath('/'.join(['.'] * 100))", expected)
+ tester("ntpath.realpath('.\\.')", expected)
+ tester("ntpath.realpath('\\'.join(['.'] * 100))", expected)
+
+ def test_realpath_pardir(self):
+ expected = ntpath.normpath(os.getcwd())
+ tester("ntpath.realpath('..')", ntpath.dirname(expected))
+ tester("ntpath.realpath('../..')",
+ ntpath.dirname(ntpath.dirname(expected)))
+ tester("ntpath.realpath('/'.join(['..'] * 50))",
+ ntpath.splitdrive(expected)[0] + '\\')
+ tester("ntpath.realpath('..\\..')",
+ ntpath.dirname(ntpath.dirname(expected)))
+ tester("ntpath.realpath('\\'.join(['..'] * 50))",
+ ntpath.splitdrive(expected)[0] + '\\')
+
+ @support.skip_unless_symlink
+ @unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
+ def test_realpath_basic(self):
+ ABSTFN = ntpath.abspath(support.TESTFN)
+ open(ABSTFN, "wb").close()
+ self.addCleanup(support.unlink, ABSTFN)
+ self.addCleanup(support.unlink, ABSTFN + "1")
+
+ os.symlink(ABSTFN, ABSTFN + "1")
+ self.assertEqual(ntpath.realpath(ABSTFN + "1"), ABSTFN)
+ self.assertEqual(ntpath.realpath(os.fsencode(ABSTFN + "1")),
+ os.fsencode(ABSTFN))
+
+ @support.skip_unless_symlink
+ @unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
+ def test_realpath_relative(self):
+ ABSTFN = ntpath.abspath(support.TESTFN)
+ open(ABSTFN, "wb").close()
+ self.addCleanup(support.unlink, ABSTFN)
+ self.addCleanup(support.unlink, ABSTFN + "1")
+
+ os.symlink(ABSTFN, ntpath.relpath(ABSTFN + "1"))
+ self.assertEqual(ntpath.realpath(ABSTFN + "1"), ABSTFN)
+
+ @support.skip_unless_symlink
+ @unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
+ def test_realpath_broken_symlinks(self):
+ ABSTFN = ntpath.abspath(support.TESTFN)
+ os.mkdir(ABSTFN)
+ self.addCleanup(support.rmtree, ABSTFN)
+
+ with support.change_cwd(ABSTFN):
+ os.mkdir("subdir")
+ os.chdir("subdir")
+ os.symlink(".", "recursive")
+ os.symlink("..", "parent")
+ os.chdir("..")
+ os.symlink(".", "self")
+ os.symlink("missing", "broken")
+ os.symlink(r"broken\bar", "broken1")
+ os.symlink(r"self\self\broken", "broken2")
+ os.symlink(r"subdir\parent\subdir\parent\broken", "broken3")
+ os.symlink(ABSTFN + r"\broken", "broken4")
+ os.symlink(r"recursive\..\broken", "broken5")
+
+ self.assertEqual(ntpath.realpath("broken"),
+ ABSTFN + r"\missing")
+ self.assertEqual(ntpath.realpath(r"broken\foo"),
+ ABSTFN + r"\missing\foo")
+ self.assertEqual(ntpath.realpath(r"broken1"),
+ ABSTFN + r"\missing\bar")
+ self.assertEqual(ntpath.realpath(r"broken1\baz"),
+ ABSTFN + r"\missing\bar\baz")
+ self.assertEqual(ntpath.realpath("broken2"),
+ ABSTFN + r"\missing")
+ self.assertEqual(ntpath.realpath("broken3"),
+ ABSTFN + r"\missing")
+ self.assertEqual(ntpath.realpath("broken4"),
+ ABSTFN + r"\missing")
+ self.assertEqual(ntpath.realpath("broken5"),
+ ABSTFN + r"\missing")
+
+ self.assertEqual(ntpath.realpath(b"broken"),
+ os.fsencode(ABSTFN + r"\missing"))
+ self.assertEqual(ntpath.realpath(rb"broken\foo"),
+ os.fsencode(ABSTFN + r"\missing\foo"))
+ self.assertEqual(ntpath.realpath(rb"broken1"),
+ os.fsencode(ABSTFN + r"\missing\bar"))
+ self.assertEqual(ntpath.realpath(rb"broken1\baz"),
+ os.fsencode(ABSTFN + r"\missing\bar\baz"))
+ self.assertEqual(ntpath.realpath(b"broken2"),
+ os.fsencode(ABSTFN + r"\missing"))
+ self.assertEqual(ntpath.realpath(rb"broken3"),
+ os.fsencode(ABSTFN + r"\missing"))
+ self.assertEqual(ntpath.realpath(b"broken4"),
+ os.fsencode(ABSTFN + r"\missing"))
+ self.assertEqual(ntpath.realpath(b"broken5"),
+ os.fsencode(ABSTFN + r"\missing"))
+
+ @support.skip_unless_symlink
+ @unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
+ def test_realpath_symlink_loops(self):
+ # Bug #930024, return the path unchanged if we get into an infinite
+ # symlink loop.
+ ABSTFN = ntpath.abspath(support.TESTFN)
+ self.addCleanup(support.unlink, ABSTFN)
+ self.addCleanup(support.unlink, ABSTFN + "1")
+ self.addCleanup(support.unlink, ABSTFN + "2")
+ self.addCleanup(support.unlink, ABSTFN + "y")
+ self.addCleanup(support.unlink, ABSTFN + "c")
+ self.addCleanup(support.unlink, ABSTFN + "a")
+
+ P = "\\\\?\\"
+
+ os.symlink(ABSTFN, ABSTFN)
+ self.assertEqual(ntpath.realpath(ABSTFN), P + ABSTFN)
+
+ # cycles are non-deterministic as to which path is returned, but
+ # it will always be the fully resolved path of one member of the cycle
+ os.symlink(ABSTFN + "1", ABSTFN + "2")
+ os.symlink(ABSTFN + "2", ABSTFN + "1")
+ expected = (P + ABSTFN + "1", P + ABSTFN + "2")
+ self.assertIn(ntpath.realpath(ABSTFN + "1"), expected)
+ self.assertIn(ntpath.realpath(ABSTFN + "2"), expected)
+
+ self.assertIn(ntpath.realpath(ABSTFN + "1\\x"),
+ (ntpath.join(r, "x") for r in expected))
+ self.assertEqual(ntpath.realpath(ABSTFN + "1\\.."),
+ ntpath.dirname(ABSTFN))
+ self.assertEqual(ntpath.realpath(ABSTFN + "1\\..\\x"),
+ ntpath.dirname(P + ABSTFN) + "\\x")
+ os.symlink(ABSTFN + "x", ABSTFN + "y")
+ self.assertEqual(ntpath.realpath(ABSTFN + "1\\..\\"
+ + ntpath.basename(ABSTFN) + "y"),
+ P + ABSTFN + "x")
+ self.assertIn(ntpath.realpath(ABSTFN + "1\\..\\"
+ + ntpath.basename(ABSTFN) + "1"),
+ expected)
+
+ os.symlink(ntpath.basename(ABSTFN) + "a\\b", ABSTFN + "a")
+ self.assertEqual(ntpath.realpath(ABSTFN + "a"), P + ABSTFN + "a")
+
+ os.symlink("..\\" + ntpath.basename(ntpath.dirname(ABSTFN))
+ + "\\" + ntpath.basename(ABSTFN) + "c", ABSTFN + "c")
+ self.assertEqual(ntpath.realpath(ABSTFN + "c"), P + ABSTFN + "c")
+
+ # Test using relative path as well.
+ self.assertEqual(ntpath.realpath(ntpath.basename(ABSTFN)), P + ABSTFN)
+
+ @support.skip_unless_symlink
+ @unittest.skipUnless(HAVE_GETFINALPATHNAME, 'need _getfinalpathname')
+ def test_realpath_symlink_prefix(self):
+ ABSTFN = ntpath.abspath(support.TESTFN)
+ self.addCleanup(support.unlink, ABSTFN + "3")
+ self.addCleanup(support.unlink, "\\\\?\\" + ABSTFN + "3.")
+ self.addCleanup(support.unlink, ABSTFN + "3link")
+ self.addCleanup(support.unlink, ABSTFN + "3.link")
+
+ with open(ABSTFN + "3", "wb") as f:
+ f.write(b'0')
+ os.symlink(ABSTFN + "3", ABSTFN + "3link")
+
+ with open("\\\\?\\" + ABSTFN + "3.", "wb") as f:
+ f.write(b'1')
+ os.symlink("\\\\?\\" + ABSTFN + "3.", ABSTFN + "3.link")
+
+ self.assertEqual(ntpath.realpath(ABSTFN + "3link"),
+ ABSTFN + "3")
+ self.assertEqual(ntpath.realpath(ABSTFN + "3.link"),
+ "\\\\?\\" + ABSTFN + "3.")
+
+ # Resolved paths should be usable to open target files
+ with open(ntpath.realpath(ABSTFN + "3link"), "rb") as f:
+ self.assertEqual(f.read(), b'0')
+ with open(ntpath.realpath(ABSTFN + "3.link"), "rb") as f:
+ self.assertEqual(f.read(), b'1')
+
+ # When the prefix is included, it is not stripped
+ self.assertEqual(ntpath.realpath("\\\\?\\" + ABSTFN + "3link"),
+ "\\\\?\\" + ABSTFN + "3")
+ self.assertEqual(ntpath.realpath("\\\\?\\" + ABSTFN + "3.link"),
+ "\\\\?\\" + ABSTFN + "3.")
+
def test_expandvars(self):
with support.EnvironmentVarGuard() as env:
env.clear()
@@ -288,11 +480,11 @@
def test_relpath(self):
tester('ntpath.relpath("a")', 'a')
- tester('ntpath.relpath(os.path.abspath("a"))', 'a')
+ tester('ntpath.relpath(ntpath.abspath("a"))', 'a')
tester('ntpath.relpath("a/b")', 'a\\b')
tester('ntpath.relpath("../a/b")', '..\\a\\b')
with support.temp_cwd(support.TESTFN) as cwd_dir:
- currentdir = os.path.basename(cwd_dir)
+ currentdir = ntpath.basename(cwd_dir)
tester('ntpath.relpath("a", "../b")', '..\\'+currentdir+'\\a')
tester('ntpath.relpath("a/b", "../c")', '..\\'+currentdir+'\\a\\b')
tester('ntpath.relpath("a", "b/c")', '..\\..\\a')
@@ -417,7 +609,7 @@
# locations below cannot then refer to mount points
#
drive, path = ntpath.splitdrive(sys.executable)
- with support.change_cwd(os.path.dirname(sys.executable)):
+ with support.change_cwd(ntpath.dirname(sys.executable)):
self.assertFalse(ntpath.ismount(drive.lower()))
self.assertFalse(ntpath.ismount(drive.upper()))
diff --git a/Lib/test/test_os.py b/Lib/test/test_os.py
index b2cd4cc..15fd65b 100644
--- a/Lib/test/test_os.py
+++ b/Lib/test/test_os.py
@@ -3358,10 +3358,7 @@
if hasattr(os, "lchmod"):
funcs.append((self.filenames, os.lchmod, 0o777))
if hasattr(os, "readlink"):
- if sys.platform == "win32":
- funcs.append((self.unicode_filenames, os.readlink,))
- else:
- funcs.append((self.filenames, os.readlink,))
+ funcs.append((self.filenames, os.readlink,))
for filenames, func, *func_args in funcs:
diff --git a/Lib/test/test_shutil.py b/Lib/test/test_shutil.py
index e209607..88dc4d9 100644
--- a/Lib/test/test_shutil.py
+++ b/Lib/test/test_shutil.py
@@ -1871,11 +1871,7 @@
dst_link = os.path.join(self.dst_dir, 'quux')
shutil.move(dst, dst_link)
self.assertTrue(os.path.islink(dst_link))
- # On Windows, os.path.realpath does not follow symlinks (issue #9949)
- if os.name == 'nt':
- self.assertEqual(os.path.realpath(src), os.readlink(dst_link))
- else:
- self.assertEqual(os.path.realpath(src), os.path.realpath(dst_link))
+ self.assertEqual(os.path.realpath(src), os.path.realpath(dst_link))
@support.skip_unless_symlink
@mock_rename