4363: Merge branch 'master' into 4363-less-filename-munging
[arvados.git] / services / fuse / tests / test_mount.py
index d6c1ee7d7b8a0d8ad1f9883b83c205fc4d77143f..29b237d148ba153e907f48ddfcf5fa744675a123 100644 (file)
@@ -17,8 +17,13 @@ class MountTestBase(unittest.TestCase):
         self.keeptmp = tempfile.mkdtemp()
         os.environ['KEEP_LOCAL_STORE'] = self.keeptmp
         self.mounttmp = tempfile.mkdtemp()
+        run_test_server.run(False)
+        run_test_server.authorize_with("admin")
+        self.api = api = fuse.SafeApi(arvados.config)
 
     def tearDown(self):
+        run_test_server.stop()
+
         # llfuse.close is buggy, so use fusermount instead.
         #llfuse.close(unmount=True)
         count = 0
@@ -62,12 +67,39 @@ class FuseMountTest(MountTestBase):
         cw.start_new_file('thing8.txt')
         cw.write("data 8")
 
+        cw.start_new_stream('edgecases')
+        for f in ":/./../.../-/*/\x01\\/ ".split("/"):
+            cw.start_new_file(f)
+            cw.write('x')
+
+        for f in ":/../.../-/*/\x01\\/ ".split("/"):
+            cw.start_new_stream('edgecases/dirs/' + f)
+            cw.start_new_file('x/x')
+            cw.write('x')
+
+        self._utf8 = ["\xe2\x9c\x8c",     # victory sign
+                      "\xe2\x9b\xb5",     # sailboat
+                      # "\xf0\x9f\x98\xb1", # scream. doesn't work!!
+                      ]
+        cw.start_new_stream('edgecases/utf8')
+        for f in self._utf8:
+            cw.start_new_file(f)
+            cw.write(f)
+
         self.testcollection = cw.finish()
+        self.api.collections().create(body={"manifest_text":cw.manifest_text()}).execute()
+
+    def assertDirContents(self, subdir, expect_content):
+        path = self.mounttmp
+        if subdir:
+            path = os.path.join(path, subdir)
+        self.assertEqual(sorted([fn.decode('utf-8') for fn in expect_content]),
+                         sorted([fn.decode('utf-8') for fn in os.listdir(path)]))
 
     def runTest(self):
         # Create the request handler
         operations = fuse.Operations(os.getuid(), os.getgid())
-        e = operations.inodes.add_entry(fuse.CollectionDirectory(llfuse.ROOT_INODE, operations.inodes, self.testcollection))
+        e = operations.inodes.add_entry(fuse.CollectionDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.testcollection))
 
         llfuse.init(operations, self.mounttmp, [])
         t = threading.Thread(None, lambda: llfuse.main())
@@ -77,21 +109,16 @@ class FuseMountTest(MountTestBase):
         operations.initlock.wait()
 
         # now check some stuff
