Merge branch 'master' of git.curoverse.com:arvados into 11876-r-sdk
[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 from .integration_test import workerPool
25
26 class MountTestBase(unittest.TestCase):
27     def setUp(self, api=None, local_store=True):
28         # The underlying C implementation of open() makes a fstat() syscall
29         # with the GIL still held.  When the GETATTR message comes back to
30         # llfuse (which in these tests is in the same interpreter process) it
31         # can't acquire the GIL, so it can't service the fstat() call, so it
32         # deadlocks.  The workaround is to run some of our test code in a
33         # separate process.  Forturnately the multiprocessing module makes this
34         # relatively easy.
35
36         self.pool = workerPool()
37         if local_store:
38             self.keeptmp = tempfile.mkdtemp()
39             os.environ['KEEP_LOCAL_STORE'] = self.keeptmp
40         else:
41             self.keeptmp = None
42         self.mounttmp = tempfile.mkdtemp()
43         run_test_server.run()
44         run_test_server.authorize_with("admin")
45         self.api = api if api else arvados.safeapi.ThreadSafeApiCache(arvados.config.settings())
46         self.llfuse_thread = None
47
48     # This is a copy of Mount's method.  TODO: Refactor MountTestBase
49     # to use a Mount instead of copying its code.
50     def _llfuse_main(self):
51         try:
52             llfuse.main()
53         except:
54             llfuse.close(unmount=False)
55             raise
56         llfuse.close()
57
58     def make_mount(self, root_class, **root_kwargs):
59         self.operations = fuse.Operations(
60             os.getuid(), os.getgid(),
61             api_client=self.api,
62             enable_write=True)
63         self.operations.inodes.add_entry(root_class(
64             llfuse.ROOT_INODE, self.operations.inodes, self.api, 0, **root_kwargs))
65         llfuse.init(self.operations, self.mounttmp, [])
66         self.llfuse_thread = threading.Thread(None, lambda: self._llfuse_main())
67         self.llfuse_thread.daemon = True
68         self.llfuse_thread.start()
69         # wait until the driver is finished initializing
70         self.operations.initlock.wait()
71         return self.operations.inodes[llfuse.ROOT_INODE]
72
73     def tearDown(self):
74         if self.llfuse_thread:
75             if self.operations.events:
76                 self.operations.events.close(timeout=10)
77             subprocess.call(["fusermount", "-u", "-z", self.mounttmp])
78             t0 = time.time()
79             self.llfuse_thread.join(timeout=10)
80             if self.llfuse_thread.is_alive():
81                 logger.warning("MountTestBase.tearDown():"
82                                " llfuse thread still alive 10s after umount"
83                                " -- exiting with SIGKILL")
84                 os.kill(os.getpid(), signal.SIGKILL)
85             waited = time.time() - t0
86             if waited > 0.1:
87                 logger.warning("MountTestBase.tearDown(): waited %f s for llfuse thread to end", waited)
88
89         os.rmdir(self.mounttmp)
90         if self.keeptmp:
91             shutil.rmtree(self.keeptmp)
92             os.environ.pop('KEEP_LOCAL_STORE')
93         run_test_server.reset()
94
95     def assertDirContents(self, subdir, expect_content):
96         path = self.mounttmp
97         if subdir:
98             path = os.path.join(path, subdir)
99         self.assertEqual(sorted(expect_content), sorted(llfuse.listdir(path)))