4 # fuse_xattrs - Add xattrs support using sidecar files
6 # Copyright (C) 2016 Felipe Barriga Richards <felipe {at} felipebarriga.cl>
8 # This program can be distributed under the terms of the GNU GPL.
9 # See the file COPYING.
14 from pathlib import Path
17 if xattr.__version__ != '0.9.1':
18 print("WARNING, only tested with xattr version 0.9.1")
21 # - listxattr: list too long
22 # - sidecar file permissions
23 # - corrupt metadata files
26 class TestXAttrs(unittest.TestCase):
28 self.sourceDir = "./source/"
29 self.mountDir = "./mount/"
30 self.randomFilename = "foo.txt"
32 self.randomFile = self.mountDir + self.randomFilename
33 self.randomFileSidecar = self.randomFile + ".xattr"
35 self.randomSourceFile = self.sourceDir + self.randomFilename
36 self.randomSourceFileSidecar = self.randomSourceFile + ".xattr"
38 if os.path.isfile(self.randomFile):
39 os.remove(self.randomFile)
41 if os.path.isfile(self.randomFileSidecar):
42 os.remove(self.randomFileSidecar)
44 Path(self.randomFile).touch()
45 self.assertTrue(os.path.isfile(self.randomFile))
46 self.assertFalse(os.path.isfile(self.randomFileSidecar))
49 if os.path.isfile(self.randomFile):
50 os.remove(self.randomFile)
52 if os.path.isfile(self.randomFileSidecar):
53 os.remove(self.randomFileSidecar)
55 def test_xattr_set(self):
56 xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
58 def test_xattr_set_name_max_length(self):
60 key = "user." + "x" * 250
62 self.assertEqual(len(key), 255)
63 xattr.setxattr(self.randomFile, key, bytes(value, enc))
65 key = "user." + "x" * 251
66 self.assertEqual(len(key), 256)
67 with self.assertRaises(OSError) as ex:
68 xattr.setxattr(self.randomFile, key, bytes(value, enc))
69 self.assertEqual(ex.exception.errno, 34)
70 self.assertEqual(ex.exception.strerror, "Numerical result out of range")
72 @unittest.expectedFailure
73 def test_xattr_set_value_max_size(self):
76 value = "x" * (64 * 1024 + 1) # we want max 64KiB of data
77 with self.assertRaises(OSError) as ex:
78 xattr.setxattr(self.randomFile, key, bytes(value, enc))
80 # on btrfs we get "no space left on device"
81 self.assertEqual(ex.exception.errno, 28)
82 self.assertEqual(ex.exception.strerror, "No space left on device")
84 # on fuse_xattr we get "Argument list too long"
85 # the error is thrown by fuse, not by fuse_xattr code
87 def test_xattr_set_namespaces(self):
88 with self.assertRaises(OSError) as ex:
89 xattr.setxattr(self.randomFile, "system.foo", bytes("bar", "utf-8"))
90 self.assertEqual(ex.exception.errno, 95)
91 self.assertEqual(ex.exception.strerror, "Operation not supported")
93 with self.assertRaises(OSError) as ex:
94 xattr.setxattr(self.randomFile, "trust.foo", bytes("bar", "utf-8"))
95 self.assertEqual(ex.exception.errno, 95)
96 self.assertEqual(ex.exception.strerror, "Operation not supported")
98 with self.assertRaises(OSError) as ex:
99 xattr.setxattr(self.randomFile, "foo.foo", bytes("bar", "utf-8"))
100 self.assertEqual(ex.exception.errno, 95)
101 self.assertEqual(ex.exception.strerror, "Operation not supported")
103 with self.assertRaises(PermissionError) as ex:
104 xattr.setxattr(self.randomFile, "security.foo", bytes("bar", "utf-8"))
105 self.assertEqual(ex.exception.errno, 1)
106 self.assertEqual(ex.exception.strerror, "Operation not permitted")
108 def test_xattr_get_non_existent(self):
110 with self.assertRaises(OSError) as ex:
111 xattr.getxattr(self.randomFile, key)
112 self.assertEqual(ex.exception.errno, 61)
113 self.assertEqual(ex.exception.strerror, "No data available")
115 def test_xattr_get(self):
119 xattr.setxattr(self.randomFile, key, bytes(value, enc))
120 read_value = xattr.getxattr(self.randomFile, key)
121 self.assertEqual(value, read_value.decode(enc))
123 def test_xattr_set_override(self):
128 xattr.setxattr(self.randomFile, key, bytes(value1, enc))
129 xattr.setxattr(self.randomFile, key, bytes(value2, enc))
130 read_value = xattr.getxattr(self.randomFile, key)
131 self.assertEqual(value2, read_value.decode(enc))
133 def test_xattr_set_create(self):
138 xattr.setxattr(self.randomFile, key, bytes(value1, enc), xattr.XATTR_CREATE)
139 with self.assertRaises(FileExistsError) as ex:
140 xattr.setxattr(self.randomFile, key, bytes(value2, enc), xattr.XATTR_CREATE)
141 self.assertEqual(ex.exception.errno, 17)
142 self.assertEqual(ex.exception.strerror, "File exists")
144 read_value = xattr.getxattr(self.randomFile, key)
145 self.assertEqual(value1, read_value.decode(enc))
147 def test_xattr_set_replace(self):
151 with self.assertRaises(OSError) as ex:
152 xattr.setxattr(self.randomFile, key, bytes(value, enc), xattr.XATTR_REPLACE)
153 self.assertEqual(ex.exception.errno, 61)
154 self.assertEqual(ex.exception.strerror, "No data available")
156 with self.assertRaises(OSError) as ex:
157 xattr.getxattr(self.randomFile, key)
158 self.assertEqual(ex.exception.errno, 61)
159 self.assertEqual(ex.exception.strerror, "No data available")
161 def test_xattr_list_empty(self):
162 attrs = xattr.listxattr(self.randomFile)
163 self.assertEqual(len(attrs), 0)
165 def test_xattr_list(self):
173 xattr.setxattr(self.randomFile, key1, bytes(value, enc))
174 xattr.setxattr(self.randomFile, key2, bytes(value, enc))
175 xattr.setxattr(self.randomFile, key3, bytes(value, enc))
177 # get and check the list
178 attrs = xattr.listxattr(self.randomFile)
180 self.assertEqual(len(attrs), 3)
181 self.assertTrue(key1 in attrs)
182 self.assertTrue(key2 in attrs)
183 self.assertTrue(key3 in attrs)
185 def test_xattr_unicode(self):
187 key = "user.fooシüßてЙĘ𝄠✠"
191 xattr.setxattr(self.randomFile, key, bytes(value, enc))
194 attrs = xattr.listxattr(self.randomFile)
195 self.assertEqual(len(attrs), 1)
196 self.assertEqual(attrs[0], key)
199 read_value = xattr.getxattr(self.randomFile, key)
200 self.assertEqual(value, read_value.decode(enc))
203 xattr.removexattr(self.randomFile, key)
205 def test_xattr_remove(self):
211 xattr.setxattr(self.randomFile, key, bytes(value, enc))
214 xattr.removexattr(self.randomFile, key)
216 # list should be empty
217 attrs = xattr.listxattr(self.randomFile)
218 self.assertEqual(len(attrs), 0)
220 # should fail when trying to read it
221 with self.assertRaises(OSError) as ex:
222 xattr.getxattr(self.randomFile, key)
223 self.assertEqual(ex.exception.errno, 61)
224 self.assertEqual(ex.exception.strerror, "No data available")
226 # removing twice should fail
227 with self.assertRaises(OSError) as ex:
228 xattr.getxattr(self.randomFile, key)
229 self.assertEqual(ex.exception.errno, 61)
230 self.assertEqual(ex.exception.strerror, "No data available")
232 def test_hide_sidecar(self):
233 xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
234 self.assertTrue(os.path.isfile(self.randomFile))
235 self.assertFalse(os.path.isfile(self.randomFileSidecar))
237 sidecarFilename = self.randomFilename + ".xattr"
238 files_mount = os.listdir(self.mountDir)
239 self.assertTrue(self.randomFilename in files_mount)
240 self.assertTrue(sidecarFilename not in files_mount)
242 files_source = os.listdir(self.sourceDir)
243 self.assertTrue(self.randomFilename in files_source)
244 self.assertTrue(sidecarFilename in files_source)
246 def test_create_new_file(self):
247 test_filename = "test_create_new_file"
248 self.assertFalse(os.path.isfile(self.sourceDir + test_filename))
249 self.assertFalse(os.path.isfile(self.mountDir + test_filename))
251 open(self.mountDir + test_filename, "a").close()
252 self.assertTrue(os.path.isfile(self.sourceDir + test_filename))
253 self.assertTrue(os.path.isfile(self.mountDir + test_filename))
254 # FIXME: if one assert fails, the file isn't going to be deleted
255 os.remove(self.mountDir + test_filename)
257 def test_remove_file_with_sidecar(self):
258 xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
259 self.assertTrue(os.path.isfile(self.randomFile))
260 self.assertTrue(os.path.isfile(self.randomSourceFile))
261 self.assertTrue(os.path.isfile(self.randomSourceFileSidecar))
263 os.remove(self.randomFile)
264 self.assertFalse(os.path.isfile(self.randomFile))
265 self.assertFalse(os.path.isfile(self.randomSourceFile))
266 self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
268 def test_remove_file_without_sidecar(self):
269 self.assertTrue(os.path.isfile(self.randomFile))
270 self.assertTrue(os.path.isfile(self.randomSourceFile))
271 self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
273 os.remove(self.randomFile)
274 self.assertFalse(os.path.isfile(self.randomFile))
275 self.assertFalse(os.path.isfile(self.randomSourceFile))
276 self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
278 if __name__ == '__main__':