]> arthur.barton.de Git - bup.git/blobdiff - lib/bup/t/tvfs.py
vfs: rely on FakeLink's target in readlink
[bup.git] / lib / bup / t / tvfs.py
index c0630125d539de2069f371aa4210e544bb684639..a35ad057fb0bd8ad5f4980843c8f7d1014889546 100644 (file)
@@ -1,20 +1,24 @@
 
-from __future__ import print_function
+from __future__ import absolute_import, print_function
 from collections import namedtuple
+from errno import ELOOP, ENOTDIR
 from io import BytesIO
 from os import environ, symlink
-from stat import S_IFDIR, S_IFREG, S_ISDIR, S_ISREG
+from random import Random, randint
+from stat import S_IFDIR, S_IFLNK, S_IFREG, S_ISDIR, S_ISREG
 from sys import stderr
 from time import localtime, strftime
 
 from wvtest import *
 
-from bup import git, metadata, vfs2 as vfs
+from bup._helpers import write_random
+from bup import git, metadata, vfs
 from bup.git import BUP_CHUNKED
-from bup.helpers import exc, exo, shstr
+from bup.helpers import exc, shstr
 from bup.metadata import Metadata
 from bup.repo import LocalRepo
-from buptest import no_lingering_errors, test_tempdir
+from bup.test.vfs import tree_dict
+from buptest import ex, exo, no_lingering_errors, test_tempdir
 
 top_dir = '../../..'
 bup_tmp = os.path.realpath('../../../t/tmp')
@@ -25,50 +29,57 @@ def ex(cmd, **kwargs):
     print(shstr(cmd), file=stderr)
     return exc(cmd, **kwargs)
 
-TreeDictValue = namedtuple('TreeDictValue', ('name', 'oid', 'meta'))
-
-def tree_items(repo, oid):
-    """Yield (name, entry_oid, meta) for each entry in oid.  meta will be
-    a Metadata object for any non-directories and for '.', otherwise
-    None.
+@wvtest
+def test_default_modes():
+    wvpasseq(S_IFREG | 0o644, vfs.default_file_mode)
+    wvpasseq(S_IFDIR | 0o755, vfs.default_dir_mode)
+    wvpasseq(S_IFLNK | 0o755, vfs.default_symlink_mode)
 
-    """
-    # This is a simpler approach than the one in the vfs, used to
-    # cross-check its behavior.
-    tree_data, bupm_oid = vfs.tree_data_and_bupm(repo, oid)
-    bupm = vfs._FileReader(repo, bupm_oid) if bupm_oid else None
+@wvtest
+def test_cache_behavior():
+    orig_max = vfs._cache_max_items
     try:
-        maybe_meta = lambda : Metadata.read(bupm) if bupm else None
-        m = maybe_meta()
-        if m:
-            m.size = 0
-        yield TreeDictValue(name='.', oid=oid, meta=m)
-        tree_ents = vfs.ordered_tree_entries(tree_data, bupm=True)
-        for name, mangled_name, kind, gitmode, sub_oid in tree_ents:
-            if mangled_name == '.bupm':
-                continue
-            assert name != '.'
-            if S_ISDIR(gitmode):
-                if kind == BUP_CHUNKED:
-                    yield TreeDictValue(name=name, oid=sub_oid,
-                                        meta=maybe_meta())
-                else:
-                    yield TreeDictValue(name=name, oid=sub_oid,
-                                        meta=vfs.default_dir_mode)
-            else:
-                yield TreeDictValue(name=name, oid=sub_oid, meta=maybe_meta())
+        vfs._cache_max_items = 2
+        vfs.clear_cache()
+        wvpasseq({}, vfs._cache)
+        wvpasseq([], vfs._cache_keys)
+        wvfail(vfs._cache_keys)
+        wvexcept(Exception, vfs.cache_notice, 'x', 1)
+        key_0 = 'itm:' + b'\0' * 20
+        key_1 = 'itm:' + b'\1' * 20
+        key_2 = 'itm:' + b'\2' * 20
+        vfs.cache_notice(key_0, 'something')
+        wvpasseq({key_0 : 'something'}, vfs._cache)
+        wvpasseq([key_0], vfs._cache_keys)
+        vfs.cache_notice(key_1, 'something else')
+        wvpasseq({key_0 : 'something', key_1 : 'something else'}, vfs._cache)
+        wvpasseq(frozenset([key_0, key_1]), frozenset(vfs._cache_keys))
+        vfs.cache_notice(key_2, 'and also')
+        wvpasseq(2, len(vfs._cache))
+        wvpass(frozenset(vfs._cache.iteritems())
+               < frozenset({key_0 : 'something',
+                            key_1 : 'something else',
+                            key_2 : 'and also'}.iteritems()))
+        wvpasseq(2, len(vfs._cache_keys))
+        wvpass(frozenset(vfs._cache_keys) < frozenset([key_0, key_1, key_2]))
+        vfs.clear_cache()
+        wvpasseq({}, vfs._cache)
+        wvpasseq([], vfs._cache_keys)
     finally:
