Improved support for batch mode execution of resolution steps.

* Moved main thread task execution logic to the RunOnMainThread class.
  This simplifies the process of scheduling execution on the main thread in
  the Unity editor and enabled addition of support for synchronous execution
  when running in batch mode where UnityEditor.EditorApplication.update is not
  called.
* CommandLine and CommandLineDialog classes will now execute all command line
  operations synchronously when running in batch mode.
* Added logging to CommandLineDialog in batch mode and when running with
  verbose logging enabled.
* Moved batch mode testing logic and Unity version checking to the
  ExceutionEnvironment class.
* Moved all explicit use of EditorApplication.update to RunOnMainThread methods
  so tasks are executed correctly in batch mode.
* Added batch mode support to CommandLineDialog (Unity crashes when showing
  editor windows in batch mode with no graphics).
* Fixed variable replacement in AndroidManifest.xml files.
  Values like "${applicationId}.foo" were being replaced by simply the
  applicationId variable, stripping the ".foo".

Bug: 79148523,77549386, 110261673
Change-Id: I3b67175e4e11eb4999fad0b158880873f87b4090

Author: Stewart Miles

source/IOSResolver/src/IOSResolver.cs

@@ -15,6 +15,7 @@
 // </copyright>
 
 #if UNITY_IOS
+using Google;
 using GooglePlayServices;
 using Google.JarResolver;
 using System;
@@ -526,9 +527,9 @@ exception is TypeInitializationException ||
         // If Cocoapod tool auto-installation is enabled try installing on the first update of
         // the editor when the editor environment has been initialized.
         if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS &&
-            AutoPodToolInstallInEditorEnabled && CocoapodsIntegrationEnabled && !InBatchMode) {
-            EditorApplication.update -= AutoInstallCocoapods;
-            EditorApplication.update += AutoInstallCocoapods;
+            AutoPodToolInstallInEditorEnabled && CocoapodsIntegrationEnabled &&
+            !ExecutionEnvironment.InBatchMode) {
+            RunOnMainThread.Run(() => { AutoInstallCocoapods(); }, runNow: false);
         }
 
 
