Added RedirectedProcess.RunInAsync. Exposed GetPackagePath. (#662)

Author: dgavedissian

spatialos.json

@@ -1,8 +1,8 @@
 {
     "name": "unity_gdk",
     "project_version": "0.0.1",
-    "sdk_version": "13.5.0",
+    "sdk_version": "13.5.1-b8033-b6bcd-WORKER-SNAPSHOT",
     "dependencies": [
-        {"name": "standard_library", "version": "13.5.0"}
+        {"name": "standard_library", "version": "13.5.1-b8033-b6bcd-WORKER-SNAPSHOT"}
     ]
-}
+}

workers/unity/Packages/com.improbable.gdk.core/package.json

@@ -8,6 +8,6 @@
     "dependencies": {
         "com.improbable.gdk.tools": "0.1.3",
         "com.unity.entities": "0.0.12-preview.18",
-        "com.unity.incrementalcompiler": "0.0.42-preview.21"
+        "com.unity.incrementalcompiler": "0.0.42-preview.28"
     }
 }

workers/unity/Packages/com.improbable.gdk.tools/Common.cs

@@ -4,6 +4,7 @@
 using System.Linq;
 using System.Text;
 using Improbable.Gdk.Tools.MiniJSON;
+using UnityEditor;
 using UnityEngine;
 
 namespace Improbable.Gdk.Tools
@@ -36,7 +37,6 @@ public static class Common
 
         private static readonly string[] MacPaths = { UsrLocalBinDir, UsrLocalShareDir };
 
-
         static Common()
         {
             try
@@ -50,22 +50,26 @@ static Common()
             }
         }
 
+        internal static string GetThisPackagePath()
+        {
+            return GetPackagePath("com.improbable.gdk.tools");
+        }
+
         /// <summary>
         ///     Finds the "file:" reference path from the package manifest.
         /// </summary>
-        internal static string GetThisPackagePath()
+        public static string GetPackagePath(string packageName)
         {
-            const string gdkTools = "com.improbable.gdk.tools";
             var manifest = ParseDependencies(ManifestPath);
 
-            if (!manifest.TryGetValue(gdkTools, out var path))
+            if (!manifest.TryGetValue(packageName, out var path))
             {
-                throw new Exception($"The project manifest must reference '{gdkTools}'.");
+                throw new Exception($"The project manifest must reference '{packageName}'.");
             }
 
             if (!path.StartsWith("file:"))
             {
-                throw new Exception($"The '{gdkTools}' package must exist on disk.");
+                throw new Exception($"The '{packageName}' package must exist on disk.");
             }
 
             path = path.Replace("file:", string.Empty);
@@ -150,5 +154,49 @@ private static string DiscoverLocation(string binarybaseName)
             Debug.LogError($"Could not discover location for {binarybaseName}");
             return string.Empty;
         }
+
+        /// <summary>
+        /// Checks whether `dotnet` and `spatial` exist on the PATH.
+        /// </summary>
+        /// <returns></returns>
+        public static bool CheckDependencies()
+        {
+            var hasDotnet = !string.IsNullOrEmpty(Common.DotNetBinary);
+            var hasSpatial = !string.IsNullOrEmpty(Common.SpatialBinary);
+
+            if (hasDotnet && hasSpatial)
+            {
+                return true;
+            }
+
+            var builder = new StringBuilder();
+
+            builder.AppendLine(
+                "The SpatialOS GDK for Unity requires 'dotnet' and 'spatial' on your PATH to run its tooling.");
+            builder.AppendLine();
+
+            if (!hasDotnet)
+            {
+                builder.AppendLine("Could not find 'dotnet' on your PATH.");
+            }
+
+            if (!hasSpatial)
+            {
+                builder.AppendLine("Could not find 'spatial' on your PATH.");
+            }
+
+            builder.AppendLine();
+            builder.AppendLine("If these exist on your PATH, restart Unity and Unity Hub.");
+            builder.AppendLine();
+            builder.AppendLine("Otherwise, install them by following our setup guide:");
+            builder.AppendLine("https://docs.improbable.io/unity/alpha/content/get-started/set-up");
+
+            EditorApplication.delayCall += () =>
+            {
+                EditorUtility.DisplayDialog("GDK dependencies check failed", builder.ToString(), "OK");
+            };
+
+            return false;
+        }
     }
 }

workers/unity/Packages/com.improbable.gdk.tools/DownloadCoreSdk.cs

@@ -116,7 +116,7 @@ internal static DownloadResult TryDownload()
         /// </summary>
         private static DownloadResult Download()
         {
-            if (!CheckDependencies())
+            if (!Common.CheckDependencies())
             {
                 return DownloadResult.Error;
             }
@@ -149,46 +149,6 @@ private static DownloadResult Download()
             return exitCode == 0 ? DownloadResult.Success : DownloadResult.Error;
         }
 
