test_stat.py 8.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250
  1. import unittest
  2. import os
  3. import socket
  4. import sys
  5. from test.support import os_helper
  6. from test.support import socket_helper
  7. from test.support.import_helper import import_fresh_module
  8. from test.support.os_helper import TESTFN
  9. c_stat = import_fresh_module('stat', fresh=['_stat'])
  10. py_stat = import_fresh_module('stat', blocked=['_stat'])
  11. class TestFilemode:
  12. statmod = None
  13. file_flags = {'SF_APPEND', 'SF_ARCHIVED', 'SF_IMMUTABLE', 'SF_NOUNLINK',
  14. 'SF_SNAPSHOT', 'UF_APPEND', 'UF_COMPRESSED', 'UF_HIDDEN',
  15. 'UF_IMMUTABLE', 'UF_NODUMP', 'UF_NOUNLINK', 'UF_OPAQUE'}
  16. formats = {'S_IFBLK', 'S_IFCHR', 'S_IFDIR', 'S_IFIFO', 'S_IFLNK',
  17. 'S_IFREG', 'S_IFSOCK', 'S_IFDOOR', 'S_IFPORT', 'S_IFWHT'}
  18. format_funcs = {'S_ISBLK', 'S_ISCHR', 'S_ISDIR', 'S_ISFIFO', 'S_ISLNK',
  19. 'S_ISREG', 'S_ISSOCK', 'S_ISDOOR', 'S_ISPORT', 'S_ISWHT'}
  20. stat_struct = {
  21. 'ST_MODE': 0,
  22. 'ST_INO': 1,
  23. 'ST_DEV': 2,
  24. 'ST_NLINK': 3,
  25. 'ST_UID': 4,
  26. 'ST_GID': 5,
  27. 'ST_SIZE': 6,
  28. 'ST_ATIME': 7,
  29. 'ST_MTIME': 8,
  30. 'ST_CTIME': 9}
  31. # permission bit value are defined by POSIX
  32. permission_bits = {
  33. 'S_ISUID': 0o4000,
  34. 'S_ISGID': 0o2000,
  35. 'S_ENFMT': 0o2000,
  36. 'S_ISVTX': 0o1000,
  37. 'S_IRWXU': 0o700,
  38. 'S_IRUSR': 0o400,
  39. 'S_IREAD': 0o400,
  40. 'S_IWUSR': 0o200,
  41. 'S_IWRITE': 0o200,
  42. 'S_IXUSR': 0o100,
  43. 'S_IEXEC': 0o100,
  44. 'S_IRWXG': 0o070,
  45. 'S_IRGRP': 0o040,
  46. 'S_IWGRP': 0o020,
  47. 'S_IXGRP': 0o010,
  48. 'S_IRWXO': 0o007,
  49. 'S_IROTH': 0o004,
  50. 'S_IWOTH': 0o002,
  51. 'S_IXOTH': 0o001}
  52. # defined by the Windows API documentation
  53. file_attributes = {
  54. 'FILE_ATTRIBUTE_ARCHIVE': 32,
  55. 'FILE_ATTRIBUTE_COMPRESSED': 2048,
  56. 'FILE_ATTRIBUTE_DEVICE': 64,
  57. 'FILE_ATTRIBUTE_DIRECTORY': 16,
  58. 'FILE_ATTRIBUTE_ENCRYPTED': 16384,
  59. 'FILE_ATTRIBUTE_HIDDEN': 2,
  60. 'FILE_ATTRIBUTE_INTEGRITY_STREAM': 32768,
  61. 'FILE_ATTRIBUTE_NORMAL': 128,
  62. 'FILE_ATTRIBUTE_NOT_CONTENT_INDEXED': 8192,
  63. 'FILE_ATTRIBUTE_NO_SCRUB_DATA': 131072,
  64. 'FILE_ATTRIBUTE_OFFLINE': 4096,
  65. 'FILE_ATTRIBUTE_READONLY': 1,
  66. 'FILE_ATTRIBUTE_REPARSE_POINT': 1024,
  67. 'FILE_ATTRIBUTE_SPARSE_FILE': 512,
  68. 'FILE_ATTRIBUTE_SYSTEM': 4,
  69. 'FILE_ATTRIBUTE_TEMPORARY': 256,
  70. 'FILE_ATTRIBUTE_VIRTUAL': 65536}
  71. def setUp(self):
  72. try:
  73. os.remove(TESTFN)
  74. except OSError:
  75. try:
  76. os.rmdir(TESTFN)
  77. except OSError:
  78. pass
  79. tearDown = setUp
  80. def get_mode(self, fname=TESTFN, lstat=True):
  81. if lstat:
  82. st_mode = os.lstat(fname).st_mode
  83. else:
  84. st_mode = os.stat(fname).st_mode
  85. modestr = self.statmod.filemode(st_mode)
  86. return st_mode, modestr
  87. def assertS_IS(self, name, mode):
  88. # test format, lstrip is for S_IFIFO
  89. fmt = getattr(self.statmod, "S_IF" + name.lstrip("F"))
  90. self.assertEqual(self.statmod.S_IFMT(mode), fmt)
  91. # test that just one function returns true
  92. testname = "S_IS" + name
  93. for funcname in self.format_funcs:
  94. func = getattr(self.statmod, funcname, None)
  95. if func is None:
  96. if funcname == testname:
  97. raise ValueError(funcname)
  98. continue
  99. if funcname == testname:
  100. self.assertTrue(func(mode))
  101. else:
  102. self.assertFalse(func(mode))
  103. @os_helper.skip_unless_working_chmod
  104. def test_mode(self):
  105. with open(TESTFN, 'w'):
  106. pass
  107. if os.name == 'posix':
  108. os.chmod(TESTFN, 0o700)
  109. st_mode, modestr = self.get_mode()
  110. self.assertEqual(modestr, '-rwx------')
  111. self.assertS_IS("REG", st_mode)
  112. self.assertEqual(self.statmod.S_IMODE(st_mode),
  113. self.statmod.S_IRWXU)
  114. os.chmod(TESTFN, 0o070)
  115. st_mode, modestr = self.get_mode()
  116. self.assertEqual(modestr, '----rwx---')
  117. self.assertS_IS("REG", st_mode)
  118. self.assertEqual(self.statmod.S_IMODE(st_mode),
  119. self.statmod.S_IRWXG)
  120. os.chmod(TESTFN, 0o007)
  121. st_mode, modestr = self.get_mode()
  122. self.assertEqual(modestr, '-------rwx')
  123. self.assertS_IS("REG", st_mode)
  124. self.assertEqual(self.statmod.S_IMODE(st_mode),
  125. self.statmod.S_IRWXO)
  126. os.chmod(TESTFN, 0o444)
  127. st_mode, modestr = self.get_mode()
  128. self.assertS_IS("REG", st_mode)
  129. self.assertEqual(modestr, '-r--r--r--')
  130. self.assertEqual(self.statmod.S_IMODE(st_mode), 0o444)
  131. else:
  132. os.chmod(TESTFN, 0o700)
  133. st_mode, modestr = self.get_mode()
  134. self.assertEqual(modestr[:3], '-rw')
  135. self.assertS_IS("REG", st_mode)
  136. self.assertEqual(self.statmod.S_IFMT(st_mode),
  137. self.statmod.S_IFREG)
  138. @os_helper.skip_unless_working_chmod
  139. def test_directory(self):
  140. os.mkdir(TESTFN)
  141. os.chmod(TESTFN, 0o700)
  142. st_mode, modestr = self.get_mode()
  143. self.assertS_IS("DIR", st_mode)
  144. if os.name == 'posix':
  145. self.assertEqual(modestr, 'drwx------')
  146. else:
  147. self.assertEqual(modestr[0], 'd')
  148. @os_helper.skip_unless_symlink
  149. def test_link(self):
  150. try:
  151. os.symlink(os.getcwd(), TESTFN)
  152. except (OSError, NotImplementedError) as err:
  153. raise unittest.SkipTest(str(err))
  154. else:
  155. st_mode, modestr = self.get_mode()
  156. self.assertEqual(modestr[0], 'l')
  157. self.assertS_IS("LNK", st_mode)
  158. @unittest.skipUnless(hasattr(os, 'mkfifo'), 'os.mkfifo not available')
  159. def test_fifo(self):
  160. if sys.platform == "vxworks":
  161. fifo_path = os.path.join("/fifos/", TESTFN)
  162. else:
  163. fifo_path = TESTFN
  164. self.addCleanup(os_helper.unlink, fifo_path)
  165. try:
  166. os.mkfifo(fifo_path, 0o700)
  167. except PermissionError as e:
  168. self.skipTest('os.mkfifo(): %s' % e)
  169. st_mode, modestr = self.get_mode(fifo_path)
  170. self.assertEqual(modestr, 'prwx------')
  171. self.assertS_IS("FIFO", st_mode)
  172. @unittest.skipUnless(os.name == 'posix', 'requires Posix')
  173. def test_devices(self):
  174. if os.path.exists(os.devnull):
  175. st_mode, modestr = self.get_mode(os.devnull, lstat=False)
  176. self.assertEqual(modestr[0], 'c')
  177. self.assertS_IS("CHR", st_mode)
  178. # Linux block devices, BSD has no block devices anymore
  179. for blockdev in ("/dev/sda", "/dev/hda"):
  180. if os.path.exists(blockdev):
  181. st_mode, modestr = self.get_mode(blockdev, lstat=False)
  182. self.assertEqual(modestr[0], 'b')
  183. self.assertS_IS("BLK", st_mode)
  184. break
  185. @socket_helper.skip_unless_bind_unix_socket
  186. def test_socket(self):
  187. with socket.socket(socket.AF_UNIX) as s:
  188. s.bind(TESTFN)
  189. st_mode, modestr = self.get_mode()
  190. self.assertEqual(modestr[0], 's')
  191. self.assertS_IS("SOCK", st_mode)
  192. def test_module_attributes(self):
  193. for key, value in self.stat_struct.items():
  194. modvalue = getattr(self.statmod, key)
  195. self.assertEqual(value, modvalue, key)
  196. for key, value in self.permission_bits.items():
  197. modvalue = getattr(self.statmod, key)
  198. self.assertEqual(value, modvalue, key)
  199. for key in self.file_flags:
  200. modvalue = getattr(self.statmod, key)
  201. self.assertIsInstance(modvalue, int)
  202. for key in self.formats:
  203. modvalue = getattr(self.statmod, key)
  204. self.assertIsInstance(modvalue, int)
  205. for key in self.format_funcs:
  206. func = getattr(self.statmod, key)
  207. self.assertTrue(callable(func))
  208. self.assertEqual(func(0), 0)
  209. @unittest.skipUnless(sys.platform == "win32",
  210. "FILE_ATTRIBUTE_* constants are Win32 specific")
  211. def test_file_attribute_constants(self):
  212. for key, value in sorted(self.file_attributes.items()):
  213. self.assertTrue(hasattr(self.statmod, key), key)
  214. modvalue = getattr(self.statmod, key)
  215. self.assertEqual(value, modvalue, key)
  216. class TestFilemodeCStat(TestFilemode, unittest.TestCase):
  217. statmod = c_stat
  218. class TestFilemodePyStat(TestFilemode, unittest.TestCase):
  219. statmod = py_stat
  220. if __name__ == '__main__':
  221. unittest.main()