@@ -537,7 +538,7 @@ exception is TypeInitializationException ||
         if (EditorUserBuildSettings.activeBuildTarget == BuildTarget.iOS &&
             (CocoapodsIntegrationMethod)settings.GetInt(PREFERENCE_COCOAPODS_INTEGRATION_METHOD,
                 CocoapodsIntegrationUpgradeDefault) == CocoapodsIntegrationMethod.None &&
-            !InBatchMode && !UpgradeToWorkspaceWarningDisabled) {
+            !ExecutionEnvironment.InBatchMode && !UpgradeToWorkspaceWarningDisabled) {
 
             switch (EditorUtility.DisplayDialogComplex(
                 "Warning: CocoaPods integration is disabled!",
@@ -712,13 +713,6 @@ public static bool UseProjectSettings {
     /// </summary>
     public static bool Enabled { get { return iOSXcodeExtensionLoaded; } }
 
-    /// <summary>
-    /// Whether the editor was launched in batch mode.
-    /// </summary>
-    private static bool InBatchMode {
-        get { return System.Environment.CommandLine.Contains("-batchmode"); }
-    }
-
     private const float epsilon = 1e-7f;
 
     /// <summary>
@@ -794,7 +788,8 @@ private delegate void LogMessageDelegate(string message, bool verbose = false,
     /// <param name="level">Severity of the message.</param>
     internal static void Log(string message, bool verbose = false,
                              LogLevel level = LogLevel.Info) {
-        logger.Level = (VerboseLoggingEnabled || InBatchMode) ? LogLevel.Verbose : LogLevel.Info;
+        logger.Level = (VerboseLoggingEnabled || ExecutionEnvironment.InBatchMode) ?
+            LogLevel.Verbose : LogLevel.Info;
         logger.Log(message, level: verbose ? LogLevel.Verbose : level);
     }
 
@@ -1161,7 +1156,6 @@ public static void InstallCocoapodsMenu() {
     /// </summary>
     public static void AutoInstallCocoapods() {
         InstallCocoapodsInteractive(displayAlreadyInstalled: false);
-        EditorApplication.update -= AutoInstallCocoapods;
     }
 
     /// <summary>
@@ -1277,7 +1271,7 @@ public static void InstallCocoapods(bool interactive, string workingDirectory,
                 }
             }
         }
-        if (VerboseLoggingEnabled || InBatchMode) {
+        if (VerboseLoggingEnabled || ExecutionEnvironment.InBatchMode) {
             installArgs += " --verbose";
         }
 
@@ -1772,6 +1766,7 @@ private static void RunCommandsAsync(CommandItem[] commands,
             dialog.autoScrollToBottom = true;
             dialog.bodyText = commands[0].ToString() + "\n";
             dialog.summaryText = summaryText ?? dialog.bodyText;
+            dialog.logger = logger;
 
             int index = 0;
             var handlerContainer = new DelegateContainer<CommandLine.CompletionHandler>();

source/PlayServicesResolver/src/AndroidSdkManager.cs

@@ -415,6 +415,7 @@ public static void QueryPackages(string toolPath, string toolArguments,
             window.modal = false;
             window.progressTitle = window.summaryText;
             window.autoScrollToBottom = true;
+            window.logger = PlayServicesResolver.logger;
             window.RunAsync(
                 toolPath, toolArguments,
                 (CommandLine.Result result) => {
@@ -544,6 +545,7 @@ private static void DisplayInstallLicenseDialog(
             window.bodyText = String.Format("{0} {1}\n\n", toolPath, toolArguments);
             window.progressTitle = window.summaryText;
             window.autoScrollToBottom = true;
+            window.logger = PlayServicesResolver.logger;
             CommandLine.IOHandler ioHandler = null;
             if (licenseResponder != null) ioHandler = licenseResponder.AggregateLine;
             PlayServicesResolver.Log(String.Format("{0} {1}", toolPath, toolArguments),
@@ -574,6 +576,7 @@ private static void DisplayLicensesDialog(string licenses, Action<bool> complete
             window.yesText = "agree";
             window.noText = "decline";
             window.result = false;
+            window.logger = PlayServicesResolver.logger;
             window.Repaint();
             window.buttonClicked = (TextAreaDialog dialog) => {
                 window.Close();

source/PlayServicesResolver/src/CommandLine.cs

@@ -26,6 +26,8 @@ namespace GooglePlayServices
     using UnityEditor;
 #endif  // UNITY_EDITOR
 
+    using Google;
+
     public static class CommandLine
     {
         /// <summary>
@@ -113,6 +115,7 @@ public static StreamData Empty
         /// <summary>
         /// Asynchronously execute a command line tool, calling the specified delegate on
         /// completion.
+        /// NOTE: In batch mode this will be executed synchronously.
         /// </summary>
         /// <param name="toolPath">Tool to execute.</param>
         /// <param name="arguments">String to pass to the tools' command line.</param>
@@ -122,17 +125,21 @@ public static StreamData Empty
         /// <param name="ioHandler">Allows a caller to provide interactive input and also handle
         /// both output and error streams from a single delegate.</param>
         public static void RunAsync(
-            string toolPath, string arguments, CompletionHandler completionDelegate,
-            string workingDirectory = null,
-            Dictionary<string, string> envVars = null,
-            IOHandler ioHandler = null)
-        {
-            Thread thread = new Thread(new ThreadStart(() => {
-                    Result result = Run(toolPath, arguments, workingDirectory, envVars: envVars,
-                                        ioHandler: ioHandler);
-                    completionDelegate(result);
-                }));
-            thread.Start();
+                string toolPath, string arguments, CompletionHandler completionDelegate,
+                string workingDirectory = null,
+                Dictionary<string, string> envVars = null,
+                IOHandler ioHandler = null) {
+            Action action = () => {
+                Result result = Run(toolPath, arguments, workingDirectory, envVars: envVars,
+                                    ioHandler: ioHandler);
+                completionDelegate(result);
+            };
+            if (ExecutionEnvironment.InBatchMode) {
+                action();
+            } else {
+                Thread thread = new Thread(new ThreadStart(action));
+                thread.Start();
+            }
         }
 
         /// <summary>

source/PlayServicesResolver/src/CommandLineDialog.cs

@@ -26,7 +26,7 @@ namespace GooglePlayServices
 
     using Google;
 
-    public class CommandLineDialog : TextAreaDialog
+    internal class CommandLineDialog : TextAreaDialog
     {
         /// <summary>
         /// Forwards the output of the currently executing command to a CommandLineDialog window.
@@ -45,6 +45,8 @@ public class ProgressReporter : CommandLine.LineReader
             private volatile int linesReported;
             // Command line tool result, set when command line execution is complete.
             private volatile CommandLine.Result result = null;
+            // Logger for messages.
+            private Google.Logger logger = null;
 
             /// <summary>
             /// Event called on the main / UI thread when the outstanding command line tool
@@ -55,12 +57,13 @@ public class ProgressReporter : CommandLine.LineReader
             /// <summary>
             /// Construct a new reporter.
             /// </summary>
-            public ProgressReporter(CommandLine.IOHandler handler = null)
-            {
+            /// <param name="logger">Logger to log command output.</param>
+            public ProgressReporter(Google.Logger logger) {
                 textQueue = System.Collections.Queue.Synchronized(new System.Collections.Queue());
                 maxProgressLines = 0;
                 linesReported = 0;
                 LineHandler += CommandLineIOHandler;
+                this.logger = logger;
                 Complete = null;
             }
 
@@ -84,18 +87,37 @@ private void CommandLineIOHandler(Process process, StreamWriter stdin,
                 // Count lines in stdout.
                 if (data.handle == 0) linesReported += CountLines(data.text);
                 // Enqueue data for the text view.
-                textQueue.Enqueue(System.Text.Encoding.UTF8.GetString(data.data));
+                var newLines = System.Text.Encoding.UTF8.GetString(data.data);
+                textQueue.Enqueue(newLines);
+                // Write to the logger.
+                foreach (var line in CommandLine.SplitLines(newLines)) {
+                    logger.Log(line, level: LogLevel.Verbose);
+                }
             }
 
             /// <summary>
             /// Called when the currently executing command completes.
             /// </summary>
             public void CommandLineToolCompletion(CommandLine.Result result)
             {
-                PlayServicesResolver.Log(
+                logger.Log(
                     String.Format("Command completed: {0}", result.message),
                     level: LogLevel.Verbose);
                 this.result = result;
+                if (ExecutionEnvironment.InBatchMode) {
+                    RunOnMainThread.Run(() => { SignalComplete(); });
+                }
+            }
+
+            /// <summary>
+            /// Signal the completion event handler.
+            /// This method *must* be called from the main thread.
+            /// </summary>
+            private void SignalComplete() {
+                if (Complete != null) {
+                    Complete(result);
+                    Complete = null;
+                }
             }
 
             /// <summary>
@@ -141,11 +163,7 @@ public void Update(CommandLineDialog window)
                 if (result != null)
                 {
                     window.progressTitle = "";
-                    if (Complete != null)
-                    {
-                        Complete(result);
-                        Complete = null;
-                    }
+                    SignalComplete();
                 }
             }
         }
@@ -154,6 +172,7 @@ public void Update(CommandLineDialog window)
         public string progressTitle;
         public string progressSummary;
         public volatile bool autoScrollToBottom;
+        public Google.Logger logger = new Google.Logger();
 
         /// <summary>
         /// Event delegate called from the Update() method of the window.
@@ -170,12 +189,49 @@ public void Update(CommandLineDialog window)
         /// <returns>Reference to the new window.</returns>
         public static CommandLineDialog CreateCommandLineDialog(string title)
         {
-            CommandLineDialog window = (CommandLineDialog)EditorWindow.GetWindow(
-                typeof(CommandLineDialog), true, title);
+            // In batch mode we simply create the class without instancing the visible window.
+            CommandLineDialog window = ExecutionEnvironment.InBatchMode ?
+                new CommandLineDialog() : (CommandLineDialog)EditorWindow.GetWindow(
+                    typeof(CommandLineDialog), true, title);
             window.Initialize();
             return window;
         }
 
+        /// <summary>
+        /// Alternative the Show() method that does not crash in batch mode.
+        /// </summary>
+        public void Show() {
+            Show(false);
+        }
+
+        /// <summary>
+        /// Alternative Show() method that does not crash in batch mode.
+        /// </summary>
+        /// <param name="immediateDisplay">Display the window now.</param>
+        public void Show(bool immediateDisplay) {
+            if (!ExecutionEnvironment.InBatchMode) {
+                base.Show(immediateDisplay);
+            }
+        }
+
+        /// <summary>
+        /// Alternative Repaint() method that does not crash in batch mode.
+        /// </summary>
+        public void Repaint() {
+            if (!ExecutionEnvironment.InBatchMode) {
+                base.Repaint();
+            }
+        }
+
+        /// <summary>
+        /// Alternative Close() method that does not crash in batch mode.
+        /// </summary>
+        public void Close() {
+            if (!ExecutionEnvironment.InBatchMode) {
+                base.Close();
+            }
+        }
+
         /// <summary>
         /// Initialize all members of the window.
         /// </summary>
@@ -209,7 +265,8 @@ public void RunAsync(
             string workingDirectory = null, Dictionary<string, string> envVars = null,
             CommandLine.IOHandler ioHandler = null, int maxProgressLines = 0)
         {
-            CommandLineDialog.ProgressReporter reporter = new CommandLineDialog.ProgressReporter();
+            CommandLineDialog.ProgressReporter reporter =
+                new CommandLineDialog.ProgressReporter(logger);
             reporter.maxProgressLines = maxProgressLines;
             // Call the reporter from the UI thread from this window.
             UpdateEvent += reporter.Update;
@@ -221,7 +278,7 @@ public void RunAsync(
             CommandLine.CompletionHandler reporterUpdateDisable =
                 (CommandLine.Result unusedResult) => { this.UpdateEvent -= reporter.Update; };
             reporter.Complete += reporterUpdateDisable;
-            PlayServicesResolver.Log(String.Format(
+            logger.Log(String.Format(
                 "Executing command: {0} {1}", toolPath, arguments), level: LogLevel.Verbose);
             CommandLine.RunAsync(toolPath, arguments, reporter.CommandLineToolCompletion,
                                  workingDirectory: workingDirectory, envVars: envVars,

source/PlayServicesResolver/src/Constants.cs

@@ -143,6 +143,7 @@ private static void RunGenGradleScript(string args, CommandLine.CompletionHandle
         window.summaryText = "Generating and running Gradle prebuild.";
         window.progressTitle = window.summaryText;
         window.autoScrollToBottom = true;
+        window.logger = PlayServicesResolver.logger;
         window.RunAsync(command, args,
             (result) => {
                 if (result.exitCode != 0) {