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