Changeset 17013 for branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Isolation/RunnerHost.cs

Timestamp:

06/17/19 10:40:41 (5 years ago)

Author:

dpiringe

Message:

#2924:

• some changes in CLIApplication.cs to reduce unnecessary allocation of string objects
• renamed AppTest to ConsoleOptimizer and fixed race condition
• replaced enum RunnerJob with class RunnerMessage for more control of saved data
• changed usage of BinaryFormatter with HEAL.Attic, following types are now Storable:
  • ConsoleOptimizer
  • InspectApplication
  • ApplicationBase
  • ApplicationRunner
  • AssemblyInfo
  • Runner
  • UniPath
  • RunnerMessage
• switched QuietMode from ApplicationRunner to IRunner
• DockerRunnerHost can now automatically build docker images for linux and windows containers (also identifies which container type is active) -> removes the condition to have the image preinstalled
  • to achieve this, there are two new folders DockerLinuxBuild and DockerWindowsBuild included in build output, which include Dockerfiles to build images for linux and windows container
• added NuGet package System.CodeDom to project HeuristicLab.Scripting-3.3
• added method Send(RunnerMessage) to IRunnerHost and transferred methods Pause and Resume to IRunner
• added internal reference of RunnerHost in Runner
• added abstract method SendMessage(RunnerMessage) in RunnerHost which gets called from method Send(RunnerMessage)
• because of a Google.Protobuf "bug", RunnerMessages cannot get serialized/deserialized directly on stream -> workaround with a byte array, which gets written and read
  • additionally, the length of the array gets sent first (length as integer -> 4 bytes)
  • static method in RunnerMessage to read a message from a stream
  • the method SendMessage(RunnerMessage) in RunnerHost implements this functionality

File:

• branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Isolation/RunnerHost.cs (modified) (9 diffs)

branches/2924_DotNetCoreMigration/HeuristicLab.PluginInfrastructure/3.3/Isolation/RunnerHost.cs

@@ -4 +4 @@
 using System.Threading;
 using System.Threading.Tasks;
+using HEAL.Attic;
 
 namespace HeuristicLab.PluginInfrastructure {
@@ -14 +15 @@
     Starting,
     Running,
-    Paused,
-    Stopping,
     Stopped
   }
@@ -27 +26 @@
     #region Vars
     protected Process process;
+    private ProtoBufSerializer serializer = new ProtoBufSerializer();
     #endregion
 
     #region Properties
+    /// <summary>
+    /// Set this to true, if console output should be disabled.
+    /// </summary>
+    public bool QuietMode { get; set; }
+
+
     /// <summary>
     /// The programm, which should be used. For example 'docker'.
@@ -41 +47 @@
     protected string Password { get; private set; }
     protected string Domain { get; private set; }
+    protected IRunner Runner { get; set; }
 
-    /// <summary>
-    /// The runner state.
-    /// </summary>
     public RunnerState State { get; protected set; } = RunnerState.Created;
     #endregion
 
     #region Constructors
+
     protected RunnerHost(string program, string startArgument, string userName, string password, string domain) {
       Program = program;
@@ -63 +68 @@
         throw new InvalidOperationException("Runner must be in state 'Created'.");
       State = RunnerState.Starting;
+      Runner = runner;
       process = new Process {
         StartInfo = new ProcessStartInfo {
@@ -72 +78 @@
           RedirectStandardError = true,
           CreateNoWindow = false,
-          UserName = string.IsNullOrEmpty(UserName) ? null : UserName,
+          UserName = string.IsNullOrEmpty(UserName) ? null : UserName, // TODO: accounts testen: https://docs.microsoft.com/en-us/windows/security/identity-protection/access-control/local-accounts#sec-localsystem
           PasswordInClearText = string.IsNullOrEmpty(Password) ? null : Password,
           Domain = string.IsNullOrEmpty(Domain) ? null : Domain,
@@ -80 +86 @@
       };
       process.Start();
+
       // registers a task for cancellation, prevents the use of polling (while-loop)
       var task = RegisterCancellation(token.HasValue ? token.Value : CancellationToken.None);
 
-      // write config to standardinput, runner listens on this and deserializes the config
-      Runner.Serialize(runner, process.StandardInput.BaseStream);
+      // set runnerhost in runner 
+      Runner r = Runner as Runner;
+      if (r != null) r.Host = this;
 
       process.BeginOutputReadLine();
       process.BeginErrorReadLine();
 
-      if (!runner.QuietMode) {
+      if (!QuietMode) {
         process.OutputDataReceived += (s, e) => Console.WriteLine(e.Data);
         process.ErrorDataReceived += (s, e) => Console.WriteLine(e.Data);
       }
+
+      // write config to standardinput, runner listens on this and deserializes the config
+      SendMessage(new TransportRunnerMessage(Runner));
+
       State = RunnerState.Running;
       if (await task) State = RunnerState.Cancelled;
       else State = RunnerState.Stopped;
-
     }
 
-    /// <summary>
-    /// Pauses the runners. The childprocess gets notified with the help of the standard input and a serialized RunnerJob.
-    /// To pause the runner, the state must be "Running".
-    /// </summary>
-    public void Pause() {
+
+    public void Send(RunnerMessage runnerMessage) {
       if (State != RunnerState.Running) throw new InvalidOperationException("Runner must be in state 'Running'!");
-      Runner.Pause(process.StandardInput.BaseStream);
-      State = RunnerState.Paused;
+      SendMessage(runnerMessage);
     }
 
-    /// <summary>
-    /// Resumes a paused runner. The childprocess gets notified with the help of the standard input and a serialized RunnerJob.
-    /// To resume the runner, the state must be "Paused".
-    /// </summary>
-    public void Resume() {
-      if (State != RunnerState.Paused) throw new InvalidOperationException("Runner must be in state 'Paused'!");
-      Runner.Resume(process.StandardInput.BaseStream);
-      State = RunnerState.Running;
+    // because we need to transfer the runner with a TransportRunnerMessage in the starting state and the 
+    // original send method should not be available until running state
+    protected virtual void SendMessage(RunnerMessage runnerMessage) {
+      runnerMessage.SendTime = DateTime.Now;
+      byte[] bytes = serializer.Serialize(runnerMessage);
+      byte[] size = BitConverter.GetBytes(bytes.Length);
+      process.StandardInput.BaseStream.Write(size, 0, size.Length);
+      process.StandardInput.BaseStream.Flush();
+      process.StandardInput.BaseStream.Write(bytes, 0, bytes.Length);
+      process.StandardInput.BaseStream.Flush();
     }
 
@@ -125 +134 @@
     /// When the child process gets finished without requested cancellation, the linked token gets cancelled and a result set. 
     /// </summary>
-    private Task<bool> RegisterCancellation(CancellationToken token) {
+    protected Task<bool> RegisterCancellation(CancellationToken token) {
       if (process != null && State == RunnerState.Starting) {
         var cts = CancellationTokenSource.CreateLinkedTokenSource(token);
@@ -133 +142 @@
         cts.Token.Register(() => {
           if (!process.HasExited) {
-            Runner.Cancel(process.StandardInput.BaseStream);
+            Runner.Cancel();
             process.WaitForExit();
           }