/usr/lib/python3/dist-packages/twisted/test/test_paths.py is in python3-twisted-experimental 13.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 | # Copyright (c) Twisted Matrix Laboratories.
# See LICENSE for details.
"""
Test cases covering L{twisted.python.filepath}.
"""
from __future__ import division, absolute_import
import os, time, pickle, errno, stat
import contextlib
from pprint import pformat
from twisted.python.compat import _PY3
from twisted.python.win32 import WindowsError, ERROR_DIRECTORY
from twisted.python import filepath
from twisted.python.runtime import platform
from twisted.trial.unittest import SkipTest, SynchronousTestCase as TestCase
from zope.interface.verify import verifyObject
class BytesTestCase(TestCase):
"""
Override default method implementations to support byte paths.
"""
def mktemp(self):
"""
Return a temporary path, encoded as bytes.
"""
return TestCase.mktemp(self).encode("utf-8")
class AbstractFilePathTestCase(BytesTestCase):
"""
Tests for L{IFilePath} implementations.
"""
f1content = b"file 1"
f2content = b"file 2"
def _mkpath(self, *p):
x = os.path.abspath(os.path.join(self.cmn, *p))
self.all.append(x)
return x
def subdir(self, *dirname):
os.mkdir(self._mkpath(*dirname))
def subfile(self, *dirname):
return open(self._mkpath(*dirname), "wb")
def setUp(self):
self.now = time.time()
cmn = self.cmn = os.path.abspath(self.mktemp())
self.all = [cmn]
os.mkdir(cmn)
self.subdir(b"sub1")
f = self.subfile(b"file1")
f.write(self.f1content)
f.close()
f = self.subfile(b"sub1", b"file2")
f.write(self.f2content)
f.close()
self.subdir(b'sub3')
f = self.subfile(b"sub3", b"file3.ext1")
f.close()
f = self.subfile(b"sub3", b"file3.ext2")
f.close()
f = self.subfile(b"sub3", b"file3.ext3")
f.close()
self.path = filepath.FilePath(cmn)
self.root = filepath.FilePath(b"/")
def test_verifyObject(self):
"""
Instances of the path type being tested provide L{IFilePath}.
"""
self.assertTrue(verifyObject(filepath.IFilePath, self.path))
def test_segmentsFromPositive(self):
"""
Verify that the segments between two paths are correctly identified.
"""
self.assertEqual(
self.path.child(b"a").child(b"b").child(b"c").segmentsFrom(self.path),
[b"a", b"b", b"c"])
def test_segmentsFromNegative(self):
"""
Verify that segmentsFrom notices when the ancestor isn't an ancestor.
"""
self.assertRaises(
ValueError,
self.path.child(b"a").child(b"b").child(b"c").segmentsFrom,
self.path.child(b"d").child(b"c").child(b"e"))
def test_walk(self):
"""
Verify that walking the path gives the same result as the known file
hierarchy.
"""
x = [foo.path for foo in self.path.walk()]
self.assertEqual(set(x), set(self.all))
def test_parents(self):
"""
L{FilePath.parents()} should return an iterator of every ancestor of
the L{FilePath} in question.
"""
L = []
pathobj = self.path.child(b"a").child(b"b").child(b"c")
fullpath = pathobj.path
lastpath = fullpath
thispath = os.path.dirname(fullpath)
while lastpath != self.root.path:
L.append(thispath)
lastpath = thispath
thispath = os.path.dirname(thispath)
self.assertEqual([x.path for x in pathobj.parents()], L)
def test_validSubdir(self):
"""
Verify that a valid subdirectory will show up as a directory, but not as a
file, not as a symlink, and be listable.
"""
sub1 = self.path.child(b'sub1')
self.failUnless(sub1.exists(),
"This directory does exist.")
self.failUnless(sub1.isdir(),
"It's a directory.")
self.failUnless(not sub1.isfile(),
"It's a directory.")
self.failUnless(not sub1.islink(),
"It's a directory.")
self.assertEqual(sub1.listdir(),
[b'file2'])
def test_invalidSubdir(self):
"""
Verify that a subdirectory that doesn't exist is reported as such.
"""
sub2 = self.path.child(b'sub2')
self.failIf(sub2.exists(),
"This directory does not exist.")
def test_validFiles(self):
"""
Make sure that we can read existent non-empty files.
"""
f1 = self.path.child(b'file1')
with contextlib.closing(f1.open()) as f:
self.assertEqual(f.read(), self.f1content)
f2 = self.path.child(b'sub1').child(b'file2')
with contextlib.closing(f2.open()) as f:
self.assertEqual(f.read(), self.f2content)
def test_multipleChildSegments(self):
"""
C{fp.descendant([a, b, c])} returns the same L{FilePath} as is returned
by C{fp.child(a).child(b).child(c)}.
"""
multiple = self.path.descendant([b'a', b'b', b'c'])
single = self.path.child(b'a').child(b'b').child(b'c')
self.assertEqual(multiple, single)
def test_dictionaryKeys(self):
"""
Verify that path instances are usable as dictionary keys.
"""
f1 = self.path.child(b'file1')
f1prime = self.path.child(b'file1')
f2 = self.path.child(b'file2')
dictoid = {}
dictoid[f1] = 3
dictoid[f1prime] = 4
self.assertEqual(dictoid[f1], 4)
self.assertEqual(list(dictoid.keys()), [f1])
self.assertTrue(list(dictoid.keys())[0] is f1)
self.assertFalse(list(dictoid.keys())[0] is f1prime) # sanity check
dictoid[f2] = 5
self.assertEqual(dictoid[f2], 5)
self.assertEqual(len(dictoid), 2)
def test_dictionaryKeyWithString(self):
"""
Verify that path instances are usable as dictionary keys which do not clash
with their string counterparts.
"""
f1 = self.path.child(b'file1')
dictoid = {f1: 'hello'}
dictoid[f1.path] = 'goodbye'
self.assertEqual(len(dictoid), 2)
def test_childrenNonexistentError(self):
"""
Verify that children raises the appropriate exception for non-existent
directories.
"""
self.assertRaises(filepath.UnlistableError,
self.path.child(b'not real').children)
def test_childrenNotDirectoryError(self):
"""
Verify that listdir raises the appropriate exception for attempting to list
a file rather than a directory.
"""
self.assertRaises(filepath.UnlistableError,
self.path.child(b'file1').children)
def test_newTimesAreFloats(self):
"""
Verify that all times returned from the various new time functions are ints
(and hopefully therefore 'high precision').
"""
for p in self.path, self.path.child(b'file1'):
self.assertEqual(type(p.getAccessTime()), float)
self.assertEqual(type(p.getModificationTime()), float)
self.assertEqual(type(p.getStatusChangeTime()), float)
def test_oldTimesAreInts(self):
"""
Verify that all times returned from the various time functions are
integers, for compatibility.
"""
for p in self.path, self.path.child(b'file1'):
self.assertEqual(type(p.getatime()), int)
self.assertEqual(type(p.getmtime()), int)
self.assertEqual(type(p.getctime()), int)
class FakeWindowsPath(filepath.FilePath):
"""
A test version of FilePath which overrides listdir to raise L{WindowsError}.
"""
def listdir(self):
"""
@raise WindowsError: always.
"""
raise WindowsError(
ERROR_DIRECTORY,
"A directory's validness was called into question")
class ListingCompatibilityTests(BytesTestCase):
"""
These tests verify compatibility with legacy behavior of directory listing.
"""
def test_windowsErrorExcept(self):
"""
Verify that when a WindowsError is raised from listdir, catching
WindowsError works.
"""
fwp = FakeWindowsPath(self.mktemp())
self.assertRaises(filepath.UnlistableError, fwp.children)
self.assertRaises(WindowsError, fwp.children)
def test_alwaysCatchOSError(self):
"""
Verify that in the normal case where a directory does not exist, we will
get an OSError.
"""
fp = filepath.FilePath(self.mktemp())
self.assertRaises(OSError, fp.children)
def test_keepOriginalAttributes(self):
"""
Verify that the Unlistable exception raised will preserve the attributes of
the previously-raised exception.
"""
fp = filepath.FilePath(self.mktemp())
ose = self.assertRaises(OSError, fp.children)
d1 = list(ose.__dict__.keys())
d1.remove('originalException')
d2 = list(ose.originalException.__dict__.keys())
d1.sort()
d2.sort()
self.assertEqual(d1, d2)
class ExplodingFile:
"""
A C{file}-alike which raises exceptions from its I/O methods and keeps track
of whether it has been closed.
@ivar closed: A C{bool} which is C{False} until C{close} is called, then it
is C{True}.
"""
closed = False
def read(self, n=0):
"""
@raise IOError: Always raised.
"""
raise IOError()
def write(self, what):
"""
@raise IOError: Always raised.
"""
raise IOError()
def close(self):
"""
Mark the file as having been closed.
"""
self.closed = True
class TrackingFilePath(filepath.FilePath):
"""
A subclass of L{filepath.FilePath} which maintains a list of all other paths
created by clonePath.
@ivar trackingList: A list of all paths created by this path via
C{clonePath} (which also includes paths created by methods like
C{parent}, C{sibling}, C{child}, etc (and all paths subsequently created
by those paths, etc).
@type trackingList: C{list} of L{TrackingFilePath}
@ivar openedFiles: A list of all file objects opened by this
L{TrackingFilePath} or any other L{TrackingFilePath} in C{trackingList}.
@type openedFiles: C{list} of C{file}
"""
def __init__(self, path, alwaysCreate=False, trackingList=None):
filepath.FilePath.__init__(self, path, alwaysCreate)
if trackingList is None:
trackingList = []
self.trackingList = trackingList
self.openedFiles = []
def open(self, *a, **k):
"""
Override 'open' to track all files opened by this path.
"""
f = filepath.FilePath.open(self, *a, **k)
self.openedFiles.append(f)
return f
def openedPaths(self):
"""
Return a list of all L{TrackingFilePath}s associated with this
L{TrackingFilePath} that have had their C{open()} method called.
"""
return [path for path in self.trackingList if path.openedFiles]
def clonePath(self, name):
"""
Override L{filepath.FilePath.clonePath} to give the new path a reference
to the same tracking list.
"""
clone = TrackingFilePath(name, trackingList=self.trackingList)
self.trackingList.append(clone)
return clone
class ExplodingFilePath(filepath.FilePath):
"""
A specialized L{FilePath} which always returns an instance of
L{ExplodingFile} from its C{open} method.
@ivar fp: The L{ExplodingFile} instance most recently returned from the
C{open} method.
"""
def __init__(self, pathName, originalExploder=None):
"""
Initialize an L{ExplodingFilePath} with a name and a reference to the
@param pathName: The path name as passed to L{filepath.FilePath}.
@type pathName: C{str}
@param originalExploder: The L{ExplodingFilePath} to associate opened
files with.
@type originalExploder: L{ExplodingFilePath}
"""
filepath.FilePath.__init__(self, pathName)
if originalExploder is None:
originalExploder = self
self._originalExploder = originalExploder
def open(self, mode=None):
"""
Create, save, and return a new C{ExplodingFile}.
@param mode: Present for signature compatibility. Ignored.
@return: A new C{ExplodingFile}.
"""
f = self._originalExploder.fp = ExplodingFile()
return f
def clonePath(self, name):
return ExplodingFilePath(name, self._originalExploder)
class PermissionsTestCase(BytesTestCase):
"""
Test Permissions and RWX classes
"""
def assertNotUnequal(self, first, second, msg=None):
"""
Tests that C{first} != C{second} is false. This method tests the
__ne__ method, as opposed to L{assertEqual} (C{first} == C{second}),
which tests the __eq__ method.
Note: this should really be part of trial
"""
if first != second:
if msg is None:
msg = '';
if len(msg) > 0:
msg += '\n'
raise self.failureException(
'%snot not unequal (__ne__ not implemented correctly):'
'\na = %s\nb = %s\n'
% (msg, pformat(first), pformat(second)))
return first
def test_rwxFromBools(self):
"""
L{RWX}'s constructor takes a set of booleans
"""
for r in (True, False):
for w in (True, False):
for x in (True, False):
rwx = filepath.RWX(r, w, x)
self.assertEqual(rwx.read, r)
self.assertEqual(rwx.write, w)
self.assertEqual(rwx.execute, x)
rwx = filepath.RWX(True, True, True)
self.assertTrue(rwx.read and rwx.write and rwx.execute)
def test_rwxEqNe(self):
"""
L{RWX}'s created with the same booleans are equivalent. If booleans
are different, they are not equal.
"""
for r in (True, False):
for w in (True, False):
for x in (True, False):
self.assertEqual(filepath.RWX(r, w, x),
filepath.RWX(r, w, x))
self.assertNotUnequal(filepath.RWX(r, w, x),
filepath.RWX(r, w, x))
self.assertNotEqual(filepath.RWX(True, True, True),
filepath.RWX(True, True, False))
self.assertNotEqual(3, filepath.RWX(True, True, True))
def test_rwxShorthand(self):
"""
L{RWX}'s shorthand string should be 'rwx' if read, write, and execute
permission bits are true. If any of those permissions bits are false,
the character is replaced by a '-'.
"""
def getChar(val, letter):
if val:
return letter
return '-'
for r in (True, False):
for w in (True, False):
for x in (True, False):
rwx = filepath.RWX(r, w, x)
self.assertEqual(rwx.shorthand(),
getChar(r, 'r') +
getChar(w, 'w') +
getChar(x, 'x'))
self.assertEqual(filepath.RWX(True, False, True).shorthand(), "r-x")
def test_permissionsFromStat(self):
"""
L{Permissions}'s constructor takes a valid permissions bitmask and
parsaes it to produce the correct set of boolean permissions.
"""
def _rwxFromStat(statModeInt, who):
def getPermissionBit(what, who):
return (statModeInt &
getattr(stat, "S_I%s%s" % (what, who))) > 0
return filepath.RWX(*[getPermissionBit(what, who) for what in
('R', 'W', 'X')])
for u in range(0, 8):
for g in range(0, 8):
for o in range(0, 8):
chmodString = "%d%d%d" % (u, g, o)
chmodVal = int(chmodString, 8)
perm = filepath.Permissions(chmodVal)
self.assertEqual(perm.user,
_rwxFromStat(chmodVal, "USR"),
"%s: got user: %s" %
(chmodString, perm.user))
self.assertEqual(perm.group,
_rwxFromStat(chmodVal, "GRP"),
"%s: got group: %s" %
(chmodString, perm.group))
self.assertEqual(perm.other,
_rwxFromStat(chmodVal, "OTH"),
"%s: got other: %s" %
(chmodString, perm.other))
perm = filepath.Permissions(0o777)
for who in ("user", "group", "other"):
for what in ("read", "write", "execute"):
self.assertTrue(getattr(getattr(perm, who), what))
def test_permissionsEq(self):
"""
Two L{Permissions}'s that are created with the same bitmask
are equivalent
"""
self.assertEqual(filepath.Permissions(0o777),
filepath.Permissions(0o777))
self.assertNotUnequal(filepath.Permissions(0o777),
filepath.Permissions(0o777))
self.assertNotEqual(filepath.Permissions(0o777),
filepath.Permissions(0o700))
self.assertNotEqual(3, filepath.Permissions(0o777))
def test_permissionsShorthand(self):
"""
L{Permissions}'s shorthand string is the RWX shorthand string for its
user permission bits, group permission bits, and other permission bits
concatenated together, without a space.
"""
for u in range(0, 8):
for g in range(0, 8):
for o in range(0, 8):
perm = filepath.Permissions(int("0o%d%d%d" % (u, g, o), 8))
self.assertEqual(perm.shorthand(),
''.join(x.shorthand() for x in (
perm.user, perm.group, perm.other)))
self.assertEqual(filepath.Permissions(0o770).shorthand(), "rwxrwx---")
class FilePathTestCase(AbstractFilePathTestCase):
"""
Test various L{FilePath} path manipulations.
In particular, note that tests defined on this class instead of on the base
class are only run against L{twisted.python.filepath}.
"""
def test_chmod(self):
"""
L{FilePath.chmod} modifies the permissions of
the passed file as expected (using C{os.stat} to check). We use some
basic modes that should work everywhere (even on Windows).
"""
for mode in (0o555, 0o777):
self.path.child(b"sub1").chmod(mode)
self.assertEqual(
stat.S_IMODE(os.stat(self.path.child(b"sub1").path).st_mode),
mode)
def symlink(self, target, name):
"""
Create a symbolic link named C{name} pointing at C{target}.
@type target: C{str}
@type name: C{str}
@raise SkipTest: raised if symbolic links are not supported on the
host platform.
"""
if getattr(os, 'symlink', None) is None:
raise SkipTest(
"Platform does not support symbolic links.")
os.symlink(target, name)
def createLinks(self):
"""
Create several symbolic links to files and directories.
"""
subdir = self.path.child(b"sub1")
self.symlink(subdir.path, self._mkpath(b"sub1.link"))
self.symlink(subdir.child(b"file2").path, self._mkpath(b"file2.link"))
self.symlink(subdir.child(b"file2").path,
self._mkpath(b"sub1", b"sub1.file2.link"))
def test_realpathSymlink(self):
"""
L{FilePath.realpath} returns the path of the ultimate target of a
symlink.
"""
self.createLinks()
self.symlink(self.path.child(b"file2.link").path,
self.path.child(b"link.link").path)
self.assertEqual(self.path.child(b"link.link").realpath(),
self.path.child(b"sub1").child(b"file2"))
def test_realpathCyclicalSymlink(self):
"""
L{FilePath.realpath} raises L{filepath.LinkError} if the path is a
symbolic link which is part of a cycle.
"""
self.symlink(self.path.child(b"link1").path, self.path.child(b"link2").path)
self.symlink(self.path.child(b"link2").path, self.path.child(b"link1").path)
self.assertRaises(filepath.LinkError,
self.path.child(b"link2").realpath)
def test_realpathNoSymlink(self):
"""
L{FilePath.realpath} returns the path itself if the path is not a
symbolic link.
"""
self.assertEqual(self.path.child(b"sub1").realpath(),
self.path.child(b"sub1"))
def test_walkCyclicalSymlink(self):
"""
Verify that walking a path with a cyclical symlink raises an error
"""
self.createLinks()
self.symlink(self.path.child(b"sub1").path,
self.path.child(b"sub1").child(b"sub1.loopylink").path)
def iterateOverPath():
return [foo.path for foo in self.path.walk()]
self.assertRaises(filepath.LinkError, iterateOverPath)
def test_walkObeysDescendWithCyclicalSymlinks(self):
"""
Verify that, after making a path with cyclical symlinks, when the
supplied C{descend} predicate returns C{False}, the target is not
traversed, as if it was a simple symlink.
"""
self.createLinks()
# we create cyclical symlinks
self.symlink(self.path.child(b"sub1").path,
self.path.child(b"sub1").child(b"sub1.loopylink").path)
def noSymLinks(path):
return not path.islink()
def iterateOverPath():
return [foo.path for foo in self.path.walk(descend=noSymLinks)]
self.assertTrue(iterateOverPath())
def test_walkObeysDescend(self):
"""
Verify that when the supplied C{descend} predicate returns C{False},
the target is not traversed.
"""
self.createLinks()
def noSymLinks(path):
return not path.islink()
x = [foo.path for foo in self.path.walk(descend=noSymLinks)]
self.assertEqual(set(x), set(self.all))
def test_getAndSet(self):
content = b'newcontent'
self.path.child(b'new').setContent(content)
newcontent = self.path.child(b'new').getContent()
self.assertEqual(content, newcontent)
content = b'content'
self.path.child(b'new').setContent(content, b'.tmp')
newcontent = self.path.child(b'new').getContent()
self.assertEqual(content, newcontent)
def test_getContentFileClosing(self):
"""
If reading from the underlying file raises an exception,
L{FilePath.getContent} raises that exception after closing the file.
"""
fp = ExplodingFilePath(b"")
self.assertRaises(IOError, fp.getContent)
self.assertTrue(fp.fp.closed)
def test_symbolicLink(self):
"""
Verify the behavior of the C{isLink} method against links and
non-links. Also check that the symbolic link shares the directory
property with its target.
"""
s4 = self.path.child(b"sub4")
s3 = self.path.child(b"sub3")
self.symlink(s3.path, s4.path)
self.assertTrue(s4.islink())
self.assertFalse(s3.islink())
self.assertTrue(s4.isdir())
self.assertTrue(s3.isdir())
def test_linkTo(self):
"""
Verify that symlink creates a valid symlink that is both a link and a
file if its target is a file, or a directory if its target is a
directory.
"""
targetLinks = [
(self.path.child(b"sub2"), self.path.child(b"sub2.link")),
(self.path.child(b"sub2").child(b"file3.ext1"),
self.path.child(b"file3.ext1.link"))
]
for target, link in targetLinks:
target.linkTo(link)
self.assertTrue(link.islink(), "This is a link")
self.assertEqual(target.isdir(), link.isdir())
self.assertEqual(target.isfile(), link.isfile())
def test_linkToErrors(self):
"""
Verify C{linkTo} fails in the following case:
- the target is in a directory that doesn't exist
- the target already exists
"""
self.assertRaises(OSError, self.path.child(b"file1").linkTo,
self.path.child(b'nosub').child(b'file1'))
self.assertRaises(OSError, self.path.child(b"file1").linkTo,
self.path.child(b'sub1').child(b'file2'))
if not getattr(os, "symlink", None):
skipMsg = "Your platform does not support symbolic links."
test_symbolicLink.skip = skipMsg
test_linkTo.skip = skipMsg
test_linkToErrors.skip = skipMsg
def testMultiExt(self):
f3 = self.path.child(b'sub3').child(b'file3')
exts = b'.foo', b'.bar', b'ext1', b'ext2', b'ext3'
self.failIf(f3.siblingExtensionSearch(*exts))
f3e = f3.siblingExtension(b".foo")
f3e.touch()
self.failIf(not f3.siblingExtensionSearch(*exts).exists())
self.failIf(not f3.siblingExtensionSearch(b'*').exists())
f3e.remove()
self.failIf(f3.siblingExtensionSearch(*exts))
def testPreauthChild(self):
fp = filepath.FilePath(b'.')
fp.preauthChild(b'foo/bar')
self.assertRaises(filepath.InsecurePath, fp.child, b'/foo')
def testStatCache(self):
p = self.path.child(b'stattest')
p.touch()
self.assertEqual(p.getsize(), 0)
self.assertEqual(abs(p.getmtime() - time.time()) // 20, 0)
self.assertEqual(abs(p.getctime() - time.time()) // 20, 0)
self.assertEqual(abs(p.getatime() - time.time()) // 20, 0)
self.assertEqual(p.exists(), True)
self.assertEqual(p.exists(), True)
# OOB removal: FilePath.remove() will automatically restat
os.remove(p.path)
# test caching
self.assertEqual(p.exists(), True)
p.restat(reraise=False)
self.assertEqual(p.exists(), False)
self.assertEqual(p.islink(), False)
self.assertEqual(p.isdir(), False)
self.assertEqual(p.isfile(), False)
def testPersist(self):
newpath = pickle.loads(pickle.dumps(self.path))
self.assertEqual(self.path.__class__, newpath.__class__)
self.assertEqual(self.path.path, newpath.path)
def testInsecureUNIX(self):
self.assertRaises(filepath.InsecurePath, self.path.child, b"..")
self.assertRaises(filepath.InsecurePath, self.path.child, b"/etc")
self.assertRaises(filepath.InsecurePath, self.path.child, b"../..")
def testInsecureWin32(self):
self.assertRaises(filepath.InsecurePath, self.path.child, b"..\\..")
self.assertRaises(filepath.InsecurePath, self.path.child, b"C:randomfile")
if platform.getType() != 'win32':
testInsecureWin32.skip = "Test will run only on Windows."
def testInsecureWin32Whacky(self):
"""
Windows has 'special' filenames like NUL and CON and COM1 and LPR
and PRN and ... god knows what else. They can be located anywhere in
the filesystem. For obvious reasons, we do not wish to normally permit
access to these.
"""
self.assertRaises(filepath.InsecurePath, self.path.child, b"CON")
self.assertRaises(filepath.InsecurePath, self.path.child, b"C:CON")
self.assertRaises(filepath.InsecurePath, self.path.child, r"C:\CON")
if platform.getType() != 'win32':
testInsecureWin32Whacky.skip = "Test will run only on Windows."
def testComparison(self):
self.assertEqual(filepath.FilePath(b'a'),
filepath.FilePath(b'a'))
self.failUnless(filepath.FilePath(b'z') >
filepath.FilePath(b'a'))
self.failUnless(filepath.FilePath(b'z') >=
filepath.FilePath(b'a'))
self.failUnless(filepath.FilePath(b'a') >=
filepath.FilePath(b'a'))
self.failUnless(filepath.FilePath(b'a') <=
filepath.FilePath(b'a'))
self.failUnless(filepath.FilePath(b'a') <
filepath.FilePath(b'z'))
self.failUnless(filepath.FilePath(b'a') <=
filepath.FilePath(b'z'))
self.failUnless(filepath.FilePath(b'a') !=
filepath.FilePath(b'z'))
self.failUnless(filepath.FilePath(b'z') !=
filepath.FilePath(b'a'))
self.failIf(filepath.FilePath(b'z') !=
filepath.FilePath(b'z'))
def test_descendantOnly(self):
"""
If C{".."} is in the sequence passed to L{FilePath.descendant},
L{InsecurePath} is raised.
"""
self.assertRaises(
filepath.InsecurePath, self.path.descendant, [b'a', b'..'])
def testSibling(self):
p = self.path.child(b'sibling_start')
ts = p.sibling(b'sibling_test')
self.assertEqual(ts.dirname(), p.dirname())
self.assertEqual(ts.basename(), b'sibling_test')
ts.createDirectory()
self.assertIn(ts, self.path.children())
def testTemporarySibling(self):
ts = self.path.temporarySibling()
self.assertEqual(ts.dirname(), self.path.dirname())
self.assertNotIn(ts.basename(), self.path.listdir())
ts.createDirectory()
self.assertIn(ts, self.path.parent().children())
def test_temporarySiblingExtension(self):
"""
If L{FilePath.temporarySibling} is given an extension argument, it will
produce path objects with that extension appended to their names.
"""
testExtension = b".test-extension"
ts = self.path.temporarySibling(testExtension)
self.assertTrue(ts.basename().endswith(testExtension),
"%s does not end with %s" % (
ts.basename(), testExtension))
def test_removeDirectory(self):
"""
L{FilePath.remove} on a L{FilePath} that refers to a directory will
recursively delete its contents.
"""
self.path.remove()
self.failIf(self.path.exists())
def test_removeWithSymlink(self):
"""
For a path which is a symbolic link, L{FilePath.remove} just deletes
the link, not the target.
"""
link = self.path.child(b"sub1.link")
# setUp creates the sub1 child
self.symlink(self.path.child(b"sub1").path, link.path)
link.remove()
self.assertFalse(link.exists())
self.assertTrue(self.path.child(b"sub1").exists())
def test_copyToDirectory(self):
"""
L{FilePath.copyTo} makes a copy of all the contents of the directory
named by that L{FilePath} if it is able to do so.
"""
oldPaths = list(self.path.walk()) # Record initial state
fp = filepath.FilePath(self.mktemp())
self.path.copyTo(fp)
self.path.remove()
fp.copyTo(self.path)
newPaths = list(self.path.walk()) # Record double-copy state
newPaths.sort()
oldPaths.sort()
self.assertEqual(newPaths, oldPaths)
def test_copyToMissingDestFileClosing(self):
"""
If an exception is raised while L{FilePath.copyTo} is trying to open
source file to read from, the destination file is closed and the
exception is raised to the caller of L{FilePath.copyTo}.
"""
nosuch = self.path.child(b"nothere")
# Make it look like something to copy, even though it doesn't exist.
# This could happen if the file is deleted between the isfile check and
# the file actually being opened.
nosuch.isfile = lambda: True
# We won't get as far as writing to this file, but it's still useful for
# tracking whether we closed it.
destination = ExplodingFilePath(self.mktemp())
self.assertRaises(IOError, nosuch.copyTo, destination)
self.assertTrue(destination.fp.closed)
def test_copyToFileClosing(self):
"""
If an exception is raised while L{FilePath.copyTo} is copying bytes
between two regular files, the source and destination files are closed
and the exception propagates to the caller of L{FilePath.copyTo}.
"""
destination = ExplodingFilePath(self.mktemp())
source = ExplodingFilePath(__file__)
self.assertRaises(IOError, source.copyTo, destination)
self.assertTrue(source.fp.closed)
self.assertTrue(destination.fp.closed)
def test_copyToDirectoryItself(self):
"""
L{FilePath.copyTo} fails with an OSError or IOError (depending on
platform, as it propagates errors from open() and write()) when
attempting to copy a directory to a child of itself.
"""
self.assertRaises((OSError, IOError),
self.path.copyTo, self.path.child(b'file1'))
def test_copyToWithSymlink(self):
"""
Verify that copying with followLinks=True copies symlink targets
instead of symlinks
"""
self.symlink(self.path.child(b"sub1").path,
self.path.child(b"link1").path)
fp = filepath.FilePath(self.mktemp())
self.path.copyTo(fp)
self.assertFalse(fp.child(b"link1").islink())
self.assertEqual([x.basename() for x in fp.child(b"sub1").children()],
[x.basename() for x in fp.child(b"link1").children()])
def test_copyToWithoutSymlink(self):
"""
Verify that copying with followLinks=False copies symlinks as symlinks
"""
self.symlink(b"sub1", self.path.child(b"link1").path)
fp = filepath.FilePath(self.mktemp())
self.path.copyTo(fp, followLinks=False)
self.assertTrue(fp.child(b"link1").islink())
self.assertEqual(os.readlink(self.path.child(b"link1").path),
os.readlink(fp.child(b"link1").path))
def test_copyToMissingSource(self):
"""
If the source path is missing, L{FilePath.copyTo} raises L{OSError}.
"""
path = filepath.FilePath(self.mktemp())
exc = self.assertRaises(OSError, path.copyTo, b'some other path')
self.assertEqual(exc.errno, errno.ENOENT)
def test_moveTo(self):
"""
Verify that moving an entire directory results into another directory
with the same content.
"""
oldPaths = list(self.path.walk()) # Record initial state
fp = filepath.FilePath(self.mktemp())
self.path.moveTo(fp)
fp.moveTo(self.path)
newPaths = list(self.path.walk()) # Record double-move state
newPaths.sort()
oldPaths.sort()
self.assertEqual(newPaths, oldPaths)
def test_moveToExistsCache(self):
"""
A L{FilePath} that has been moved aside with L{FilePath.moveTo} no
longer registers as existing. Its previously non-existent target
exists, though, as it was created by the call to C{moveTo}.
"""
fp = filepath.FilePath(self.mktemp())
fp2 = filepath.FilePath(self.mktemp())
fp.touch()
# Both a sanity check (make sure the file status looks right) and an
# enticement for stat-caching logic to kick in and remember that these
# exist / don't exist.
self.assertEqual(fp.exists(), True)
self.assertEqual(fp2.exists(), False)
fp.moveTo(fp2)
self.assertEqual(fp.exists(), False)
self.assertEqual(fp2.exists(), True)
def test_moveToExistsCacheCrossMount(self):
"""
The assertion of test_moveToExistsCache should hold in the case of a
cross-mount move.
"""
self.setUpFaultyRename()
self.test_moveToExistsCache()
def test_moveToSizeCache(self, hook=lambda : None):
"""
L{FilePath.moveTo} clears its destination's status cache, such that
calls to L{FilePath.getsize} after the call to C{moveTo} will report the
new size, not the old one.
This is a separate test from C{test_moveToExistsCache} because it is
intended to cover the fact that the destination's cache is dropped;
test_moveToExistsCache doesn't cover this case because (currently) a
file that doesn't exist yet does not cache the fact of its non-
existence.
"""
fp = filepath.FilePath(self.mktemp())
fp2 = filepath.FilePath(self.mktemp())
fp.setContent(b"1234")
fp2.setContent(b"1234567890")
hook()
# Sanity check / kick off caching.
self.assertEqual(fp.getsize(), 4)
self.assertEqual(fp2.getsize(), 10)
# Actually attempting to replace a file on Windows would fail with
# ERROR_ALREADY_EXISTS, but we don't need to test that, just the cached
# metadata, so, delete the file ...
os.remove(fp2.path)
# ... but don't clear the status cache, as fp2.remove() would.
self.assertEqual(fp2.getsize(), 10)
fp.moveTo(fp2)
self.assertEqual(fp2.getsize(), 4)
def test_moveToSizeCacheCrossMount(self):
"""
The assertion of test_moveToSizeCache should hold in the case of a
cross-mount move.
"""
self.test_moveToSizeCache(hook=self.setUpFaultyRename)
def test_moveToError(self):
"""
Verify error behavior of moveTo: it should raises one of OSError or
IOError if you want to move a path into one of its child. It's simply
the error raised by the underlying rename system call.
"""
self.assertRaises((OSError, IOError), self.path.moveTo, self.path.child(b'file1'))
def setUpFaultyRename(self):
"""
Set up a C{os.rename} that will fail with L{errno.EXDEV} on first call.
This is used to simulate a cross-device rename failure.
@return: a list of pair (src, dest) of calls to C{os.rename}
@rtype: C{list} of C{tuple}
"""
invokedWith = []
def faultyRename(src, dest):
invokedWith.append((src, dest))
if len(invokedWith) == 1:
raise OSError(errno.EXDEV, 'Test-induced failure simulating '
'cross-device rename failure')
return originalRename(src, dest)
originalRename = os.rename
self.patch(os, "rename", faultyRename)
return invokedWith
def test_crossMountMoveTo(self):
"""
C{moveTo} should be able to handle C{EXDEV} error raised by
C{os.rename} when trying to move a file on a different mounted
filesystem.
"""
invokedWith = self.setUpFaultyRename()
# Bit of a whitebox test - force os.rename, which moveTo tries
# before falling back to a slower method, to fail, forcing moveTo to
# use the slower behavior.
self.test_moveTo()
# A bit of a sanity check for this whitebox test - if our rename
# was never invoked, the test has probably fallen into disrepair!
self.assertTrue(invokedWith)
def test_crossMountMoveToWithSymlink(self):
"""
By default, when moving a symlink, it should follow the link and
actually copy the content of the linked node.
"""
invokedWith = self.setUpFaultyRename()
f2 = self.path.child(b'file2')
f3 = self.path.child(b'file3')
self.symlink(self.path.child(b'file1').path, f2.path)
f2.moveTo(f3)
self.assertFalse(f3.islink())
self.assertEqual(f3.getContent(), b'file 1')
self.assertTrue(invokedWith)
def test_crossMountMoveToWithoutSymlink(self):
"""
Verify that moveTo called with followLinks=False actually create
another symlink.
"""
invokedWith = self.setUpFaultyRename()
f2 = self.path.child(b'file2')
f3 = self.path.child(b'file3')
self.symlink(self.path.child(b'file1').path, f2.path)
f2.moveTo(f3, followLinks=False)
self.assertTrue(f3.islink())
self.assertEqual(f3.getContent(), b'file 1')
self.assertTrue(invokedWith)
def test_createBinaryMode(self):
"""
L{FilePath.create} should always open (and write to) files in binary
mode; line-feed octets should be unmodified.
(While this test should pass on all platforms, it is only really
interesting on platforms which have the concept of binary mode, i.e.
Windows platforms.)
"""
path = filepath.FilePath(self.mktemp())
f = path.create()
self.failUnless("b" in f.mode)
f.write(b"\n")
f.close()
read = open(path.path, "rb").read()
self.assertEqual(read, b"\n")
def testOpen(self):
# Opening a file for reading when it does not already exist is an error
nonexistent = self.path.child(b'nonexistent')
e = self.assertRaises(IOError, nonexistent.open)
self.assertEqual(e.errno, errno.ENOENT)
# Opening a file for writing when it does not exist is okay
writer = self.path.child(b'writer')
f = writer.open('w')
f.write(b'abc\ndef')
f.close()
# Make sure those bytes ended up there - and test opening a file for
# reading when it does exist at the same time
f = writer.open()
self.assertEqual(f.read(), b'abc\ndef')
f.close()
# Re-opening that file in write mode should erase whatever was there.
f = writer.open('w')
f.close()
f = writer.open()
self.assertEqual(f.read(), b'')
f.close()
# Put some bytes in a file so we can test that appending does not
# destroy them.
appender = self.path.child(b'appender')
f = appender.open('w')
f.write(b'abc')
f.close()
f = appender.open('a')
f.write(b'def')
f.close()
f = appender.open('r')
self.assertEqual(f.read(), b'abcdef')
f.close()
# read/write should let us do both without erasing those bytes
f = appender.open('r+')
self.assertEqual(f.read(), b'abcdef')
# ANSI C *requires* an fseek or an fgetpos between an fread and an
# fwrite or an fwrite and a fread. We can't reliable get Python to
# invoke fgetpos, so we seek to a 0 byte offset from the current
# position instead. Also, Python sucks for making this seek
# relative to 1 instead of a symbolic constant representing the
# current file position.
f.seek(0, 1)
# Put in some new bytes for us to test for later.
f.write(b'ghi')
f.close()
# Make sure those new bytes really showed up
f = appender.open('r')
self.assertEqual(f.read(), b'abcdefghi')
f.close()
# write/read should let us do both, but erase anything that's there
# already.
f = appender.open('w+')
self.assertEqual(f.read(), b'')
f.seek(0, 1) # Don't forget this!
f.write(b'123')
f.close()
# super append mode should let us read and write and also position the
# cursor at the end of the file, without erasing everything.
f = appender.open('a+')
# The order of these lines may seem surprising, but it is necessary.
# The cursor is not at the end of the file until after the first write.
f.write(b'456')
f.seek(0, 1) # Asinine.
self.assertEqual(f.read(), b'')
f.seek(0, 0)
self.assertEqual(f.read(), b'123456')
f.close()
# Opening a file exclusively must fail if that file exists already.
nonexistent.requireCreate(True)
nonexistent.open('w').close()
existent = nonexistent
del nonexistent
self.assertRaises((OSError, IOError), existent.open)
def test_openWithExplicitBinaryMode(self):
"""
Due to a bug in Python 2.7 on Windows including multiple 'b'
characters in the mode passed to the built-in open() will cause an
error. FilePath.open() ensures that only a single 'b' character is
included in the mode passed to the built-in open().
See http://bugs.python.org/issue7686 for details about the bug.
"""
writer = self.path.child(b'explicit-binary')
file = writer.open('wb')
file.write(b'abc\ndef')
file.close()
self.assertTrue(writer.exists)
def test_openWithRedundantExplicitBinaryModes(self):
"""
Due to a bug in Python 2.7 on Windows including multiple 'b'
characters in the mode passed to the built-in open() will cause an
error. No matter how many 'b' modes are specified, FilePath.open()
ensures that only a single 'b' character is included in the mode
passed to the built-in open().
See http://bugs.python.org/issue7686 for details about the bug.
"""
writer = self.path.child(b'multiple-binary')
file = writer.open('wbb')
file.write(b'abc\ndef')
file.close()
self.assertTrue(writer.exists)
def test_existsCache(self):
"""
Check that C{filepath.FilePath.exists} correctly restat the object if
an operation has occurred in the mean time.
"""
fp = filepath.FilePath(self.mktemp())
self.assertEqual(fp.exists(), False)
fp.makedirs()
self.assertEqual(fp.exists(), True)
def test_changed(self):
"""
L{FilePath.changed} indicates that the L{FilePath} has changed, but does
not re-read the status information from the filesystem until it is
queried again via another method, such as C{getsize}.
"""
fp = filepath.FilePath(self.mktemp())
fp.setContent(b"12345")
self.assertEqual(fp.getsize(), 5)
# Someone else comes along and changes the file.
fObj = open(fp.path, 'wb')
fObj.write(b"12345678")
fObj.close()
# Sanity check for caching: size should still be 5.
self.assertEqual(fp.getsize(), 5)
fp.changed()
# This path should look like we don't know what status it's in, not that
# we know that it didn't exist when last we checked.
self.assertEqual(fp.statinfo, None)
self.assertEqual(fp.getsize(), 8)
def test_getPermissions_POSIX(self):
"""
Getting permissions for a file returns a L{Permissions} object for
POSIX platforms (which supports separate user, group, and other
permissions bits.
"""
for mode in (0o777, 0o700):
self.path.child(b"sub1").chmod(mode)
self.assertEqual(self.path.child(b"sub1").getPermissions(),
filepath.Permissions(mode))
self.path.child(b"sub1").chmod(0o764) #sanity check
self.assertEqual(self.path.child(b"sub1").getPermissions().shorthand(),
"rwxrw-r--")
def test_getPermissions_Windows(self):
"""
Getting permissions for a file returns a L{Permissions} object in
Windows. Windows requires a different test, because user permissions
= group permissions = other permissions. Also, chmod may not be able
to set the execute bit, so we are skipping tests that set the execute
bit.
"""
# Change permission after test so file can be deleted
self.addCleanup(self.path.child(b"sub1").chmod, 0o777)
for mode in (0o777, 0o555):
self.path.child(b"sub1").chmod(mode)
self.assertEqual(self.path.child(b"sub1").getPermissions(),
filepath.Permissions(mode))
self.path.child(b"sub1").chmod(0o511) #sanity check to make sure that
# user=group=other permissions
self.assertEqual(self.path.child(b"sub1").getPermissions().shorthand(),
"r-xr-xr-x")
def test_whetherBlockOrSocket(self):
"""
Ensure that a file is not a block or socket
"""
self.assertFalse(self.path.isBlockDevice())
self.assertFalse(self.path.isSocket())
def test_statinfoBitsNotImplementedInWindows(self):
"""
Verify that certain file stats are not available on Windows
"""
self.assertRaises(NotImplementedError, self.path.getInodeNumber)
self.assertRaises(NotImplementedError, self.path.getDevice)
self.assertRaises(NotImplementedError, self.path.getNumberOfHardLinks)
self.assertRaises(NotImplementedError, self.path.getUserID)
self.assertRaises(NotImplementedError, self.path.getGroupID)
def test_statinfoBitsAreNumbers(self):
"""
Verify that file inode/device/nlinks/uid/gid stats are numbers in
a POSIX environment
"""
if _PY3:
numbers = int
else:
numbers = (int, long)
c = self.path.child(b'file1')
for p in self.path, c:
self.assertIsInstance(p.getInodeNumber(), numbers)
self.assertIsInstance(p.getDevice(), numbers)
self.assertIsInstance(p.getNumberOfHardLinks(), numbers)
self.assertIsInstance(p.getUserID(), numbers)
self.assertIsInstance(p.getGroupID(), numbers)
self.assertEqual(self.path.getUserID(), c.getUserID())
self.assertEqual(self.path.getGroupID(), c.getGroupID())
def test_statinfoNumbersAreValid(self):
"""
Verify that the right numbers come back from the right accessor methods
for file inode/device/nlinks/uid/gid (in a POSIX environment)
"""
# specify fake statinfo information
class FakeStat:
st_ino = 200
st_dev = 300
st_nlink = 400
st_uid = 500
st_gid = 600
# monkey patch in a fake restat method for self.path
fake = FakeStat()
def fakeRestat(*args, **kwargs):
self.path.statinfo = fake
self.path.restat = fakeRestat
# ensure that restat will need to be called to get values
self.path.statinfo = None
self.assertEqual(self.path.getInodeNumber(), fake.st_ino)
self.assertEqual(self.path.getDevice(), fake.st_dev)
self.assertEqual(self.path.getNumberOfHardLinks(), fake.st_nlink)
self.assertEqual(self.path.getUserID(), fake.st_uid)
self.assertEqual(self.path.getGroupID(), fake.st_gid)
if platform.isWindows():
test_statinfoBitsAreNumbers.skip = True
test_statinfoNumbersAreValid.skip = True
test_getPermissions_POSIX.skip = True
else:
test_statinfoBitsNotImplementedInWindows.skip = "Test will run only on Windows."
test_getPermissions_Windows.skip = "Test will run only on Windows."
class SetContentTests(BytesTestCase):
"""
Tests for L{FilePath.setContent}.
"""
def test_write(self):
"""
Contents of the file referred to by a L{FilePath} can be written using
L{FilePath.setContent}.
"""
pathString = self.mktemp()
path = filepath.FilePath(pathString)
path.setContent(b"hello, world")
with open(pathString, "rb") as fObj:
contents = fObj.read()
self.assertEqual(b"hello, world", contents)
def test_fileClosing(self):
"""
If writing to the underlying file raises an exception,
L{FilePath.setContent} raises that exception after closing the file.
"""
fp = ExplodingFilePath(b"")
self.assertRaises(IOError, fp.setContent, b"blah")
self.assertTrue(fp.fp.closed)
def test_nameCollision(self):
"""
L{FilePath.setContent} will use a different temporary filename on each
invocation, so that multiple processes, threads, or reentrant
invocations will not collide with each other.
"""
fp = TrackingFilePath(self.mktemp())
fp.setContent(b"alpha")
fp.setContent(b"beta")
# Sanity check: setContent should only open one derivative path each
# time to store the temporary file.
openedSiblings = fp.openedPaths()
self.assertEqual(len(openedSiblings), 2)
self.assertNotEqual(openedSiblings[0], openedSiblings[1])
def _assertOneOpened(self, fp, extension):
"""
Assert that the L{TrackingFilePath} C{fp} was used to open one sibling
with the given extension.
@param fp: A L{TrackingFilePath} which should have been used to open
file at a sibling path.
@type fp: L{TrackingFilePath}
@param extension: The extension the sibling path is expected to have
had.
@type extension: L{bytes}
@raise: C{self.failureException} is raised if the extension of the
opened file is incorrect or if not exactly one file was opened
using C{fp}.
"""
opened = fp.openedPaths()
self.assertEqual(len(opened), 1, "expected exactly one opened file")
self.assertTrue(
opened[0].basename().endswith(extension),
"%s does not end with %r extension" % (
opened[0].basename(), extension))
def test_defaultExtension(self):
"""
L{FilePath.setContent} creates temporary files with the extension
I{.new} if no alternate extension value is given.
"""
fp = TrackingFilePath(self.mktemp())
fp.setContent(b"hello")
self._assertOneOpened(fp, b".new")
def test_customExtension(self):
"""
L{FilePath.setContent} creates temporary files with a user-supplied
extension so that if it is somehow interrupted while writing them the
file that it leaves behind will be identifiable.
"""
fp = TrackingFilePath(self.mktemp())
fp.setContent(b"goodbye", b"-something-else")
self._assertOneOpened(fp, b"-something-else")
|