-        if bupm:
-            bupm.close()
+        vfs._cache_max_items = orig_max
+        vfs.clear_cache()
 
-def tree_dict(repo, oid):
-    return dict((x.name, x) for x in tree_items(repo, oid))
+## The clear_cache() calls below are to make sure that the test starts
+## from a known state since at the moment the cache entry for a given
+## item (like a commit) can change.  For example, its meta value might
+## be promoted from a mode to a Metadata instance once the tree it
+## refers to is traversed.
 
 def run_augment_item_meta_tests(repo,
                                 file_path, file_size,
                                 link_path, link_target):
     _, file_item = vfs.resolve(repo, file_path)[-1]
-    _, link_item = vfs.lresolve(repo, link_path)[-1]
+    _, link_item = vfs.resolve(repo, link_path, follow=False)[-1]
     wvpass(isinstance(file_item.meta, Metadata))
     wvpass(isinstance(link_item.meta, Metadata))
     # Note: normally, modifying item.meta values is forbidden
@@ -161,14 +172,14 @@ def test_misc():
             repo = LocalRepo()
 
             wvstart('readlink')
-            ls_tree = exo(('git', 'ls-tree', 'test', 'symlink'))
-            mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
+            ls_tree = exo(('git', 'ls-tree', 'test', 'symlink')).out
+            mode, typ, oidx, name = ls_tree.strip().split(None, 3)
             assert name == 'symlink'
             link_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
             wvpasseq('file', vfs.readlink(repo, link_item))
 
-            ls_tree = exo(('git', 'ls-tree', 'test', 'file'))
-            mode, typ, oidx, name = ls_tree[0].strip().split(None, 3)
+            ls_tree = exo(('git', 'ls-tree', 'test', 'file')).out
+            mode, typ, oidx, name = ls_tree.strip().split(None, 3)
             assert name == 'file'
             file_item = vfs.Item(oid=oidx.decode('hex'), meta=int(mode, 8))
             wvexcept(Exception, vfs.readlink, repo, file_item)
@@ -181,6 +192,9 @@ def test_misc():
             fake_item = file_item._replace(meta=meta)
             wvpasseq(42, vfs.item_size(repo, fake_item))
 
