Add two utility functions to FileUtils

GetRelativePathFromAssetsOrPackagesFolder() - Get the relative path
from a path under "Assets" or "Packages" folder.

CreateFolder() - Create the folder at given path, including its
ancestor folders.

Also adjust GetPackageDirectoryType(), IsUnderPackageDirectory(),
and GetPackageDirectory() to have more consistent results.

Change-Id: Ieb326658ccf57d891a731e2f97ca837eca044095

Author: chkuang-g

source/VersionHandlerImpl/src/FileUtils.cs

@@ -44,13 +44,13 @@ internal class FileUtils {
         /// Regex to match packages folder like "Packages/com.company.pkg"
         /// </summary>
         private static Regex PACKAGES_ASSETDB_PATH_REGEX =
-                new Regex(@"^(Packages[/\\][^/\\]+)([/\\].*)?$");
+                new Regex(@"^(Packages[/\\][^/\\]+)[/\\](.*)?$");
 
         /// <summary>
         /// Regex to match packages folder like "Library/PackageCache/com.company.pkg"
         /// </summary>
         private static Regex PACKAGES_PHYSICAL_PATH_REGEX =
-                new Regex(@"^(Library[/\\]PackageCache[/\\])([^/\\]+)(@[^/\\]+)([/\\].*)?$");
+                new Regex(@"^(Library[/\\]PackageCache[/\\])([^/\\]+)(@[^/\\]+)[/\\](.*)?$");
 
         /// <summary>
         /// Returns the project directory (e.g contains the Assets folder).
@@ -463,6 +463,37 @@ public static string GetPackageDirectory(
             return packageDir;
         }
 
+        /// <summary>
+        /// Get the relative path from a path under "Assets" or "Packages" folder.
+        /// </summary>
+        /// <param name="path">Path to the file/directory.</param>
+        /// <param name="basePath">Return the base path under project folder such as "Assets",
+        /// "Packages/package-id" or "Library/ProjectCache/package-id@version". Empty string
+        /// if the path is under neither of them.</param>
+        /// <param name="relativePath">Return relative path from "Assets", "Packages/package-id"
+        /// or "Library/ProjectCache/package-id@version". Return path if it is under neither of
+        /// them.</param>
+        /// <returns>True if the path is under Assets or Package folder. False otherwise.</returns>
+        public static bool GetRelativePathFromAssetsOrPackagesFolder(
+                string path, out string basePath, out string relativePath){
+            if (IsUnderDirectory(path, ASSETS_FOLDER)) {
+                basePath = ASSETS_FOLDER;
+                relativePath = path.Length >= (basePath.Length + 1) ?
+                        path.Substring(basePath.Length + 1) : "";
+                return true;
+            } else if (IsUnderPackageDirectory(path)) {
+                basePath = GetPackageDirectory(path);
+                relativePath = path.Length >= (basePath.Length + 1) ?
+                        path.Substring(basePath.Length + 1) : "";
+                return true;
+            }
+
+            // No under Assets folder or Packages folder.
+            basePath = "";
+            relativePath = path;
+            return false;
+        }
+
         /// <summary>
         /// Result of RemoveAssets().
         /// </summary>
@@ -581,5 +612,22 @@ public static RemoveAssetsResult RemoveAssets(IEnumerable<string> filenames,
             }
             return result;
         }
-   }
+
+        /// <summary>
+        /// Recursively create all parent folders given a path.
+        /// </summary>
+        /// <param name="path">Path to the file/directory that needs checking.</param>
+        /// <returns>True if all folders are created successfully.</returns>
+        public static bool CreateFolder(string path) {
+            if (AssetDatabase.IsValidFolder(path)) {
+                return true;
+            }
+            DirectoryInfo di = new DirectoryInfo(path);
+            var parentFolder = Path.GetDirectoryName(path);
+            if (!CreateFolder(parentFolder)) {
+                return false;
+            }
+            return !String.IsNullOrEmpty(AssetDatabase.CreateFolder(parentFolder, di.Name));
+        }
+    }
 }

