tests/test_acls.py

   1 #
   2 #
   3
   4 """Unittests for the posix1e module"""
   5
   6 #  Copyright (C) 2002-2009, 2012, 2014, 2015 Iustin Pop <iustin@k1024.org>
   7 #
   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.
  12 #
  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.
  17 #
  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
  21 #  02110-1301  USA
  22
  23
  24 import unittest
  25 import os
  26 import tempfile
  27 import sys
  28 import platform
  29 import re
  30 import errno
  31 import operator
  32 import pytest  # type: ignore
  33 import contextlib
  34 import pathlib
  35 import io
  36
  37 import posix1e
  38 from posix1e import *
  39
  40 TEST_DIR = os.environ.get("TEST_DIR", ".")
  41
  42 BASIC_ACL_TEXT = "u::rw,g::r,o::-"
  43 TEXT_0755 = "u::rwx,g::rx,o::rx"
  44
  45 # Permset permission information
  46 PERMSETS = [
  47     (ACL_READ, "read", Permset.read),
  48     (ACL_WRITE, "write", Permset.write),
  49     (ACL_EXECUTE, "execute", Permset.execute),
  50 ]
  51
  52 PERMSETS_IDS = [p[1] for p in PERMSETS]
  53
  54 ALL_TAGS = [
  55   (posix1e.ACL_USER, "user"),
  56   (posix1e.ACL_GROUP, "group"),
  57   (posix1e.ACL_USER_OBJ, "user object"),
  58   (posix1e.ACL_GROUP_OBJ, "group object"),
  59   (posix1e.ACL_MASK, "mask"),
  60   (posix1e.ACL_OTHER, "other"),
  61 ]
  62
  63 ALL_TAG_VALUES = [i[0] for i in ALL_TAGS]
  64 ALL_TAG_DESCS = [i[1] for i in ALL_TAGS]
  65
  66 # Fixtures and helpers
  67
  68 def ignore_ioerror(errnum, fn, *args, **kwargs):
  69     """Call a function while ignoring some IOErrors.
  70
  71     This is needed as some OSes (e.g. FreeBSD) return failure (EINVAL)
  72     when doing certain operations on an invalid ACL.
  73
  74     """
  75     try:
  76         fn(*args, **kwargs)
  77     except IOError as err:
  78         if err.errno == errnum:
  79             return
  80         raise
  81
  82 def assert_acl_eq(a, b):
  83     if HAS_ACL_CHECK:
  84         assert a == b
  85     assert str(a) == str(b)
  86
  87 @pytest.fixture
  88 def testdir():
  89     """per-test temp dir based in TEST_DIR"""
  90     with tempfile.TemporaryDirectory(dir=TEST_DIR) as dname:
  91         yield dname
  92
  93 def get_file(path):
  94     fh, fname = tempfile.mkstemp(".test", "xattr-", path)
  95     return fh, fname
  96
  97 @contextlib.contextmanager
  98 def get_file_name(path):
  99     fh, fname = get_file(path)
 100     os.close(fh)
 101     yield fname
 102
 103 @contextlib.contextmanager
 104 def get_file_fd(path):
 105     fd = get_file(path)[0]
 106     yield fd
 107     os.close(fd)
 108
 109 @contextlib.contextmanager
 110 def get_file_object(path):
 111     fd = get_file(path)[0]
 112     with os.fdopen(fd) as f:
 113         yield f
 114
 115 @contextlib.contextmanager
 116 def get_dir(path):
 117     yield tempfile.mkdtemp(".test", "xattr-", path)
 118
 119 def get_symlink(path, dangling=True):
 120     """create a symlink"""
 121     fh, fname = get_file(path)
 122     os.close(fh)
 123     if dangling:
 124         os.unlink(fname)
 125     sname = fname + ".symlink"
 126     os.symlink(fname, sname)
 127     return fname, sname
 128
 129 @contextlib.contextmanager
 130 def get_valid_symlink(path):
 131     yield get_symlink(path, dangling=False)[1]
 132
 133 @contextlib.contextmanager
 134 def get_dangling_symlink(path):
 135     yield get_symlink(path, dangling=True)[1]
 136
 137 @contextlib.contextmanager
 138 def get_file_and_symlink(path):
 139     yield get_symlink(path, dangling=False)
 140
 141 @contextlib.contextmanager
 142 def get_file_and_fobject(path):
 143     fh, fname = get_file(path)
 144     with os.fdopen(fh) as fo:
 145         yield fname, fo
 146
 147 # Wrappers that build upon existing values
 148
 149 def as_wrapper(call, fn, closer=None):
 150     @contextlib.contextmanager
 151     def f(path):
 152         with call(path) as r:
 153             val = fn(r)
 154             yield val
 155             if closer is not None:
 156                 closer(val)
 157     return f
 158
 159 def as_bytes(call):
 160     return as_wrapper(call, lambda r: r.encode())
 161
 162 def as_fspath(call):
 163     return as_wrapper(call, pathlib.PurePath)
 164
 165 def as_iostream(call):
 166     opener = lambda f: io.open(f, "r")
 167     closer = lambda r: r.close()
 168     return as_wrapper(call, opener, closer)
 169
 170 NOT_BEFORE_36 = pytest.mark.xfail(condition="sys.version_info < (3,6)",
 171                                   strict=True)
 172 NOT_PYPY = pytest.mark.xfail(condition="platform.python_implementation() == 'PyPy'",
 173                                   strict=False)
 174
 175 require_acl_from_mode = pytest.mark.skipif("not HAS_ACL_FROM_MODE")
 176 require_acl_check = pytest.mark.skipif("not HAS_ACL_CHECK")
 177 require_acl_entry = pytest.mark.skipif("not HAS_ACL_ENTRY")
 178 require_extended_check = pytest.mark.skipif("not HAS_EXTENDED_CHECK")
 179 require_equiv_mode = pytest.mark.skipif("not HAS_EQUIV_MODE")
 180 require_copy_ext = pytest.mark.skipif("not HAS_COPY_EXT")
 181
 182 # Note: ACLs are valid only for files/directories, not symbolic links
 183 # themselves, so we only create valid symlinks.
 184 FILE_P = [
 185     get_file_name,
 186     as_bytes(get_file_name),
 187     pytest.param(as_fspath(get_file_name),
 188                  marks=[NOT_BEFORE_36, NOT_PYPY]),
 189     get_dir,
 190     as_bytes(get_dir),
 191     pytest.param(as_fspath(get_dir),
 192                  marks=[NOT_BEFORE_36, NOT_PYPY]),
 193     get_valid_symlink,
 194     as_bytes(get_valid_symlink),
 195     pytest.param(as_fspath(get_valid_symlink),
 196                  marks=[NOT_BEFORE_36, NOT_PYPY]),
 197 ]
 198
 199 FILE_D = [
 200     "file name",
 201     "file name (bytes)",
 202     "file name (path)",
 203     "directory",
 204     "directory (bytes)",
 205     "directory (path)",
 206     "file via symlink",
 207     "file via symlink (bytes)",
 208     "file via symlink (path)",
 209 ]
 210
 211 FD_P = [
 212     get_file_fd,
 213     get_file_object,
 214     as_iostream(get_file_name),
 215 ]
 216
 217 FD_D = [
 218     "file FD",
 219     "file object",
 220     "file io stream",
 221 ]
 222
 223 DIR_D = [
 224     "directory",
 225     "directory (bytes)",
 226     "directory (path object)",
 227 ]
 228
 229 DIR_P = [
 230     get_dir,
 231     as_bytes(get_dir),
 232     pytest.param(as_fspath(get_dir),
 233                  marks=[NOT_BEFORE_36, NOT_PYPY]),
 234 ]
 235
 236 ALL_P = FILE_P + FD_P
 237 ALL_D = FILE_D + FD_D
 238
 239 @pytest.fixture(params=FILE_P, ids=FILE_D)
 240 def file_subject(testdir, request):
 241     with request.param(testdir) as value:
 242         yield value
 243
 244 @pytest.fixture(params=FD_P, ids=FD_D)
 245 def fd_subject(testdir, request):
 246     with request.param(testdir) as value:
 247         yield value
 248
 249 @pytest.fixture(params=DIR_P, ids=DIR_D)
 250 def dir_subject(testdir, request):
 251     with request.param(testdir) as value:
 252         yield value
 253
 254 @pytest.fixture(params=ALL_P, ids=ALL_D)
 255 def subject(testdir, request):
 256     with request.param(testdir) as value:
 257         yield value
 258
 259
 260 class TestLoad:
 261     """Load/create tests"""
 262     def test_from_file(self, file_subject):
 263         """Test loading ACLs from a file/directory"""
 264         acl = posix1e.ACL(file=file_subject)
 265         assert acl.valid()
 266
 267     def test_from_dir(self, dir_subject):
 268         """Test loading ACLs from a directory"""
 269         acl2 = posix1e.ACL(filedef=dir_subject)
 270         # default ACLs might or might not be valid; missing ones are
 271         # not valid, so we don't test acl2 for validity
 272
 273     def test_from_fd(self, fd_subject):
 274         """Test loading ACLs from a file descriptor"""
 275         acl = posix1e.ACL(fd=fd_subject)
 276         assert acl.valid()
 277
 278     def test_from_nonexisting(self, testdir):
 279         _, fname = get_file(testdir)
 280         with pytest.raises(IOError):
 281             posix1e.ACL(file="fname"+".no-such-file")
 282         with pytest.raises(IOError):
 283             posix1e.ACL(filedef="fname"+".no-such-file")
 284
 285     def test_from_invalid_fd(self, testdir):
 286         fd, _ = get_file(testdir)
 287         os.close(fd)
 288         with pytest.raises(IOError):
 289             posix1e.ACL(fd=fd)
 290
 291     def test_from_empty_invalid(self):
 292         """Test creating an empty ACL"""
 293         acl1 = posix1e.ACL()
 294         assert not acl1.valid()
 295
 296     def test_from_text(self):
 297         """Test creating an ACL from text"""
 298         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 299         assert acl1.valid()
 300
 301     # This is acl_check, but should actually be have_linux...
 302     @require_acl_check
 303     def test_from_acl(self):
 304         """Test creating an ACL from an existing ACL"""
 305         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 306         acl2 = posix1e.ACL(acl=acl1)
 307         assert acl1 == acl2
 308
 309     def test_from_acl_via_str(self):
 310         # This is needed for not HAVE_LINUX cases.
 311         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 312         acl2 = posix1e.ACL(acl=acl1)
 313         assert str(acl1) == str(acl2)
 314
 315     def test_invalid_creation_params(self, testdir):
 316         """Test that creating an ACL from multiple objects fails"""
 317         fd, _ = get_file(testdir)
 318         with pytest.raises(ValueError):
 319           posix1e.ACL(text=BASIC_ACL_TEXT, fd=fd)
 320
 321     def test_invalid_value_creation(self):
 322         """Test that creating an ACL from wrong specification fails"""
 323         with pytest.raises(EnvironmentError):
 324           posix1e.ACL(text="foobar")
 325         with pytest.raises(TypeError):
 326           posix1e.ACL(foo="bar")
 327
 328     def test_uninit(self):
 329         """Checks that uninit is actually empty init"""
 330         acl = posix1e.ACL.__new__(posix1e.ACL)
 331         assert not acl.valid()
 332         e = acl.append()
 333         e.permset
 334         acl.delete_entry(e)
 335
 336     def test_double_init(self):
 337         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 338         assert acl1.valid()
 339         acl1.__init__(text=BASIC_ACL_TEXT) # type: ignore
 340         assert acl1.valid()
 341         acl2 = ACL(text=TEXT_0755)
 342         assert acl1 != acl2
 343         acl1.__init__(acl=acl2)  # type: ignore
 344         assert_acl_eq(acl1, acl2)
 345
 346     def test_reinit_failure_noop(self):
 347         a = posix1e.ACL(text=TEXT_0755)
 348         b = posix1e.ACL(acl=a)
 349         assert_acl_eq(a, b)
 350         with pytest.raises(IOError):
 351             a.__init__(text='foobar')
 352         assert_acl_eq(a, b)
 353
 354     @pytest.mark.xfail(reason="Unreliable test, re-init doesn't always invalidate children")
 355     def test_double_init_breaks_children(self):
 356         acl = posix1e.ACL()
 357         e = acl.append()
 358         e.permset.write = True
 359         acl.__init__() # type: ignore
 360         with pytest.raises(EnvironmentError):
 361             e.permset.write = False
 362
 363
 364 class TestAclExtensions:
 365     """ACL extensions checks"""
 366
 367     @require_acl_from_mode
 368     def test_from_mode(self):
 369         """Test loading ACLs from an octal mode"""
 370         acl1 = posix1e.ACL(mode=0o644)
 371         assert acl1.valid()
 372
 373     @require_acl_check
 374     def test_acl_check(self):
 375         """Test the acl_check method"""
 376         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 377         assert not acl1.check()
 378         acl2 = posix1e.ACL()
 379         c = acl2.check()
 380         assert c == (ACL_MISS_ERROR, 0)
 381         assert isinstance(c, tuple)
 382         assert c[0] == ACL_MISS_ERROR
 383         e = acl2.append()
 384         c = acl2.check()
 385         assert c == (ACL_ENTRY_ERROR, 0)
 386
 387     def test_applyto(self, subject):
 388         """Test the apply_to function"""
 389         # TODO: add read/compare with before, once ACL can be init'ed
 390         # from any source.
 391         basic_acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 392         basic_acl.applyto(subject)
 393         enhanced_acl = posix1e.ACL(text="u::rw,g::-,o::-,u:root:rw,mask::r")
 394         assert enhanced_acl.valid()
 395         enhanced_acl.applyto(subject)
 396
 397     def test_apply_to_with_wrong_object(self):
 398         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 399         assert acl1.valid()
 400         with pytest.raises(TypeError):
 401           acl1.applyto(object())
 402         with pytest.raises(TypeError):
 403           acl1.applyto(object(), object()) # type: ignore
 404
 405     def test_apply_to_fail(self, testdir):
 406         acl1 = posix1e.ACL(text=BASIC_ACL_TEXT)
 407         assert acl1.valid()
 408         fd, fname = get_file(testdir)
 409         os.close(fd)
 410         with pytest.raises(IOError):
 411           acl1.applyto(fd)
 412         with pytest.raises(IOError, match="no-such-file"):
 413           acl1.applyto(fname+".no-such-file")
 414
 415     @require_extended_check
 416     def test_applyto_extended(self, subject):
 417         """Test the acl_extended function"""
 418         basic_acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 419         basic_acl.applyto(subject)
 420         assert not has_extended(subject)
 421         enhanced_acl = posix1e.ACL(text="u::rw,g::-,o::-,u:root:rw,mask::r")
 422         assert enhanced_acl.valid()
 423         enhanced_acl.applyto(subject)
 424         assert has_extended(subject)
 425
 426     @require_extended_check
 427     @pytest.mark.parametrize(
 428         "gen", [ get_file_and_symlink, get_file_and_fobject ])
 429     def test_applyto_extended_mixed(self, testdir, gen):
 430         """Test the acl_extended function"""
 431         with gen(testdir) as (a, b):
 432             basic_acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 433             basic_acl.applyto(a)
 434             for item in a, b:
 435                 assert not has_extended(item)
 436             enhanced_acl = posix1e.ACL(text="u::rw,g::-,o::-,u:root:rw,mask::r")
 437             assert enhanced_acl.valid()
 438             enhanced_acl.applyto(b)
 439             for item in a, b:
 440                 assert has_extended(item)
 441
 442     @require_extended_check
 443     def test_extended_fail(self, testdir):
 444         fd, fname = get_file(testdir)
 445         os.close(fd)
 446         with pytest.raises(IOError):
 447           has_extended(fd)
 448         with pytest.raises(IOError, match="no-such-file"):
 449           has_extended(fname+".no-such-file")
 450
 451     @require_extended_check
 452     def test_extended_arg_handling(self):
 453       with pytest.raises(TypeError):
 454         has_extended() # type: ignore
 455       with pytest.raises(TypeError):
 456         has_extended(object()) # type: ignore
 457
 458     @require_equiv_mode
 459     def test_equiv_mode(self):
 460         """Test the equiv_mode function"""
 461         if HAS_ACL_FROM_MODE:
 462             for mode in 0o644, 0o755:
 463                 acl = posix1e.ACL(mode=mode)
 464                 assert acl.equiv_mode() == mode
 465         acl = posix1e.ACL(text="u::rw,g::r,o::r")
 466         assert acl.equiv_mode() == 0o644
 467         acl = posix1e.ACL(text="u::rx,g::-,o::-")
 468         assert acl.equiv_mode() == 0o500
 469
 470     @require_equiv_mode
 471     @pytest.mark.xfail(reason="It seems equiv mode always passes, even for empty ACLs")
 472     def test_equiv_mode_invalid(self):
 473         """Test equiv_mode on invalid ACLs"""
 474         a = posix1e.ACL()
 475         with pytest.raises(EnvironmentError):
 476             a.equiv_mode()
 477
 478     @require_acl_check
 479     def test_to_any_text(self):
 480         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 481         assert b"u::" in \
 482           acl.to_any_text(options=posix1e.TEXT_ABBREVIATE)
 483         assert b"user::" in acl.to_any_text()
 484
 485     @require_acl_check
 486     def test_to_any_text_wrong_args(self):
 487         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 488         with pytest.raises(TypeError):
 489           acl.to_any_text(foo="bar") # type: ignore
 490
 491
 492     @require_acl_check
 493     def test_rich_compare(self):
 494         acl1 = posix1e.ACL(text="u::rw,g::r,o::r")
 495         acl2 = posix1e.ACL(acl=acl1)
 496         acl3 = posix1e.ACL(text="u::rw,g::rw,o::r")
 497         assert acl1 == acl2
 498         assert acl1 != acl3
 499         with pytest.raises(TypeError):
 500           acl1 < acl2 # type: ignore
 501         with pytest.raises(TypeError):
 502           acl1 >= acl3 # type: ignore
 503         assert acl1 != True # type: ignore
 504         assert not (acl1 == 1) # type: ignore
 505         with pytest.raises(TypeError):
 506           acl1 > True # type: ignore
 507
 508     @require_acl_entry
 509     def test_acl_iterator(self):
 510         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 511         for entry in acl:
 512             assert entry.parent is acl
 513
 514     @require_copy_ext
 515     def test_acl_copy_ext(self):
 516         a = posix1e.ACL(text=BASIC_ACL_TEXT)
 517         b = posix1e.ACL()
 518         c = posix1e.ACL(acl=b)
 519         assert a != b
 520         assert b == c
 521         state = a.__getstate__()
 522         b.__setstate__(state)
 523         assert a == b
 524         assert b != c
 525
 526     @require_copy_ext
 527     def test_acl_copy_ext_args(self):
 528         a = posix1e.ACL()
 529         with pytest.raises(TypeError):
 530             a.__setstate__(None)
 531
 532     @require_copy_ext
 533     def test_acl_init_copy_ext(self):
 534         a = posix1e.ACL(text=BASIC_ACL_TEXT)
 535         b = posix1e.ACL()
 536         c = posix1e.ACL(data=a.__getstate__())
 537         assert c != b
 538         assert c == a
 539
 540     @require_copy_ext
 541     def test_acl_init_copy_ext_invalid(self):
 542         with pytest.raises(IOError):
 543             posix1e.ACL(data=b"foobar")
 544
 545
 546 class TestWrite:
 547     """Write tests"""
 548
 549     def test_delete_default(self, testdir):
 550         """Test removing the default ACL"""
 551         with get_dir(testdir) as dname:
 552           posix1e.delete_default(dname)
 553
 554     def test_delete_default_fail(self, testdir):
 555         """Test removing the default ACL"""
 556         with get_file_name(testdir) as fname:
 557             with pytest.raises(IOError, match="no-such-file"):
 558                 posix1e.delete_default(fname+".no-such-file")
 559
 560     @NOT_PYPY
 561     def test_delete_default_wrong_arg(self):
 562         with pytest.raises(TypeError):
 563           posix1e.delete_default(object()) # type: ignore
 564
 565     def test_reapply(self, testdir):
 566         """Test re-applying an ACL"""
 567         fd, fname = get_file(testdir)
 568         acl1 = posix1e.ACL(fd=fd)
 569         acl1.applyto(fd)
 570         acl1.applyto(fname)
 571         with get_dir(testdir) as dname:
 572           acl2 = posix1e.ACL(file=fname)
 573           acl2.applyto(dname)
 574
 575
 576
 577 @require_acl_entry
 578 class TestModification:
 579     """ACL modification tests"""
 580
 581     def checkRef(self, obj):
 582         """Checks if a given obj has a 'sane' refcount"""
 583         if platform.python_implementation() == "PyPy":
 584             return
 585         ref_cnt = sys.getrefcount(obj)
 586         # FIXME: hardcoded value for the max ref count... but I've
 587         # seen it overflow on bad reference counting, so it's better
 588         # to be safe
 589         if ref_cnt < 2 or ref_cnt > 1024:
 590             pytest.fail("Wrong reference count, expected 2-1024 and got %d" %
 591                         ref_cnt)
 592
 593     def test_str(self):
 594         """Test str() of an ACL."""
 595         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 596         str_acl = str(acl)
 597         self.checkRef(str_acl)
 598
 599     def test_append(self):
 600         """Test append a new Entry to the ACL"""
 601         acl = posix1e.ACL()
 602         e = acl.append()
 603         e.tag_type = posix1e.ACL_OTHER
 604         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 605         str_format = str(e)
 606         self.checkRef(str_format)
 607         e2 = acl.append(e)
 608         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 609         assert not acl.valid()
 610
 611     def test_wrong_append(self):
 612         """Test append a new Entry to the ACL based on wrong object type"""
 613         acl = posix1e.ACL()
 614         with pytest.raises(TypeError):
 615           acl.append(object()) # type: ignore
 616
 617     @pytest.mark.xfail(reason="Behaviour not conform to specification")
 618     def test_append_invalid_source(self):
 619         a = posix1e.ACL()
 620         b = posix1e.ACL()
 621         f = b.append()
 622         b.delete_entry(f)
 623         with pytest.raises(EnvironmentError):
 624             f.permset.write = True
 625         with pytest.raises(EnvironmentError):
 626             e = a.append(f)
 627
 628     def test_entry_creation(self):
 629         acl = posix1e.ACL()
 630         e = posix1e.Entry(acl)
 631         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 632         str_format = str(e)
 633         self.checkRef(str_format)
 634
 635     def test_entry_failed_creation(self):
 636         # Checks for partial initialisation and deletion on error
 637         # path.
 638         with pytest.raises(TypeError):
 639           posix1e.Entry(object()) # type: ignore
 640
 641     def test_entry_reinitialisations(self):
 642         a = posix1e.ACL()
 643         b = posix1e.ACL()
 644         e = posix1e.Entry(a)
 645         e.__init__(a) # type: ignore
 646         with pytest.raises(ValueError, match="different parent"):
 647             e.__init__(b) # type: ignore
 648
 649     @NOT_PYPY
 650     def test_entry_reinit_leaks_refcount(self):
 651         acl = posix1e.ACL()
 652         e = acl.append()
 653         ref = sys.getrefcount(acl)
 654         e.__init__(acl) # type: ignore
 655         assert ref == sys.getrefcount(acl), "Uh-oh, ref leaks..."
 656
 657     def test_delete(self):
 658         """Test delete Entry from the ACL"""
 659         acl = posix1e.ACL()
 660         e = acl.append()
 661         e.tag_type = posix1e.ACL_OTHER
 662         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 663         acl.delete_entry(e)
 664         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 665
 666     def test_double_delete(self):
 667         """Test delete Entry from the ACL"""
 668         # This is not entirely valid/correct, since the entry object
 669         # itself is invalid after the first deletion, so we're
 670         # actually testing deleting an invalid object, not a
 671         # non-existing entry...
 672         acl = posix1e.ACL()
 673         e = acl.append()
 674         e.tag_type = posix1e.ACL_OTHER
 675         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 676         acl.delete_entry(e)
 677         ignore_ioerror(errno.EINVAL, acl.calc_mask)
 678         with pytest.raises(EnvironmentError):
 679           acl.delete_entry(e)
 680
 681     def test_delete_unowned(self):
 682         """Test delete Entry from the ACL"""
 683         a = posix1e.ACL()
 684         b = posix1e.ACL()
 685         e = a.append()
 686         e.tag_type = posix1e.ACL_OTHER
 687         with pytest.raises(ValueError, match="un-owned entry"):
 688             b.delete_entry(e)
 689
 690     # This currently fails as this deletion seems to be accepted :/
 691     @pytest.mark.xfail(reason="Entry deletion is unreliable")
 692     def testDeleteInvalidEntry(self):
 693         """Test delete foreign Entry from the ACL"""
 694         acl1 = posix1e.ACL()
 695         acl2 = posix1e.ACL()
 696         e = acl1.append()
 697         e.tag_type = posix1e.ACL_OTHER
 698         ignore_ioerror(errno.EINVAL, acl1.calc_mask)
 699         with pytest.raises(EnvironmentError):
 700           acl2.delete_entry(e)
 701
 702     def test_delete_invalid_object(self):
 703         """Test delete a non-Entry from the ACL"""
 704         acl = posix1e.ACL()
 705         with pytest.raises(TypeError):
 706           acl.delete_entry(object()) # type: ignore
 707
 708     def test_double_entries(self):
 709         """Test double entries"""
 710         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 711         assert acl.valid()
 712         for tag_type in (posix1e.ACL_USER_OBJ, posix1e.ACL_GROUP_OBJ,
 713                          posix1e.ACL_OTHER):
 714             e = acl.append()
 715             e.tag_type = tag_type
 716             e.permset.clear()
 717             assert not acl.valid(), ("ACL containing duplicate entries"
 718                                      " should not be valid")
 719             acl.delete_entry(e)
 720
 721     def test_multiple_good_entries(self):
 722         """Test multiple valid entries"""
 723         acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 724         assert acl.valid()
 725         for tag_type in (posix1e.ACL_USER,
 726                          posix1e.ACL_GROUP):
 727             for obj_id in range(5):
 728                 e = acl.append()
 729                 e.tag_type = tag_type
 730                 e.qualifier = obj_id
 731                 e.permset.clear()
 732                 acl.calc_mask()
 733                 assert acl.valid(), ("ACL should be able to hold multiple"
 734                                      " user/group entries")
 735
 736     def test_multiple_bad_entries(self):
 737         """Test multiple invalid entries"""
 738         for tag_type in (posix1e.ACL_USER,
 739                          posix1e.ACL_GROUP):
 740             acl = posix1e.ACL(text=BASIC_ACL_TEXT)
 741             assert acl.valid()
 742             e1 = acl.append()
 743             e1.tag_type = tag_type
 744             e1.qualifier = 0
 745             e1.permset.clear()
 746             acl.calc_mask()
 747             assert acl.valid(), ("ACL should be able to add a"
 748                                  " user/group entry")
 749             e2 = acl.append()
 750             e2.tag_type = tag_type
 751             e2.qualifier = 0
 752             e2.permset.clear()
 753             ignore_ioerror(errno.EINVAL, acl.calc_mask)
 754             assert not acl.valid(), ("ACL should not validate when"
 755                                      " containing two duplicate entries")
 756             acl.delete_entry(e1)
 757             # FreeBSD trips over itself here and can't delete the
 758             # entry, even though it still exists.
 759             ignore_ioerror(errno.EINVAL, acl.delete_entry, e2)
 760
 761     def test_copy(self):
 762         acl = ACL()
 763         e1 = acl.append()
 764         e1.tag_type = ACL_USER
 765         p1 = e1.permset
 766         p1.clear()
 767         p1.read = True
 768         p1.write = True
 769         e2 = acl.append()
 770         e2.tag_type = ACL_GROUP
 771         p2 = e2.permset
 772         p2.clear()
 773         p2.read = True
 774         assert not p2.write
 775         e2.copy(e1)
 776         assert p2.write
 777         assert e1.tag_type == e2.tag_type
 778
 779     def test_copy_wrong_arg(self):
 780         acl = ACL()
 781         e = acl.append()
 782         with pytest.raises(TypeError):
 783           e.copy(object()) # type: ignore
 784
 785     def test_set_permset(self):
 786         acl = ACL()
 787         e1 = acl.append()
 788         e1.tag_type = ACL_USER
 789         p1 = e1.permset
 790         p1.clear()
 791         p1.read = True
 792         p1.write = True
 793         e2 = acl.append()
 794         e2.tag_type = ACL_GROUP
 795         p2 = e2.permset
 796         p2.clear()
 797         p2.read = True
 798         assert not p2.write
 799         e2.permset = p1
 800         assert e2.permset.write
 801         assert e2.tag_type == ACL_GROUP
 802
 803     def test_set_permset_wrong_arg(self):
 804         acl = ACL()
 805         e = acl.append()
 806         with pytest.raises(TypeError):
 807           e.permset = object() # type: ignore
 808
 809     def test_permset_creation(self):
 810         acl = ACL()
 811         e = acl.append()
 812         p1 = e.permset
 813         p2 = Permset(e)
 814         #assert p1 == p2
 815
 816     def test_permset_creation_wrong_arg(self):
 817         with pytest.raises(TypeError):
 818           Permset(object()) # type: ignore
 819
 820     def test_permset_reinitialisations(self):
 821         a = posix1e.ACL()
 822         e = posix1e.Entry(a)
 823         f = posix1e.Entry(a)
 824         p = e.permset
 825         p.__init__(e) # type: ignore
 826         with pytest.raises(ValueError, match="different parent"):
 827             p.__init__(f) # type: ignore
 828
 829     @NOT_PYPY
 830     def test_permset_reinit_leaks_refcount(self):
 831         acl = posix1e.ACL()
 832         e = acl.append()
 833         p = e.permset
 834         ref = sys.getrefcount(e)
 835         p.__init__(e) # type: ignore
 836         assert ref == sys.getrefcount(e), "Uh-oh, ref leaks..."
 837
 838     @pytest.mark.parametrize("perm, txt, accessor",
 839                              PERMSETS, ids=PERMSETS_IDS)
 840     def test_permset(self, perm, txt, accessor):
 841         """Test permissions"""
 842         del accessor
 843         acl = posix1e.ACL()
 844         e = acl.append()
 845         ps = e.permset
 846         ps.clear()
 847         str_ps = str(ps)
 848         self.checkRef(str_ps)
 849         assert not ps.test(perm), ("Empty permission set should not"
 850                                    " have permission '%s'" % txt)
 851         ps.add(perm)
 852         assert ps.test(perm), ("Permission '%s' should exist"
 853                                " after addition" % txt)
 854         str_ps = str(ps)
 855         self.checkRef(str_ps)
 856         ps.delete(perm)
 857         assert not ps.test(perm), ("Permission '%s' should not exist"
 858                                    " after deletion" % txt)
 859         ps.add(perm)
 860         assert ps.test(perm), ("Permission '%s' should exist"
 861                                " after addition" % txt)
 862         ps.clear()
 863         assert not ps.test(perm), ("Permission '%s' should not exist"
 864                                    " after clearing" % txt)
 865
 866
 867
 868     @pytest.mark.parametrize("perm, txt, accessor",
 869                              PERMSETS, ids=PERMSETS_IDS)
 870     def test_permset_via_accessors(self, perm, txt, accessor):
 871         """Test permissions"""
 872         acl = posix1e.ACL()
 873         e = acl.append()
 874         ps = e.permset
 875         ps.clear()
 876         def getter():
 877             return accessor.__get__(ps) # type: ignore
 878         def setter(value):
 879             return accessor.__set__(ps, value) # type: ignore
 880         str_ps = str(ps)
 881         self.checkRef(str_ps)
 882         assert not getter(), ("Empty permission set should not"
 883                               " have permission '%s'" % txt)
 884         setter(True)
 885         assert ps.test(perm), ("Permission '%s' should exist"
 886                                " after addition" % txt)
 887         assert getter(), ("Permission '%s' should exist"
 888                           " after addition" % txt)
 889         str_ps = str(ps)
 890         self.checkRef(str_ps)
 891         setter(False)
 892         assert not ps.test(perm), ("Permission '%s' should not exist"
 893                                    " after deletion" % txt)
 894         assert not getter(), ("Permission '%s' should not exist"
 895                                   " after deletion" % txt)
 896         setter(True)
 897         assert getter()
 898         ps.clear()
 899         assert not getter()
 900
 901     def test_permset_invalid_type(self):
 902         acl = posix1e.ACL()
 903         e = acl.append()
 904         ps = e.permset
 905         ps.clear()
 906         with pytest.raises(TypeError):
 907           ps.add("foobar") # type: ignore
 908         with pytest.raises(TypeError):
 909           ps.delete("foobar") # type: ignore
 910         with pytest.raises(TypeError):
 911           ps.test("foobar") # type: ignore
 912         with pytest.raises(ValueError):
 913           ps.write = object() # type: ignore
 914
 915     @pytest.mark.parametrize("tag", [ACL_USER, ACL_GROUP],
 916                              ids=["ACL_USER", "ACL_GROUP"])
 917     def test_qualifier_values(self, tag):
 918         """Tests qualifier correct store/retrieval"""
 919         acl = posix1e.ACL()
 920         e = acl.append()
 921         qualifier = 1
 922         e.tag_type = tag
 923         while True:
 924             regex = re.compile("(user|group) with (u|g)id %d" % qualifier)
 925             try:
 926                 e.qualifier = qualifier
 927             except OverflowError:
 928                 # reached overflow condition, break
 929                 break
 930             assert e.qualifier == qualifier
 931             assert regex.search(str(e)) is not None
 932             qualifier *= 2
 933
 934     def test_qualifier_overflow(self):
 935         """Tests qualifier overflow handling"""
 936         acl = posix1e.ACL()
 937         e = acl.append()
 938         # the uid_t/gid_t are unsigned, so they can hold slightly more
 939         # than sys.maxsize*2 (on Linux).
 940         qualifier = (sys.maxsize + 1) * 2
 941         for tag in [posix1e.ACL_USER, posix1e.ACL_GROUP]:
 942             e.tag_type = tag
 943             with pytest.raises(OverflowError):
 944                 e.qualifier = qualifier
 945
 946     def test_qualifier_underflow(self):
 947         """Tests negative qualifier handling"""
 948         # Note: this presumes that uid_t/gid_t in C are unsigned...
 949         acl = posix1e.ACL()
 950         e = acl.append()
 951         for tag in [posix1e.ACL_USER, posix1e.ACL_GROUP]:
 952             e.tag_type = tag
 953             for qualifier in [-10, -5, -1]:
 954                 with pytest.raises(OverflowError):
 955                     e.qualifier = qualifier
 956
 957     def test_invalid_qualifier(self):
 958         """Tests invalid qualifier handling"""
 959         acl = posix1e.ACL()
 960         e = acl.append()
 961         with pytest.raises(TypeError):
 962           e.qualifier = object() # type: ignore
 963         with pytest.raises((TypeError, AttributeError)):
 964           del e.qualifier
 965
 966     def test_qualifier_on_wrong_tag(self):
 967         """Tests qualifier setting on wrong tag"""
 968         acl = posix1e.ACL()
 969         e = acl.append()
 970         e.tag_type = posix1e.ACL_OTHER
 971         with pytest.raises(TypeError):
 972           e.qualifier = 1
 973         with pytest.raises(TypeError):
 974           e.qualifier
 975
 976     @pytest.mark.parametrize("tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
 977     def test_tag_types(self, tag):
 978         """Tests tag type correct set/get"""
 979         acl = posix1e.ACL()
 980         e = acl.append()
 981         e.tag_type = tag
 982         assert e.tag_type == tag
 983         # check we can show all tag types without breaking
 984         assert str(e)
 985
 986     @pytest.mark.parametrize("src_tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
 987     @pytest.mark.parametrize("dst_tag", ALL_TAG_VALUES, ids=ALL_TAG_DESCS)
 988     def test_tag_overwrite(self, src_tag, dst_tag):
 989         """Tests tag type correct set/get"""
 990         acl = posix1e.ACL()
 991         e = acl.append()
 992         e.tag_type = src_tag
 993         assert e.tag_type == src_tag
 994         assert str(e)
 995         e.tag_type = dst_tag
 996         assert e.tag_type == dst_tag
 997         assert str(e)
 998
 999     def test_invalid_tags(self):
1000         """Tests tag type incorrect set/get"""
1001         acl = posix1e.ACL()
1002         e = acl.append()
1003         with pytest.raises(TypeError):
1004           e.tag_type = object() # type: ignore
1005         e.tag_type = posix1e.ACL_USER_OBJ
1006         # For some reason, PyPy raises AttributeError. Strange...
1007         with pytest.raises((TypeError, AttributeError)):
1008           del e.tag_type
1009
1010     def test_tag_wrong_overwrite(self):
1011         acl = posix1e.ACL()
1012         e = acl.append()
1013         e.tag_type = posix1e.ACL_USER_OBJ
1014         tag = max(ALL_TAG_VALUES) + 1
1015         with pytest.raises(EnvironmentError):
1016           e.tag_type = tag
1017         # Check tag is still valid.
1018         assert e.tag_type == posix1e.ACL_USER_OBJ
1019
1020 if __name__ == "__main__":
1021     unittest.main()