removed VirtualFileSytem.getPrefix() and added VirtualFileSytem.getMountPoint() instead

Author: tomasstupka

graalpython/com.oracle.graal.python.test.integration/src/org/graalvm/python/embedding/utils/test/VirtualFileSystemTest.java

@@ -72,8 +72,27 @@ public void defaultValues() throws Exception {
         VirtualFileSystem vfs = VirtualFileSystem.create();
         VirtualFileSystem vfs2 = VirtualFileSystem.newBuilder().build();
 
-        assertEquals(vfs.getPrefix(), vfs2.getPrefix());
-        assertEquals(vfs.getFileListPath(), vfs2.getFileListPath());
+        assertEquals(vfs.getMountPoint(), vfs2.getMountPoint());
+        assertEquals(vfs.vfsHomePath(), vfs2.vfsHomePath());
+        assertEquals(vfs.vfsProjPath(), vfs2.vfsProjPath());
+        assertEquals(vfs.vfsVenvPath(), vfs2.vfsVenvPath());
+
+        assertEquals(IS_WINDOWS ? "X:\\graalpy_vfs" : "/graalpy_vfs", vfs.getMountPoint());
+        assertEquals(IS_WINDOWS ? "X:\\graalpy_vfs\\home" : "/graalpy_vfs/home", vfs.vfsHomePath());
+        assertEquals(IS_WINDOWS ? "X:\\graalpy_vfs\\proj" : "/graalpy_vfs/proj", vfs.vfsProjPath());
+        assertEquals(IS_WINDOWS ? "X:\\graalpy_vfs\\venv" : "/graalpy_vfs/venv", vfs.vfsVenvPath());
+    }
+
+    @Test
+    public void mountPoints() throws Exception {
+        VirtualFileSystem vfs = VirtualFileSystem.newBuilder().//
+                        unixMountPoint(VFS_MOUNT_POINT).//
+                        windowsMountPoint(VFS_WIN_MOUNT_POINT).build();
+
+        assertEquals(VFS_MOUNT_POINT, vfs.getMountPoint());
+        assertEquals(IS_WINDOWS ? VFS_WIN_MOUNT_POINT + "\\home" : VFS_UNIX_MOUNT_POINT + "/home", vfs.vfsHomePath());
+        assertEquals(IS_WINDOWS ? VFS_WIN_MOUNT_POINT + "\\proj" : VFS_UNIX_MOUNT_POINT + "/proj", vfs.vfsProjPath());
+        assertEquals(IS_WINDOWS ? VFS_WIN_MOUNT_POINT + "\\venv" : VFS_UNIX_MOUNT_POINT + "/venv", vfs.vfsVenvPath());
     }
 
     @Test
@@ -393,7 +412,6 @@ public Context getContext(Function<VirtualFileSystem.Builder, VirtualFileSystem.
             return cachedContext;
         }
         VirtualFileSystem.Builder builder = VirtualFileSystem.newBuilder().//
-// vfsPrefix(VFS_PREFIX).//
                         unixMountPoint(VFS_MOUNT_POINT).//
                         windowsMountPoint(VFS_WIN_MOUNT_POINT).//
                         resourceLoadingClass(VirtualFileSystemTest.class);

graalpython/org.graalvm.python.embedding/src/org/graalvm/python/embedding/vfs/VirtualFileSystem.java

@@ -132,7 +132,11 @@ public Builder allowHostIO(HostIO b) {
 
         /**
          * The mount point for the virtual filesystem on Windows. This mount point shadows any real
-         * filesystem, so should be chosen to avoid clashes with the users machine.
+         * filesystem, so should be chosen to avoid clashes with the users machine, e.g. if set to
+         * "X:\graalpy_vfs", then a resource with path /org.graalvm.python.vfs/xyz/abc is visible as
+         * "X:\graalpy_vfs\xyz\abc". This needs to be an absolute path with platform-specific
+         * separators without any trailing separator. If that file or directory actually exists, it
+         * will not be accessible.
          */
         public Builder windowsMountPoint(String s) {
             windowsMountPoint = s;
@@ -141,7 +145,11 @@ public Builder windowsMountPoint(String s) {
 
         /**
          * The mount point for the virtual filesystem on Unices. This mount point shadows any real
-         * filesystem, so should be chosen to avoid clashes with the users machine.
+         * filesystem, so should be chosen to avoid clashes with the users machine, e.g. if set to
+         * "/graalpy_vfs", then a resource with path /org.graalvm.python.vfs/xyz/abc is visible as
+         * "/graalpy_vfs/xyz/abc". This needs to be an absolute path with platform-specific
+         * separators without any trailing separator. If that file or directory actually exists, it
+         * will not be accessible.
          */
         public Builder unixMountPoint(String s) {
             unixMountPoint = s;
@@ -259,7 +267,7 @@ public DirEntry(String platformPath) {
 
     /*
      * Determines where the virtual filesystem lives in the real filesystem, e.g. if set to
-     * "X:\graalpy_vfs", then a resource with path /vfs/xyz/abc is visible as
+     * "X:\graalpy_vfs", then a resource with path /org.graalvm.python.vfs/xyz/abc is visible as
      * "X:\graalpy_vfs\xyz\abc". This needs to be an absolute path with platform-specific separators
      * without any trailing separator. If that file or directory actually exists, it will not be
      * accessible.
@@ -493,12 +501,14 @@ private BaseEntry getEntry(Path inputPath) throws IOException {
         return vfsEntries.get(toCaseComparable(path.toString()));
     }
 
-    public String getPrefix() {
-        return this.vfsPrefix;
-    }
-
-    public String getFileListPath() {
-        return this.filesListPath;
+    /**
+     * The mount point for the virtual filesystem.
+     *
+     * @see Builder#windowsMountPoint(String)
+     * @see Builder#unixMountPoint(String)
+     */
+    public String getMountPoint() {
+        return this.mountPoint.toString();
     }
 
     private boolean pathIsInVfs(Path path) {
@@ -514,8 +524,8 @@ private boolean shouldExtract(Path path) {
 
     /**
      * Extracts a file or directory from the resource to the temporary directory and returns the
-     * path to the extracted file. Inexisting parent directories will also be created (recursively).
-     * If the extracted file or directory already exists, nothing will be done.
+     * path to the extracted file. Nonexistent parent directories will also be created
+     * (recursively). If the extracted file or directory already exists, nothing will be done.
      */
     private Path getExtractedPath(Path path) {
         assert extractDir != null;