8288: Give fusermount -u a chance to work before resorting to operations.destroy().
[arvados.git] / services / fuse / tests / mount_test_base.py
1 import arvados
2 import arvados.safeapi
3 import arvados_fuse as fuse
4 import llfuse
5 import os
6 import shutil
7 import subprocess
8 import sys
9 import tempfile
10 import threading
11 import time
12 import unittest
13 import logging
14 import multiprocessing
15 import run_test_server
16
17 logger = logging.getLogger('arvados.arv-mount')
18
19 class MountTestBase(unittest.TestCase):
20     def setUp(self, api=None, local_store=True):
21         # The underlying C implementation of open() makes a fstat() syscall
22         # with the GIL still held.  When the GETATTR message comes back to
23         # llfuse (which in these tests is in the same interpreter process) it
24         # can't acquire the GIL, so it can't service the fstat() call, so it
25         # deadlocks.  The workaround is to run some of our test code in a
26         # separate process.  Forturnately the multiprocessing module makes this
27         # relatively easy.
28         self.pool = multiprocessing.Pool(1)
29
30         if local_store:
31             self.keeptmp = tempfile.mkdtemp()
32             os.environ['KEEP_LOCAL_STORE'] = self.keeptmp
33         else:
34             self.keeptmp = None
35         self.mounttmp = tempfile.mkdtemp()
36         run_test_server.run()
37         run_test_server.authorize_with("admin")
38         self.api = api if api else arvados.safeapi.ThreadSafeApiCache(arvados.config.settings())
39
40     # This is a copy of Mount's method.  TODO: Refactor MountTestBase
41     # to use a Mount instead of copying its code.
42     def _llfuse_main(self):
43         try:
44             llfuse.main()
45         except:
46             llfuse.close(unmount=False)
47             raise
48         llfuse.close()
49
50     def make_mount(self, root_class, **root_kwargs):
51         self.operations = fuse.Operations(
52             os.getuid(), os.getgid(),
53             api_client=self.api,
54             enable_write=True)
55         self.operations.inodes.add_entry(root_class(
56             llfuse.ROOT_INODE, self.operations.inodes, self.api, 0, **root_kwargs))
57         llfuse.init(self.operations, self.mounttmp, [])
58         self.llfuse_thread = threading.Thread(None, lambda: self._llfuse_main())
59         self.llfuse_thread.daemon = True
60         self.llfuse_thread.start()
61         # wait until the driver is finished initializing
62         self.operations.initlock.wait()
63         return self.operations.inodes[llfuse.ROOT_INODE]
64
65     def tearDown(self):
66         self.pool.terminate()
67         self.pool.join()
68         del self.pool
69
70         subprocess.call(["fusermount", "-u", "-z", self.mounttmp])
71         self.llfuse_thread.join(timeout=0.1)
72         if self.llfuse_thread.is_alive():
73             logger.warning("MountTestBase.tearDown():"
74                            " llfuse thread still alive 100ms after umount"
75                            " -- resorting to operations.destroy()")
76             self.operations.destroy()
77
78         os.rmdir(self.mounttmp)
79         if self.keeptmp:
80             shutil.rmtree(self.keeptmp)
81             os.environ.pop('KEEP_LOCAL_STORE')
82         run_test_server.reset()
83
84     def assertDirContents(self, subdir, expect_content):
85         path = self.mounttmp
86         if subdir:
87             path = os.path.join(path, subdir)
88         self.assertEqual(sorted(expect_content), sorted(llfuse.listdir(path)))