Changeset 16998 for branches/2924_DotNetCoreMigration

Timestamp:

05/29/19 12:31:59 (5 years ago)

Author:

dpiringe

Message:

#2924:

• in project HeuristicLab.CommandLineInterface changed output for options -> hidden options are not shown in the help box anymore
• in project HeuristicLab.DynamicAssemblyTestApp:
  • added ApplicationAttributes
  • added full cancel/pause/resume support for class AppTest to test the same behaviour between main and child process
• in project HeuristicLab:
  • changed auto generated Dockerfile -> only copies necessary projects -> speeds up the build process
  • in file HeuristicLab-3.3.csproj:
    • changed DockerDefaultTargetOS to Linux
    • removed reference HeuristicLab.DefinitionLanguage
    • added icon and manifest
  • deleted folder Properties with file launchSettings.json
  • changed the direct access to ApplicationTypes for OptimizeCommand and InspectCommand to new method IApplicationManager.GetInstances<T>(params object[] args)
• added build script for docker image dockerImageBuild.ps1

Location:

branches/2924_DotNetCoreMigration

Files:

• HeuristicLab.CommandLineInterface/CLIConsole.cs (modified) (3 diffs)
• HeuristicLab.DynamicAssemblyTestApp/AppTest.cs (modified) (2 diffs)
• HeuristicLab.DynamicAssemblyTestApp/InspectApplication.cs (modified) (1 diff)
• HeuristicLab/3.3/ApplicationCommand.cs (modified) (4 diffs)
• HeuristicLab/3.3/Dockerfile (modified) (1 diff)
• HeuristicLab/3.3/HeuristicLab-3.3.csproj (modified) (3 diffs)
• HeuristicLab/3.3/InspectCommand.cs (modified) (2 diffs)
• HeuristicLab/3.3/OptimizeCommand.cs (modified) (2 diffs)
• HeuristicLab/3.3/Properties (deleted)
• dockerImageBuild.ps1 (added)

branches/2924_DotNetCoreMigration/HeuristicLab.CommandLineInterface/CLIConsole.cs

@@ -28 +28 @@
       WriteHeader(cmdData);
 
-      if(exception != null) WriteErrors(exception);
-      
+      if (exception != null) WriteErrors(exception);
+
       WriteSyntax(cmdData);
 
@@ -62 +62 @@
       Console.WriteLine($"ERROR(S):");
       AggregateException ae = exception as AggregateException;
-      if(ae != null) {
-        foreach(var e in ae.InnerExceptions) {
+      if (ae != null) {
+        foreach (var e in ae.InnerExceptions) {
           Console.WriteLine($"  -> {e} ");
         }
       } else {
         Console.WriteLine($"  -> {exception}");
-      }      
+      }
       Console.WriteLine();
     }
@@ -94 +94 @@
       WriteBoxSeparatorLine();
       foreach (OptionData opt in cmdData.Options)
-        WriteBoxLine(
-          ((opt.Shortcut != null) ?
-            $"{(OptionData.ShortcutPrefix + opt.Shortcut).ToLower() + ",",-ShortcutWidth}" :
-            $""
-          ) +
-          $"{(OptionData.LongformPrefix + opt.Identifier).ToLower()}",
-          opt.Property?.PropertyType.GetPrettyName(),
-          opt.Description
-        );
+        if (!opt.Hidden)
+          WriteBoxLine(
+            ((opt.Shortcut != null) ?
+              $"{(OptionData.ShortcutPrefix + opt.Shortcut).ToLower() + ",",-ShortcutWidth}" :
+              $""
+            ) +
+            $"{(OptionData.LongformPrefix + opt.Identifier).ToLower()}",
+            opt.Property?.PropertyType.GetPrettyName(),
+            opt.Description
+          );
       WriteBoxSeparatorLine();
     }

branches/2924_DotNetCoreMigration/HeuristicLab.DynamicAssemblyTestApp/AppTest.cs

@@ -1 +1 @@
 using System;
 using System.IO;
+using System.Threading;
 using HeuristicLab.Common;
 using HeuristicLab.Core;