-        d1 = os.listdir(self.mounttmp)
-        d1.sort()
-        self.assertEqual(['dir1', 'dir2', 'thing1.txt', 'thing2.txt'], d1)
-
-        d2 = os.listdir(os.path.join(self.mounttmp, 'dir1'))
-        d2.sort()
-        self.assertEqual(['thing3.txt', 'thing4.txt'], d2)
-
-        d3 = os.listdir(os.path.join(self.mounttmp, 'dir2'))
-        d3.sort()
-        self.assertEqual(['dir3', 'thing5.txt', 'thing6.txt'], d3)
-
-        d4 = os.listdir(os.path.join(self.mounttmp, 'dir2/dir3'))
-        d4.sort()
-        self.assertEqual(['thing7.txt', 'thing8.txt'], d4)
+        self.assertDirContents(None, ['thing1.txt', 'thing2.txt',
+                                      'edgecases', 'dir1', 'dir2'])
+        self.assertDirContents('dir1', ['thing3.txt', 'thing4.txt'])
+        self.assertDirContents('dir2', ['thing5.txt', 'thing6.txt', 'dir3'])
+        self.assertDirContents('dir2/dir3', ['thing7.txt', 'thing8.txt'])
+        self.assertDirContents('edgecases',
+                               "dirs/utf8/:/_/__/.../-/*/\x01\\/ ".split("/"))
+        self.assertDirContents('edgecases/dirs',
+                               ":/__/.../-/*/\x01\\/ ".split("/"))
+        self.assertDirContents('edgecases/utf8', self._utf8)
 
         files = {'thing1.txt': 'data 1',
                  'thing2.txt': 'data 2',
@@ -117,11 +144,12 @@ class FuseMagicTest(MountTestBase):
         cw.write("data 1")
 
         self.testcollection = cw.finish()
+        self.api.collections().create(body={"manifest_text":cw.manifest_text()}).execute()
 
     def runTest(self):
         # Create the request handler
         operations = fuse.Operations(os.getuid(), os.getgid())
-        e = operations.inodes.add_entry(fuse.MagicDirectory(llfuse.ROOT_INODE, operations.inodes))
+        e = operations.inodes.add_entry(fuse.MagicDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0))
 
         self.mounttmp = tempfile.mkdtemp()
 
@@ -135,7 +163,7 @@ class FuseMagicTest(MountTestBase):
         # now check some stuff
         d1 = os.listdir(self.mounttmp)
         d1.sort()
-        self.assertEqual([], d1)
+        self.assertEqual(['README'], d1)
 
         d2 = os.listdir(os.path.join(self.mounttmp, self.testcollection))
         d2.sort()
@@ -143,7 +171,7 @@ class FuseMagicTest(MountTestBase):
 
         d3 = os.listdir(self.mounttmp)
         d3.sort()
-        self.assertEqual([self.testcollection], d3)
+        self.assertEqual([self.testcollection, 'README'], d3)
 
         files = {}
         files[os.path.join(self.mounttmp, self.testcollection, 'thing1.txt')] = 'data 1'
@@ -152,189 +180,187 @@ class FuseMagicTest(MountTestBase):
             with open(os.path.join(self.mounttmp, k)) as f:
                 self.assertEqual(v, f.read())
 
-#
-# Restore these tests when working on issue #3644
-#
-# class FuseTagsTest(MountTestBase):
-#     def setUp(self):
-#         super(FuseTagsTest, self).setUp()
-
-#         cw = arvados.CollectionWriter()
-
-#         cw.start_new_file('foo')
-#         cw.write("foo")
-
-#         self.testcollection = cw.finish()
-
-#         run_test_server.run()
-
-#     def runTest(self):
-#         run_test_server.authorize_with("admin")
-#         api = arvados.api('v1', cache=False)
-
-#         operations = fuse.Operations(os.getuid(), os.getgid())
-#         e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, api))
-
-#         llfuse.init(operations, self.mounttmp, [])
-#         t = threading.Thread(None, lambda: llfuse.main())
-#         t.start()
 
