lib/bup/t/tmetadata.py

   1
   2 from __future__ import absolute_import, print_function
   3 import errno, glob, grp, pwd, stat, tempfile, subprocess
   4
   5 from wvtest import *
   6
   7 from bup import git, metadata
   8 from bup import vfs
   9 from bup.compat import range
  10 from bup.helpers import clear_errors, detect_fakeroot, is_superuser, resolve_parent
  11 from bup.repo import LocalRepo
  12 from bup.xstat import utime, lutime
  13 from buptest import no_lingering_errors, test_tempdir
  14 import bup.helpers as helpers
  15
  16
  17 top_dir = '../../..'
  18 bup_tmp = os.path.realpath('../../../t/tmp')
  19 bup_path = top_dir + '/bup'
  20 start_dir = os.getcwd()
  21
  22
  23 def ex(*cmd):
  24     try:
  25         cmd_str = ' '.join(cmd)
  26         print(cmd_str, file=sys.stderr)
  27         rc = subprocess.call(cmd)
  28         if rc < 0:
  29             print('terminated by signal', - rc, file=sys.stderr)
  30             sys.exit(1)
  31         elif rc > 0:
  32             print('returned exit status', rc, file=sys.stderr)
  33             sys.exit(1)
  34     except OSError as e:
  35         print('subprocess call failed:', e, file=sys.stderr)
  36         sys.exit(1)
  37
  38
  39 def setup_testfs():
  40     assert(sys.platform.startswith('linux'))
  41     # Set up testfs with user_xattr, etc.
  42     if subprocess.call(['modprobe', 'loop']) != 0:
  43         return False
  44     subprocess.call(['umount', 'testfs'])
  45     ex('dd', 'if=/dev/zero', 'of=testfs.img', 'bs=1M', 'count=32')
  46     ex('mke2fs', '-F', '-j', '-m', '0', 'testfs.img')
  47     ex('rm', '-rf', 'testfs')
  48     os.mkdir('testfs')
  49     ex('mount', '-o', 'loop,acl,user_xattr', 'testfs.img', 'testfs')
  50     # Hide, so that tests can't create risks.
  51     os.chown('testfs', 0, 0)
  52     os.chmod('testfs', 0o700)
  53     return True
  54
  55
  56 def cleanup_testfs():
  57     subprocess.call(['umount', 'testfs'])
  58     helpers.unlink('testfs.img')
  59
  60
  61 @wvtest
  62 def test_clean_up_archive_path():
  63     with no_lingering_errors():
  64         cleanup = metadata._clean_up_path_for_archive
  65         WVPASSEQ(cleanup('foo'), 'foo')
  66         WVPASSEQ(cleanup('/foo'), 'foo')
  67         WVPASSEQ(cleanup('///foo'), 'foo')
  68         WVPASSEQ(cleanup('/foo/bar'), 'foo/bar')
  69         WVPASSEQ(cleanup('foo/./bar'), 'foo/bar')
  70         WVPASSEQ(cleanup('/foo/./bar'), 'foo/bar')
  71         WVPASSEQ(cleanup('/foo/./bar/././baz'), 'foo/bar/baz')
  72         WVPASSEQ(cleanup('/foo/./bar///././baz'), 'foo/bar/baz')
  73         WVPASSEQ(cleanup('//./foo/./bar///././baz/.///'), 'foo/bar/baz/')
  74         WVPASSEQ(cleanup('./foo/./.bar'), 'foo/.bar')
  75         WVPASSEQ(cleanup('./foo/.'), 'foo')
  76         WVPASSEQ(cleanup('./foo/..'), '.')
  77         WVPASSEQ(cleanup('//./..//.../..//.'), '.')
  78         WVPASSEQ(cleanup('//./..//..././/.'), '...')
  79         WVPASSEQ(cleanup('/////.'), '.')
  80         WVPASSEQ(cleanup('/../'), '.')
  81         WVPASSEQ(cleanup(''), '.')
  82
  83
  84 @wvtest
  85 def test_risky_path():
  86     with no_lingering_errors():
  87         risky = metadata._risky_path
  88         WVPASS(risky('/foo'))
  89         WVPASS(risky('///foo'))
  90         WVPASS(risky('/../foo'))
  91         WVPASS(risky('../foo'))
  92         WVPASS(risky('foo/..'))
  93         WVPASS(risky('foo/../'))
  94         WVPASS(risky('foo/../bar'))
  95         WVFAIL(risky('foo'))
  96         WVFAIL(risky('foo/'))
  97         WVFAIL(risky('foo///'))
  98         WVFAIL(risky('./foo'))
  99         WVFAIL(risky('foo/.'))
 100         WVFAIL(risky('./foo/.'))
 101         WVFAIL(risky('foo/bar'))
 102         WVFAIL(risky('foo/./bar'))
 103
 104
 105 @wvtest
 106 def test_clean_up_extract_path():
 107     with no_lingering_errors():
 108         cleanup = metadata._clean_up_extract_path
 109         WVPASSEQ(cleanup('/foo'), 'foo')
 110         WVPASSEQ(cleanup('///foo'), 'foo')
 111         WVFAIL(cleanup('/../foo'))
 112         WVFAIL(cleanup('../foo'))
 113         WVFAIL(cleanup('foo/..'))
 114         WVFAIL(cleanup('foo/../'))
 115         WVFAIL(cleanup('foo/../bar'))
 116         WVPASSEQ(cleanup('foo'), 'foo')
 117         WVPASSEQ(cleanup('foo/'), 'foo/')
 118         WVPASSEQ(cleanup('foo///'), 'foo///')
 119         WVPASSEQ(cleanup('./foo'), './foo')
 120         WVPASSEQ(cleanup('foo/.'), 'foo/.')
 121         WVPASSEQ(cleanup('./foo/.'), './foo/.')
 122         WVPASSEQ(cleanup('foo/bar'), 'foo/bar')
 123         WVPASSEQ(cleanup('foo/./bar'), 'foo/./bar')
 124         WVPASSEQ(cleanup('/'), '.')
 125         WVPASSEQ(cleanup('./'), './')
 126         WVPASSEQ(cleanup('///foo/bar'), 'foo/bar')
 127         WVPASSEQ(cleanup('///foo/bar'), 'foo/bar')
 128
 129
 130 @wvtest
 131 def test_metadata_method():
 132     with no_lingering_errors():
 133         with test_tempdir('bup-tmetadata-') as tmpdir:
 134             bup_dir = tmpdir + '/bup'
 135             data_path = tmpdir + '/foo'
 136             os.mkdir(data_path)
 137             ex('touch', data_path + '/file')
 138             ex('ln', '-s', 'file', data_path + '/symlink')
 139             test_time1 = 13 * 1000000000
 140             test_time2 = 42 * 1000000000
 141             utime(data_path + '/file', (0, test_time1))
 142             lutime(data_path + '/symlink', (0, 0))
 143             utime(data_path, (0, test_time2))
 144             ex(bup_path, '-d', bup_dir, 'init')
 145             ex(bup_path, '-d', bup_dir, 'index', '-v', data_path)
 146             ex(bup_path, '-d', bup_dir, 'save', '-tvvn', 'test', data_path)
 147             git.check_repo_or_die(bup_dir)
 148             repo = LocalRepo()
 149             resolved = vfs.resolve(repo,
 150                                    '/test/latest' + resolve_parent(data_path),
 151                                    follow=False)
 152             leaf_name, leaf_item = resolved[-1]
 153             m = leaf_item.meta
 154             WVPASS(m.mtime == test_time2)
 155             WVPASS(leaf_name == 'foo')
 156             contents = tuple(vfs.contents(repo, leaf_item))
 157             WVPASS(len(contents) == 3)
 158             WVPASSEQ(frozenset(name for name, item in contents),
 159                      frozenset(('.', 'file', 'symlink')))
 160             for name, item in contents:
 161                 if name == 'file':
 162                     m = item.meta
 163                     WVPASS(m.mtime == test_time1)
 164                 elif name == 'symlink':
 165                     m = item.meta
 166                     WVPASSEQ(m.symlink_target, 'file')
 167                     WVPASSEQ(m.size, 4)
 168                     WVPASSEQ(m.mtime, 0)
 169
 170
 171 def _first_err():
 172     if helpers.saved_errors:
 173         return str(helpers.saved_errors[0])
 174     return ''
 175
 176
 177 @wvtest
 178 def test_from_path_error():
 179     if is_superuser() or detect_fakeroot():
 180         return
 181     with no_lingering_errors():
 182         with test_tempdir('bup-tmetadata-') as tmpdir:
 183             path = tmpdir + '/foo'
 184             os.mkdir(path)
 185             m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 186             WVPASSEQ(m.path, path)
 187             os.chmod(path, 0o000)
 188             metadata.from_path(path, archive_path=path, save_symlinks=True)
 189             if metadata.get_linux_file_attr:
 190                 print('saved_errors:', helpers.saved_errors, file=sys.stderr)
 191                 WVPASS(len(helpers.saved_errors) == 1)
 192                 errmsg = _first_err()
 193                 WVPASS(errmsg.startswith('read Linux attr'))
 194                 clear_errors()
 195
 196
 197 def _linux_attr_supported(path):
 198     # Expects path to denote a regular file or a directory.
 199     if not metadata.get_linux_file_attr:
 200         return False
 201     try:
 202         metadata.get_linux_file_attr(path)
 203     except OSError as e:
 204         if e.errno in (errno.ENOTTY, errno.ENOSYS, errno.EOPNOTSUPP):
 205             return False
 206         else:
 207             raise
 208     return True
 209
 210
 211 @wvtest
 212 def test_apply_to_path_restricted_access():
 213     if is_superuser() or detect_fakeroot():
 214         return
 215     if sys.platform.startswith('cygwin'):
 216         return # chmod 000 isn't effective.
 217     with no_lingering_errors():
 218         with test_tempdir('bup-tmetadata-') as tmpdir:
 219             parent = tmpdir + '/foo'
 220             path = parent + '/bar'
 221             os.mkdir(parent)
 222             os.mkdir(path)
 223             clear_errors()
 224             m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 225             WVPASSEQ(m.path, path)
 226             os.chmod(parent, 0o000)
 227             m.apply_to_path(path)
 228             print('saved_errors:', helpers.saved_errors, file=sys.stderr)
 229             expected_errors = ['utime: ']
 230             if m.linux_attr and _linux_attr_supported(tmpdir):
 231                 expected_errors.append('Linux chattr: ')
 232             if metadata.xattr and m.linux_xattr:
 233                 expected_errors.append("xattr.set '")
 234             WVPASS(len(helpers.saved_errors) == len(expected_errors))
 235             for i in range(len(expected_errors)):
 236                 WVPASS(str(helpers.saved_errors[i]).startswith(expected_errors[i]))
 237             clear_errors()
 238
 239
 240 @wvtest
 241 def test_restore_over_existing_target():
 242     with no_lingering_errors():
 243         with test_tempdir('bup-tmetadata-') as tmpdir:
 244             path = tmpdir + '/foo'
 245             os.mkdir(path)
 246             dir_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 247             os.rmdir(path)
 248             open(path, 'w').close()
 249             file_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 250             # Restore dir over file.
 251             WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 252             WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 253             # Restore dir over dir.
 254             WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 255             WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 256             # Restore file over dir.
 257             WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 258             WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 259             # Restore file over file.
 260             WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 261             WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 262             # Restore file over non-empty dir.
 263             os.remove(path)
 264             os.mkdir(path)
 265             open(path + '/bar', 'w').close()
 266             WVEXCEPT(Exception, file_m.create_path, path, create_symlinks=True)
 267             # Restore dir over non-empty dir.
 268             os.remove(path + '/bar')
 269             os.mkdir(path + '/bar')
 270             WVEXCEPT(Exception, dir_m.create_path, path, create_symlinks=True)
 271
 272
 273 from bup.metadata import posix1e
 274 if not posix1e:
 275     @wvtest
 276     def POSIX1E_ACL_SUPPORT_IS_MISSING():
 277         pass
 278
 279
 280 from bup.metadata import xattr
 281 if xattr:
 282     @wvtest
 283     def test_handling_of_incorrect_existing_linux_xattrs():
 284         if not is_superuser() or detect_fakeroot():
 285             WVMSG('skipping test -- not superuser')
 286             return
 287         if not setup_testfs():
 288             WVMSG('unable to load loop module; skipping dependent tests')
 289             return
 290         for f in glob.glob('testfs/*'):
 291             ex('rm', '-rf', f)
 292         path = 'testfs/foo'
 293         open(path, 'w').close()
 294         xattr.set(path, 'foo', 'bar', namespace=xattr.NS_USER)
 295         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 296         xattr.set(path, 'baz', 'bax', namespace=xattr.NS_USER)
 297         m.apply_to_path(path, restore_numeric_ids=False)
 298         WVPASSEQ(xattr.list(path), ['user.foo'])
 299         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 300         xattr.set(path, 'foo', 'baz', namespace=xattr.NS_USER)
 301         m.apply_to_path(path, restore_numeric_ids=False)
 302         WVPASSEQ(xattr.list(path), ['user.foo'])
 303         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 304         xattr.remove(path, 'foo', namespace=xattr.NS_USER)
 305         m.apply_to_path(path, restore_numeric_ids=False)
 306         WVPASSEQ(xattr.list(path), ['user.foo'])
 307         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 308         os.chdir(start_dir)
 309         cleanup_testfs()