7475: Merge branch 'master' into 7475-nodemgr-unsatisfiable-job-comms
[arvados.git] / services / fuse / tests / mount_test_base.py
1 # Copyright (C) The Arvados Authors. All rights reserved.
2 #
3 # SPDX-License-Identifier: AGPL-3.0
4
5 import arvados
6 import arvados_fuse as fuse
7 import arvados.safeapi
8 import llfuse
9 import logging
10 import multiprocessing
11 import os
12 import run_test_server
13 import shutil
14 import signal
15 import subprocess
16 import sys
17 import tempfile
18 import threading
19 import time
20 import unittest
21
22 logger = logging.getLogger('arvados.arv-mount')
23
24 class MountTestBase(unittest.TestCase):
25     def setUp(self, api=None, local_store=True):
26         # The underlying C implementation of open() makes a fstat() syscall
27         # with the GIL still held.  When the GETATTR message comes back to
28         # llfuse (which in these tests is in the same interpreter process) it
29         # can't acquire the GIL, so it can't service the fstat() call, so it
30         # deadlocks.  The workaround is to run some of our test code in a
31         # separate process.  Forturnately the multiprocessing module makes this
32         # relatively easy.
33         self.pool = multiprocessing.Pool(1)
34
35         if local_store:
36             self.keeptmp = tempfile.mkdtemp()
37             os.environ['KEEP_LOCAL_STORE'] = self.keeptmp
38         else:
39             self.keeptmp = None
40         self.mounttmp = tempfile.mkdtemp()
41         run_test_server.run()
42         run_test_server.authorize_with("admin")
43         self.api = api if api else arvados.safeapi.ThreadSafeApiCache(arvados.config.settings())
44         self.llfuse_thread = None
45
46         # Workaround for llfuse deadlock bug. See #10805, #8345,
47         # https://bitbucket.org/nikratio/python-llfuse/issues/108
48         llfuse.close = lambda *args: None
49
50     # This is a copy of Mount's method.  TODO: Refactor MountTestBase
51     # to use a Mount instead of copying its code.
52     def _llfuse_main(self):
53         try:
54             llfuse.main()
55         except:
56             llfuse.close(unmount=False)
57             raise
58         llfuse.close()
59
60     def make_mount(self, root_class, **root_kwargs):
61         self.operations = fuse.Operations(
62             os.getuid(), os.getgid(),
63             api_client=self.api,
64             enable_write=True)
65         self.operations.inodes.add_entry(root_class(
66             llfuse.ROOT_INODE, self.operations.inodes, self.api, 0, **root_kwargs))
67         llfuse.init(self.operations, self.mounttmp, [])
68         self.llfuse_thread = threading.Thread(None, lambda: self._llfuse_main())
69         self.llfuse_thread.daemon = True
70         self.llfuse_thread.start()
71         # wait until the driver is finished initializing
72         self.operations.initlock.wait()
73         return self.operations.inodes[llfuse.ROOT_INODE]
74
75     def tearDown(self):
76         if self.llfuse_thread:
77             if self.operations.events:
78                 self.operations.events.close(timeout=10)
79             subprocess.call(["fusermount", "-u", "-z", self.mounttmp])
80             t0 = time.time()
81             self.llfuse_thread.join(timeout=10)
82             if self.llfuse_thread.is_alive():
83                 logger.warning("MountTestBase.tearDown():"
84                                " llfuse thread still alive 10s after umount"
85                                " -- exiting with SIGKILL")
86                 os.kill(os.getpid(), signal.SIGKILL)
87             waited = time.time() - t0
88             if waited > 0.1:
89                 logger.warning("MountTestBase.tearDown(): waited %f s for llfuse thread to end", waited)
90
91         os.rmdir(self.mounttmp)
92         if self.keeptmp:
93             shutil.rmtree(self.keeptmp)
94             os.environ.pop('KEEP_LOCAL_STORE')
95         run_test_server.reset()
96         self.pool.close()
97         self.pool.join()
98
99     def assertDirContents(self, subdir, expect_content):
100         path = self.mounttmp
101         if subdir:
102             path = os.path.join(path, subdir)
103         self.assertEqual(sorted(expect_content), sorted(llfuse.listdir(path)))