services/fuse/tests/test_mount.py

   1 import unittest
   2 import arvados
   3 import arvados_fuse as fuse
   4 import threading
   5 import time
   6 import os
   7 import llfuse
   8 import tempfile
   9 import shutil
  10 import subprocess
  11 import glob
  12 import run_test_server
  13 import json
  14
  15 class MountTestBase(unittest.TestCase):
  16     def setUp(self):
  17         self.keeptmp = tempfile.mkdtemp()
  18         os.environ['KEEP_LOCAL_STORE'] = self.keeptmp
  19         self.mounttmp = tempfile.mkdtemp()
  20         run_test_server.run(False)
  21         run_test_server.authorize_with("admin")
  22         self.api = api = fuse.SafeApi(arvados.config)
  23
  24     def tearDown(self):
  25         run_test_server.stop()
  26
  27         # llfuse.close is buggy, so use fusermount instead.
  28         #llfuse.close(unmount=True)
  29         count = 0
  30         success = 1
  31         while (count < 9 and success != 0):
  32           success = subprocess.call(["fusermount", "-u", self.mounttmp])
  33           time.sleep(0.5)
  34           count += 1
  35
  36         os.rmdir(self.mounttmp)
  37         shutil.rmtree(self.keeptmp)
  38
  39     def assertDirContents(self, subdir, expect_content):
  40         path = self.mounttmp
  41         if subdir:
  42             path = os.path.join(path, subdir)
  43         self.assertEqual(sorted(expect_content), sorted(os.listdir(path)))
  44
  45
  46 class FuseMountTest(MountTestBase):
  47     def setUp(self):
  48         super(FuseMountTest, self).setUp()
  49
  50         cw = arvados.CollectionWriter()
  51
  52         cw.start_new_file('thing1.txt')
  53         cw.write("data 1")
  54         cw.start_new_file('thing2.txt')
  55         cw.write("data 2")
  56         cw.start_new_stream('dir1')
  57
  58         cw.start_new_file('thing3.txt')
  59         cw.write("data 3")
  60         cw.start_new_file('thing4.txt')
  61         cw.write("data 4")
  62
  63         cw.start_new_stream('dir2')
  64         cw.start_new_file('thing5.txt')
  65         cw.write("data 5")
  66         cw.start_new_file('thing6.txt')
  67         cw.write("data 6")
  68
  69         cw.start_new_stream('dir2/dir3')
  70         cw.start_new_file('thing7.txt')
  71         cw.write("data 7")
  72
  73         cw.start_new_file('thing8.txt')
  74         cw.write("data 8")
  75
  76         cw.start_new_stream('edgecases')
  77         for f in ":/./../.../-/*/\x01\\/ ".split("/"):
  78             cw.start_new_file(f)
  79             cw.write('x')
  80
  81         for f in ":/../.../-/*/\x01\\/ ".split("/"):
  82             cw.start_new_stream('edgecases/dirs/' + f)
  83             cw.start_new_file('x/x')
  84             cw.write('x')
  85
  86         self.testcollection = cw.finish()
  87         self.api.collections().create(body={"manifest_text":cw.manifest_text()}).execute()
  88
  89     def runTest(self):
  90         # Create the request handler
  91         operations = fuse.Operations(os.getuid(), os.getgid())
  92         e = operations.inodes.add_entry(fuse.CollectionDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.testcollection))
  93
  94         llfuse.init(operations, self.mounttmp, [])
  95         t = threading.Thread(None, lambda: llfuse.main())
  96         t.start()
  97
  98         # wait until the driver is finished initializing
  99         operations.initlock.wait()
 100
 101         # now check some stuff
 102         self.assertDirContents(None, ['thing1.txt', 'thing2.txt',
 103                                       'edgecases', 'dir1', 'dir2'])
 104         self.assertDirContents('dir1', ['thing3.txt', 'thing4.txt'])
 105         self.assertDirContents('dir2', ['thing5.txt', 'thing6.txt', 'dir3'])
 106         self.assertDirContents('dir2/dir3', ['thing7.txt', 'thing8.txt'])
 107         self.assertDirContents('edgecases',
 108                                "dirs/:/_/__/.../-/*/\x01\\/ ".split("/"))
 109         self.assertDirContents('edgecases/dirs',
 110                                ":/__/.../-/*/\x01\\/ ".split("/"))
 111
 112         files = {'thing1.txt': 'data 1',
 113                  'thing2.txt': 'data 2',
 114                  'dir1/thing3.txt': 'data 3',
 115                  'dir1/thing4.txt': 'data 4',
 116                  'dir2/thing5.txt': 'data 5',
 117                  'dir2/thing6.txt': 'data 6',
 118                  'dir2/dir3/thing7.txt': 'data 7',
 119                  'dir2/dir3/thing8.txt': 'data 8'}
 120
 121         for k, v in files.items():
 122             with open(os.path.join(self.mounttmp, k)) as f:
 123                 self.assertEqual(v, f.read())
 124
 125
 126 class FuseMagicTest(MountTestBase):
 127     def setUp(self):
 128         super(FuseMagicTest, self).setUp()
 129
 130         cw = arvados.CollectionWriter()
 131
 132         cw.start_new_file('thing1.txt')
 133         cw.write("data 1")
 134
 135         self.testcollection = cw.finish()
 136         self.api.collections().create(body={"manifest_text":cw.manifest_text()}).execute()
 137
 138     def runTest(self):
 139         # Create the request handler
 140         operations = fuse.Operations(os.getuid(), os.getgid())
 141         e = operations.inodes.add_entry(fuse.MagicDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0))
 142
 143         self.mounttmp = tempfile.mkdtemp()
 144
 145         llfuse.init(operations, self.mounttmp, [])
 146         t = threading.Thread(None, lambda: llfuse.main())
 147         t.start()
 148
 149         # wait until the driver is finished initializing
 150         operations.initlock.wait()
 151
 152         # now check some stuff
 153         d1 = os.listdir(self.mounttmp)
 154         d1.sort()
 155         self.assertEqual(['README'], d1)
 156
 157         d2 = os.listdir(os.path.join(self.mounttmp, self.testcollection))
 158         d2.sort()
 159         self.assertEqual(['thing1.txt'], d2)
 160
 161         d3 = os.listdir(self.mounttmp)
 162         d3.sort()
 163         self.assertEqual([self.testcollection, 'README'], d3)
 164
 165         files = {}
 166         files[os.path.join(self.mounttmp, self.testcollection, 'thing1.txt')] = 'data 1'
 167
 168         for k, v in files.items():
 169             with open(os.path.join(self.mounttmp, k)) as f:
 170                 self.assertEqual(v, f.read())
 171
 172
 173 class FuseTagsTest(MountTestBase):
 174     def runTest(self):
 175         operations = fuse.Operations(os.getuid(), os.getgid())
 176         e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0))
 177
 178         llfuse.init(operations, self.mounttmp, [])
 179         t = threading.Thread(None, lambda: llfuse.main())
 180         t.start()
 181
 182         # wait until the driver is finished initializing
 183         operations.initlock.wait()
 184
 185         d1 = os.listdir(self.mounttmp)
 186         d1.sort()
 187         self.assertEqual(['foo_tag'], d1)
 188
 189         d2 = os.listdir(os.path.join(self.mounttmp, 'foo_tag'))
 190         d2.sort()
 191         self.assertEqual(['zzzzz-4zz18-fy296fx3hot09f7'], d2)
 192
 193         d3 = os.listdir(os.path.join(self.mounttmp, 'foo_tag', 'zzzzz-4zz18-fy296fx3hot09f7'))
 194         d3.sort()
 195         self.assertEqual(['foo'], d3)
 196
 197
 198 class FuseTagsUpdateTest(MountTestBase):
 199     def tag_collection(self, coll_uuid, tag_name):
 200         return self.api.links().create(
 201             body={'link': {'head_uuid': coll_uuid,
 202                            'link_class': 'tag',
 203                            'name': tag_name,
 204         }}).execute()
 205
 206     def runTest(self):
 207         operations = fuse.Operations(os.getuid(), os.getgid())
 208         e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, poll_time=1))
 209
 210         llfuse.init(operations, self.mounttmp, [])
 211         t = threading.Thread(None, lambda: llfuse.main())
 212         t.start()
 213
 214         # wait until the driver is finished initializing
 215         operations.initlock.wait()
 216         self.assertIn('foo_tag', os.listdir(self.mounttmp))
 217
 218         bar_uuid = run_test_server.fixture('collections')['bar_file']['uuid']
 219         self.tag_collection(bar_uuid, 'fuse_test_tag')
 220         time.sleep(1)
 221         self.assertIn('fuse_test_tag', os.listdir(self.mounttmp))
 222         self.assertDirContents('fuse_test_tag', [bar_uuid])
 223
 224         baz_uuid = run_test_server.fixture('collections')['baz_file']['uuid']
 225         l = self.tag_collection(baz_uuid, 'fuse_test_tag')
 226         time.sleep(1)
 227         self.assertDirContents('fuse_test_tag', [bar_uuid, baz_uuid])
 228
 229         self.api.links().delete(uuid=l['uuid']).execute()
 230         time.sleep(1)
 231         self.assertDirContents('fuse_test_tag', [bar_uuid])
 232
 233
 234 class FuseSharedTest(MountTestBase):
 235     def runTest(self):
 236         operations = fuse.Operations(os.getuid(), os.getgid())
 237         e = operations.inodes.add_entry(fuse.SharedDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.api.users().current().execute()['uuid']))
 238
 239         llfuse.init(operations, self.mounttmp, [])
 240         t = threading.Thread(None, lambda: llfuse.main())
 241         t.start()
 242
 243         # wait until the driver is finished initializing
 244         operations.initlock.wait()
 245
 246         # shared_dirs is a list of the directories exposed
 247         # by fuse.SharedDirectory (i.e. any object visible
 248         # to the current user)
 249         shared_dirs = os.listdir(self.mounttmp)
 250         shared_dirs.sort()
 251         self.assertIn('FUSE User', shared_dirs)
 252
 253         # fuse_user_objs is a list of the objects owned by the FUSE
 254         # test user (which present as files in the 'FUSE User'
 255         # directory)
 256         fuse_user_objs = os.listdir(os.path.join(self.mounttmp, 'FUSE User'))
 257         fuse_user_objs.sort()
 258         self.assertEqual(['Empty collection.link',                # permission link on collection
 259                           'FUSE Test Project',                    # project owned by user
 260                           'collection #1 owned by FUSE',          # collection owned by user
 261                           'collection #2 owned by FUSE',          # collection owned by user
 262                           'pipeline instance owned by FUSE.pipelineInstance',  # pipeline instance owned by user
 263                       ], fuse_user_objs)
 264
 265         # test_proj_files is a list of the files in the FUSE Test Project.
 266         test_proj_files = os.listdir(os.path.join(self.mounttmp, 'FUSE User', 'FUSE Test Project'))
 267         test_proj_files.sort()
 268         self.assertEqual(['collection in FUSE project',
 269                           'pipeline instance in FUSE project.pipelineInstance',
 270                           'pipeline template in FUSE project.pipelineTemplate'
 271                       ], test_proj_files)
 272
 273         # Double check that we can open and read objects in this folder as a file,
 274         # and that its contents are what we expect.
 275         with open(os.path.join(
 276                 self.mounttmp,
 277                 'FUSE User',
 278                 'FUSE Test Project',
 279                 'pipeline template in FUSE project.pipelineTemplate')) as f:
 280             j = json.load(f)
 281             self.assertEqual("pipeline template in FUSE project", j['name'])
 282
 283
 284 class FuseHomeTest(MountTestBase):
 285     def runTest(self):
 286         operations = fuse.Operations(os.getuid(), os.getgid())
 287         e = operations.inodes.add_entry(fuse.ProjectDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.api.users().current().execute()))
 288
 289         llfuse.init(operations, self.mounttmp, [])
 290         t = threading.Thread(None, lambda: llfuse.main())
 291         t.start()
 292
 293         # wait until the driver is finished initializing
 294         operations.initlock.wait()
 295
 296         d1 = os.listdir(self.mounttmp)
 297         d1.sort()
 298         self.assertIn('Unrestricted public data', d1)
 299
 300         d2 = os.listdir(os.path.join(self.mounttmp, 'Unrestricted public data'))
 301         d2.sort()
 302         self.assertEqual(['GNU General Public License, version 3'], d2)
 303
 304         d3 = os.listdir(os.path.join(self.mounttmp, 'Unrestricted public data', 'GNU General Public License, version 3'))
 305         d3.sort()
 306         self.assertEqual(["GNU_General_Public_License,_version_3.pdf"], d3)
 307
 308
 309 class FuseUnitTest(unittest.TestCase):
 310     def test_sanitize_filename(self):
 311         acceptable = [
 312             "foo.txt",
 313             ".foo",
 314             "..foo",
 315             "...",
 316             "foo...",
 317             "foo..",
 318             "foo.",
 319             "-",
 320             "\x01\x02\x03",
 321             ]
 322         unacceptable = [
 323             "f\00",
 324             "\00\00",
 325             "/foo",
 326             "foo/",
 327             "//",
 328             ]
 329         for f in acceptable:
 330             self.assertEqual(f, fuse.sanitize_filename(f))
 331         for f in unacceptable:
 332             self.assertNotEqual(f, fuse.sanitize_filename(f))
 333             # The sanitized filename should be the same length, though.
 334             self.assertEqual(len(f), len(fuse.sanitize_filename(f)))
 335         # Special cases
 336         self.assertEqual("_", fuse.sanitize_filename(""))
 337         self.assertEqual("_", fuse.sanitize_filename("."))
 338         self.assertEqual("__", fuse.sanitize_filename(".."))