UT-511: fix a bug and some tests

The auto-updater is now robust to FbxPrefab not being found, or having
duplicates, for whatever reason. In particular on 2018.1 we find it in a fixed
location because the asset database can't find anything in the packages.

Added a ChangeLog as is required; also now we use the ChangeLog to determine the version.

Author: Benoit Hudson

Assets/com.unity.formats.fbx.tests/FbxPrefabAutoUpdaterTest.cs

@@ -54,6 +54,15 @@ public void BasicTest ()
             var imported = new HashSet<string> (new string [] { "Assets/path/to/foo.fbx", m_fbxPath });
             Assert.IsTrue (FbxPrefabAutoUpdater.MayHaveFbxPrefabToFbxAsset (m_prefabPath, fbxPrefabPath,
                         imported));
+
+            // Create an empty (and duplicate) FbxPrefab.cs to confuse the auto-updater. Make sure it's properly confused.
+            // This test only works in 2018.2 or later; 2018.1 hard-codes the path.
+#if UNITY_2018_2_OR_LATER
+            System.IO.File.WriteAllText(this.filePath + '/' + FbxPrefabAutoUpdater.FBX_PREFAB_FILE, "class CeciNestPasUnFbxPrefab : UnityEngine.MonoBehaviour {}\n");
+            AssetDatabase.Refresh(); // force refresh
+            // TODO: assert that we're getting a log warning, but this still works
+            Assert.IsTrue (FbxPrefabAutoUpdater.MayHaveFbxPrefabToFbxAsset (m_prefabPath, fbxPrefabPath, imported));
+#endif
         }
 
         [Test]

Packages/com.unity.formats.fbx/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changes in Fbx Exporter
+
+## [0.0.2-preview] - 2018-05-02
+
+- Initial version for Package Manager

Packages/com.unity.formats.fbx/CHANGELOG.md.meta

@@ -77,9 +77,9 @@ public class ModelExporter : System.IDisposable
                 @"";
 
             /// <summary>
-            /// Path to the README file in Unity's virtual file system.
+            /// Path to the CHANGELOG file in Unity's virtual file system. Used to get the version number.
             /// </summary>
-            const string ReadmeRelativePath = "Assets/com.unity.formats.fbx/README.txt";
+            const string ChangeLogPath = "Packages/com.unity.formats.fbx/CHANGELOG.md";
 
             // NOTE: The ellipsis at the end of the Menu Item name prevents the context
             //       from being passed to command, thus resulting in OnContextItem()