source/VersionHandlerImpl/unit_tests/src/FileUtilsTest.cs

@@ -81,6 +81,8 @@ public void GetPackageDirectoryType() {
             Assert.That(FileUtils.GetPackageDirectoryType("Packages/"),
                         Is.EqualTo(FileUtils.PackageDirectoryType.None));
             Assert.That(FileUtils.GetPackageDirectoryType("Packages/com.company.pkg"),
+                        Is.EqualTo(FileUtils.PackageDirectoryType.None));
+            Assert.That(FileUtils.GetPackageDirectoryType("Packages/com.company.pkg/"),
                         Is.EqualTo(FileUtils.PackageDirectoryType.AssetDatabasePath));
             Assert.That(FileUtils.GetPackageDirectoryType("Packages/com.company.pkg/Foo"),
                         Is.EqualTo(FileUtils.PackageDirectoryType.AssetDatabasePath));
@@ -94,7 +96,7 @@ public void GetPackageDirectoryType() {
                         Is.EqualTo(FileUtils.PackageDirectoryType.None));
             Assert.That(FileUtils.GetPackageDirectoryType(
                         "Library/PackageCache/[email protected]"),
-                        Is.EqualTo(FileUtils.PackageDirectoryType.PhysicalPath));
+                        Is.EqualTo(FileUtils.PackageDirectoryType.None));
             Assert.That(FileUtils.GetPackageDirectoryType(
                         "Library/PackageCache/[email protected]/Foo"),
                         Is.EqualTo(FileUtils.PackageDirectoryType.PhysicalPath));
@@ -117,7 +119,7 @@ public void IsUnderPackageDirectory() {
             Assert.That(FileUtils.IsUnderPackageDirectory("Packages/"),
                         Is.EqualTo(false));
             Assert.That(FileUtils.IsUnderPackageDirectory("Packages/com.company.pkg"),
-                        Is.EqualTo(true));
+                        Is.EqualTo(false));
             Assert.That(FileUtils.IsUnderPackageDirectory("Packages/com.company.pkg/Foo"),
                         Is.EqualTo(true));
             Assert.That(FileUtils.IsUnderPackageDirectory("Packages/com.company.pkg/Foo/Bar"),
@@ -130,7 +132,7 @@ public void IsUnderPackageDirectory() {
                         Is.EqualTo(false));
             Assert.That(FileUtils.IsUnderPackageDirectory(
                         "Library/PackageCache/[email protected]"),
-                        Is.EqualTo(true));
+                        Is.EqualTo(false));
             Assert.That(FileUtils.IsUnderPackageDirectory(
                         "Library/PackageCache/[email protected]/Foo"),
                         Is.EqualTo(true));
@@ -152,12 +154,17 @@ public void GetPackageDirectory() {
             Assert.That(FileUtils.GetPackageDirectory("Packages"), Is.EqualTo(""));
             Assert.That(FileUtils.GetPackageDirectory("Packages/"), Is.EqualTo(""));
             Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg"),
+                        Is.EqualTo(""));
+            Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg/"),
                         Is.EqualTo(expectedAssetDBPath));
             Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg/Foo"),
                         Is.EqualTo(expectedAssetDBPath));
             Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg/Foo/Bar"),
                         Is.EqualTo(expectedAssetDBPath));
             Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg",
+                        FileUtils.PackageDirectoryType.AssetDatabasePath),
+                        Is.EqualTo(""));
+            Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg/",
                         FileUtils.PackageDirectoryType.AssetDatabasePath),
                         Is.EqualTo(expectedAssetDBPath));
             Assert.That(FileUtils.GetPackageDirectory("Packages/com.company.pkg/Foo",
@@ -185,6 +192,9 @@ public void GetPackageDirectory() {
                         Is.EqualTo(""));
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]"),
+                        Is.EqualTo(""));
+            Assert.That(FileUtils.GetPackageDirectory(
+                        "Library/PackageCache/[email protected]/"),
                         Is.EqualTo(expectedActualPath));
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]/Foo"),
@@ -195,6 +205,10 @@ public void GetPackageDirectory() {
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]",
                         FileUtils.PackageDirectoryType.AssetDatabasePath),