-        private static bool CheckDependencies()
-        {
-            var hasDotnet = !string.IsNullOrEmpty(Common.DotNetBinary);
-            var hasSpatial = !string.IsNullOrEmpty(Common.SpatialBinary);
-
-            if (hasDotnet && hasSpatial)
-            {
-                return true;
-            }
-
-            var builder = new StringBuilder();
-
-            builder.AppendLine(
-                "The SpatialOS GDK for Unity requires 'dotnet' and 'spatial' on your PATH to run its tooling.");
-            builder.AppendLine();
-
-            if (!hasDotnet)
-            {
-                builder.AppendLine("Could not find 'dotnet' on your PATH.");
-            }
-
-            if (!hasSpatial)
-            {
-                builder.AppendLine("Could not find 'spatial' on your PATH.");
-            }
-
-            builder.AppendLine();
-            builder.AppendLine("If these exist on your PATH, restart Unity and Unity Hub.");
-            builder.AppendLine();
-            builder.AppendLine("Otherwise, install them by following our setup guide:");
-            builder.AppendLine("https://docs.improbable.io/unity/alpha/content/get-started/set-up");
-
-            EditorApplication.delayCall += () =>
-            {
-                EditorUtility.DisplayDialog("GDK dependencies check failed", builder.ToString(), "OK");
-            };
-
-            return false;
-        }
-
         private static string[] ConstructArguments()
         {
             var toolsConfig = GdkToolsConfiguration.GetOrCreateInstance();

workers/unity/Packages/com.improbable.gdk.tools/RedirectedProcess.cs

@@ -1,13 +1,22 @@
 using System;
+using System.Collections.Generic;
 using System.Diagnostics;
 using System.IO;
 using System.Text;
+using System.Threading.Tasks;
 using Improbable.Gdk.Tools.MiniJSON;
 using UnityEngine;
 using Debug = UnityEngine.Debug;
 
 namespace Improbable.Gdk.Tools
 {
+    public class RedirectedProcessResult
+    {
+        public int ExitCode;
+        public List<string> Stdout;
+        public List<string> Stderr;
+    }
+
     /// <summary>
     ///     Runs a windowless process with its stdout/stderr redirected to the Unity console as a single debug print at the
     ///     end.
@@ -28,7 +37,7 @@ public static int Run(string command, params string[] arguments)
         /// <summary>
         ///     Runs the redirected process and waits for it to return.
         /// </summary>
-        /// <param name="workingDirectory">The directory to run the filename from.</param>
+        /// <param name="workingDirectory">The directory to run the command from.</param>
         /// <param name="command">The filename to run.</param>
         /// <param name="arguments">Parameters that will be passed to the command.</param>
         /// <returns>The exit code.</returns>
@@ -95,6 +104,89 @@ void OnReceived(object sender, DataReceivedEventArgs args)
             }
         }
 
+        /// <summary>
+        ///     Runs the redirected process and returns a task which can be waited on.
+        /// </summary>
+        /// <param name="workingDirectory">The directory to run the command from.</param>
+        /// <param name="command">The filename to run.</param>
+        /// <param name="arguments">Parameters that will be passed to the command.</param>
+        /// <param name="redirectStdout">Redirect standard output to Debug.Log</param>
+        /// <param name="redirectStderr">Redirect standard error to Debug.LogError</param>
+        /// <returns>A task which would return the exit code and output.</returns>
+        public static async Task<RedirectedProcessResult> RunInAsync(string workingDirectory, string command, string[] arguments, bool redirectStdout = false, bool redirectStderr = false)
+        {
+            var info = new ProcessStartInfo(command, string.Join(" ", arguments))
+            {
+                CreateNoWindow = true,
+                RedirectStandardError = true,
+                RedirectStandardOutput = true,
+                UseShellExecute = false,
+                WorkingDirectory = workingDirectory
+            };
+
+            return await Task.Run(() =>
+            {
+                using (var process = Process.Start(info))
+                {
+                    if (process == null)
+                    {
+                        throw new Exception(
+                            $"Failed to run {info.FileName} {info.Arguments}\nIs the .NET Core SDK installed?");
+                    }
+
+                    process.EnableRaisingEvents = true;
+
+                    var processStandardOutput = new List<string>();
+                    var processStandardError = new List<string>();
+
+                    void OnStandardOutput(object sender, DataReceivedEventArgs args)
+                    {
+                        if (!string.IsNullOrEmpty(args.Data))
+                        {
+                            if (redirectStdout)
+                            {
+                                Debug.Log(args.Data);
+                            }
+                            lock (processStandardOutput)
+                            {
+                                processStandardOutput.Add(args.Data);
+                            }
+                        }
+                    }
+
+                    void OnStandardError(object sender, DataReceivedEventArgs args)
+                    {
+                        if (!string.IsNullOrEmpty(args.Data))
+                        {
+                            if (redirectStderr)
+                            {
+                                Debug.LogError(args.Data);
+                            }
+                            lock (processStandardOutput)
+                            {
+                                processStandardError.Add(args.Data);
+                            }
+                        }
+                    }
+
+                    process.OutputDataReceived += OnStandardOutput;
+                    process.ErrorDataReceived += OnStandardError;
+
+                    process.BeginOutputReadLine();
+                    process.BeginErrorReadLine();
+
+                    process.WaitForExit();
+
+                    return new RedirectedProcessResult
+                    {
+                        ExitCode = process.ExitCode,
+                        Stdout = processStandardOutput,
+                        Stderr = processStandardError
+                    };
+                }
+            });
+        }
+
         private static string ProcessSpatialOutput(string argsData)
         {
             if (!argsData.StartsWith("{") || !argsData.EndsWith("}"))

workers/unity/Packages/com.improbable.gdk.tools/core-sdk.version

@@ -1 +1 @@
-13.5.0
+13.5.1-b8033-b6bcd-WORKER-SNAPSHOT