+            _, fakelink_item = vfs.resolve(repo, '/test/latest', follow=False)[-1]
+            wvpasseq(17, vfs.item_size(repo, fakelink_item))
+
             wvstart('augment_item_meta')
             run_augment_item_meta_tests(repo,
                                         '/test/latest/file', 7,
@@ -199,142 +213,65 @@ def test_misc():
             file_copy.meta.user = None
             wvpass(file_item.meta.user)
 
-@wvtest
-def test_resolve():
-    with no_lingering_errors():
-        with test_tempdir('bup-tvfs-') as tmpdir:
-            resolve = vfs.resolve
-            lresolve = vfs.lresolve
-            bup_dir = tmpdir + '/bup'
-            environ['GIT_DIR'] = bup_dir
-            environ['BUP_DIR'] = bup_dir
-            git.repodir = bup_dir
-            data_path = tmpdir + '/src'
-            save_time = 100000
-            save_time_str = strftime('%Y-%m-%d-%H%M%S', localtime(save_time))
-            os.mkdir(data_path)
-            with open(data_path + '/file', 'w+') as tmpfile:
-                print('canary', file=tmpfile)
-            symlink('file', data_path + '/symlink')
-            ex((bup_path, 'init'))
-            ex((bup_path, 'index', '-v', data_path))
-            ex((bup_path, 'save', '-d', str(save_time), '-tvvn', 'test',
-                '--strip', data_path))
-            ex((bup_path, 'tag', 'test-tag', 'test'))
-            repo = LocalRepo()
-
-            tip_hash = exo(('git', 'show-ref', 'refs/heads/test'))[0]
-            tip_oidx = tip_hash.strip().split()[0]
-            tip_oid = tip_oidx.decode('hex')
-            tip_meta = Metadata()
-            tip_meta.mode = S_IFDIR | 0o755
-            tip_meta.uid = tip_meta.gid = tip_meta.size = 0
-            tip_meta.atime = tip_meta.mtime = tip_meta.ctime = save_time * 10**9
-            test_revlist = vfs.RevList(meta=tip_meta, oid=tip_oid)
-            tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
-                                 tip_oidx))[0].strip()
-            tip_tree_oid = tip_tree_oidx.decode('hex')
-            tip_tree = tree_dict(repo, tip_tree_oid)
-
-            wvstart('resolve: /')
-            res = resolve(repo, '/')
-            wvpasseq(1, len(res))
-            wvpasseq((('', vfs._root),), res)
-            ignore, root_item = res[0]
-            root_content = frozenset(vfs.contents(repo, root_item))
-            wvpasseq(frozenset([('.', root_item),
-                                ('.tag', vfs._tags),
-                                ('test', test_revlist)]),
-                     root_content)
-
-            wvstart('resolve: /.tag')
-            res = resolve(repo, '/.tag')
-            wvpasseq(2, len(res))
-            wvpasseq((('', vfs._root), ('.tag', vfs._tags)),
-                     res)
-            ignore, tag_item = res[1]
-            tag_content = frozenset(vfs.contents(repo, tag_item))
-            wvpasseq(frozenset([('.', tag_item),
-                                ('test-tag', test_revlist)]),
-                     tag_content)
-
-            wvstart('resolve: /test')
-            res = resolve(repo, '/test')
-            wvpasseq(2, len(res))
-            wvpasseq((('', vfs._root), ('test', test_revlist)), res)
-            ignore, test_item = res[1]
-            test_content = frozenset(vfs.contents(repo, test_item))
-            expected_latest_item = vfs.Commit(meta=S_IFDIR | 0o755,
-                                              oid=tip_tree_oid,
-                                              coid=tip_oid)
-            wvpasseq(frozenset([('.', test_revlist),
-                                (save_time_str, expected_latest_item),
-                                ('latest', expected_latest_item)]),
-                     test_content)
-
-            wvstart('resolve: /test/latest')
-            res = resolve(repo, '/test/latest')
-            wvpasseq(3, len(res))
-            expected_latest_item_w_meta = vfs.Commit(meta=tip_tree['.'].meta,
-                                                     oid=tip_tree_oid,
-                                                     coid=tip_oid)
-            expected = (('', vfs._root),
-                        ('test', test_revlist),
-                        ('latest', expected_latest_item_w_meta))
-            wvpasseq(expected, res)
-            ignore, latest_item = res[2]
-            latest_content = frozenset(vfs.contents(repo, latest_item))
-            expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
-                                 for x in (tip_tree[name]
-                                           for name in ('.', 'file',
-                                                        'symlink')))
-            wvpasseq(expected, latest_content)
-
-            wvstart('resolve: /test/latest/foo')
-            res = resolve(repo, '/test/latest/file')
-            wvpasseq(4, len(res))
-            expected_file_item_w_meta = vfs.Item(meta=tip_tree['file'].meta,
-                                                 oid=tip_tree['file'].oid)
-            expected = (('', vfs._root),
-                        ('test', test_revlist),
-                        ('latest', expected_latest_item_w_meta),
-                        ('file', expected_file_item_w_meta))
-            wvpasseq(expected, res)
-
-            wvstart('resolve: /test/latest/symlink')
-            res = resolve(repo, '/test/latest/symlink')
-            wvpasseq(4, len(res))
-            expected = (('', vfs._root),
-                        ('test', test_revlist),
-                        ('latest', expected_latest_item_w_meta),
-                        ('file', expected_file_item_w_meta))
-            wvpasseq(expected, res)
-
-            wvstart('lresolve: /test/latest/symlink')
-            res = lresolve(repo, '/test/latest/symlink')
-            wvpasseq(4, len(res))
-            symlink_value = tip_tree['symlink']
-            expected_symlink_item_w_meta = vfs.Item(meta=symlink_value.meta,
-                                                    oid=symlink_value.oid)
-            expected = (('', vfs._root),
-                        ('test', test_revlist),
-                        ('latest', expected_latest_item_w_meta),
-                        ('symlink', expected_symlink_item_w_meta))
-            wvpasseq(expected, res)
-
-            wvstart('resolve: /test/latest/missing')
-            res = resolve(repo, '/test/latest/missing')
-            wvpasseq(4, len(res))
-            name, item = res[-1]
-            wvpasseq('missing', name)
-            wvpass(item is None)
+def write_sized_random_content(parent_dir, size, seed):
+    verbose = 0
+    with open('%s/%d' % (parent_dir, size), 'wb') as f:
+        write_random(f.fileno(), size, seed, verbose)
+
+def validate_vfs_streaming_read(repo, item, expected_path, read_sizes):
+    for read_size in read_sizes:
+        with open(expected_path, 'rb') as expected:
+            with vfs.fopen(repo, item) as actual:
+                ex_buf = expected.read(read_size)
+                act_buf = actual.read(read_size)
+                while ex_buf and act_buf:
+                    wvpassge(read_size, len(ex_buf))
+                    wvpassge(read_size, len(act_buf))
+                    wvpasseq(len(ex_buf), len(act_buf))
+                    wvpass(ex_buf == act_buf)
+                    ex_buf = expected.read(read_size)
+                    act_buf = actual.read(read_size)
+                wvpasseq('', ex_buf)
+                wvpasseq('', act_buf)
+
+def validate_vfs_seeking_read(repo, item, expected_path, read_sizes):
+    def read_act(act_pos):
+        with vfs.fopen(repo, item) as actual:
+            actual.seek(act_pos)
+            wvpasseq(act_pos, actual.tell())
+            act_buf = actual.read(read_size)
+            act_pos += len(act_buf)
+            wvpasseq(act_pos, actual.tell())
+            return act_pos, act_buf
+
+    for read_size in read_sizes:
+        with open(expected_path, 'rb') as expected:
+                ex_buf = expected.read(read_size)
+                act_buf = None
+                act_pos = 0
+                while ex_buf:
+                    act_pos, act_buf = read_act(act_pos)
+                    wvpassge(read_size, len(ex_buf))
+                    wvpassge(read_size, len(act_buf))
+                    wvpasseq(len(ex_buf), len(act_buf))
+                    wvpass(ex_buf == act_buf)
+                    if not act_buf:
+                        break
+                    ex_buf = expected.read(read_size)
+                else:  # hit expected eof first
+                    act_pos, act_buf = read_act(act_pos)
+                wvpasseq('', ex_buf)
+                wvpasseq('', act_buf)
 
 @wvtest
