import xattr
from pathlib import Path
import os
+import errno
+import sys
+
+if xattr.__version__ != '0.9.1':
+ print("WARNING, only tested with xattr version 0.9.1")
+
+# Linux / BSD Compatibility
+ENOATTR = errno.ENODATA
+if hasattr(errno, "ENOATTR"):
+ ENOATTR = errno.ENOATTR
# TODO
# - listxattr: list too long
# - sidecar file permissions
# - corrupt metadata files
+skipNamespaceTests = False
-class TestXAttrs(unittest.TestCase):
+
+class TestXAttrBase(unittest.TestCase):
def setUp(self):
- self.randomFile = "./mount/tmp/foo.txt"
- self.randomFileSidecar = "./mount/tmp/foo.txt.xattr"
+ self.sourceDir = "./source/"
+ self.mountDir = "./mount/"
+ self.randomFilename = "foo.txt"
+
+ self.randomFile = self.mountDir + self.randomFilename
+ self.randomFileSidecar = self.randomFile + ".xattr"
+
+ self.randomSourceFile = self.sourceDir + self.randomFilename
+ self.randomSourceFileSidecar = self.randomSourceFile + ".xattr"
+
if os.path.isfile(self.randomFile):
os.remove(self.randomFile)
- Path(self.randomFile).touch()
if os.path.isfile(self.randomFileSidecar):
os.remove(self.randomFileSidecar)
- def tearDown(self):
- os.remove(self.randomFile)
-
- def test_xattr_set(self):
- xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
-
- def test_xattr_set_name_max_length(self):
- enc = "utf-8"
- key = "user." + "x" * 250
- value = "x"
- self.assertEqual(len(key), 255)
- xattr.setxattr(self.randomFile, key, bytes(value, enc))
-
- key = "user." + "x" * 251
- self.assertEqual(len(key), 256)
- with self.assertRaises(OSError) as ex:
- xattr.setxattr(self.randomFile, key, bytes(value, enc))
- self.assertEqual(ex.exception.errno, 34)
- self.assertEqual(ex.exception.strerror, "Numerical result out of range")
-
- @unittest.expectedFailure
- def test_xattr_set_value_max_size(self):
- enc = "utf-8"
- key = "user.foo"
- value = "x" * (64 * 1024 + 1) # we want max 64KiB of data
- with self.assertRaises(OSError) as ex:
- xattr.setxattr(self.randomFile, key, bytes(value, enc))
-
- # on btrfs we get "no space left on device"
- self.assertEqual(ex.exception.errno, 28)
- self.assertEqual(ex.exception.strerror, "No space left on device")
+ Path(self.randomFile).touch()
+ self.assertTrue(os.path.isfile(self.randomFile))
+ self.assertFalse(os.path.isfile(self.randomFileSidecar))
- # on fuse_xattr we get "Argument list too long"
- # the error is thrown by fuse, not by fuse_xattr code
+ def tearDown(self):
+ if os.path.isfile(self.randomFile):
+ os.remove(self.randomFile)
- def test_xattr_set_namespaces(self):
- with self.assertRaises(OSError) as ex:
- xattr.setxattr(self.randomFile, "system.foo", bytes("bar", "utf-8"))
- self.assertEqual(ex.exception.errno, 95)
- self.assertEqual(ex.exception.strerror, "Operation not supported")
+ if os.path.isfile(self.randomFileSidecar):
+ os.remove(self.randomFileSidecar)
- with self.assertRaises(OSError) as ex:
- xattr.setxattr(self.randomFile, "trust.foo", bytes("bar", "utf-8"))
- self.assertEqual(ex.exception.errno, 95)
- self.assertEqual(ex.exception.strerror, "Operation not supported")
- with self.assertRaises(OSError) as ex:
- xattr.setxattr(self.randomFile, "foo.foo", bytes("bar", "utf-8"))
- self.assertEqual(ex.exception.errno, 95)
- self.assertEqual(ex.exception.strerror, "Operation not supported")
+##########################################################################################
+# The following tests are generic for any FS that supports extended attributes
+class TestGenericXAttrs(TestXAttrBase):
- with self.assertRaises(PermissionError) as ex:
- xattr.setxattr(self.randomFile, "security.foo", bytes("bar", "utf-8"))
- self.assertEqual(ex.exception.errno, 1)
- self.assertEqual(ex.exception.strerror, "Operation not permitted")
+ def test_xattr_set(self):
+ xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
def test_xattr_get_non_existent(self):
key = "user.foo"
with self.assertRaises(OSError) as ex:
xattr.getxattr(self.randomFile, key)
- self.assertEqual(ex.exception.errno, 61)
- self.assertEqual(ex.exception.strerror, "No data available")
+ self.assertEqual(ex.exception.errno, ENOATTR)
def test_xattr_get(self):
enc = "utf-8"
read_value = xattr.getxattr(self.randomFile, key)
self.assertEqual(value, read_value.decode(enc))
+ # FIXME: On OSX fuse is replacing the return value 0 with -1
+ def test_xattr_set_empty(self):
+ enc = "utf-8"
+ key = "user.foo"
+ value = ""
+ xattr.setxattr(self.randomFile, key, bytes(value, enc))
+ read_value = xattr.getxattr(self.randomFile, key)
+ self.assertEqual(value, read_value.decode(enc))
+
def test_xattr_set_override(self):
enc = "utf-8"
key = "user.foo"
value = "bar"
with self.assertRaises(OSError) as ex:
xattr.setxattr(self.randomFile, key, bytes(value, enc), xattr.XATTR_REPLACE)
- self.assertEqual(ex.exception.errno, 61)
- self.assertEqual(ex.exception.strerror, "No data available")
+ self.assertEqual(ex.exception.errno, ENOATTR)
with self.assertRaises(OSError) as ex:
xattr.getxattr(self.randomFile, key)
- self.assertEqual(ex.exception.errno, 61)
- self.assertEqual(ex.exception.strerror, "No data available")
+ self.assertEqual(ex.exception.errno, ENOATTR)
def test_xattr_list_empty(self):
attrs = xattr.listxattr(self.randomFile)
# list
attrs = xattr.listxattr(self.randomFile)
self.assertEqual(len(attrs), 1)
- self.assertTrue(key in attrs)
+ self.assertEqual(attrs[0], key)
# read
read_value = xattr.getxattr(self.randomFile, key)
# should fail when trying to read it
with self.assertRaises(OSError) as ex:
xattr.getxattr(self.randomFile, key)
- self.assertEqual(ex.exception.errno, 61)
- self.assertEqual(ex.exception.strerror, "No data available")
+ self.assertEqual(ex.exception.errno, ENOATTR)
# removing twice should fail
with self.assertRaises(OSError) as ex:
xattr.getxattr(self.randomFile, key)
- self.assertEqual(ex.exception.errno, 61)
- self.assertEqual(ex.exception.strerror, "No data available")
+ self.assertEqual(ex.exception.errno, ENOATTR)
+
+ def test_xattr_set_name_max_length(self):
+ max_len = 255
+ if sys.platform != 'linux':
+ max_len = 127 # OSX VFS only support names up to 127 bytes
+
+ enc = "utf-8"
+ key = "user." + "x" * (max_len - 5)
+ value = "x"
+ self.assertEqual(len(key), max_len)
+ xattr.setxattr(self.randomFile, key, bytes(value, enc)) # NOTE: WILL FAIL IF RUNNING ON HFS+
+
+ key = "user." + "x" * (max_len - 5 + 1)
+ self.assertEqual(len(key), max_len + 1)
+ with self.assertRaises(OSError) as ex:
+ xattr.setxattr(self.randomFile, key, bytes(value, enc))
+ if sys.platform == 'linux':
+ self.assertEqual(ex.exception.errno, errno.ERANGE) # This is the behavior of BTRFS
+ else:
+ self.assertEqual(ex.exception.errno, errno.ENAMETOOLONG)
+
+ #########################################################
+ # On Linux: The test fails as the max value is detected before reaching the filesystem
+ # On OSX: Works on fuse_xattr but fails on HFS+ (doesn't has limit)
+ @unittest.skipIf(sys.platform == "linux", "Skipping test on Linux")
+ def test_xattr_set_value_max_size(self):
+ enc = "utf-8"
+ key = "user.foo"
+ value = "x" * (64 * 1024 + 1) # we want max 64KiB of data
+ with self.assertRaises(OSError) as ex:
+ xattr.setxattr(self.randomFile, key, bytes(value, enc)) # NOTE: This test fail on HFS+ (doesn't have limit)
+
+ self.assertEqual(ex.exception.errno, errno.ENOSPC)
+
+ # on fuse_xattr we get "Argument list too long"
+ # the error is thrown by fuse, not by fuse_xattr code
+
+ #########################################################
+ # Those tests are going to pass on Linux but fail on BSD
+ # BSD doesn't support namespaces.
+ @unittest.skipIf(skipNamespaceTests, "Namespace tests disabled")
+ def test_xattr_set_namespaces(self):
+ with self.assertRaises(OSError) as ex:
+ xattr.setxattr(self.randomFile, "system.foo", bytes("bar", "utf-8"))
+ self.assertEqual(ex.exception.errno, 95)
+ self.assertEqual(ex.exception.strerror, "Operation not supported")
+
+ with self.assertRaises(OSError) as ex:
+ xattr.setxattr(self.randomFile, "trust.foo", bytes("bar", "utf-8"))
+ self.assertEqual(ex.exception.errno, 95)
+ self.assertEqual(ex.exception.strerror, "Operation not supported")
+
+ with self.assertRaises(OSError) as ex:
+ xattr.setxattr(self.randomFile, "foo.foo", bytes("bar", "utf-8"))
+ self.assertEqual(ex.exception.errno, 95)
+ self.assertEqual(ex.exception.strerror, "Operation not supported")
+
+ with self.assertRaises(PermissionError) as ex:
+ xattr.setxattr(self.randomFile, "security.foo", bytes("bar", "utf-8"))
+ self.assertEqual(ex.exception.errno, 1)
+ self.assertEqual(ex.exception.strerror, "Operation not permitted")
+
+
+######################################################################
+# The following tests should fail if they are running on a normal FS
+class TestFuseXATTR(TestXAttrBase):
+
+ def test_hide_sidecar(self):
+ xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
+ self.assertTrue(os.path.isfile(self.randomFile))
+ self.assertFalse(os.path.isfile(self.randomFileSidecar))
+
+ sidecarFilename = self.randomFilename + ".xattr"
+ files_mount = os.listdir(self.mountDir)
+ self.assertTrue(self.randomFilename in files_mount)
+ self.assertTrue(sidecarFilename not in files_mount)
+
+ files_source = os.listdir(self.sourceDir)
+ self.assertTrue(self.randomFilename in files_source)
+ self.assertTrue(sidecarFilename in files_source)
+
+ def test_fuse_xattr_create_new_file(self):
+ test_filename = "test_create_new_file"
+ self.assertFalse(os.path.isfile(self.sourceDir + test_filename))
+ self.assertFalse(os.path.isfile(self.mountDir + test_filename))
+
+ open(self.mountDir + test_filename, "a").close()
+ self.assertTrue(os.path.isfile(self.sourceDir + test_filename))
+ self.assertTrue(os.path.isfile(self.mountDir + test_filename))
+ # FIXME: if one assert fails, the file isn't going to be deleted
+ os.remove(self.mountDir + test_filename)
+
+ def test_fuse_xattr_remove_file_with_sidecar(self):
+ xattr.setxattr(self.randomFile, "user.foo", bytes("bar", "utf-8"))
+ self.assertTrue(os.path.isfile(self.randomFile))
+ self.assertTrue(os.path.isfile(self.randomSourceFile))
+ self.assertTrue(os.path.isfile(self.randomSourceFileSidecar))
+
+ os.remove(self.randomFile)
+ self.assertFalse(os.path.isfile(self.randomFile))
+ self.assertFalse(os.path.isfile(self.randomSourceFile))
+ self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
+
+ def test_fuse_xattr_remove_file_without_sidecar(self):
+ self.assertTrue(os.path.isfile(self.randomFile))
+ self.assertTrue(os.path.isfile(self.randomSourceFile))
+ self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
+
+ os.remove(self.randomFile)
+ self.assertFalse(os.path.isfile(self.randomFile))
+ self.assertFalse(os.path.isfile(self.randomSourceFile))
+ self.assertFalse(os.path.isfile(self.randomSourceFileSidecar))
if __name__ == '__main__':
unittest.main()