-#         # wait until the driver is finished initializing
-#         operations.initlock.wait()
-
-#         d1 = os.listdir(self.mounttmp)
-#         d1.sort()
-#         self.assertEqual(['foo_tag'], d1)
-
-#         d2 = os.listdir(os.path.join(self.mounttmp, 'foo_tag'))
-#         d2.sort()
-#         self.assertEqual(['1f4b0bc7583c2a7f9102c395f4ffc5e3+45'], d2)
-
-#         d3 = os.listdir(os.path.join(self.mounttmp, 'foo_tag', '1f4b0bc7583c2a7f9102c395f4ffc5e3+45'))
-#         d3.sort()
-#         self.assertEqual(['foo'], d3)
-
-#         files = {}
-#         files[os.path.join(self.mounttmp, 'foo_tag', '1f4b0bc7583c2a7f9102c395f4ffc5e3+45', 'foo')] = 'foo'
-
-#         for k, v in files.items():
-#             with open(os.path.join(self.mounttmp, k)) as f:
-#                 self.assertEqual(v, f.read())
-
-
-#     def tearDown(self):
-#         run_test_server.stop()
-
-#         super(FuseTagsTest, self).tearDown()
-
-# class FuseTagsUpdateTestBase(MountTestBase):
-
-#     def runRealTest(self):
-#         run_test_server.authorize_with("admin")
-#         api = arvados.api('v1', cache=False)
-
-#         operations = fuse.Operations(os.getuid(), os.getgid())
-#         e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, api, poll_time=1))
-
-#         llfuse.init(operations, self.mounttmp, [])
-#         t = threading.Thread(None, lambda: llfuse.main())
-#         t.start()
-
-#         # wait until the driver is finished initializing
-#         operations.initlock.wait()
+class FuseTagsTest(MountTestBase):
+    def runTest(self):
+        operations = fuse.Operations(os.getuid(), os.getgid())
+        e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0))
 
-#         d1 = os.listdir(self.mounttmp)
-#         d1.sort()
-#         self.assertEqual(['foo_tag'], d1)
+        llfuse.init(operations, self.mounttmp, [])
+        t = threading.Thread(None, lambda: llfuse.main())
+        t.start()
 
-#         api.links().create(body={'link': {
-#             'head_uuid': 'fa7aeb5140e2848d39b416daeef4ffc5+45',
-#             'link_class': 'tag',
-#             'name': 'bar_tag'
-#         }}).execute()
+        # wait until the driver is finished initializing
+        operations.initlock.wait()
 
-#         time.sleep(1)
+        d1 = os.listdir(self.mounttmp)
+        d1.sort()
+        self.assertEqual(['foo_tag'], d1)
 
-#         d2 = os.listdir(self.mounttmp)
-        d2.sort()
-#         self.assertEqual(['bar_tag', 'foo_tag'], d2)
+        d2 = os.listdir(os.path.join(self.mounttmp, 'foo_tag'))
+        d2.sort()
+        self.assertEqual(['zzzzz-4zz18-fy296fx3hot09f7'], d2)
 
-#         d3 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
-        d3.sort()
-#         self.assertEqual(['fa7aeb5140e2848d39b416daeef4ffc5+45'], d3)
+        d3 = os.listdir(os.path.join(self.mounttmp, 'foo_tag', 'zzzzz-4zz18-fy296fx3hot09f7'))
+        d3.sort()
+        self.assertEqual(['foo'], d3)
 
-#         l = api.links().create(body={'link': {
-#             'head_uuid': 'ea10d51bcf88862dbcc36eb292017dfd+45',
-#             'link_class': 'tag',
-#             'name': 'bar_tag'
-#         }}).execute()
 
-#         time.sleep(1)
+class FuseTagsUpdateTest(MountTestBase):
+    def runRealTest(self):
+        operations = fuse.Operations(os.getuid(), os.getgid())
+        e = operations.inodes.add_entry(fuse.TagsDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, poll_time=1))
 
-#         d4 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
-#         d4.sort()
-#         self.assertEqual(['ea10d51bcf88862dbcc36eb292017dfd+45', 'fa7aeb5140e2848d39b416daeef4ffc5+45'], d4)
+        llfuse.init(operations, self.mounttmp, [])
+        t = threading.Thread(None, lambda: llfuse.main())
+        t.start()
 
-#         api.links().delete(uuid=l['uuid']).execute()
+        # wait until the driver is finished initializing
+        operations.initlock.wait()
 
-#         time.sleep(1)
+        d1 = os.listdir(self.mounttmp)
+        d1.sort()
+        self.assertEqual(['foo_tag'], d1)
 
-#         d5 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
-#         d5.sort()
-#         self.assertEqual(['fa7aeb5140e2848d39b416daeef4ffc5+45'], d5)
+        self.api.links().create(body={'link': {
+            'head_uuid': 'fa7aeb5140e2848d39b416daeef4ffc5+45',
+            'link_class': 'tag',
+            'name': 'bar_tag'
+        }}).execute()
 