-def test_resolve_loop():
+def test_read_and_seek():
+    # Write a set of randomly sized files containing random data whose
+    # names are their sizes, and then verify that what we get back
+    # from the vfs when seeking and reading with various block sizes
+    # matches the original content.
     with no_lingering_errors():
-        with test_tempdir('bup-tvfs-resloop-') as tmpdir:
+        with test_tempdir('bup-tvfs-read-') as tmpdir:
             resolve = vfs.resolve
-            lresolve = vfs.lresolve
             bup_dir = tmpdir + '/bup'
             environ['GIT_DIR'] = bup_dir
             environ['BUP_DIR'] = bup_dir
@@ -342,12 +279,35 @@ def test_resolve_loop():
             repo = LocalRepo()
             data_path = tmpdir + '/src'
             os.mkdir(data_path)
-            symlink('loop', data_path + '/loop')
+            seed = randint(-(1 << 31), (1 << 31) - 1)
+            rand = Random()
+            rand.seed(seed)
+            print('test_read seed:', seed, file=sys.stderr)
+            max_size = 2 * 1024 * 1024
+            sizes = set((rand.randint(1, max_size) for _ in xrange(5)))
+            sizes.add(1)
+            sizes.add(max_size)
+            for size in sizes:
+                write_sized_random_content(data_path, size, seed)
             ex((bup_path, 'init'))
             ex((bup_path, 'index', '-v', data_path))
             ex((bup_path, 'save', '-d', '100000', '-tvvn', 'test', '--strip',
                 data_path))