@@ -240,32 +240,34 @@ public static Material DefaultMaterial {
             /// </summary>
             public static string GetVersionFromReadme()
             {
-                if (string.IsNullOrEmpty (ReadmeRelativePath)) {
-                    Debug.LogWarning ("Missing relative path to README");
-                    return null;
-                }
-                if (!File.Exists (ReadmeRelativePath)) {
-                    Debug.LogWarning (string.Format("Could not find README.txt at: {0}", ReadmeRelativePath));
+                if (!File.Exists (ChangeLogPath)) {
+                    Debug.LogWarning (string.Format("Could not find version number, the ChangeLog file is missing from: {0}", ChangeLogPath));
                     return null;
                 }
 
-                try{
-                    var versionHeader = "VERSION:";
-                    var lines = File.ReadAllLines (ReadmeRelativePath);
+                try {
+                    // The format is:
+                    // ## [a.b.c-whatever] - yyyy-mm-dd
+                    // we extract the first bit.
+                    var lines = File.ReadAllLines (ChangeLogPath);
                     foreach (var line in lines) {
-                        if (line.StartsWith(versionHeader)) {
-                            var version = line.Replace (versionHeader, "");
+                        var match = System.Text.RegularExpressions.Regex.Match(line, @"^\s*##\s*\[(.*)\]");
+                        if (match.Success) {
+                            var version = match.Groups[1].Value;
                             return version.Trim ();
                         }
                     }
+
+                    // If we're here, we didn't find any match.
+                    Debug.LogWarning (string.Format("Could not find most recent version number in {0}", ChangeLogPath));
+                    return null;
                 }
                 catch(IOException e){
                     Debug.LogException (e);
-                    Debug.LogWarning (string.Format("Error will reading file {0} ({1})", ReadmeRelativePath, e));
+                    Debug.LogWarning (string.Format("Error reading file {0} ({1})", ChangeLogPath, e));
                     return null;
                 }
-                Debug.LogWarning (string.Format("Could not find version number in README.txt at: {0}", ReadmeRelativePath));
-                return null;
+
             }
 
             /// <summary>

Packages/com.unity.formats.fbx/Editor/Scripts/FbxExporter.cs

@@ -24,10 +24,12 @@ namespace FbxExporters
     /// </summary>
     public /*static*/ class FbxPrefabAutoUpdater : UnityEditor.AssetPostprocessor
     {
-        #if UNITY_EDITOR
-        public const string FBX_PREFAB_FILE = "/FbxPrefab.cs";
-        #else
+        #if COM_UNITY_FORMATS_FBX_AS_ASSET
         public const string FBX_PREFAB_FILE = "/UnityFbxPrefab.dll";
+        #elif UNITY_2018_2_OR_LATER
+        public const string FBX_PREFAB_FILE = "/FbxPrefab.cs";
+        #else // Unity 2018.1 and fbx installed as a package
+        public const string FBX_PREFAB_FILE = "Packages/com.unity.formats.fbx/Runtime/FbxPrefab.cs";
         #endif
 
         const string MenuItemName = "GameObject/Update from FBX";
@@ -37,17 +39,36 @@ namespace FbxExporters
 
         public static string FindFbxPrefabAssetPath()
         {
+        #if COM_UNITY_FORMATS_FBX_AS_ASSET || UNITY_2018_2_OR_LATER
             // Find guids that are scripts that look like FbxPrefab.
             // That catches FbxPrefabTest too, so we have to make sure.
             var allGuids = AssetDatabase.FindAssets("FbxPrefab t:MonoScript");
+            string foundPath = "";
             foreach (var guid in allGuids) {
                 var path = AssetDatabase.GUIDToAssetPath(guid);
                 if (path.EndsWith(FBX_PREFAB_FILE)) {
-                    return path;
+                    if (!string.IsNullOrEmpty(foundPath)) {
+                        // How did this happen? Anyway, just don't try.
+                        Debug.LogWarning(string.Format("{0} found in multiple places; did you forget to delete one of these?\n{1}\n{2}",
+                                FBX_PREFAB_FILE.Substring(1), foundPath, path));
+                        return "";
+                    }
+                    foundPath = path;
                 }
             }
-            Debug.LogError(string.Format("{0} not found; are you trying to uninstall {1}?", FBX_PREFAB_FILE.Substring(1), FbxExporters.Editor.ModelExporter.PACKAGE_UI_NAME));
+            Debug.LogWarning(string.Format("{0} not found; are you trying to uninstall {1}?", FBX_PREFAB_FILE.Substring(1), FbxExporters.Editor.ModelExporter.PACKAGE_UI_NAME));
             return "";
+        #else
+            // In Unity 2018.1, FindAssets can't find FbxPrefab.cs in a package.
+            // So we hardcode the path.
+            var path = FBX_PREFAB_FILE;
+            if (System.IO.File.Exists(System.IO.Path.GetFullPath(path))) {
+                return path;
+            } else {
+                Debug.LogWarning(string.Format("{0} not found; are you trying to uninstall {1}?", FBX_PREFAB_FILE, FbxExporters.Editor.ModelExporter.PACKAGE_UI_NAME));
+                return "";
+            }
+        #endif
         }
 
         public static bool IsFbxAsset(string assetPath) {
@@ -68,19 +89,22 @@ public static bool IsPrefabAsset(string assetPath) {
         public static bool MayHaveFbxPrefabToFbxAsset(string prefabPath,
                 string fbxPrefabScriptPath, HashSet<string> fbxImported) {
             var depPaths = AssetDatabase.GetDependencies(prefabPath, recursive: false);
-            bool dependsOnFbxPrefab = false;
-            bool dependsOnImportedFbx = false;
+
+            // If we can find the path to the FbxPrefab, check that the prefab depends on it.
+            // If we can't find FbxPrefab.cs then just ignore that dependence requirement.
+            if (!string.IsNullOrEmpty(fbxPrefabScriptPath)) {
+                if (!depPaths.Contains(fbxPrefabScriptPath)) {
+                    return false;
+                }
+            }
+
+            // We found (or don't care about) the FbxPrefab, now check if we
+            // depend on any of the imported fbx files.
             foreach (var dep in depPaths) {
-                if (dep == fbxPrefabScriptPath) {
-                    if (dependsOnImportedFbx) { return true; }
-                    dependsOnFbxPrefab = true;
-                } else if (fbxImported.Contains(dep)) {
-                    if (dependsOnFbxPrefab) { return true; }
-                    dependsOnImportedFbx = true;
+                if (fbxImported.Contains(dep)) {
+                    return true;
                 }
             }
-            // Either none or only one of the conditions was true, which
-            // means this prefab certainly doesn't match.
             return false;
         }