lib/bup/t/tmetadata.py

   1 import glob, grp, pwd, stat, tempfile, subprocess
   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     os.chown('testfs', 0, 0)
  37     os.chmod('testfs', 0700)
  38
  39
  40 def cleanup_testfs():
  41     subprocess.call(['umount', 'testfs'])
  42     unlink('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 def _first_err():
 112     if helpers.saved_errors:
 113         return str(helpers.saved_errors[0])
 114     return ''
 115
 116
 117 @wvtest
 118 def test_from_path_error():
 119     if os.geteuid() == 0 or detect_fakeroot():
 120         return
 121     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 122     try:
 123         path = tmpdir + '/foo'
 124         os.mkdir(path)
 125         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 126         WVPASSEQ(m.path, path)
 127         os.chmod(path, 000)
 128         metadata.from_path(path, archive_path=path, save_symlinks=True)
 129         if metadata.get_linux_file_attr:
 130             errmsg = _first_err()
 131             WVPASS(errmsg.startswith('read Linux attr'))
 132             clear_errors()
 133     finally:
 134         subprocess.call(['rm', '-rf', tmpdir])
 135
 136
 137 @wvtest
 138 def test_apply_to_path_restricted_access():
 139     if os.geteuid() == 0 or detect_fakeroot():
 140         return
 141     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 142     try:
 143         path = tmpdir + '/foo'
 144         os.mkdir(path)
 145         clear_errors()
 146         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 147         WVPASSEQ(m.path, path)
 148         os.chmod(tmpdir, 000)
 149         m.apply_to_path(path)
 150         errmsg = _first_err()
 151         WVPASS(errmsg.startswith('utime: '))
 152         clear_errors()
 153     finally:
 154         subprocess.call(['rm', '-rf', tmpdir])
 155
 156
 157 @wvtest
 158 def test_restore_restricted_user_group():
 159     if os.geteuid() == 0 or detect_fakeroot():
 160         return
 161     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 162     try:
 163         path = tmpdir + '/foo'
 164         os.mkdir(path)
 165         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 166         WVPASSEQ(m.path, path)
 167         WVPASSEQ(m.apply_to_path(path), None)
 168         orig_uid = m.uid
 169         m.uid = 0;
 170         m.apply_to_path(path, restore_numeric_ids=True)
 171         errmsg = _first_err()
 172         WVPASS(errmsg.startswith('lchown: '))
 173         clear_errors()
 174         m.uid = orig_uid
 175         m.gid = 0;
 176         m.apply_to_path(path, restore_numeric_ids=True)
 177         errmsg = _first_err()
 178         WVPASS(errmsg.startswith('lchown: ') or os.stat(path).st_gid == m.gid)
 179         clear_errors()
 180     finally:
 181         subprocess.call(['rm', '-rf', tmpdir])
 182
 183
 184 @wvtest
 185 def test_restore_nonexistent_user_group():
 186     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 187     try:
 188         path = tmpdir + '/foo'
 189         os.mkdir(path)
 190         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 191         WVPASSEQ(m.path, path)
 192         junk,m.owner = max([(len(x.pw_name), x.pw_name + 'x')
 193                             for x in pwd.getpwall()])
 194         junk,m.group = max([(len(x.gr_name), x.gr_name + 'x')
 195                             for x in grp.getgrall()])
 196         WVPASSEQ(m.apply_to_path(path, restore_numeric_ids=True), None)
 197         WVPASSEQ(os.stat(path).st_uid, m.uid)
 198         WVPASSEQ(os.stat(path).st_gid, m.gid)
 199         WVPASSEQ(m.apply_to_path(path, restore_numeric_ids=False), None)
 200         WVPASSEQ(os.stat(path).st_uid, m.uid)
 201         WVPASSEQ(os.stat(path).st_gid, m.gid)
 202     finally:
 203         subprocess.call(['rm', '-rf', tmpdir])
 204
 205
 206 @wvtest
 207 def test_restore_over_existing_target():
 208     tmpdir = tempfile.mkdtemp(prefix='bup-tmetadata-')
 209     try:
 210         path = tmpdir + '/foo'
 211         os.mkdir(path)
 212         dir_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 213         os.rmdir(path)
 214         open(path, 'w').close()
 215         file_m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 216         # Restore dir over file.
 217         WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 218         WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 219         # Restore dir over dir.
 220         WVPASSEQ(dir_m.create_path(path, create_symlinks=True), None)
 221         WVPASS(stat.S_ISDIR(os.stat(path).st_mode))
 222         # Restore file over dir.
 223         WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 224         WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 225         # Restore file over file.
 226         WVPASSEQ(file_m.create_path(path, create_symlinks=True), None)
 227         WVPASS(stat.S_ISREG(os.stat(path).st_mode))
 228         # Restore file over non-empty dir.
 229         os.remove(path)
 230         os.mkdir(path)
 231         open(path + '/bar', 'w').close()
 232         WVEXCEPT(Exception, file_m.create_path, path, create_symlinks=True)
 233         # Restore dir over non-empty dir.
 234         os.remove(path + '/bar')
 235         os.mkdir(path + '/bar')
 236         WVEXCEPT(Exception, dir_m.create_path, path, create_symlinks=True)
 237     finally:
 238         subprocess.call(['rm', '-rf', tmpdir])
 239
 240
 241 from bup.metadata import posix1e
 242 if not posix1e:
 243     @wvtest
 244     def POSIX1E_ACL_SUPPORT_IS_MISSING():
 245         pass
 246
 247
 248 from bup.metadata import xattr
 249 if not xattr:
 250     @wvtest
 251     def LINUX_XATTR_SUPPORT_IS_MISSING():
 252         pass
 253 else:
 254     @wvtest
 255     def test_handling_of_incorrect_existing_linux_xattrs():
 256         if os.geteuid() != 0 or detect_fakeroot():
 257             return
 258         setup_testfs()
 259         for f in glob.glob('testfs/*'):
 260             ex('rm', '-rf', f)
 261         path = 'testfs/foo'
 262         open(path, 'w').close()
 263         xattr.set(path, 'foo', 'bar', namespace=xattr.NS_USER)
 264         m = metadata.from_path(path, archive_path=path, save_symlinks=True)
 265         xattr.set(path, 'baz', 'bax', namespace=xattr.NS_USER)
 266         m.apply_to_path(path, restore_numeric_ids=False)
 267         WVPASSEQ(xattr.list(path), ['user.foo'])
 268         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 269         xattr.set(path, 'foo', 'baz', namespace=xattr.NS_USER)
 270         m.apply_to_path(path, restore_numeric_ids=False)
 271         WVPASSEQ(xattr.list(path), ['user.foo'])
 272         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 273         xattr.remove(path, 'foo', namespace=xattr.NS_USER)
 274         m.apply_to_path(path, restore_numeric_ids=False)
 275         WVPASSEQ(xattr.list(path), ['user.foo'])
 276         WVPASSEQ(xattr.get(path, 'user.foo'), 'bar')
 277         os.chdir(top_dir)
 278         cleanup_testfs()