lib/bup/t/tmetadata.py

   1 import glob, grp, pwd, stat, tempfile, subprocess, xattr
   2 import bup.helpers as helpers
   3 from bup import metadata
   4 from bup.helpers import clear_errors, detect_fakeroot
   5 from wvtest import *
   6
   7
   8 top_dir = os.getcwd()
   9
  10
  11 def ex(*cmd):
  12     try:
  13         cmd_str = ' '.join(cmd)
  14         print >> sys.stderr, cmd_str
  15         rc = subprocess.call(cmd)
  16         if rc < 0:
  17             print >> sys.stderr, 'terminated by signal', - rc
  18             sys.exit(1)
  19         elif rc > 0:
  20             print >> sys.stderr, 'returned exit status', rc
  21             sys.exit(1)
  22     except OSError, e:
  23         print >> sys.stderr, 'subprocess call failed:', e
  24         sys.exit(1)
  25
  26
  27 def setup_testfs():
  28     # Set up testfs with user_xattr, etc.
  29     subprocess.call(['umount', 'testfs'])
  30     ex('dd', 'if=/dev/zero', 'of=testfs.img', 'bs=1M', 'count=32')
  31     ex('mke2fs', '-F', '-j', '-m', '0', 'testfs.img')
  32     ex('rm', '-rf', 'testfs')
  33     os.mkdir('testfs')
  34     ex('mount', '-o', 'loop,acl,user_xattr', 'testfs.img', 'testfs')
  35     # Hide, so that tests can't create risks.
  36     ex('chown', 'root:root', 'testfs')
  37     os.chmod('testfs', 0700)
  38
  39
  40 def cleanup_testfs():
  41     subprocess.call(['umount', 'testfs'])
  42     subprocess.call(['rm', '-f', 'testfs.img'])
  43
  44
  45 @wvtest
  46 def test_clean_up_archive_path():
  47     cleanup = metadata._clean_up_path_for_archive
  48     WVPASSEQ(cleanup('foo'), 'foo')
  49     WVPASSEQ(cleanup('/foo'), 'foo')
  50     WVPASSEQ(cleanup('///foo'), 'foo')
  51     WVPASSEQ(cleanup('/foo/bar'), 'foo/bar')
  52     WVPASSEQ(cleanup('foo/./bar'), 'foo/bar')
  53     WVPASSEQ(cleanup('/foo/./bar'), 'foo/bar')
  54     WVPASSEQ(cleanup('/foo/./bar/././baz'), 'foo/bar/baz')
  55     WVPASSEQ(cleanup('/foo/./bar///././baz'), 'foo/bar/baz')
  56     WVPASSEQ(cleanup('//./foo/./bar///././baz/.///'), 'foo/bar/baz/')
  57     WVPASSEQ(cleanup('./foo/./.bar'), 'foo/.bar')
  58     WVPASSEQ(cleanup('./foo/.'), 'foo')
  59     WVPASSEQ(cleanup('./foo/..'), '.')
  60     WVPASSEQ(cleanup('//./..//.../..//.'), '.')
  61     WVPASSEQ(cleanup('//./..//..././/.'), '...')
  62     WVPASSEQ(cleanup('/////.'), '.')
  63     WVPASSEQ(cleanup('/../'), '.')
  64     WVPASSEQ(cleanup(''), '.')
  65
  66
  67 @wvtest
  68 def test_risky_path():
  69     risky = metadata._risky_path
  70     WVPASS(risky('/foo'))
  71     WVPASS(risky('///foo'))
  72     WVPASS(risky('/../foo'))
  73     WVPASS(risky('../foo'))
  74     WVPASS(risky('foo/..'))
  75     WVPASS(risky('foo/../'))
  76     WVPASS(risky('foo/../bar'))
  77     WVFAIL(risky('foo'))
  78     WVFAIL(risky('foo/'))
  79     WVFAIL(risky('foo///'))
  80     WVFAIL(risky('./foo'))
  81     WVFAIL(risky('foo/.'))
  82     WVFAIL(risky('./foo/.'))
  83     WVFAIL(risky('foo/bar'))
  84     WVFAIL(risky('foo/./bar'))
  85
  86
  87 @wvtest
  88 def test_clean_up_extract_path():
  89     cleanup = metadata._clean_up_extract_path
  90     WVPASSEQ(cleanup('/foo'), 'foo')
  91     WVPASSEQ(cleanup('///foo'), 'foo')
  92     WVFAIL(cleanup('/../foo'))
  93     WVFAIL(cleanup('../foo'))
  94     WVFAIL(cleanup('foo/..'))
  95     WVFAIL(cleanup('foo/../'))
  96     WVFAIL(cleanup('foo/../bar'))
  97     WVPASSEQ(cleanup('foo'), 'foo')
  98     WVPASSEQ(cleanup('foo/'), 'foo/')
  99     WVPASSEQ(cleanup('foo///'), 'foo///')
 100     WVPASSEQ(cleanup('./foo'), './foo')
 101     WVPASSEQ(cleanup('foo/.'), 'foo/.')
 102     WVPASSEQ(cleanup('./foo/.'), './foo/.')
 103     WVPASSEQ(cleanup('foo/bar'), 'foo/bar')
 104     WVPASSEQ(cleanup('foo/./bar'), 'foo/./bar')
 105     WVPASSEQ(cleanup('/'), '.')
 106     WVPASSEQ(cleanup('./'), './')
 107     WVPASSEQ(cleanup('///foo/bar'), 'foo/bar')
 108     WVPASSEQ(cleanup('///foo/bar'), 'foo/bar')
 109
 110
 111 @wvtest
 112 def test_from_path_error():
 113     if os.geteuid() == 0 or detect_fakeroot():
 114         return
 115     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 116     try:
 117         path = tmpdir + '/foo'
 118         subprocess.call(['mkdir', path])
 119         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 120         WVPASSEQ(m.path, path)
 121         subprocess.call(['chmod', '000', path])
 122         metadata.from_path(path, archive_path=path, save_symlinks=True)
 123         errmsg = helpers.saved_errors[0] if helpers.saved_errors else ''
 124         WVPASS(errmsg.startswith('read Linux attr'))
 125         clear_errors()
 126     finally:
 127         subprocess.call(['rm', '-rf', tmpdir])
 128
 129
 130 @wvtest
 131 def test_apply_to_path_restricted_access():
 132     if os.geteuid() == 0 or detect_fakeroot():
 133         return
 134     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 135     try:
 136         path = tmpdir + '/foo'
 137         subprocess.call(['mkdir', path])
 138         clear_errors()
 139         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 140         WVPASSEQ(m.path, path)
 141         subprocess.call(['chmod', '000', tmpdir])
 142         m.apply_to_path(path)
 143         errmsg = str(helpers.saved_errors[0]) if helpers.saved_errors else ''
 144         WVPASS(errmsg.startswith('utime: '))
 145         clear_errors()
 146     finally:
 147         subprocess.call(['rm', '-rf', tmpdir])
 148
 149
 150 @wvtest
 151 def test_restore_restricted_user_group():
 152     if os.geteuid() == 0 or detect_fakeroot():
 153         return
 154     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 155     try:
 156         path = tmpdir + '/foo'
 157         subprocess.call(['mkdir', path])
 158         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 159         WVPASSEQ(m.path, path)
 160         WVPASSEQ(m.apply_to_path(path), None)
 161         orig_uid = m.uid
 162         m.uid = 0;
 163         m.apply_to_path(path, restore_numeric_ids=True)
 164         errmsg = str(helpers.saved_errors[0]) if helpers.saved_errors else ''
 165         WVPASS(errmsg.startswith('lchown: '))
 166         clear_errors()
 167         m.uid = orig_uid
 168         m.gid = 0;
 169         m.apply_to_path(path, restore_numeric_ids=True)
 170         errmsg = str(helpers.saved_errors[0]) if helpers.saved_errors else ''
 171         WVPASS(errmsg.startswith('lchown: ') or os.stat(path).st_gid == m.gid)
 172         clear_errors()
 173     finally:
 174         subprocess.call(['rm', '-rf', tmpdir])
 175
 176
 177 @wvtest
 178 def test_restore_nonexistent_user_group():
 179     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 180     try:
 181         path = tmpdir + '/foo'
 182         subprocess.call(['mkdir', path])
 183         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 184         WVPASSEQ(m.path, path)
 185         m.owner = max([x.pw_name for x in pwd.getpwall()], key=len) + 'x'
 186         m.group = max([x.gr_name for x in grp.getgrall()], key=len) + 'x'
 187         WVPASSEQ(m.apply_to_path(path, restore_numeric_ids=True), None)
 188         WVPASSEQ(os.stat(path).st_uid, m.uid)
 189         WVPASSEQ(os.stat(path).st_gid, m.gid)
 190         WVPASSEQ(m.apply_to_path(path, restore_numeric_ids=False), None)
 191         WVPASSEQ(os.stat(path).st_uid, os.geteuid())
 192         WVPASSEQ(os.stat(path).st_gid, os.getgid())
 193     finally:
 194         subprocess.call(['rm', '-rf', tmpdir])
 195
 196
 197 @wvtest
 198 def test_restore_over_existing_target():
 199     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 200     try:
 201         path = tmpdir + '/foo'
 202         os.mkdir(path)
 203         dir_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 204         os.rmdir(path)
 205         open(path, 'w').close()
 206         file_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 207         # Restore dir over file.
 208         WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 209         WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 210         # Restore dir over dir.
 211         WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 212         WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 213         # Restore file over dir.
 214         WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 215         WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 216         # Restore file over file.
 217         WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 218         WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 219         # Restore file over non-empty dir.
 220         os.remove(path)
 221         os.mkdir(path)
 222         open(path + '/bar', 'w').close()
 223         WVEXCEPT(Exception, file_m.create_path, path, create_symlinks=True)
 224         # Restore dir over non-empty dir.
 225         os.remove(path + '/bar')
 226         os.mkdir(path + '/bar')
 227         WVEXCEPT(Exception, dir_m.create_path, path, create_symlinks=True)
 228     finally:
 229         subprocess.call(['rm', '-rf', tmpdir])
 230
 231
 232 @wvtest
 233 def test_handling_of_incorrect_existing_linux_xattrs():
 234     if os.geteuid() != 0 or detect_fakeroot():
 235         return
 236     setup_testfs()
 237     subprocess.check_call('rm -rf testfs/*', shell=True)
 238     path = 'testfs/foo'
 239     open(path, 'w').close()
 240     xattr.set(path, 'foo', 'bar', namespace=xattr.NS_USER)
 241     m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 242     xattr.set(path, 'baz', 'bax', namespace=xattr.NS_USER)
 243     m.apply_to_path(path, restore_numeric_ids=False)
 244     WVPASSEQ(xattr.list(path), ['user.foo'])
 245     WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 246     xattr.set(path, 'foo', 'baz', namespace=xattr.NS_USER)
 247     m.apply_to_path(path, restore_numeric_ids=False)
 248     WVPASSEQ(xattr.list(path), ['user.foo'])
 249     WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 250     xattr.remove(path, 'foo', namespace=xattr.NS_USER)
 251     m.apply_to_path(path, restore_numeric_ids=False)
 252     WVPASSEQ(xattr.list(path), ['user.foo'])
 253     WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 254     os.chdir(top_dir)
 255     cleanup_testfs()