@@ -8 +9 @@
 namespace HeuristicLab.DynamicAssemblyTestApp {
   [Serializable]
+  [Application("CLIOptimize", "")]
   public class AppTest : ApplicationBase {
 
+    #region Vars
+    [NonSerialized]
+    private IExecutable executable;
+    [NonSerialized]
+    private static AutoResetEvent autoResetEvent = new AutoResetEvent(false);
+    [NonSerialized]
+    private static object locker = new object();
+    #endregion
+
+    #region Properties
     public UniPath InputFilePath { get; set; } = null;
     public UniPath OutputPath { get; set; } = null;
+    #endregion
+
+    #region Constructors
+    public AppTest() { }
+    public AppTest(UniPath inputFilePath, UniPath outputPath) {
+      InputFilePath = inputFilePath;
+      OutputPath = outputPath;
+    }
+    #endregion
+
     public override void Run(ICommandLineArgument[] args) {
-      ContentManager.Initialize(new PersistenceContentManager());
-      IStorableContent content = ContentManager.Load(InputFilePath.ToString());
-      IExecutable exec = content as IExecutable;
-      if (exec != null) {
-        exec.Start();
-        IOptimizer optimizer = exec as IOptimizer;
-        if (optimizer != null) {
-          Console.WriteLine("\nRESULT(S):");
-          int i = 1;
-          foreach (var run in optimizer.Runs) {
-            Console.WriteLine($"{"-------------------------------- RUN",35} {$"{i++:D3}" + " --------------------------------",-35}");
-            foreach (var res in run.Results) {
-              Console.WriteLine($"{res.Key,35} : {res.Value,-35}");
-            }
+      Init();
+      lock (locker) {
+        executable.Stopped += Executable_Stopped;
+        executable.StartAsync();
+      }
+      autoResetEvent.WaitOne();
+    }
+
+    public override void OnCancel() {
+      lock (locker) {
+        base.OnCancel();
+        if (executable != null)
+          executable.Stop();
+      }
+    }
+
+    public override void OnPause() {
+      base.OnPause();
+      lock (locker) {
+        if (executable != null) executable.Pause();
+      }
+    }
+
+    public override void OnResume() {
+      base.OnResume();
+      lock (locker) {
+        if (executable != null)
+          executable.StartAsync();
+      }
+    }
+
+    #region Helper
+    private void Init() {
+      lock (locker) {
+        ContentManager.Initialize(new PersistenceContentManager());
+        IStorableContent content = ContentManager.Load(InputFilePath.ToString());
+        executable = content as IExecutable;
+        if (executable == null)
+          throw new NotSupportedException("The given file does not contain any algorithm to start.");
+      }
+    }
+
+    private void Executable_Stopped(object sender, EventArgs e) {
+      lock (locker) {
+        IOptimizer optimizer = executable as IOptimizer;
+        if (optimizer != null) PrintResults(optimizer);
+        ContentManager.Save((IStorableContent)executable, OutputPath.ToString() + Path.DirectorySeparatorChar + "result.hl", true);
+      }
+      autoResetEvent.Set();
+    }
+
+    private void PrintResults(IOptimizer optimizer) {
+      lock (locker) {
+        Console.WriteLine("\nRESULT(S):");
+        int i = 1;
+        foreach (var run in optimizer.Runs) {
+          Console.WriteLine($"{"-------------------------------- RUN",35} {$"{i++:D3}" + " --------------------------------",-35}");
+          foreach (var res in run.Results) {
+            Console.WriteLine($"{res.Key,35} : {res.Value,-35}");
           }
         }
-        
-        ContentManager.Save((IStorableContent)exec, OutputPath.ToString() + Path.DirectorySeparatorChar + "result.hl", true);
-      } else throw new NotSupportedException("The given file does not contain any algorithm to start.");
+      }
     }
+    #endregion
   }
 }

branches/2924_DotNetCoreMigration/HeuristicLab.DynamicAssemblyTestApp/InspectApplication.cs

@@ -7 +7 @@
 namespace HeuristicLab.DynamicAssemblyTestApp {
   [Serializable]
+  [Application("CLIInspect", "")]
   public class InspectApplication : ApplicationBase {
     public UniPath InputFilePath { get; set; }
+
+    public InspectApplication() { }
+
+    public InspectApplication(UniPath inputFilePath) {
+      InputFilePath = inputFilePath;
+    }
+
     public override void Run(ICommandLineArgument[] args) {
       ContentManager.Initialize(new PersistenceContentManager());

branches/2924_DotNetCoreMigration/HeuristicLab/3.3/ApplicationCommand.cs

@@ -1 +1 @@
 using System;
-using System.Collections.Generic;
 using System.IO;
 using HeuristicLab.CommandLineInterface;
@@ -12 +11 @@
   }
 
-  [HeuristicLab.CommandLineInterface.Application(
+  [CommandLineInterface.Application(
     "HL", "1.0.0.0",
     SubCommands = new Type[] {
@@ -32 +31 @@
 
     public void Execute() {
-      if(StartAsRunnerHost) {
+      if (StartAsRunnerHost) {
         StartupRunnerHost();
       } else {
         SetupIsolation();
       }
-      
     }
 
@@ -48 +46 @@
       else
         Console.Error.WriteLine("Cannot deserialize data from stdin to a type of RunnerConfig!");
-
     }
 

branches/2924_DotNetCoreMigration/HeuristicLab/3.3/Dockerfile

@@ -1 @@
-#Depending on the operating system of the host machines(s) that will build or run the containers, the image specified in the FROM statement may need to be changed.
-#For more information, please see https://aka.ms/containercompat
-
-FROM mcr.microsoft.com/dotnet/core/runtime:3.0-nanoserver-1809 AS base
+FROM mcr.microsoft.com/dotnet/core/runtime:3.0-buster-slim AS base
 WORKDIR /app
 
-FROM mcr.microsoft.com/dotnet/core/sdk:3.0-nanoserver-1809 AS build
+FROM mcr.microsoft.com/dotnet/core/sdk:3.0-buster AS build
 WORKDIR /src
-COPY ["HeuristicLab/3.3/HeuristicLab-3.3.csproj", "HeuristicLab/3.3/"]
-COPY ["HeuristicLab.CommandLineInterface/HeuristicLab.CommandLineInterface.csproj", "HeuristicLab.CommandLineInterface/"]
-COPY ["HeuristicLab.Common/3.3/HeuristicLab.Common-3.3.csproj", "HeuristicLab.Common/3.3/"]
-COPY ["HeuristicLab.PluginInfrastructure/3.3/HeuristicLab.PluginInfrastructure-3.3.csproj", "HeuristicLab.PluginInfrastructure/3.3/"]
-COPY ["HeuristicLab.DefinitionLanguage/HeuristicLab.DefinitionLanguage.csproj", "HeuristicLab.DefinitionLanguage/"]
-COPY ["HeuristicLab.Core/3.3/HeuristicLab.Core-3.3.csproj", "HeuristicLab.Core/3.3/"]
-COPY ["HeuristicLab.Persistence/3.3/HeuristicLab.Persistence-3.3.csproj", "HeuristicLab.Persistence/3.3/"]
-COPY ["HeuristicLab.Tracing/3.3/HeuristicLab.Tracing-3.3.csproj", "HeuristicLab.Tracing/3.3/"]
-COPY ["HeuristicLab.Common.Resources/3.3/HeuristicLab.Common.Resources-3.3.csproj", "HeuristicLab.Common.Resources/3.3/"]
-COPY ["HeuristicLab.Collections/3.3/HeuristicLab.Collections-3.3.csproj", "HeuristicLab.Collections/3.3/"]
-COPY ["HeuristicLab.DynamicAssemblyTestApp/HeuristicLab.DynamicAssemblyTestApp.csproj", "HeuristicLab.DynamicAssemblyTestApp/"]
-COPY ["HeuristicLab.Optimization/3.3/HeuristicLab.Optimization-3.3.csproj", "HeuristicLab.Optimization/3.3/"]
-COPY ["HeuristicLab.Data/3.3/HeuristicLab.Data-3.3.csproj", "HeuristicLab.Data/3.3/"]
-COPY ["HeuristicLab.Parameters/3.3/HeuristicLab.Parameters-3.3.csproj", "HeuristicLab.Parameters/3.3/"]
-COPY ["HeuristicLab.Operators/3.3/HeuristicLab.Operators-3.3.csproj", "HeuristicLab.Operators/3.3/"]
+COPY ["HeuristicLab/3.3/", "HeuristicLab/3.3/"]
+COPY ["HeuristicLab.CommandLineInterface/", "HeuristicLab.CommandLineInterface/"]
+COPY ["HeuristicLab.Common/3.3/", "HeuristicLab.Common/3.3/"]
+COPY ["HeuristicLab.PluginInfrastructure/3.3/", "HeuristicLab.PluginInfrastructure/3.3/"]
+COPY ["HeuristicLab.DynamicAssemblyTestApp/", "HeuristicLab.DynamicAssemblyTestApp/"]
+COPY ["HeuristicLab.Core/3.3/", "HeuristicLab.Core/3.3/"]
+COPY ["HeuristicLab.Persistence/3.3/", "HeuristicLab.Persistence/3.3/"]
+COPY ["HeuristicLab.Tracing/3.3/", "HeuristicLab.Tracing/3.3/"]
+COPY ["HeuristicLab.Common.Resources/3.3/", "HeuristicLab.Common.Resources/3.3/"]
+COPY ["HeuristicLab.Collections/3.3/", "HeuristicLab.Collections/3.3/"]
+COPY ["HeuristicLab.Optimization/3.3/", "HeuristicLab.Optimization/3.3/"]
+COPY ["HeuristicLab.Data/3.3/", "HeuristicLab.Data/3.3/"]
+COPY ["HeuristicLab.Parameters/3.3/", "HeuristicLab.Parameters/3.3/"]
+COPY ["HeuristicLab.Operators/3.3/", "HeuristicLab.Operators/3.3/"]
 RUN dotnet restore "HeuristicLab/3.3/HeuristicLab-3.3.csproj"
-COPY . .
 WORKDIR "/src/HeuristicLab/3.3"
 RUN dotnet build "HeuristicLab-3.3.csproj" -c Release -o /app

branches/2924_DotNetCoreMigration/HeuristicLab/3.3/HeuristicLab-3.3.csproj

@@ -4 +4 @@
     <OutputType>Exe</OutputType>
     <TargetFramework>netcoreapp3.0</TargetFramework>
-    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
-    <DockerDefaultTargetOS>Windows</DockerDefaultTargetOS>
+    <AppendTargetFrameworkToOutputPath>false</AppendTargetFrameworkToOutputPath>
+    <DockerDefaultTargetOS>Linux</DockerDefaultTargetOS>
     <Copyright>(c) 2002-2018 HEAL</Copyright>
     <Product>HeuristicLab</Product>
@@ -13 +13 @@
     <AssemblyFileVersion>3.3.15.0</AssemblyFileVersion>
     <RootNamespace>HeuristicLab</RootNamespace>
+    <ApplicationIcon>HeuristicLab.ico</ApplicationIcon>
+    <ApplicationManifest>app.manifest</ApplicationManifest>
   </PropertyGroup>
 
@@ -23 +25 @@
   </ItemGroup>
 
-
   <ItemGroup>
     <ProjectReference Include="..\..\HeuristicLab.CommandLineInterface\HeuristicLab.CommandLineInterface.csproj" />
     <ProjectReference Include="..\..\HeuristicLab.Common\3.3\HeuristicLab.Common-3.3.csproj" />
-    <ProjectReference Include="..\..\HeuristicLab.DefinitionLanguage\HeuristicLab.DefinitionLanguage.csproj" />
     <ProjectReference Include="..\..\HeuristicLab.DynamicAssemblyTestApp\HeuristicLab.DynamicAssemblyTestApp.csproj" />
     <ProjectReference Include="..\..\HeuristicLab.PluginInfrastructure\3.3\HeuristicLab.PluginInfrastructure-3.3.csproj" />

branches/2924_DotNetCoreMigration/HeuristicLab/3.3/InspectCommand.cs

@@ -1 @@
-using System;
-using System.Collections.Generic;
-using System.IO;
+using System.IO;
+using System.Linq;
 using HeuristicLab.CommandLineInterface;
-using HeuristicLab.DynamicAssemblyTestApp;
 using HeuristicLab.PluginInfrastructure;
 
@@ -21 +19 @@
           QuietMode = false,
           AssembliesToLoad = Settings.assemblyInfos,
-          StartApplication = new InspectApplication() {
-            InputFilePath = new UniPath(Input)
-          }
+          StartApplication =
+            ApplicationManager.Manager.GetInstances<IApplication>(new UniPath(Input))
+            .Where(x => x.Name.Equals("CLIInspect"))
+            .First()
+
         });
       }
-      
     }
   }

branches/2924_DotNetCoreMigration/HeuristicLab/3.3/OptimizeCommand.cs

@@ -1 @@
-using System.Collections.Generic;
-using System.IO;
+using System.IO;
+using System.Linq;
 using HeuristicLab.CommandLineInterface;
-using HeuristicLab.DynamicAssemblyTestApp;
 using HeuristicLab.PluginInfrastructure;
 
@@ -27 +26 @@
           QuietMode = Quiet,
           AssembliesToLoad = Settings.assemblyInfos,
-          StartApplication = new AppTest() {
-            InputFilePath = new UniPath(Input),
-            OutputPath = new UniPath(Output ?? Input.Replace(Path.GetFileName(Input), ""))
-          }
+          StartApplication =
+            ApplicationManager.Manager.GetInstances<IApplication>(
+              new UniPath(Input),
+              new UniPath(Output ?? Input.Replace(Path.GetFileName(Input), ""))
+            ).Where(x => x.Name.Equals("CLIOptimize"))
+             .First()
         });
       }