+                        Is.EqualTo(""));
+            Assert.That(FileUtils.GetPackageDirectory(
+                        "Library/PackageCache/[email protected]/",
+                        FileUtils.PackageDirectoryType.AssetDatabasePath),
                         Is.EqualTo(expectedAssetDBPath));
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]/Foo",
@@ -207,6 +221,10 @@ public void GetPackageDirectory() {
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]",
                         FileUtils.PackageDirectoryType.PhysicalPath),
+                        Is.EqualTo(""));
+            Assert.That(FileUtils.GetPackageDirectory(
+                        "Library/PackageCache/[email protected]/",
+                        FileUtils.PackageDirectoryType.PhysicalPath),
                         Is.EqualTo(expectedActualPath));
             Assert.That(FileUtils.GetPackageDirectory(
                         "Library/PackageCache/[email protected]/Foo",
@@ -218,5 +236,126 @@ public void GetPackageDirectory() {
                         Is.EqualTo(expectedActualPath));
 
         }
+
+        /// <summary>
+        /// Test FileUtils.GetRelativePathFromAssetsOrPackagesFolder()
+        /// </summary>
+        [Test]
+        public void GetRelativePathFromAssetsOrPackagesFolder() {
+            string basePath;
+            string relativePath;
+            bool result;
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Assets", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("Assets"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Assets/", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Assets"));
+            Assert.That(relativePath, Is.EqualTo(""));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Assets/Foo", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Assets"));
+            Assert.That(relativePath, Is.EqualTo("Foo"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Assets/Foo/", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Assets"));
+            Assert.That(relativePath, Is.EqualTo("Foo/"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Assets/Foo/Bar", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Assets"));
+            Assert.That(relativePath, Is.EqualTo("Foo/Bar"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Packages/com.company.pkg", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("Packages/com.company.pkg"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Packages/com.company.pkg/", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Packages/com.company.pkg"));
+            Assert.That(relativePath, Is.EqualTo(""));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Packages/com.company.pkg/Foo", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Packages/com.company.pkg"));
+            Assert.That(relativePath, Is.EqualTo("Foo"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Packages/com.company.pkg/Foo/", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Packages/com.company.pkg"));
+            Assert.That(relativePath, Is.EqualTo("Foo/"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Packages/com.company.pkg/Foo/Bar", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Packages/com.company.pkg"));
+            Assert.That(relativePath, Is.EqualTo("Foo/Bar"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Library/PackageCache/[email protected]", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("Library/PackageCache/[email protected]"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Library/PackageCache/[email protected]/", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Library/PackageCache/[email protected]"));
+            Assert.That(relativePath, Is.EqualTo(""));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Library/PackageCache/[email protected]/Foo",
+                    out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Library/PackageCache/[email protected]"));
+            Assert.That(relativePath, Is.EqualTo("Foo"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Library/PackageCache/[email protected]/Foo/",
+                    out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Library/PackageCache/[email protected]"));
+            Assert.That(relativePath, Is.EqualTo("Foo/"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Library/PackageCache/[email protected]/Foo/Bar",
+                    out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(true));
+            Assert.That(basePath, Is.EqualTo("Library/PackageCache/[email protected]"));
+            Assert.That(relativePath, Is.EqualTo("Foo/Bar"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "/Foo", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("/Foo"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Foo", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("Foo"));
+
+            result = FileUtils.GetRelativePathFromAssetsOrPackagesFolder(
+                    "Foo/Bar", out basePath, out relativePath);
+            Assert.That(result, Is.EqualTo(false));
+            Assert.That(basePath, Is.EqualTo(""));
+            Assert.That(relativePath, Is.EqualTo("Foo/Bar"));
+        }
     }
 }