+        time.sleep(1)
 
-# class FuseTagsUpdateTestWebsockets(FuseTagsUpdateTestBase):
-#     def setUp(self):
-#         super(FuseTagsUpdateTestWebsockets, self).setUp()
-#         run_test_server.run(True)
+        d2 = os.listdir(self.mounttmp)
+        d2.sort()
+        self.assertEqual(['bar_tag', 'foo_tag'], d2)
 
-#     def runTest(self):
-#         self.runRealTest()
+        d3 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
+        d3.sort()
+        self.assertEqual(['fa7aeb5140e2848d39b416daeef4ffc5+45'], d3)
 
-#     def tearDown(self):
-#         run_test_server.stop()
-#         super(FuseTagsUpdateTestWebsockets, self).tearDown()
+        l = self.api.links().create(body={'link': {
+            'head_uuid': 'ea10d51bcf88862dbcc36eb292017dfd+45',
+            'link_class': 'tag',
+            'name': 'bar_tag'
+        }}).execute()
 
+        time.sleep(1)
 
-# class FuseTagsUpdateTestPoll(FuseTagsUpdateTestBase):
-#     def setUp(self):
-#         super(FuseTagsUpdateTestPoll, self).setUp()
-#         run_test_server.run(False)
+        d4 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
+        d4.sort()
+        self.assertEqual(['ea10d51bcf88862dbcc36eb292017dfd+45', 'fa7aeb5140e2848d39b416daeef4ffc5+45'], d4)
 
-#     def runTest(self):
-#         self.runRealTest()
+        self.api.links().delete(uuid=l['uuid']).execute()
 
-#     def tearDown(self):
-#         run_test_server.stop()
-#         super(FuseTagsUpdateTestPoll, self).tearDown()
+        time.sleep(1)
 
+        d5 = os.listdir(os.path.join(self.mounttmp, 'bar_tag'))
+        d5.sort()
+        self.assertEqual(['fa7aeb5140e2848d39b416daeef4ffc5+45'], d5)
 
-# class FuseGroupsTest(MountTestBase):
-#     def setUp(self):
-#         super(FuseGroupsTest, self).setUp()
-#         run_test_server.run()
 
-#     def runTest(self):
-#         run_test_server.authorize_with("admin")
-#         api = arvados.api('v1', cache=False)
+class FuseSharedTest(MountTestBase):
+    def runTest(self):
+        operations = fuse.Operations(os.getuid(), os.getgid())
+        e = operations.inodes.add_entry(fuse.SharedDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.api.users().current().execute()['uuid']))
 
-#         operations = fuse.Operations(os.getuid(), os.getgid())
-#         e = operations.inodes.add_entry(fuse.GroupsDirectory(llfuse.ROOT_INODE, operations.inodes, api))
+        llfuse.init(operations, self.mounttmp, [])
+        t = threading.Thread(None, lambda: llfuse.main())
+        t.start()
 
-#         llfuse.init(operations, self.mounttmp, [])
-#         t = threading.Thread(None, lambda: llfuse.main())
-#         t.start()
+        # wait until the driver is finished initializing
+        operations.initlock.wait()
 
