Build scripts to create publish folders and archive packages

scripts/runhelpers.cake

@@ -0,0 +1,204 @@
+using System.Collections.Generic;
+using System.Diagnostics;
+
+/// <summary>
+///  Class encompassing the optional settings for running processes.
+/// </summary>
+public class RunOptions
+{
+    /// <summary>
+    ///  The working directory of the process.
+    /// </summary>
+    public string WorkingDirectory { get; set; }
+    /// <summary>
+    ///  Container logging the StandardOutput content.
+    /// </summary>
+    public IList<string> StandardOutputListing { get; set; }
+    /// <summary>
+    ///  Desired maximum time-out for the process
+    /// </summary>
+    public int TimeOut { get; set; }
+}
+
+/// <summary>
+///  Wrapper for the exit code and state.
+///  Used to query the result of an execution with method calls.
+/// </summary>
+public struct ExitStatus
+{
+    private int _code;
+    private bool _timeOut;
+    /// <summary>
+    ///  Default constructor when the execution finished.
+    /// </summary>
+    /// <param name="code">The exit code</param>
+    public ExitStatus(int code)
+    {
+        this._code = code;
+        this._timeOut = false;
+    }
+    /// <summary>
+    ///  Default constructor when the execution potentially timed out.
+    /// </summary>
+    /// <param name="code">The exit code</param>
+    /// <param name="timeOut">True if the execution timed out</param>
+    public ExitStatus(int code, bool timeOut)
+    {
+        this._code = code;
+        this._timeOut = timeOut;
+    }
+    /// <summary>
+    ///  Flag signalling that the execution timed out.
+    /// </summary>
+    public bool DidTimeOut { get { return _timeOut; } }
+    /// <summary>
+    ///  Implicit conversion from ExitStatus to the exit code.
+    /// </summary>
+    /// <param name="exitStatus">The exit status</param>
+    /// <returns>The exit code</returns>
+    public static implicit operator int(ExitStatus exitStatus)
+    {
+        return exitStatus._code;
+    }
+    /// <summary>
+    ///  Trigger Exception for non-zero exit code.
+    /// </summary>
+    /// <param name="errorMessage">The message to use in the Exception</param>
+    /// <returns>The exit status for further queries</returns>
+    public ExitStatus ExceptionOnError(string errorMessage)
+    {
+        if (this._code != 0)
+        {
+            throw new Exception(errorMessage);
+        }
+        return this;
+    }
+}
+
+/// <summary>
+///  Run the given executable with the given arguments.
+/// </summary>
+/// <param name="exec">Executable to run</param>
+/// <param name="args">Arguments</param>
+/// <returns>The exit status for further queries</returns>
+ExitStatus Run(string exec, string args)
+{
+    return Run(exec, args, new RunOptions());
+}
+
+/// <summary>
+///  Run the given executable with the given arguments.
+/// </summary>
+/// <param name="exec">Executable to run</param>
+/// <param name="args">Arguments</param>
+/// <param name="workingDirectory">Working directory</param>
+/// <returns>The exit status for further queries</returns>
+ExitStatus Run(string exec, string args, string workingDirectory)
+{
+    return Run(exec, args,
+        new RunOptions()
+        {
+            WorkingDirectory = workingDirectory
+        });
+}
+
+/// <summary>
+///  Run the given executable with the given arguments.
+/// </summary>
+/// <param name="exec">Executable to run</param>
+/// <param name="args">Arguments</param>
+/// <param name="runOptions">Optional settings</param>
+/// <returns>The exit status for further queries</returns>
+ExitStatus Run(string exec, string args, RunOptions runOptions)
+{
+    var workingDirectory = runOptions.WorkingDirectory ?? System.IO.Directory.GetCurrentDirectory();
+    var process = System.Diagnostics.Process.Start(
+            new ProcessStartInfo(exec, args)
+            {
+                WorkingDirectory = workingDirectory,
+                UseShellExecute = false,
+                RedirectStandardOutput = runOptions.StandardOutputListing != null
+            });
+    if (runOptions.StandardOutputListing != null)
+    {
+        process.OutputDataReceived += (s, e) =>
+        {
+            if (e.Data != null)
+            {
+                runOptions.StandardOutputListing.Add(e.Data);
+            }
+        };
+        process.BeginOutputReadLine();
+    }
+    if (runOptions.TimeOut == 0)
+    {
+        process.WaitForExit();
+        return new ExitStatus(process.ExitCode);
+    }
+    else
+    {
+        bool finished = process.WaitForExit(runOptions.TimeOut);
+        if (finished)
+        {
+            return new ExitStatus(process.ExitCode);
+        }
+        else
+        {
+            KillProcessTree(process);
+            return new ExitStatus(0, true);
+        }
+    }
+}
+
+/// <summary>
+///  Run restore with the given arguments
+/// </summary>
+/// <param name="exec">Executable to run</param>
+/// <param name="args">Arguments</param>
+/// <param name="runOptions">Optional settings</param>
+/// <returns>The exit status for further queries</returns>
+ExitStatus RunRestore(string exec, string args, string workingDirectory)
+{
+    Information("Restoring packages....");
+    var p = StartAndReturnProcess(exec,
+        new ProcessSettings
+        {
+            Arguments = args,
+            RedirectStandardOutput = true,
+            WorkingDirectory = workingDirectory
+        });
+    p.WaitForExit();
+    var exitCode = p.GetExitCode();
+
+    if (exitCode == 0)
+    {
+        Information("Package restore successful!");
+    }
+    else
+    {
+        Error(string.Join("\n", p.GetStandardOutput()));
+    }
+    return new ExitStatus(exitCode);
+}
+
+/// <summary>
+///  Kill the given process and all its child processes.
+/// </summary>
+/// <param name="process">Root process</param>
+public void KillProcessTree(Process process)
+{
+    // Child processes are not killed on Windows by default
+    // Use TASKKILL to kill the process hierarchy rooted in the process
+    if (IsRunningOnWindows())
+    {
+        StartProcess($"TASKKILL",
+            new ProcessSettings
+            {
+                Arguments = $"/PID {process.Id} /T /F",
+            });
+    }
+    else
+    {
+        process.Kill();
+    }
+}