Cross platform DynamoCore local setup (part1) #13547
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| # Build Dynamo using latest VS and DotNET | ||
| name: Dynamo-net6.0-Build | ||
| on: [push,pull_request] | ||
| jobs: | ||
| build: | ||
| runs-on: windows-latest | ||
| steps: | ||
| - name: Checkout Dynamo Repo | ||
| uses: actions/checkout@v2 | ||
| with: | ||
| path: Dynamo | ||
| repository: DynamoDS/Dynamo | ||
| - name: Setup dotnet | ||
| uses: actions/setup-dotnet@v3 | ||
| with: | ||
| dotnet-version: '6.0.x' | ||
| - name: Install dependencies for windows runtime | ||
| run: dotnet restore $Env:GITHUB_WORKSPACE\Dynamo\src\DynamoCore.net6.sln --runtime=win10-x64 | ||
|
There was a problem hiding this comment. we are using dotnet restore because it allows us to specify the target runtime (windows or linux) |
||
| - name: Build Dynamo with MSBuild for Windows | ||
| run: | | ||
| echo "***Continue with the build, Good luck developer!***" | ||
| cd "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin\" | ||
aparajit-pratap marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| .\MSBuild.exe $Env:GITHUB_WORKSPACE\Dynamo\src\DynamoCore.net6.sln /p:Configuration=Release /p:Platform=NET60_Windows | ||
| # look for Dynamo | ||
| - name: Navigate to Dynamo Windows Folder | ||
| run: | | ||
| cd "$Env:GITHUB_WORKSPACE\Dynamo\bin\NET60_Windows\Release" | ||
| echo "***Locating DynamoCLI for Windows!***" | ||
| test ".\DynamoCLI.exe" && echo "DynamoCLI exists!" | ||
| - name: Install dependencies for linux runtime | ||
| run: dotnet restore $Env:GITHUB_WORKSPACE\Dynamo\src\DynamoCore.net6.sln --runtime=linux-x64 | ||
| - name: Build Dynamo with MSBuild for Linux | ||
| run: | | ||
| echo "***Continue with the build, Good luck developer!***" | ||
| cd "C:\Program Files\Microsoft Visual Studio\2022\Enterprise\MSBuild\Current\Bin\" | ||
| .\MSBuild.exe $Env:GITHUB_WORKSPACE\Dynamo\src\DynamoCore.net6.sln /p:Configuration=Release /p:Platform=NET60_Linux | ||
| - name: Navigate to Dynamo Linux Folder | ||
| run: | | ||
| cd "$Env:GITHUB_WORKSPACE\Dynamo\bin\NET60_Linux\Release" | ||
| echo "***Locating DynamoCLI for Linux!***" | ||
| test ".\DynamoCLI.exe" && echo "DynamoCLI exists!" | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,19 +13,70 @@ | |
| using Dynamo.Updates; | ||
| using DynamoApplications.Properties; | ||
| using DynamoShapeManager; | ||
| using DynamoUtilities; | ||
| using Microsoft.Win32; | ||
| #if NET6_0_OR_GREATER | ||
| using CommandLine; | ||
| #else | ||
| using NDesk.Options; | ||
| #endif | ||
|
|
||
| namespace Dynamo.Applications | ||
| { | ||
| #if NET6_0_OR_GREATER | ||
| internal class CMDLineOptions | ||
| { | ||
| [Option('l', "Locale", Required = false, HelpText = "Running Dynamo under a different locale setting.")] | ||
|
There was a problem hiding this comment. some of the new cmdline args have changed (as oposed to the old way - using There was a problem hiding this comment. FYI @mjkkirschner @sm6srw There was a problem hiding this comment. yep, bummer, I regret the suggestion - 😢 - but thanks for making the change, probably good to switch to something that actually gets updated. |
||
| public string Locale { get; set; } = String.Empty; | ||
| [Option('c', "CommandFilePath", Required = false, HelpText = "Instruct Dynamo to open a commandfile and run the commands it contains at this path," + | ||
| "this option is only supported when run from DynamoSandbox")] | ||
| public string CommandFilePath { get; set; } = String.Empty; | ||
| [Option('o', "OpenFilePath", Required = false, HelpText = "Instruct Dynamo to open headless and run a dyn file at this path.")] | ||
| public string OpenFilePath { get; set; } = String.Empty; | ||
| [Option('v', "Verbose", Required = false, HelpText = "Instruct Dynamo to output all evalautions it performs to an xml file at this path.")] | ||
| public string Verbose { get; set; } = String.Empty; | ||
| [Option('x', "ConvertFile", Required = false, HelpText = "When used in combination with the 'O' flag, opens a .dyn file from the specified path and converts it to .json." + | ||
| "File will have the .json extension and be located in the same directory as the original file.")] | ||
| public bool ConvertFile { get; set; } | ||
| [Option('g', "Geometry", Required = false, HelpText = "Instruct Dynamo to output geometry from all evaluations to a json file at this path.")] | ||
|
There was a problem hiding this comment. yeah, so what happens here with the two There was a problem hiding this comment. I did not even try. Obviously something is not going to work There was a problem hiding this comment. doesn't need to be resolved here but we should probably align these and just document the break between the two targets. There was a problem hiding this comment. will add a task for it once we are sure that this is the package we want |
||
| public string GeometryFilePath { get; set; } = String.Empty; | ||
| [Option('i', "Import", Required = false, HelpText = "Instruct Dynamo to import an assembly as a node library.This argument should be a filepath to a single.dll" + | ||
| " - if you wish to import multiple dlls - list the dlls separated by a space: -i 'assembly1.dll' 'assembly2.dll'")] | ||
| public IEnumerable<String> ImportedPaths { get; set; } = new List<string>(); | ||
| [Option('g', "GeometryPath", Required = false, HelpText = "relative or absolute path to a directory containing ASM. When supplied, instead of searching the hard disk for ASM, it will be loaded directly from this path.")] | ||
| public string ASMPath { get; set; } = String.Empty; | ||
| [Option('k', "KeepAlive", Required = false, HelpText = "Keepalive mode, leave the Dynamo process running until a loaded extension shuts it down.")] | ||
| public bool KeepAlive { get; set; } | ||
| [Option('n', "NoConsole", Required = false, HelpText = "Don't rely on the console window to interact with CLI in Keepalive mode.")] | ||
| public bool NoConsole { get; set; } | ||
| [Option('u', "UserData", Required = false, HelpText = "Specify user data folder to be used by PathResolver with CLI.")] | ||
| public string UserDataFolder { get; set; } = String.Empty; | ||
| [Option("CommonData", Required = false, HelpText = "Specify common data folder to be used by PathResolver with CLI.")] | ||
| public string CommonDataFolder { get; set; } = String.Empty; | ||
| [Option("HostName", Required = false, HelpText = "Identify Dynamo variation associated with host.")] | ||
| public string HostName { get; set; } = String.Empty; | ||
| [Option("DisableAnalytics", Required = false, HelpText = "Disables analytics in Dynamo for the process liftime.")] | ||
| public bool DisableAnalytics { get; set; } | ||
| [Option("ParentId", Required = false, HelpText = "Identify Dynamo host analytics parent id.")] | ||
| public string ParentId { get; set; } = String.Empty; | ||
| [Option("SessionId", Required = false, HelpText = "Identify Dynamo host analytics session id.")] | ||
| public string SessionId { get; set; } = String.Empty; | ||
| [Option("CERLocation", Required = false, HelpText = "Specify the crash error report tool location on disk.")] | ||
| public string CERLocation { get; set; } = String.Empty; | ||
| } | ||
| #endif | ||
|
|
||
|
There was a problem hiding this comment. I decided to use a separate |
||
| public class StartupUtils | ||
| { | ||
| //TODO internal? | ||
| /// <summary> | ||
| /// Raised when loading of the ASM binaries fails. A failure message is passed as a parameter. | ||
| /// </summary> | ||
| public static event Action<string> ASMPreloadFailure; | ||
|
|
||
| #if NET6_0_OR_GREATER | ||
| [System.Runtime.Versioning.SupportedOSPlatform("windows")] | ||
| #endif | ||
| internal class SandboxLookUp : DynamoLookUp | ||
| { | ||
| public override IEnumerable<string> GetDynamoInstallLocations() | ||
|
|
@@ -69,6 +120,34 @@ public struct CommandLineArguments | |
| { | ||
| public static CommandLineArguments Parse(string[] args) | ||
| { | ||
| #if NET6_0_OR_GREATER | ||
|
|
||
| return Parser.Default.ParseArguments<CMDLineOptions>(args).MapResult((cmdArgs) => { | ||
| if (!string.IsNullOrEmpty(cmdArgs.Verbose) && string.IsNullOrEmpty(cmdArgs.OpenFilePath)) | ||
| { | ||
| Console.WriteLine("you must supply a file to open if you want to save an evaluation output "); | ||
| } | ||
|
|
||
| return new CommandLineArguments() | ||
| { | ||
| Locale = cmdArgs.Locale, | ||
| CommandFilePath = cmdArgs.CommandFilePath, | ||
| OpenFilePath = cmdArgs.OpenFilePath, | ||
| Verbose = cmdArgs.Verbose, | ||
| ConvertFile = cmdArgs.ConvertFile, | ||
| GeometryFilePath = cmdArgs.GeometryFilePath, | ||
| ImportedPaths = cmdArgs.ImportedPaths, | ||
| ASMPath = cmdArgs.ASMPath, | ||
| KeepAlive = cmdArgs.KeepAlive, | ||
| NoConsole = cmdArgs.NoConsole, | ||
| UserDataFolder = cmdArgs.UserDataFolder, | ||
| CommonDataFolder = cmdArgs.CommonDataFolder, | ||
| DisableAnalytics = cmdArgs.DisableAnalytics, | ||
| AnalyticsInfo = new HostAnalyticsInfo() { HostName = cmdArgs.HostName, ParentId = cmdArgs.ParentId, SessionId = cmdArgs.SessionId }, | ||
| CERLocation = cmdArgs.CERLocation | ||
| }; | ||
| }, errs => new CommandLineArguments()); | ||
| #else | ||
| // Running Dynamo sandbox with a command file: | ||
| // DynamoSandbox.exe /c "C:\file path\file.xml" | ||
| // | ||
|
|
@@ -172,14 +251,17 @@ public static CommandLineArguments Parse(string[] args) | |
| AnalyticsInfo = new HostAnalyticsInfo() { HostName = hostname, ParentId = parentId, SessionId = sessionId }, | ||
| CERLocation = cerLocation | ||
| }; | ||
| #endif | ||
| } | ||
|
|
||
| #if NET6_0_OR_GREATER | ||
| #else | ||
| private static void ShowHelp(OptionSet opSet) | ||
| { | ||
| Console.WriteLine("options:"); | ||
| opSet.WriteOptionDescriptions(Console.Out); | ||
| } | ||
| #endif | ||
| public string Locale { get; set; } | ||
| public string CommandFilePath { get; set; } | ||
| public string OpenFilePath { get; set; } | ||
|
|
@@ -196,7 +278,6 @@ private static void ShowHelp(OptionSet opSet) | |
| public string HostName { get; set; } | ||
| public bool DisableAnalytics { get; set; } | ||
| public HostAnalyticsInfo AnalyticsInfo { get; set; } | ||
| public string CERLocation { get; set; } | ||
| } | ||
|
|
||
|
|
@@ -205,6 +286,9 @@ private static void ShowHelp(OptionSet opSet) | |
| /// </summary> | ||
| /// <param name="geometryFactoryPath">libG ProtoInterface path</param> | ||
| /// <param name="preloaderLocation">libG folder path</param> | ||
| #if NET6_0_OR_GREATER | ||
| [System.Runtime.Versioning.SupportedOSPlatform("windows")] | ||
aparajit-pratap marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| #endif | ||
| public static void PreloadShapeManager(ref string geometryFactoryPath, ref string preloaderLocation) | ||
| { | ||
| var exePath = Assembly.GetExecutingAssembly().Location; | ||
|
|
@@ -227,6 +311,9 @@ public static void PreloadShapeManager(ref string geometryFactoryPath, ref strin | |
| ///for now, building an updatemanager instance requires finding Dynamo install location | ||
| ///which if we are running on mac os or *nix will use different logic then SandboxLookup | ||
| /// </summary> | ||
| #if NET6_0_OR_GREATER | ||
| [System.Runtime.Versioning.SupportedOSPlatform("windows")] | ||
| #endif | ||
| private static IUpdateManager InitializeUpdateManager() | ||
| { | ||
| var cfg = UpdateManagerConfiguration.GetSettings(new SandboxLookUp()); | ||
|
|
@@ -312,7 +399,7 @@ public static DynamoModel MakeModel(bool CLImode) | |
|
|
||
| private static bool PreloadASM(string asmPath, out string geometryFactoryPath, out string preloaderLocation ) | ||
| { | ||
| if (string.IsNullOrEmpty(asmPath) && OSHelper.IsWindows()) | ||
| { | ||
| geometryFactoryPath = string.Empty; | ||
| preloaderLocation = string.Empty; | ||
|
|
@@ -378,7 +465,7 @@ private static DynamoModel StartDynamoWithDefaultConfig(bool CLImode, | |
| CLIMode = CLImode | ||
| }; | ||
| config.AuthProvider = CLImode ? null : new Core.IDSDKManager(); | ||
| config.UpdateManager = CLImode ? null : OSHelper.IsWindows() ? InitializeUpdateManager() : null; | ||
|
There was a problem hiding this comment. what is windows only about updatemanager? There was a problem hiding this comment.
There was a problem hiding this comment. Hopefully we can get rid of most of the Windows only APIs from DynamoCore |
||
| config.StartInTestMode = CLImode; | ||
| config.PathResolver = CLImode ? new CLIPathResolver(preloaderLocation, userDataFolder, commonDataFolder) as IPathResolver : new SandboxPathResolver(preloaderLocation) as IPathResolver; | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should this also build on Ubuntu?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we need msbuild for now. Not sure if msbuild is available on liinux machines
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
well you can do
mono msbuild...Why do we need msbuild?
I guess it's not super important because msbuild supports cross compiling - is that correct?... kind of a pain to maintain a windows build machine though?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we will need a windows build machine to build Dynamo.net6.All (with UI)
DynamoCore (no UI) should be able to build on linux and run on any machine.
I guess if we need a windows machine for all of dynamo (with ui) anyway, then we can just build every part of it there