-#         # wait until the driver is finished initializing
-#         operations.initlock.wait()
+        # shared_dirs is a list of the directories exposed
+        # by fuse.SharedDirectory (i.e. any object visible
+        # to the current user)
+        shared_dirs = os.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 = os.listdir(os.path.join(self.mounttmp, 'FUSE User'))
+        fuse_user_objs.sort()
+        self.assertEqual(['Empty collection.link',                # permission link on collection
+                          '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 = os.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.
+        with open(os.path.join(
+                self.mounttmp,
+                'FUSE User',
+                'FUSE Test Project',
+                'pipeline template in FUSE project.pipelineTemplate')) as f:
+            j = json.load(f)
+            self.assertEqual("pipeline template in FUSE project", j['name'])
+
+
+class FuseHomeTest(MountTestBase):
+    def runTest(self):
+        operations = fuse.Operations(os.getuid(), os.getgid())
+        e = operations.inodes.add_entry(fuse.ProjectDirectory(llfuse.ROOT_INODE, operations.inodes, self.api, 0, self.api.users().current().execute()))
 
-#         d1 = os.listdir(self.mounttmp)
-#         d1.sort()
-#         self.assertIn('zzzzz-j7d0g-v955i6s2oi1cbso', d1)
+        llfuse.init(operations, self.mounttmp, [])
+        t = threading.Thread(None, lambda: llfuse.main())
+        t.start()
 
-#         d2 = os.listdir(os.path.join(self.mounttmp, 'zzzzz-j7d0g-v955i6s2oi1cbso'))
-#         d2.sort()
-#         self.assertEqual(['1f4b0bc7583c2a7f9102c395f4ffc5e3+45 added sometime',
-#                           "I'm a job in a project",
-#                           "I'm a template in a project",
-#                           "zzzzz-j58dm-5gid26432uujf79",
-#                           "zzzzz-j58dm-7r18rnd5nzhg5yk",
-#                           "zzzzz-j58dm-ypsjlol9dofwijz",
-#                           "zzzzz-j7d0g-axqo7eu9pwvna1x"
-#                       ], d2)
+        # wait until the driver is finished initializing
+        operations.initlock.wait()
 
-#         d3 = os.listdir(os.path.join(self.mounttmp, 'zzzzz-j7d0g-v955i6s2oi1cbso', 'zzzzz-j7d0g-axqo7eu9pwvna1x'))
-#         d3.sort()
-#         self.assertEqual(["I'm in a subproject, too",
-#                           "ea10d51bcf88862dbcc36eb292017dfd+45 added sometime",
-#                           "zzzzz-j58dm-c40lddwcqqr1ffs"
-#                       ], d3)
+        d1 = os.listdir(self.mounttmp)
+        d1.sort()
+        self.assertIn('Unrestricted public data', d1)
 
-#         with open(os.path.join(self.mounttmp, 'zzzzz-j7d0g-v955i6s2oi1cbso', "I'm a template in a project")) as f:
-#             j = json.load(f)
-#             self.assertEqual("Two Part Pipeline Template", j['name'])
+        d2 = os.listdir(os.path.join(self.mounttmp, 'Unrestricted public data'))
+        d2.sort()
+        self.assertEqual(['GNU General Public License, version 3'], d2)
 
-#     def tearDown(self):
-#         run_test_server.stop()
-#         super(FuseGroupsTest, self).tearDown()
+        d3 = os.listdir(os.path.join(self.mounttmp, 'Unrestricted public data', 'GNU General Public License, version 3'))
+        d3.sort()
+        self.assertEqual(["GNU_General_Public_License,_version_3.pdf"], d3)
+
+
+class FuseUnitTest(unittest.TestCase):
+    def test_sanitize_filename(self):
+        acceptable = [
+            "foo.txt",
+            ".foo",
+            "..foo",
+            "...",
+            "foo...",
+            "foo..",
+            "foo.",
+            "-",
+            "\x01\x02\x03",
+            ]
+        unacceptable = [
+            "f\00",
+            "\00\00",
+            "/foo",
+            "foo/",
+            "//",
+            ]
+        for f in acceptable:
+            self.assertEqual(f, fuse.sanitize_filename(f))
+        for f in unacceptable:
+            self.assertNotEqual(f, fuse.sanitize_filename(f))
+            # The sanitized filename should be the same length, though.
+            self.assertEqual(len(f), len(fuse.sanitize_filename(f)))
+        # Special cases
+        self.assertEqual("_", fuse.sanitize_filename(""))
+        self.assertEqual("_", fuse.sanitize_filename("."))
+        self.assertEqual("__", fuse.sanitize_filename(".."))