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_misc():
 134     with no_lingering_errors():
 135         with test_tempdir('bup-tvfs-') as tmpdir:
 136             bup_dir = tmpdir + '/bup'
 137             environ['GIT_DIR'] = bup_dir
 138             environ['BUP_DIR'] = bup_dir
 139             git.repodir = bup_dir
 140             data_path = tmpdir + '/src'
 141             os.mkdir(data_path)
 142             with open(data_path + '/file', 'w+') as tmpfile:
 143                 tmpfile.write(b'canary\n')
 144             symlink('file', data_path + '/symlink')
 145             ex((bup_path, 'init'))
 146             ex((bup_path, 'index', '-v', data_path))
 147             ex((bup_path, 'save', '-d', '100000', '-tvvn', 'test', '--strip',
 148                 data_path))
 149             repo = LocalRepo()
 150
 151             wvstart('readlink')
 152             ls_tree = exo(('git', 'ls-tree', 'test', 'symlink'))
 153             mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
 154             assert name == 'symlink'
 155             link_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
 156             wvpasseq('file', vfs.readlink(repo, link_item))
 157
 158             ls_tree = exo(('git', 'ls-tree', 'test', 'file'))
 159             mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
 160             assert name == 'file'
 161             file_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
 162             wvexcept(Exception, vfs.readlink, repo, file_item)
 163
 164             wvstart('item_size')
 165             wvpasseq(4, vfs.item_size(repo, link_item))
 166             wvpasseq(7, vfs.item_size(repo, file_item))
 167             meta = metadata.from_path(__file__)
 168             meta.size = 42
 169             fake_item = file_item._replace(meta=meta)
 170             wvpasseq(42, vfs.item_size(repo, fake_item))
 171
 172             wvstart('augment_item_meta')
 173             run_augment_item_meta_tests(repo,
 174                                         '/test/latest/file', 7,
 175                                         '/test/latest/symlink', 'file')
 176
 177             wvstart('copy_item')
 178             # FIXME: this caused StopIteration
 179             #_, file_item = vfs.resolve(repo, '/file')[-1]
 180             _, file_item = vfs.resolve(repo, '/test/latest/file')[-1]
 181             file_copy = vfs.copy_item(file_item)
 182             wvpass(file_copy is not file_item)
 183             wvpass(file_copy.meta is not file_item.meta)
 184             wvpass(isinstance(file_copy, tuple))
 185             wvpass(file_item.meta.user)
 186             wvpass(file_copy.meta.user)
 187             file_copy.meta.user = None
 188             wvpass(file_item.meta.user)
 189
 190 @wvtest
 191 def test_resolve():
 192     with no_lingering_errors():
 193         with test_tempdir('bup-tvfs-') as tmpdir:
 194             resolve = vfs.resolve
 195             lresolve = vfs.lresolve
 196             bup_dir = tmpdir + '/bup'
 197             environ['GIT_DIR'] = bup_dir
 198             environ['BUP_DIR'] = bup_dir
 199             git.repodir = bup_dir
 200             data_path = tmpdir + '/src'
 201             save_time = 100000
 202             save_time_str = strftime('%Y-%m-%d-%H%M%S', localtime(save_time))
 203             os.mkdir(data_path)
 204             with open(data_path + '/file', 'w+') as tmpfile:
 205                 print('canary', file=tmpfile)
 206             symlink('file', data_path + '/symlink')
 207             ex((bup_path, 'init'))
 208             ex((bup_path, 'index', '-v', data_path))
 209             ex((bup_path, 'save', '-d', str(save_time), '-tvvn', 'test',
 210                 '--strip', data_path))
 211             ex((bup_path, 'tag', 'test-tag', 'test'))
 212             repo = LocalRepo()
 213
 214             tip_hash = exo(('git', 'show-ref', 'refs/heads/test'))[0]
 215             tip_oidx = tip_hash.strip().split()[0]
 216             tip_oid = tip_oidx.decode('hex')
 217             tip_meta = Metadata()
 218             tip_meta.mode = S_IFDIR | 0o755
 219             tip_meta.uid = tip_meta.gid = tip_meta.size = 0
 220             tip_meta.atime = tip_meta.mtime = tip_meta.ctime = save_time * 10**9
 221             test_revlist = vfs.RevList(meta=tip_meta, oid=tip_oid)
 222             tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
 223                                  tip_oidx))[0].strip()
 224             tip_tree_oid = tip_tree_oidx.decode('hex')
 225             tip_tree = tree_dict(repo, tip_tree_oid)
 226
 227             wvstart('resolve: /')
 228             res = resolve(repo, '/')
 229             wvpasseq(1, len(res))
 230             wvpasseq((('', vfs._root),), res)
 231             ignore, root_item = res[0]
 232             root_content = frozenset(vfs.contents(repo, root_item))
 233             wvpasseq(frozenset([('.', root_item),
 234                                 ('.tag', vfs._tags),
 235                                 ('test', test_revlist)]),
 236                      root_content)
 237
 238             wvstart('resolve: /.tag')
 239             res = resolve(repo, '/.tag')
 240             wvpasseq(2, len(res))
 241             wvpasseq((('', vfs._root), ('.tag', vfs._tags)),
 242                      res)
 243             ignore, tag_item = res[1]
 244             tag_content = frozenset(vfs.contents(repo, tag_item))
 245             wvpasseq(frozenset([('.', tag_item),
 246                                 ('test-tag', test_revlist)]),
 247                      tag_content)
 248
 249             wvstart('resolve: /test')
 250             res = resolve(repo, '/test')
 251             wvpasseq(2, len(res))
 252             wvpasseq((('', vfs._root), ('test', test_revlist)), res)
 253             ignore, test_item = res[1]
 254             test_content = frozenset(vfs.contents(repo, test_item))
 255             expected_latest_item = vfs.Item(meta=S_IFDIR | 0o755,
 256                                                     oid=tip_tree_oid)
 257             wvpasseq(frozenset([('.', test_revlist),
 258                                 (save_time_str, expected_latest_item),
 259                                 ('latest', expected_latest_item)]),
 260                      test_content)
 261
 262             wvstart('resolve: /test/latest')
 263             res = resolve(repo, '/test/latest')
 264             wvpasseq(3, len(res))
 265             expected_latest_item_w_meta = vfs.Item(meta=tip_tree['.'].meta,
 266                                                    oid=tip_tree_oid)
 267             expected = (('', vfs._root),
 268                         ('test', test_revlist),
 269                         ('latest', expected_latest_item_w_meta))
 270             wvpasseq(expected, res)
 271             ignore, latest_item = res[2]
 272             latest_content = frozenset(vfs.contents(repo, latest_item))
 273             expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
 274                                  for x in (tip_tree[name]
 275                                            for name in ('.', 'file',
 276                                                         'symlink')))
 277             wvpasseq(expected, latest_content)
 278
 279             wvstart('resolve: /test/latest/foo')
 280             res = resolve(repo, '/test/latest/file')
 281             wvpasseq(4, len(res))
 282             expected_file_item_w_meta = vfs.Item(meta=tip_tree['file'].meta,
 283                                                  oid=tip_tree['file'].oid)
 284             expected = (('', vfs._root),
 285                         ('test', test_revlist),
 286                         ('latest', expected_latest_item_w_meta),
 287                         ('file', expected_file_item_w_meta))
 288             wvpasseq(expected, res)
 289
 290             wvstart('resolve: /test/latest/symlink')
 291             res = resolve(repo, '/test/latest/symlink')
 292             wvpasseq(4, len(res))
 293             expected = (('', vfs._root),
 294                         ('test', test_revlist),
 295                         ('latest', expected_latest_item_w_meta),
 296                         ('file', expected_file_item_w_meta))
 297             wvpasseq(expected, res)
 298
 299             wvstart('lresolve: /test/latest/symlink')
 300             res = lresolve(repo, '/test/latest/symlink')
 301             wvpasseq(4, len(res))
 302             symlink_value = tip_tree['symlink']
 303             expected_symlink_item_w_meta = vfs.Item(meta=symlink_value.meta,
 304                                                     oid=symlink_value.oid)
 305             expected = (('', vfs._root),
 306                         ('test', test_revlist),
 307                         ('latest', expected_latest_item_w_meta),
 308                         ('symlink', expected_symlink_item_w_meta))
 309             wvpasseq(expected, res)
 310
 311             wvstart('resolve: /test/latest/missing')
 312             res = resolve(repo, '/test/latest/missing')
 313             wvpasseq(4, len(res))
 314             name, item = res[-1]
 315             wvpasseq('missing', name)
 316             wvpass(item is None)
 317
 318 @wvtest
 319 def test_resolve_loop():
 320     with no_lingering_errors():
 321         with test_tempdir('bup-tvfs-resloop-') as tmpdir:
 322             resolve = vfs.resolve
 323             lresolve = vfs.lresolve
 324             bup_dir = tmpdir + '/bup'
 325             environ['GIT_DIR'] = bup_dir
 326             environ['BUP_DIR'] = bup_dir
 327             git.repodir = bup_dir
 328             repo = LocalRepo()
 329             data_path = tmpdir + '/src'
 330             os.mkdir(data_path)
 331             symlink('loop', data_path + '/loop')
 332             ex((bup_path, 'init'))
 333             ex((bup_path, 'index', '-v', data_path))
 334             ex((bup_path, 'save', '-d', '100000', '-tvvn', 'test', '--strip',
 335                 data_path))
 336             wvexcept(vfs.Loop, resolve, repo, '/test/latest/loop')
 337
 338 @wvtest
 339 def test_contents_with_mismatched_bupm_git_ordering():
 340     with no_lingering_errors():
 341         with test_tempdir('bup-tvfs-') as tmpdir:
 342             bup_dir = tmpdir + '/bup'
 343             environ['GIT_DIR'] = bup_dir
 344             environ['BUP_DIR'] = bup_dir
 345             git.repodir = bup_dir
 346             data_path = tmpdir + '/src'
 347             os.mkdir(data_path)
 348             os.mkdir(data_path + '/foo')
 349             with open(data_path + '/foo.', 'w+') as tmpfile:
 350                 tmpfile.write(b'canary\n')
 351             ex((bup_path, 'init'))
 352             ex((bup_path, 'index', '-v', data_path))
 353             ex((bup_path, 'save', '-tvvn', 'test', '--strip',
 354                 data_path))
 355             repo = LocalRepo()
 356             tip_sref = exo(('git', 'show-ref', 'refs/heads/test'))[0]
 357             tip_oidx = tip_sref.strip().split()[0]
 358             tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
 359                                  tip_oidx))[0].strip()
 360             tip_tree_oid = tip_tree_oidx.decode('hex')
 361             tip_tree = tree_dict(repo, tip_tree_oid)
 362
 363             name, item = vfs.resolve(repo, '/test/latest')[2]
 364             wvpasseq('latest', name)
 365             expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
 366                                  for x in (tip_tree[name]
 367                                            for name in ('.', 'foo', 'foo.')))
 368             contents = tuple(vfs.contents(repo, item))
 369             wvpasseq(expected, frozenset(contents))
 370             # Spot check, in case tree_dict shares too much code with the vfs
 371             name, item = next(((n, i) for n, i in contents if n == 'foo'))
 372             wvpass(S_ISDIR(item.meta))
 373             name, item = next(((n, i) for n, i in contents if n == 'foo.'))
 374             wvpass(S_ISREG(item.meta.mode))
 375
 376 # FIXME: add tests for the want_meta=False cases.