lib/bup/t/tvfs.py

   1
   2 from __future__ import print_function
   3 from collections import namedtuple
   4 from io import BytesIO
   5 from os import environ, symlink
   6 from stat import S_IFDIR, S_IFREG, S_ISDIR, S_ISREG
   7 from sys import stderr
   8 from time import localtime, strftime
   9
  10 from wvtest import *
  11
  12 from bup import git, metadata, vfs2 as vfs
  13 from bup.git import BUP_CHUNKED
  14 from bup.helpers import exc, exo, shstr
  15 from bup.metadata import Metadata
  16 from bup.repo import LocalRepo
  17 from buptest import no_lingering_errors, test_tempdir
  18
  19 top_dir = '../../..'
  20 bup_tmp = os.path.realpath('../../../t/tmp')
  21 bup_path = top_dir + '/bup'
  22 start_dir = os.getcwd()
  23
  24 def ex(cmd, **kwargs):
  25     print(shstr(cmd), file=stderr)
  26     return exc(cmd, **kwargs)
  27
  28 TreeDictValue = namedtuple('TreeDictValue', ('name', 'oid', 'meta'))
  29
  30 def tree_items(repo, oid):
  31     """Yield (name, entry_oid, meta) for each entry in oid.  meta will be
  32     a Metadata object for any non-directories and for '.', otherwise
  33     None.
  34
  35     """
  36     # This is a simpler approach than the one in the vfs, used to
  37     # cross-check its behavior.
  38     tree_data, bupm_oid = vfs.tree_data_and_bupm(repo, oid)
  39     bupm = vfs._FileReader(repo, bupm_oid) if bupm_oid else None
  40     try:
  41         maybe_meta = lambda : Metadata.read(bupm) if bupm else None
  42         m = maybe_meta()
  43         if m:
  44             m.size = 0
  45         yield TreeDictValue(name='.', oid=oid, meta=m)
  46         tree_ents = vfs.ordered_tree_entries(tree_data, bupm=True)
  47         for name, mangled_name, kind, gitmode, sub_oid in tree_ents:
  48             if mangled_name == '.bupm':
  49                 continue
  50             assert name != '.'
  51             if S_ISDIR(gitmode):
  52                 if kind == BUP_CHUNKED:
  53                     yield TreeDictValue(name=name, oid=sub_oid,
  54                                         meta=maybe_meta())
  55                 else:
  56                     yield TreeDictValue(name=name, oid=sub_oid,
  57                                         meta=vfs.default_dir_mode)
  58             else:
  59                 yield TreeDictValue(name=name, oid=sub_oid, meta=maybe_meta())
  60     finally:
  61         if bupm:
  62             bupm.close()
  63
  64 def tree_dict(repo, oid):
  65     return dict((x.name, x) for x in tree_items(repo, oid))
  66
  67 def run_augment_item_meta_tests(repo,
  68                                 file_path, file_size,
  69                                 link_path, link_target):
  70     _, file_item = vfs.resolve(repo, file_path)[-1]
  71     _, link_item = vfs.lresolve(repo, link_path)[-1]
  72     wvpass(isinstance(file_item.meta, Metadata))
  73     wvpass(isinstance(link_item.meta, Metadata))
  74     # Note: normally, modifying item.meta values is forbidden
  75     file_item.meta.size = file_item.meta.size or vfs.item_size(repo, file_item)
  76     link_item.meta.size = link_item.meta.size or vfs.item_size(repo, link_item)
  77
  78     ## Ensure a fully populated item is left alone
  79     augmented = vfs.augment_item_meta(repo, file_item)
  80     wvpass(augmented is file_item)
  81     wvpass(augmented.meta is file_item.meta)
  82     augmented = vfs.augment_item_meta(repo, file_item, include_size=True)
  83     wvpass(augmented is file_item)
  84     wvpass(augmented.meta is file_item.meta)
  85
  86     ## Ensure a missing size is handled poperly
  87     file_item.meta.size = None
  88     augmented = vfs.augment_item_meta(repo, file_item)
  89     wvpass(augmented is file_item)
  90     wvpass(augmented.meta is file_item.meta)
  91     augmented = vfs.augment_item_meta(repo, file_item, include_size=True)
  92     wvpass(augmented is not file_item)
  93     wvpasseq(file_size, augmented.meta.size)
  94
  95     ## Ensure a meta mode is handled properly
  96     mode_item = file_item._replace(meta=vfs.default_file_mode)
  97     augmented = vfs.augment_item_meta(repo, mode_item)
  98     augmented_w_size = vfs.augment_item_meta(repo, mode_item, include_size=True)
  99     for item in (augmented, augmented_w_size):
 100         meta = item.meta
 101         wvpass(item is not file_item)
 102         wvpass(isinstance(meta, Metadata))
 103         wvpasseq(vfs.default_file_mode, meta.mode)
 104         wvpasseq((0, 0, 0, 0, 0),
 105                  (meta.uid, meta.gid, meta.atime, meta.mtime, meta.ctime))
 106     wvpass(augmented.meta.size is None)
 107     wvpasseq(file_size, augmented_w_size.meta.size)
 108
 109     ## Ensure symlinks are handled properly
 110     mode_item = link_item._replace(meta=vfs.default_symlink_mode)
 111     augmented = vfs.augment_item_meta(repo, mode_item)
 112     wvpass(augmented is not mode_item)
 113     wvpass(isinstance(augmented.meta, Metadata))
 114     wvpasseq(link_target, augmented.meta.symlink_target)
 115     wvpasseq(len(link_target), augmented.meta.size)
 116     augmented = vfs.augment_item_meta(repo, mode_item, include_size=True)
 117     wvpass(augmented is not mode_item)
 118     wvpass(isinstance(augmented.meta, Metadata))
 119     wvpasseq(link_target, augmented.meta.symlink_target)
 120     wvpasseq(len(link_target), augmented.meta.size)
 121
 122
 123 @wvtest
 124 def test_item_mode():
 125     with no_lingering_errors():
 126         mode = S_IFDIR | 0o755
 127         meta = metadata.from_path('.')
 128         oid = '\0' * 20
 129         wvpasseq(mode, vfs.item_mode(vfs.Item(oid=oid, meta=mode)))
 130         wvpasseq(meta.mode, vfs.item_mode(vfs.Item(oid=oid, meta=meta)))
 131
 132 @wvtest
 133 def test_reverse_suffix_duplicates():
 134     suffix = lambda x: tuple(vfs._reverse_suffix_duplicates(x))
 135     wvpasseq(('x',), suffix(('x',)))
 136     wvpasseq(('x', 'y'), suffix(('x', 'y')))
 137     wvpasseq(('x-1', 'x-0'), suffix(('x',) * 2))
 138     wvpasseq(['x-%02d' % n for n in reversed(range(11))],
 139              list(suffix(('x',) * 11)))
 140     wvpasseq(('x-1', 'x-0', 'y'), suffix(('x', 'x', 'y')))
 141     wvpasseq(('x', 'y-1', 'y-0'), suffix(('x', 'y', 'y')))
 142     wvpasseq(('x', 'y-1', 'y-0', 'z'), suffix(('x', 'y', 'y', 'z')))
 143
 144 @wvtest
 145 def test_misc():
 146     with no_lingering_errors():
 147         with test_tempdir('bup-tvfs-') as tmpdir:
 148             bup_dir = tmpdir + '/bup'
 149             environ['GIT_DIR'] = bup_dir
 150             environ['BUP_DIR'] = bup_dir
 151             git.repodir = bup_dir
 152             data_path = tmpdir + '/src'
 153             os.mkdir(data_path)
 154             with open(data_path + '/file', 'w+') as tmpfile:
 155                 tmpfile.write(b'canary\n')
 156             symlink('file', data_path + '/symlink')
 157             ex((bup_path, 'init'))
 158             ex((bup_path, 'index', '-v', data_path))
 159             ex((bup_path, 'save', '-d', '100000', '-tvvn', 'test', '--strip',
 160                 data_path))
 161             repo = LocalRepo()
 162
 163             wvstart('readlink')
 164             ls_tree = exo(('git', 'ls-tree', 'test', 'symlink'))
 165             mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
 166             assert name == 'symlink'
 167             link_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
 168             wvpasseq('file', vfs.readlink(repo, link_item))
 169
 170             ls_tree = exo(('git', 'ls-tree', 'test', 'file'))
 171             mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
 172             assert name == 'file'
 173             file_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
 174             wvexcept(Exception, vfs.readlink, repo, file_item)
 175
 176             wvstart('item_size')
 177             wvpasseq(4, vfs.item_size(repo, link_item))
 178             wvpasseq(7, vfs.item_size(repo, file_item))
 179             meta = metadata.from_path(__file__)
 180             meta.size = 42
 181             fake_item = file_item._replace(meta=meta)
 182             wvpasseq(42, vfs.item_size(repo, fake_item))
 183
 184             wvstart('augment_item_meta')
 185             run_augment_item_meta_tests(repo,
 186                                         '/test/latest/file', 7,
 187                                         '/test/latest/symlink', 'file')
 188
 189             wvstart('copy_item')
 190             # FIXME: this caused StopIteration
 191             #_, file_item = vfs.resolve(repo, '/file')[-1]
 192             _, file_item = vfs.resolve(repo, '/test/latest/file')[-1]
 193             file_copy = vfs.copy_item(file_item)
 194             wvpass(file_copy is not file_item)
 195             wvpass(file_copy.meta is not file_item.meta)
 196             wvpass(isinstance(file_copy, tuple))
 197             wvpass(file_item.meta.user)
 198             wvpass(file_copy.meta.user)
 199             file_copy.meta.user = None
 200             wvpass(file_item.meta.user)
 201
 202 @wvtest
 203 def test_resolve():
 204     with no_lingering_errors():
 205         with test_tempdir('bup-tvfs-') as tmpdir:
 206             resolve = vfs.resolve
 207             lresolve = vfs.lresolve
 208             bup_dir = tmpdir + '/bup'
 209             environ['GIT_DIR'] = bup_dir
 210             environ['BUP_DIR'] = bup_dir
 211             git.repodir = bup_dir
 212             data_path = tmpdir + '/src'
 213             save_time = 100000
 214             save_time_str = strftime('%Y-%m-%d-%H%M%S', localtime(save_time))
 215             os.mkdir(data_path)
 216             with open(data_path + '/file', 'w+') as tmpfile:
 217                 print('canary', file=tmpfile)
 218             symlink('file', data_path + '/symlink')
 219             ex((bup_path, 'init'))
 220             ex((bup_path, 'index', '-v', data_path))
 221             ex((bup_path, 'save', '-d', str(save_time), '-tvvn', 'test',
 222                 '--strip', data_path))
 223             ex((bup_path, 'tag', 'test-tag', 'test'))
 224             repo = LocalRepo()
 225
 226             tip_hash = exo(('git', 'show-ref', 'refs/heads/test'))[0]
 227             tip_oidx = tip_hash.strip().split()[0]
 228             tip_oid = tip_oidx.decode('hex')
 229             tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
 230                                  tip_oidx))[0].strip()
 231             tip_tree_oid = tip_tree_oidx.decode('hex')
 232             tip_tree = tree_dict(repo, tip_tree_oid)
 233             test_revlist = vfs.RevList(meta=S_IFDIR | 0o755, oid=tip_oid)
 234             test_revlist_w_meta = vfs.RevList(meta=tip_tree['.'].meta,
 235                                               oid=tip_oid)
 236             expected_latest_item = vfs.Commit(meta=S_IFDIR | 0o755,
 237                                               oid=tip_tree_oid,
 238                                               coid=tip_oid)
 239             expected_test_tag_item = expected_latest_item
 240
 241             wvstart('resolve: /')
 242             res = resolve(repo, '/')
 243             wvpasseq(1, len(res))
 244             wvpasseq((('', vfs._root),), res)
 245             ignore, root_item = res[0]
 246             root_content = frozenset(vfs.contents(repo, root_item))
 247             wvpasseq(frozenset([('.', root_item),
 248                                 ('.tag', vfs._tags),
 249                                 ('test', test_revlist)]),
 250                      root_content)
 251
 252             wvstart('resolve: /.tag')
 253             res = resolve(repo, '/.tag')
 254             wvpasseq(2, len(res))
 255             wvpasseq((('', vfs._root), ('.tag', vfs._tags)),
 256                      res)
 257             ignore, tag_item = res[1]
 258             tag_content = frozenset(vfs.contents(repo, tag_item))
 259             wvpasseq(frozenset([('.', tag_item),
 260                                 ('test-tag', expected_test_tag_item)]),
 261                      tag_content)
 262
 263             wvstart('resolve: /test')
 264             res = resolve(repo, '/test')
 265             wvpasseq(2, len(res))
 266             wvpasseq((('', vfs._root), ('test', test_revlist)), res)
 267             ignore, test_item = res[1]
 268             test_content = frozenset(vfs.contents(repo, test_item))
 269             wvpasseq(frozenset([('.', test_revlist_w_meta),
 270                                 (save_time_str, expected_latest_item),
 271                                 ('latest', expected_latest_item)]),
 272                      test_content)
 273
 274             wvstart('resolve: /test/latest')
 275             res = resolve(repo, '/test/latest')
 276             wvpasseq(3, len(res))
 277             expected_latest_item_w_meta = vfs.Commit(meta=tip_tree['.'].meta,
 278                                                      oid=tip_tree_oid,
 279                                                      coid=tip_oid)
 280             expected = (('', vfs._root),
 281                         ('test', test_revlist),
 282                         ('latest', expected_latest_item_w_meta))
 283             wvpasseq(expected, res)
 284             ignore, latest_item = res[2]
 285             latest_content = frozenset(vfs.contents(repo, latest_item))
 286             expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
 287                                  for x in (tip_tree[name]
 288                                            for name in ('.', 'file',
 289                                                         'symlink')))
 290             wvpasseq(expected, latest_content)
 291
 292             wvstart('resolve: /test/latest/foo')
 293             res = resolve(repo, '/test/latest/file')
 294             wvpasseq(4, len(res))
 295             expected_file_item_w_meta = vfs.Item(meta=tip_tree['file'].meta,
 296                                                  oid=tip_tree['file'].oid)
 297             expected = (('', vfs._root),
 298                         ('test', test_revlist),
 299                         ('latest', expected_latest_item_w_meta),
 300                         ('file', expected_file_item_w_meta))
 301             wvpasseq(expected, res)
 302
 303             wvstart('resolve: /test/latest/symlink')
 304             res = resolve(repo, '/test/latest/symlink')
 305             wvpasseq(4, len(res))
 306             expected = (('', vfs._root),
 307                         ('test', test_revlist),
 308                         ('latest', expected_latest_item_w_meta),
 309                         ('file', expected_file_item_w_meta))
 310             wvpasseq(expected, res)
 311
 312             wvstart('lresolve: /test/latest/symlink')
 313             res = lresolve(repo, '/test/latest/symlink')
 314             wvpasseq(4, len(res))
 315             symlink_value = tip_tree['symlink']
 316             expected_symlink_item_w_meta = vfs.Item(meta=symlink_value.meta,
 317                                                     oid=symlink_value.oid)
 318             expected = (('', vfs._root),
 319                         ('test', test_revlist),
 320                         ('latest', expected_latest_item_w_meta),
 321                         ('symlink', expected_symlink_item_w_meta))
 322             wvpasseq(expected, res)
 323
 324             wvstart('resolve: /test/latest/missing')
 325             res = resolve(repo, '/test/latest/missing')
 326             wvpasseq(4, len(res))
 327             name, item = res[-1]
 328             wvpasseq('missing', name)
 329             wvpass(item is None)
 330
 331 @wvtest
 332 def test_resolve_loop():
 333     with no_lingering_errors():
 334         with test_tempdir('bup-tvfs-resloop-') as tmpdir:
 335             resolve = vfs.resolve
 336             lresolve = vfs.lresolve
 337             bup_dir = tmpdir + '/bup'
 338             environ['GIT_DIR'] = bup_dir
 339             environ['BUP_DIR'] = bup_dir
 340             git.repodir = bup_dir
 341             repo = LocalRepo()
 342             data_path = tmpdir + '/src'
 343             os.mkdir(data_path)
 344             symlink('loop', data_path + '/loop')
 345             ex((bup_path, 'init'))
 346             ex((bup_path, 'index', '-v', data_path))
 347             ex((bup_path, 'save', '-d', '100000', '-tvvn', 'test', '--strip',
 348                 data_path))
 349             wvexcept(vfs.Loop, resolve, repo, '/test/latest/loop')
 350
 351 @wvtest
 352 def test_contents_with_mismatched_bupm_git_ordering():
 353     with no_lingering_errors():
 354         with test_tempdir('bup-tvfs-') as tmpdir:
 355             bup_dir = tmpdir + '/bup'
 356             environ['GIT_DIR'] = bup_dir
 357             environ['BUP_DIR'] = bup_dir
 358             git.repodir = bup_dir
 359             data_path = tmpdir + '/src'
 360             os.mkdir(data_path)
 361             os.mkdir(data_path + '/foo')
 362             with open(data_path + '/foo.', 'w+') as tmpfile:
 363                 tmpfile.write(b'canary\n')
 364             ex((bup_path, 'init'))
 365             ex((bup_path, 'index', '-v', data_path))
 366             ex((bup_path, 'save', '-tvvn', 'test', '--strip',
 367                 data_path))
 368             repo = LocalRepo()
 369             tip_sref = exo(('git', 'show-ref', 'refs/heads/test'))[0]
 370             tip_oidx = tip_sref.strip().split()[0]
 371             tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
 372                                  tip_oidx))[0].strip()
 373             tip_tree_oid = tip_tree_oidx.decode('hex')
 374             tip_tree = tree_dict(repo, tip_tree_oid)
 375
 376             name, item = vfs.resolve(repo, '/test/latest')[2]
 377             wvpasseq('latest', name)
 378             expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
 379                                  for x in (tip_tree[name]
 380                                            for name in ('.', 'foo', 'foo.')))
 381             contents = tuple(vfs.contents(repo, item))
 382             wvpasseq(expected, frozenset(contents))
 383             # Spot check, in case tree_dict shares too much code with the vfs
 384             name, item = next(((n, i) for n, i in contents if n == 'foo'))
 385             wvpass(S_ISDIR(item.meta))
 386             name, item = next(((n, i) for n, i in contents if n == 'foo.'))
 387             wvpass(S_ISREG(item.meta.mode))
 388
 389 @wvtest
 390 def test_duplicate_save_dates():
 391     with no_lingering_errors():
 392         with test_tempdir('bup-tvfs-') as tmpdir:
 393             bup_dir = tmpdir + '/bup'
 394             environ['GIT_DIR'] = bup_dir
 395             environ['BUP_DIR'] = bup_dir
 396             environ['TZ'] = 'UTC'
 397             git.repodir = bup_dir
 398             data_path = tmpdir + '/src'
 399             os.mkdir(data_path)
 400             with open(data_path + '/file', 'w+') as tmpfile:
 401                 tmpfile.write(b'canary\n')
 402             ex((bup_path, 'init'))
 403             ex((bup_path, 'index', '-v', data_path))
 404             for i in range(11):
 405                 ex((bup_path, 'save', '-d', '100000', '-n', 'test', data_path))
 406             repo = LocalRepo()
 407             res = vfs.resolve(repo, '/test')
 408             wvpasseq(2, len(res))
 409             name, revlist = res[-1]
 410             wvpasseq('test', name)
 411             wvpasseq(('.',
 412                       '1970-01-02-034640-00',
 413                       '1970-01-02-034640-01',
 414                       '1970-01-02-034640-02',
 415                       '1970-01-02-034640-03',
 416                       '1970-01-02-034640-04',
 417                       '1970-01-02-034640-05',
 418                       '1970-01-02-034640-06',
 419                       '1970-01-02-034640-07',
 420                       '1970-01-02-034640-08',
 421                       '1970-01-02-034640-09',
 422                       '1970-01-02-034640-10',
 423                       'latest'),
 424                      tuple(sorted(x[0] for x in vfs.contents(repo, revlist))))
 425
 426 # FIXME: add tests for the want_meta=False cases.