X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/2d4198a095e193102daa2710c6b2baba7be7c9ce..386e1eefaac2021805f73732b10e9f543c221593:/services/fuse/tests/test_mount.py diff --git a/services/fuse/tests/test_mount.py b/services/fuse/tests/test_mount.py index ac5af5ba3a..ec8868af7d 100644 --- a/services/fuse/tests/test_mount.py +++ b/services/fuse/tests/test_mount.py @@ -1,77 +1,50 @@ -import arvados -import arvados.safeapi -import arvados_fuse as fuse -import glob +# Copyright (C) The Arvados Authors. All rights reserved. +# +# SPDX-License-Identifier: AGPL-3.0 + import json import llfuse +import logging +import mock import os -import shutil import subprocess -import sys -import tempfile -import threading import time import unittest -import logging -import multiprocessing + +import arvados +import arvados_fuse as fuse import run_test_server +from mount_test_base import MountTestBase + logger = logging.getLogger('arvados.arv-mount') -class MountTestBase(unittest.TestCase): - def setUp(self): - # The underlying C implementation of open() makes a fstat() syscall - # with the GIL still held. When the GETATTR message comes back to - # llfuse (which in these tests is in the same interpreter process) it - # can't acquire the GIL, so it can't service the fstat() call, so it - # deadlocks. The workaround is to run some of our test code in a - # separate process. Forturnately the multiprocessing module makes this - # relatively easy. - self.pool = multiprocessing.Pool(1) - - self.keeptmp = tempfile.mkdtemp() - os.environ['KEEP_LOCAL_STORE'] = self.keeptmp - self.mounttmp = tempfile.mkdtemp() - run_test_server.run() - run_test_server.authorize_with("admin") - self.api = arvados.safeapi.ThreadSafeApiCache(arvados.config.settings()) - - def make_mount(self, root_class, **root_kwargs): - self.operations = fuse.Operations(os.getuid(), os.getgid(), enable_write=True) - self.operations.inodes.add_entry(root_class( - llfuse.ROOT_INODE, self.operations.inodes, self.api, 0, **root_kwargs)) - llfuse.init(self.operations, self.mounttmp, []) - threading.Thread(None, llfuse.main).start() - # wait until the driver is finished initializing - self.operations.initlock.wait() - return self.operations.inodes[llfuse.ROOT_INODE] - - def tearDown(self): - self.pool.terminate() - self.pool.join() - del self.pool - - # llfuse.close is buggy, so use fusermount instead. - #llfuse.close(unmount=True) - - count = 0 - success = 1 - while (count < 9 and success != 0): - success = subprocess.call(["fusermount", "-u", self.mounttmp]) - time.sleep(0.1) - count += 1 - - self.operations.destroy() - - os.rmdir(self.mounttmp) - shutil.rmtree(self.keeptmp) - run_test_server.reset() - - def assertDirContents(self, subdir, expect_content): - path = self.mounttmp - if subdir: - path = os.path.join(path, subdir) - self.assertEqual(sorted(expect_content), sorted(llfuse.listdir(path))) + +class AssertWithTimeout(object): + """Allow some time for an assertion to pass.""" + + def __init__(self, timeout=0): + self.timeout = timeout + + def __iter__(self): + self.deadline = time.time() + self.timeout + self.done = False + return self + + def next(self): + if self.done: + raise StopIteration + return self.attempt + + def attempt(self, fn, *args, **kwargs): + try: + fn(*args, **kwargs) + except AssertionError: + if time.time() > self.deadline: + raise + time.sleep(0.1) + else: + self.done = True class FuseMountTest(MountTestBase): @@ -84,8 +57,8 @@ class FuseMountTest(MountTestBase): cw.write("data 1") cw.start_new_file('thing2.txt') cw.write("data 2") - cw.start_new_stream('dir1') + cw.start_new_stream('dir1') cw.start_new_file('thing3.txt') cw.write("data 3") cw.start_new_file('thing4.txt') @@ -105,11 +78,11 @@ class FuseMountTest(MountTestBase): cw.write("data 8") cw.start_new_stream('edgecases') - for f in ":/./../.../-/*/\x01\\/ ".split("/"): + for f in ":/.../-/*/\x01\\/ ".split("/"): cw.start_new_file(f) cw.write('x') - for f in ":/../.../-/*/\x01\\/ ".split("/"): + for f in ":/.../-/*/\x01\\/ ".split("/"): cw.start_new_stream('edgecases/dirs/' + f) cw.start_new_file('x/x') cw.write('x') @@ -126,9 +99,9 @@ class FuseMountTest(MountTestBase): self.assertDirContents('dir2', ['thing5.txt', 'thing6.txt', 'dir3']) self.assertDirContents('dir2/dir3', ['thing7.txt', 'thing8.txt']) self.assertDirContents('edgecases', - "dirs/:/_/__/.../-/*/\x01\\/ ".split("/")) + "dirs/:/.../-/*/\x01\\/ ".split("/")) self.assertDirContents('edgecases/dirs', - ":/__/.../-/*/\x01\\/ ".split("/")) + ":/.../-/*/\x01\\/ ".split("/")) files = {'thing1.txt': 'data 1', 'thing2.txt': 'data 2', @@ -163,8 +136,8 @@ class FuseNoAPITest(MountTestBase): class FuseMagicTest(MountTestBase): - def setUp(self): - super(FuseMagicTest, self).setUp() + def setUp(self, api=None): + super(FuseMagicTest, self).setUp(api=api) cw = arvados.CollectionWriter() @@ -172,7 +145,8 @@ class FuseMagicTest(MountTestBase): cw.write("data 1") self.testcollection = cw.finish() - self.api.collections().create(body={"manifest_text":cw.manifest_text()}).execute() + self.test_manifest = cw.manifest_text() + self.api.collections().create(body={"manifest_text":self.test_manifest}).execute() def runTest(self): self.make_mount(fuse.MagicDirectory) @@ -232,72 +206,76 @@ class FuseTagsUpdateTest(MountTestBase): bar_uuid = run_test_server.fixture('collections')['bar_file']['uuid'] self.tag_collection(bar_uuid, 'fuse_test_tag') - time.sleep(1) - self.assertIn('fuse_test_tag', llfuse.listdir(self.mounttmp)) + for attempt in AssertWithTimeout(10): + attempt(self.assertIn, 'fuse_test_tag', llfuse.listdir(self.mounttmp)) self.assertDirContents('fuse_test_tag', [bar_uuid]) baz_uuid = run_test_server.fixture('collections')['baz_file']['uuid'] l = self.tag_collection(baz_uuid, 'fuse_test_tag') - time.sleep(1) - self.assertDirContents('fuse_test_tag', [bar_uuid, baz_uuid]) + for attempt in AssertWithTimeout(10): + attempt(self.assertDirContents, 'fuse_test_tag', [bar_uuid, baz_uuid]) self.api.links().delete(uuid=l['uuid']).execute() - time.sleep(1) - self.assertDirContents('fuse_test_tag', [bar_uuid]) + for attempt in AssertWithTimeout(10): + attempt(self.assertDirContents, 'fuse_test_tag', [bar_uuid]) + + +def fuseSharedTestHelper(mounttmp): + class Test(unittest.TestCase): + def runTest(self): + # Double check that we can open and read objects in this folder as a file, + # and that its contents are what we expect. + baz_path = os.path.join( + mounttmp, + 'FUSE User', + 'FUSE Test Project', + 'collection in FUSE project', + 'baz') + with open(baz_path) as f: + self.assertEqual("baz", f.read()) + + # check mtime on collection + st = os.stat(baz_path) + try: + mtime = st.st_mtime_ns / 1000000000 + except AttributeError: + mtime = st.st_mtime + self.assertEqual(mtime, 1391448174) + + # shared_dirs is a list of the directories exposed + # by fuse.SharedDirectory (i.e. any object visible + # to the current user) + shared_dirs = llfuse.listdir(mounttmp) + shared_dirs.sort() + self.assertIn('FUSE User', shared_dirs) + + # fuse_user_objs is a list of the objects owned by the FUSE + # test user (which present as files in the 'FUSE User' + # directory) + fuse_user_objs = llfuse.listdir(os.path.join(mounttmp, 'FUSE User')) + fuse_user_objs.sort() + self.assertEqual(['FUSE Test Project', # project owned by user + 'collection #1 owned by FUSE', # collection owned by user + 'collection #2 owned by FUSE' # collection owned by user + ], fuse_user_objs) + + # test_proj_files is a list of the files in the FUSE Test Project. + test_proj_files = llfuse.listdir(os.path.join(mounttmp, 'FUSE User', 'FUSE Test Project')) + test_proj_files.sort() + self.assertEqual(['collection in FUSE project' + ], test_proj_files) + Test().runTest() + class FuseSharedTest(MountTestBase): def runTest(self): self.make_mount(fuse.SharedDirectory, exclude=self.api.users().current().execute()['uuid']) + keep = arvados.keep.KeepClient() + keep.put("baz") - # shared_dirs is a list of the directories exposed - # by fuse.SharedDirectory (i.e. any object visible - # to the current user) - shared_dirs = llfuse.listdir(self.mounttmp) - shared_dirs.sort() - self.assertIn('FUSE User', shared_dirs) - - # fuse_user_objs is a list of the objects owned by the FUSE - # test user (which present as files in the 'FUSE User' - # directory) - fuse_user_objs = llfuse.listdir(os.path.join(self.mounttmp, 'FUSE User')) - fuse_user_objs.sort() - self.assertEqual(['FUSE Test Project', # project owned by user - 'collection #1 owned by FUSE', # collection owned by user - 'collection #2 owned by FUSE', # collection owned by user - 'pipeline instance owned by FUSE.pipelineInstance', # pipeline instance owned by user - ], fuse_user_objs) - - # test_proj_files is a list of the files in the FUSE Test Project. - test_proj_files = llfuse.listdir(os.path.join(self.mounttmp, 'FUSE User', 'FUSE Test Project')) - test_proj_files.sort() - self.assertEqual(['collection in FUSE project', - 'pipeline instance in FUSE project.pipelineInstance', - 'pipeline template in FUSE project.pipelineTemplate' - ], test_proj_files) - - # Double check that we can open and read objects in this folder as a file, - # and that its contents are what we expect. - pipeline_template_path = os.path.join( - self.mounttmp, - 'FUSE User', - 'FUSE Test Project', - 'pipeline template in FUSE project.pipelineTemplate') - with open(pipeline_template_path) as f: - j = json.load(f) - self.assertEqual("pipeline template in FUSE project", j['name']) - - # check mtime on template - st = os.stat(pipeline_template_path) - self.assertEqual(st.st_mtime, 1397493304) - - # check mtime on collection - st = os.stat(os.path.join( - self.mounttmp, - 'FUSE User', - 'collection #1 owned by FUSE')) - self.assertEqual(st.st_mtime, 1391448174) + self.pool.apply(fuseSharedTestHelper, (self.mounttmp,)) class FuseHomeTest(MountTestBase): @@ -478,12 +456,16 @@ class FuseWriteFileTest(MountTestBase): self.assertNotIn("file1.txt", collection) + self.assertEqual(0, self.operations.write_counter.get()) self.pool.apply(fuseWriteFileTestHelperWriteFile, (self.mounttmp,)) + self.assertEqual(12, self.operations.write_counter.get()) with collection.open("file1.txt") as f: self.assertEqual(f.read(), "Hello world!") + self.assertEqual(0, self.operations.read_counter.get()) self.pool.apply(fuseWriteFileTestHelperReadFile, (self.mounttmp,)) + self.assertEqual(12, self.operations.read_counter.get()) collection2 = self.api.collections().get(uuid=collection.manifest_locator()).execute() self.assertRegexpMatches(collection2["manifest_text"], @@ -750,7 +732,7 @@ class FuseUpdateFromEventTest(MountTestBase): with llfuse.lock: m.new_collection(collection.api_response(), collection) - self.operations.listen_for_events(self.api) + self.operations.listen_for_events() d1 = llfuse.listdir(os.path.join(self.mounttmp)) self.assertEqual([], sorted(d1)) @@ -759,12 +741,8 @@ class FuseUpdateFromEventTest(MountTestBase): with collection2.open("file1.txt", "w") as f: f.write("foo") - time.sleep(1) - - # should show up via event bus notify - - d1 = llfuse.listdir(os.path.join(self.mounttmp)) - self.assertEqual(["file1.txt"], sorted(d1)) + for attempt in AssertWithTimeout(10): + attempt(self.assertEqual, ["file1.txt"], llfuse.listdir(os.path.join(self.mounttmp))) def fuseFileConflictTestHelper(mounttmp): @@ -1047,6 +1025,40 @@ class FuseProjectMvTest(MountTestBase): self.pool.apply(fuseProjectMvTestHelper1, (self.mounttmp,)) +def fuseFsyncTestHelper(mounttmp, k): + class Test(unittest.TestCase): + def runTest(self): + fd = os.open(os.path.join(mounttmp, k), os.O_RDONLY) + os.fsync(fd) + os.close(fd) + + Test().runTest() + +class FuseFsyncTest(FuseMagicTest): + def runTest(self): + self.make_mount(fuse.MagicDirectory) + self.pool.apply(fuseFsyncTestHelper, (self.mounttmp, self.testcollection)) + + +class MagicDirApiError(FuseMagicTest): + def setUp(self): + api = mock.MagicMock() + super(MagicDirApiError, self).setUp(api=api) + api.collections().get().execute.side_effect = iter([Exception('API fail'), {"manifest_text": self.test_manifest}]) + api.keep.get.side_effect = Exception('Keep fail') + + def runTest(self): + self.make_mount(fuse.MagicDirectory) + + self.operations.inodes.inode_cache.cap = 1 + self.operations.inodes.inode_cache.min_entries = 2 + + with self.assertRaises(OSError): + llfuse.listdir(os.path.join(self.mounttmp, self.testcollection)) + + llfuse.listdir(os.path.join(self.mounttmp, self.testcollection)) + + class FuseUnitTest(unittest.TestCase): def test_sanitize_filename(self): acceptable = [ @@ -1077,3 +1089,66 @@ class FuseUnitTest(unittest.TestCase): self.assertEqual("_", fuse.sanitize_filename("")) self.assertEqual("_", fuse.sanitize_filename(".")) self.assertEqual("__", fuse.sanitize_filename("..")) + + +class FuseMagicTestPDHOnly(MountTestBase): + def setUp(self, api=None): + super(FuseMagicTestPDHOnly, self).setUp(api=api) + + cw = arvados.CollectionWriter() + + cw.start_new_file('thing1.txt') + cw.write("data 1") + + self.testcollection = cw.finish() + self.test_manifest = cw.manifest_text() + created = self.api.collections().create(body={"manifest_text":self.test_manifest}).execute() + self.testcollectionuuid = str(created['uuid']) + + def verify_pdh_only(self, pdh_only=False, skip_pdh_only=False): + if skip_pdh_only is True: + self.make_mount(fuse.MagicDirectory) # in this case, the default by_id applies + else: + self.make_mount(fuse.MagicDirectory, pdh_only=pdh_only) + + mount_ls = llfuse.listdir(self.mounttmp) + self.assertIn('README', mount_ls) + self.assertFalse(any(arvados.util.keep_locator_pattern.match(fn) or + arvados.util.uuid_pattern.match(fn) + for fn in mount_ls), + "new FUSE MagicDirectory lists Collection") + + # look up using pdh should succeed in all cases + self.assertDirContents(self.testcollection, ['thing1.txt']) + self.assertDirContents(os.path.join('by_id', self.testcollection), + ['thing1.txt']) + mount_ls = llfuse.listdir(self.mounttmp) + self.assertIn('README', mount_ls) + self.assertIn(self.testcollection, mount_ls) + self.assertIn(self.testcollection, + llfuse.listdir(os.path.join(self.mounttmp, 'by_id'))) + + files = {} + files[os.path.join(self.mounttmp, self.testcollection, 'thing1.txt')] = 'data 1' + + for k, v in files.items(): + with open(os.path.join(self.mounttmp, k)) as f: + self.assertEqual(v, f.read()) + + # look up using uuid should fail when pdh_only is set + if pdh_only is True: + with self.assertRaises(OSError): + self.assertDirContents(os.path.join('by_id', self.testcollectionuuid), + ['thing1.txt']) + else: + self.assertDirContents(os.path.join('by_id', self.testcollectionuuid), + ['thing1.txt']) + + def test_with_pdh_only_true(self): + self.verify_pdh_only(pdh_only=True) + + def test_with_pdh_only_false(self): + self.verify_pdh_only(pdh_only=False) + + def test_with_default_by_id(self): + self.verify_pdh_only(skip_pdh_only=True)