-            wvexcept(vfs.Loop, resolve, repo, '/test/latest/loop')
+            read_sizes = set((rand.randint(1, max_size) for _ in xrange(10)))
+            sizes.add(1)
+            sizes.add(max_size)
+            print('test_read src sizes:', sizes, file=sys.stderr)
+            print('test_read read sizes:', read_sizes, file=sys.stderr)
+            for size in sizes:
+                res = resolve(repo, '/test/latest/' + str(size))
+                _, item = res[-1]
+                wvpasseq(size, vfs.item_size(repo, res[-1][1]))
+                validate_vfs_streaming_read(repo, item,
+                                            '%s/%d' % (data_path, size),
+                                            read_sizes)
+                validate_vfs_seeking_read(repo, item,
+                                          '%s/%d' % (data_path, size),
+                                          read_sizes)
 
 @wvtest
 def test_contents_with_mismatched_bupm_git_ordering():
@@ -364,18 +324,20 @@ def test_contents_with_mismatched_bupm_git_ordering():
                 tmpfile.write(b'canary\n')
             ex((bup_path, 'init'))
             ex((bup_path, 'index', '-v', data_path))
-            ex((bup_path, 'save', '-tvvn', 'test', '--strip',
-                data_path))
+            save_utc = 100000
+            save_name = strftime('%Y-%m-%d-%H%M%S', localtime(save_utc))
+            ex((bup_path, 'save', '-tvvn', 'test', '-d', str(save_utc),
+                '--strip', data_path))
             repo = LocalRepo()
-            tip_sref = exo(('git', 'show-ref', 'refs/heads/test'))[0]
+            tip_sref = exo(('git', 'show-ref', 'refs/heads/test')).out
             tip_oidx = tip_sref.strip().split()[0]
             tip_tree_oidx = exo(('git', 'log', '--pretty=%T', '-n1',
-                                 tip_oidx))[0].strip()
+                                 tip_oidx)).out.strip()
             tip_tree_oid = tip_tree_oidx.decode('hex')
             tip_tree = tree_dict(repo, tip_tree_oid)
 
             name, item = vfs.resolve(repo, '/test/latest')[2]
-            wvpasseq('latest', name)
+            wvpasseq(save_name, name)
             expected = frozenset((x.name, vfs.Item(oid=x.oid, meta=x.meta))
                                  for x in (tip_tree[name]
                                            for name in ('.', 'foo', 'foo.')))
@@ -410,18 +372,26 @@ def test_duplicate_save_dates():
             name, revlist = res[-1]
             wvpasseq('test', name)
             wvpasseq(('.',
-                      '1970-01-02-034640-10',
-                      '1970-01-02-034640-09',
-                      '1970-01-02-034640-08',
-                      '1970-01-02-034640-07',
-                      '1970-01-02-034640-06',
-                      '1970-01-02-034640-05',
-                      '1970-01-02-034640-04',
-                      '1970-01-02-034640-03',
-                      '1970-01-02-034640-02',
-                      '1970-01-02-034640-01',
                       '1970-01-02-034640-00',
+                      '1970-01-02-034640-01',
+                      '1970-01-02-034640-02',
+                      '1970-01-02-034640-03',
+                      '1970-01-02-034640-04',
+                      '1970-01-02-034640-05',
+                      '1970-01-02-034640-06',
+                      '1970-01-02-034640-07',
+                      '1970-01-02-034640-08',
+                      '1970-01-02-034640-09',
+                      '1970-01-02-034640-10',
                       'latest'),
-                     tuple(x[0] for x in vfs.contents(repo, revlist)))
+                     tuple(sorted(x[0] for x in vfs.contents(repo, revlist))))
 
-# FIXME: add tests for the want_meta=False cases.
+@wvtest
+def test_item_read_write():
+    with no_lingering_errors():
+        x = vfs.Root(meta=13)
+        stream = BytesIO()
+        vfs.write_item(stream, x)
+        print('stream:', repr(stream.getvalue()), stream.tell(), file=sys.stderr)
+        stream.seek(0)
+        wvpasseq(x, vfs.read_item(stream))