4 """Unittests for the posix1e module"""
6 # Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop <iustin@k1024.org>
8 # This library is free software; you can redistribute it and/or
9 # modify it under the terms of the GNU Lesser General Public
10 # License as published by the Free Software Foundation; either
11 # version 2.1 of the License, or (at your option) any later version.
13 # This library is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 # Lesser General Public License for more details.
18 # You should have received a copy of the GNU Lesser General Public
19 # License along with this library; if not, write to the Free Software
20 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
40 TEST_DIR = os.environ.get("TEST_DIR", ".")
42 BASIC_ACL_TEXT = "u::rw,g::r,o::-"
44 # Permset permission information
46 posix1e.ACL_READ: ("read", posix1e.Permset.read),
47 posix1e.ACL_WRITE: ("write", posix1e.Permset.write),
48 posix1e.ACL_EXECUTE: ("execute", posix1e.Permset.execute),
52 (posix1e.ACL_USER, "user"),
53 (posix1e.ACL_GROUP, "group"),
54 (posix1e.ACL_USER_OBJ, "user object"),
55 (posix1e.ACL_GROUP_OBJ, "group object"),
56 (posix1e.ACL_MASK, "mask"),
57 (posix1e.ACL_OTHER, "other"),
60 ALL_TAG_VALUES = [i[0] for i in ALL_TAGS]
61 ALL_TAG_DESCS = [i[1] for i in ALL_TAGS]
63 # Fixtures and helpers
65 def ignore_ioerror(errnum, fn, *args, **kwargs):
66 """Call a function while ignoring some IOErrors.
68 This is needed as some OSes (e.g. FreeBSD) return failure (EINVAL)
69 when doing certain operations on an invalid ACL.
75 err = sys.exc_info()[1]
76 if err.errno == errnum:
82 """per-test temp dir based in TEST_DIR"""
83 with tempfile.TemporaryDirectory(dir=TEST_DIR) as dname:
87 fh, fname = tempfile.mkstemp(".test", "xattr-", path)
90 @contextlib.contextmanager
91 def get_file_name(path):
92 fh, fname = get_file(path)
96 @contextlib.contextmanager
97 def get_file_fd(path):
98 fd = get_file(path)[0]
102 @contextlib.contextmanager
103 def get_file_object(path):
104 fd = get_file(path)[0]
105 with os.fdopen(fd) as f:
108 @contextlib.contextmanager
110 yield tempfile.mkdtemp(".test", "xattr-", path)
112 def get_symlink(path, dangling=True):
113 """create a symlink"""
114 fh, fname = get_file(path)
118 sname = fname + ".symlink"
119 os.symlink(fname, sname)
122 @contextlib.contextmanager
123 def get_valid_symlink(path):
124 yield get_symlink(path, dangling=False)[1]
126 @contextlib.contextmanager
127 def get_dangling_symlink(path):
128 yield get_symlink(path, dangling=True)[1]
130 @contextlib.contextmanager
131 def get_file_and_symlink(path):
132 yield get_symlink(path, dangling=False)
134 @contextlib.contextmanager
135 def get_file_and_fobject(path):
136 fh, fname = get_file(path)
137 with os.fdopen(fh) as fo:
140 # Wrappers that build upon existing values
142 def as_wrapper(call, fn, closer=None):
143 @contextlib.contextmanager
145 with call(path) as r:
148 if closer is not None:
153 return as_wrapper(call, lambda r: r.encode())
156 return as_wrapper(call, pathlib.PurePath)
158 def as_iostream(call):
159 opener = lambda f: io.open(f, "r")
160 closer = lambda r: r.close()
161 return as_wrapper(call, opener, closer)
163 NOT_BEFORE_36 = pytest.mark.xfail(condition="sys.version_info < (3,6)",
165 NOT_PYPY = pytest.mark.xfail(condition="platform.python_implementation() == 'PyPy'",
168 require_acl_from_mode = pytest.mark.skipif("not HAS_ACL_FROM_MODE")
169 require_acl_check = pytest.mark.skipif("not HAS_ACL_CHECK")
170 require_acl_entry = pytest.mark.skipif("not HAS_ACL_ENTRY")
171 require_extended_check = pytest.mark.skipif("not HAS_EXTENDED_CHECK")
172 require_equiv_mode = pytest.mark.skipif("not HAS_EQUIV_MODE")
174 # Note: ACLs are valid only for files/directories, not symbolic links
175 # themselves, so we only create valid symlinks.
178 as_bytes(get_file_name),
179 pytest.param(as_fspath(get_file_name),
180 marks=[NOT_BEFORE_36, NOT_PYPY]),
183 pytest.param(as_fspath(get_dir),
184 marks=[NOT_BEFORE_36, NOT_PYPY]),
186 as_bytes(get_valid_symlink),
187 pytest.param(as_fspath(get_valid_symlink),
188 marks=[NOT_BEFORE_36, NOT_PYPY]),
199 "file via symlink (bytes)",
200 "file via symlink (path)",
206 as_iostream(get_file_name),
215 ALL_P = FILE_P + FD_P
216 ALL_D = FILE_D + FD_D
218 @pytest.fixture(params=FILE_P, ids=FILE_D)
219 def file_subject(testdir, request):
220 with request.param(testdir) as value:
223 @pytest.fixture(params=FD_P, ids=FD_D)
224 def fd_subject(testdir, request):
225 with request.param(testdir) as value:
228 @pytest.fixture(params=ALL_P, ids=ALL_D)
229 def subject(testdir, request):
230 with request.param(testdir) as value:
235 """Load/create tests"""
236 def test_from_file(self, testdir):
237 """Test loading ACLs from a file"""
238 _, fname = get_file(testdir)
239 acl1 = posix1e.ACL(file=fname)
242 def test_from_dir(self, testdir):
243 """Test loading ACLs from a directory"""
244 with get_dir(testdir) as dname:
245 acl1 = posix1e.ACL(file=dname)
246 acl2 = posix1e.ACL(filedef=dname)
248 # default ACLs might or might not be valid; missing ones are
249 # not valid, so we don't test acl2 for validity
251 def test_from_fd(self, testdir):
252 """Test loading ACLs from a file descriptor"""
253 fd, _ = get_file(testdir)
254 acl1 = posix1e.ACL(fd=fd)
257 def test_from_empty_invalid(self):
258 """Test creating an empty ACL"""
260 assert not acl1.valid()
262 def test_from_text(self):
263 """Test creating an ACL from text"""
264 acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
267 def test_from_acl(self):
268 """Test creating an ACL from an existing ACL"""
270 acl2 = posix1e.ACL(acl=acl1)
273 def test_invalid_creation_params(self, testdir):
274 """Test that creating an ACL from multiple objects fails"""
275 fd, _ = get_file(testdir)
276 with pytest.raises(ValueError):
277 posix1e.ACL(text=BASIC_ACL_TEXT, fd=fd)
279 def test_invalid_value_creation(self):
280 """Test that creating an ACL from wrong specification fails"""
281 with pytest.raises(EnvironmentError):
282 posix1e.ACL(text="foobar")
283 with pytest.raises(TypeError):
284 posix1e.ACL(foo="bar")
286 def test_double_init(self):
287 acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
289 acl1.__init__(text=BASIC_ACL_TEXT)
292 class TestAclExtensions:
293 """ACL extensions checks"""
295 @require_acl_from_mode
296 def test_from_mode(self):
297 """Test loading ACLs from an octal mode"""
298 acl1 = posix1e.ACL(mode=0o644)
302 def test_acl_check(self):
303 """Test the acl_check method"""
304 acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
305 assert not acl1.check()
309 @require_extended_check
310 def test_applyto_extended(self, subject):
311 """Test the acl_extended function"""
312 basic_acl = posix1e.ACL(text=BASIC_ACL_TEXT)
313 basic_acl.applyto(subject)
314 assert not has_extended(subject)
315 enhanced_acl = posix1e.ACL(text="u::rw,g::-,o::-,u:root:rw,mask::r")
316 assert enhanced_acl.valid()
317 enhanced_acl.applyto(subject)
318 assert has_extended(subject)
320 @require_extended_check
321 @pytest.mark.parametrize(
322 "gen", [ get_file_and_symlink, get_file_and_fobject ])
323 def test_applyto_extended_mixed(self, testdir, gen):
324 """Test the acl_extended function"""
325 with gen(testdir) as (a, b):
326 basic_acl = posix1e.ACL(text=BASIC_ACL_TEXT)
329 assert not has_extended(item)
330 enhanced_acl = posix1e.ACL(text="u::rw,g::-,o::-,u:root:rw,mask::r")
331 assert enhanced_acl.valid()
332 enhanced_acl.applyto(b)
334 assert has_extended(item)
336 @require_extended_check
337 def test_extended_arg_handling(self):
338 with pytest.raises(TypeError):
340 with pytest.raises(TypeError):
341 has_extended(object())
344 def test_equiv_mode(self):
345 """Test the equiv_mode function"""
346 if HAS_ACL_FROM_MODE:
347 for mode in 0o644, 0o755:
348 acl = posix1e.ACL(mode=mode)
349 assert acl.equiv_mode() == mode
350 acl = posix1e.ACL(text="u::rw,g::r,o::r")
351 assert acl.equiv_mode() == 0o644
352 acl = posix1e.ACL(text="u::rx,g::-,o::-")
353 assert acl.equiv_mode() == 0o500
356 def test_to_any_text(self):
357 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
359 acl.to_any_text(options=posix1e.TEXT_ABBREVIATE)
360 assert b"user::" in acl.to_any_text()
363 def test_to_any_text_wrong_args(self):
364 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
365 with pytest.raises(TypeError):
366 acl.to_any_text(foo="bar")
370 def test_rich_compare(self):
371 acl1 = posix1e.ACL(text="u::rw,g::r,o::r")
372 acl2 = posix1e.ACL(acl=acl1)
373 acl3 = posix1e.ACL(text="u::rw,g::rw,o::r")
376 with pytest.raises(TypeError):
378 with pytest.raises(TypeError):
381 assert not (acl1 == 1)
382 with pytest.raises(TypeError):
385 def test_apply_to_with_wrong_object(self):
386 acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
388 with pytest.raises(TypeError):
389 acl1.applyto(object())
390 with pytest.raises(TypeError):
391 acl1.applyto(object(), object())
394 def test_acl_iterator(self):
395 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
397 assert entry.parent is acl
403 def test_delete_default(self, testdir):
404 """Test removing the default ACL"""
405 with get_dir(testdir) as dname:
406 posix1e.delete_default(dname)
409 def test_delete_default_wrong_arg(self):
410 with pytest.raises(TypeError):
411 posix1e.delete_default(object())
413 def test_reapply(self, testdir):
414 """Test re-applying an ACL"""
415 fd, fname = get_file(testdir)
416 acl1 = posix1e.ACL(fd=fd)
419 with get_dir(testdir) as dname:
420 acl2 = posix1e.ACL(file=fname)
426 class TestModification:
427 """ACL modification tests"""
429 def checkRef(self, obj):
430 """Checks if a given obj has a 'sane' refcount"""
431 if platform.python_implementation() == "PyPy":
433 ref_cnt = sys.getrefcount(obj)
434 # FIXME: hardcoded value for the max ref count... but I've
435 # seen it overflow on bad reference counting, so it's better
437 if ref_cnt < 2 or ref_cnt > 1024:
438 pytest.fail("Wrong reference count, expected 2-1024 and got %d" %
442 """Test str() of an ACL."""
443 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
445 self.checkRef(str_acl)
447 def test_append(self):
448 """Test append a new Entry to the ACL"""
451 e.tag_type = posix1e.ACL_OTHER
452 ignore_ioerror(errno.EINVAL, acl.calc_mask)
454 self.checkRef(str_format)
456 ignore_ioerror(errno.EINVAL, acl.calc_mask)
457 assert not acl.valid()
459 def test_wrong_append(self):
460 """Test append a new Entry to the ACL based on wrong object type"""
462 with pytest.raises(TypeError):
465 def test_entry_creation(self):
467 e = posix1e.Entry(acl)
468 ignore_ioerror(errno.EINVAL, acl.calc_mask)
470 self.checkRef(str_format)
472 def test_entry_failed_creation(self):
473 # Checks for partial initialisation and deletion on error
475 with pytest.raises(TypeError):
476 posix1e.Entry(object())
478 def test_delete(self):
479 """Test delete Entry from the ACL"""
482 e.tag_type = posix1e.ACL_OTHER
483 ignore_ioerror(errno.EINVAL, acl.calc_mask)
485 ignore_ioerror(errno.EINVAL, acl.calc_mask)
487 def test_double_delete(self):
488 """Test delete Entry from the ACL"""
489 # This is not entirely valid/correct, since the entry object
490 # itself is invalid after the first deletion, so we're
491 # actually testing deleting an invalid object, not a
492 # non-existing entry...
495 e.tag_type = posix1e.ACL_OTHER
496 ignore_ioerror(errno.EINVAL, acl.calc_mask)
498 ignore_ioerror(errno.EINVAL, acl.calc_mask)
499 with pytest.raises(EnvironmentError):
502 # This currently fails as this deletion seems to be accepted :/
503 @pytest.mark.xfail(reason="Entry deletion is unreliable")
504 def testDeleteInvalidEntry(self):
505 """Test delete foreign Entry from the ACL"""
509 e.tag_type = posix1e.ACL_OTHER
510 ignore_ioerror(errno.EINVAL, acl1.calc_mask)
511 with pytest.raises(EnvironmentError):
514 def test_delete_invalid_object(self):
515 """Test delete a non-Entry from the ACL"""
517 with pytest.raises(TypeError):
518 acl.delete_entry(object())
520 def test_double_entries(self):
521 """Test double entries"""
522 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
524 for tag_type in (posix1e.ACL_USER_OBJ, posix1e.ACL_GROUP_OBJ,
527 e.tag_type = tag_type
529 assert not acl.valid(), ("ACL containing duplicate entries"
530 " should not be valid")
533 def test_multiple_good_entries(self):
534 """Test multiple valid entries"""
535 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
537 for tag_type in (posix1e.ACL_USER,
539 for obj_id in range(5):
541 e.tag_type = tag_type
545 assert acl.valid(), ("ACL should be able to hold multiple"
546 " user/group entries")
548 def test_multiple_bad_entries(self):
549 """Test multiple invalid entries"""
550 for tag_type in (posix1e.ACL_USER,
552 acl = posix1e.ACL(text=BASIC_ACL_TEXT)
555 e1.tag_type = tag_type
559 assert acl.valid(), ("ACL should be able to add a"
562 e2.tag_type = tag_type
565 ignore_ioerror(errno.EINVAL, acl.calc_mask)
566 assert not acl.valid(), ("ACL should not validate when"
567 " containing two duplicate entries")
569 # FreeBSD trips over itself here and can't delete the
570 # entry, even though it still exists.
571 ignore_ioerror(errno.EINVAL, acl.delete_entry, e2)
576 e1.tag_type = ACL_USER
582 e2.tag_type = ACL_GROUP
589 assert e1.tag_type == e2.tag_type
591 def test_copy_wrong_arg(self):
594 with pytest.raises(TypeError):
597 def test_set_permset(self):
600 e1.tag_type = ACL_USER
606 e2.tag_type = ACL_GROUP
612 assert e2.permset.write
613 assert e2.tag_type == ACL_GROUP
615 def test_set_permset_wrong_arg(self):
618 with pytest.raises(TypeError):
621 def test_permset_creation(self):
626 #self.assertEqual(p1, p2)
628 def test_permset_creation_wrong_arg(self):
629 with pytest.raises(TypeError):
632 def test_permset(self):
633 """Test permissions"""
639 self.checkRef(str_ps)
640 for perm in PERMSETS:
642 txt = PERMSETS[perm][0]
643 self.checkRef(str_ps)
644 assert not ps.test(perm), ("Empty permission set should not"
645 " have permission '%s'" % txt)
647 assert ps.test(perm), ("Permission '%s' should exist"
648 " after addition" % txt)
650 self.checkRef(str_ps)
652 assert not ps.test(perm), ("Permission '%s' should not exist"
653 " after deletion" % txt)
655 def test_permset_via_accessors(self):
656 """Test permissions"""
662 self.checkRef(str_ps)
664 return PERMSETS[perm][1].__get__(ps)
665 def setter(parm, value):
666 return PERMSETS[perm][1].__set__(ps, value)
667 for perm in PERMSETS:
669 self.checkRef(str_ps)
670 txt = PERMSETS[perm][0]
671 assert not getter(perm), ("Empty permission set should not"
672 " have permission '%s'" % txt)
674 assert ps.test(perm), ("Permission '%s' should exist"
675 " after addition" % txt)
676 assert getter(perm), ("Permission '%s' should exist"
677 " after addition" % txt)
679 self.checkRef(str_ps)
681 assert not ps.test(perm), ("Permission '%s' should not exist"
682 " after deletion" % txt)
683 assert not getter(perm), ("Permission '%s' should not exist"
684 " after deletion" % txt)
686 def test_permset_invalid_type(self):
691 with pytest.raises(TypeError):
693 with pytest.raises(TypeError):
695 with pytest.raises(TypeError):
697 with pytest.raises(ValueError):
700 def test_qualifier_values(self):
701 """Tests qualifier correct store/retrieval"""
704 # work around deprecation warnings
705 for tag in [posix1e.ACL_USER, posix1e.ACL_GROUP]:
709 if tag == posix1e.ACL_USER:
710 regex = re.compile("user with uid %d" % qualifier)
712 regex = re.compile("group with gid %d" % qualifier)
714 e.qualifier = qualifier
715 except OverflowError:
716 # reached overflow condition, break
718 assert e.qualifier == qualifier
719 assert regex.search(str(e)) is not None
722 def test_qualifier_overflow(self):
723 """Tests qualifier overflow handling"""
726 qualifier = sys.maxsize * 2
727 for tag in [posix1e.ACL_USER, posix1e.ACL_GROUP]:
729 with pytest.raises(OverflowError):
730 e.qualifier = qualifier
732 def test_negative_qualifier(self):
733 """Tests negative qualifier handling"""
734 # Note: this presumes that uid_t/gid_t in C are unsigned...
737 for tag in [posix1e.ACL_USER, posix1e.ACL_GROUP]:
739 for qualifier in [-10, -5, -1]:
740 with pytest.raises(OverflowError):
741 e.qualifier = qualifier
743 def test_invalid_qualifier(self):
744 """Tests invalid qualifier handling"""
747 with pytest.raises(TypeError):
748 e.qualifier = object()
749 with pytest.raises((TypeError, AttributeError)):
752 def test_qualifier_on_wrong_tag(self):
753 """Tests qualifier setting on wrong tag"""
756 e.tag_type = posix1e.ACL_OTHER
757 with pytest.raises(TypeError):
759 with pytest.raises(TypeError):
762 @pytest.mark.parametrize("tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
763 def test_tag_types(self, tag):
764 """Tests tag type correct set/get"""
768 assert e.tag_type == tag
769 # check we can show all tag types without breaking
772 @pytest.mark.parametrize("src_tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
773 @pytest.mark.parametrize("dst_tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
774 def test_tag_overwrite(self, src_tag, dst_tag):
775 """Tests tag type correct set/get"""
779 assert e.tag_type == src_tag
782 assert e.tag_type == dst_tag
785 def test_invalid_tags(self):
786 """Tests tag type incorrect set/get"""
789 with pytest.raises(TypeError):
790 e.tag_type = object()
791 e.tag_type = posix1e.ACL_USER_OBJ
792 # For some reason, PyPy raises AttributeError. Strange...
793 with pytest.raises((TypeError, AttributeError)):
796 def test_tag_wrong_overwrite(self):
799 e.tag_type = posix1e.ACL_USER_OBJ
800 tag = max(ALL_TAG_VALUES) + 1
801 with pytest.raises(EnvironmentError):
803 # Check tag is still valid.
804 assert e.tag_type == posix1e.ACL_USER_OBJ
806 if __name__ == "__main__":