refactor: code clean-up, add SystemInfo into ExecutionContext

chickensoft-games · Feb 2, 2025 · 1629ed3 · 1629ed3
1 parent 6c7aaf7
commit 1629ed3
Show file tree

Hide file tree

Showing 28 changed files with 42 additions and 55 deletions.
diff --git a/GodotEnv.Tests/reports/method_coverage.svg b/GodotEnv.Tests/reports/method_coverage.svg
diff --git a/GodotEnv.Tests/src/MainTest.cs b/GodotEnv.Tests/src/MainTest.cs
@@ -2,6 +2,7 @@ namespace Chickensoft.GodotEnv.Tests;
 
 using System.Threading.Tasks;
 using Chickensoft.GodotEnv.Common.Models;
+using global::GodotEnv.Common.Utilities;
 using Moq;
 using Shouldly;
 using Xunit;
@@ -18,10 +19,11 @@ public void CreateExecutionContextParsesArgs() {
     var config = new ConfigFile();
     var args = new string[] { "a", "--", "b" };
     var workingDir = "/";
+    var systemInfo = new Mock<ISystemInfo>();
     var addonsContext = new Mock<IAddonsContext>();
     var godotContext = new Mock<IGodotContext>();
     var context = GodotEnv.CreateExecutionContext(
-      args, config, workingDir, addonsContext.Object,
+      args, config, workingDir, systemInfo.Object, addonsContext.Object,
       godotContext.Object
     );
     context.CliArgs.ShouldBe(["a"]);

diff --git a/GodotEnv.Tests/src/common/models/ExecutionContextTest.cs b/GodotEnv.Tests/src/common/models/ExecutionContextTest.cs
@@ -17,6 +17,7 @@ public class ExecutionContextTest {
   [Fact]
   public void Initializes() {
     var config = new ConfigFile();
+    var systemInfo = new MockSystemInfo(OSType.Linux, CPUArch.X64);
     var addons = new Mock<IAddonsContext>().Object;
     var godot = new Mock<IGodotContext>().Object;
 
@@ -25,6 +26,7 @@ public void Initializes() {
       CommandArgs: _commandArgs,
       Version: VERSION,
       WorkingDir: WORKING_DIR,
+      SystemInfo: systemInfo,
       Config: config,
       Addons: addons,
       Godot: godot
@@ -34,12 +36,13 @@ public void Initializes() {
     executionContext.CommandArgs.ShouldBe(_commandArgs);
     executionContext.Version.ShouldBe(VERSION);
     executionContext.WorkingDir.ShouldBe(WORKING_DIR);
+    executionContext.SystemInfo.ShouldBe(systemInfo);
     executionContext.Config.ShouldBe(config);
     executionContext.Addons.ShouldBe(addons);
     executionContext.Godot.ShouldBe(godot);
 
     executionContext
-      .CreateLog(new MockSystemInfo(OSType.Linux, CPUArch.X64), new FakeInMemoryConsole())
+      .CreateLog(new FakeInMemoryConsole())
       .ShouldBeAssignableTo<ILog>();
   }
 }
diff --git a/GodotEnv.Tests/src/features/addons/commands/AddonsCommandTest.cs b/GodotEnv.Tests/src/features/addons/commands/AddonsCommandTest.cs
@@ -18,8 +18,8 @@ public async Task Executes() {
     var console = new FakeInMemoryConsole();
     var log = new Log(systemInfo, console); // Use real log to test colors in output
 
-    context.Setup(ctx => ctx.Godot.Platform.SystemInfo).Returns(systemInfo);
-    context.Setup(ctx => ctx.CreateLog(systemInfo, console)).Returns(log);
+    context.Setup(ctx => ctx.SystemInfo).Returns(systemInfo);
+    context.Setup(ctx => ctx.CreateLog(console)).Returns(log);
 
     var addonCommand = new AddonsCommand(context.Object);
     await addonCommand.ExecuteAsync(console);

diff --git a/GodotEnv.Tests/src/features/addons/commands/install/AddonsInstallCommandTest.cs b/GodotEnv.Tests/src/features/addons/commands/install/AddonsInstallCommandTest.cs
@@ -51,8 +51,8 @@ out ILog log
 
     var workingDir = "/";
 
-    context.Setup(context => context.Godot.Platform.SystemInfo).Returns(systemInfo.Object);
-    context.Setup(context => context.CreateLog(systemInfo.Object, fakeConsole)).Returns(log);
+    context.Setup(context => context.SystemInfo).Returns(systemInfo.Object);
+    context.Setup(context => context.CreateLog(fakeConsole)).Returns(log);
     context.Setup(context => context.WorkingDir).Returns(workingDir);
 
     var addonsFileRepo = new Mock<IAddonsFileRepository>();

diff --git a/GodotEnv.Tests/src/features/godot/commands/GodotListCommandTest.cs b/GodotEnv.Tests/src/features/godot/commands/GodotListCommandTest.cs
@@ -38,7 +38,7 @@ public GodotListCommandTest() {
     _godotContext.Setup(c => c.Platform).Returns(_environment.Object);
     _context.SetupGet(context => context.Godot).Returns(_godotContext.Object);
     _log = new Log(_systemInfo, _console);
-    _context.Setup(context => context.CreateLog(_systemInfo, _console)).Returns(_log);
+    _context.Setup(context => context.CreateLog(_console)).Returns(_log);
   }
 
   public void Dispose() => _console.Dispose();

diff --git a/GodotEnv.Tests/src/features/godot/domain/GodotRepositoryTest.cs b/GodotEnv.Tests/src/features/godot/domain/GodotRepositoryTest.cs
@@ -60,7 +60,7 @@ public async Task AddOrUpdateGodotEnvVariable() {
     var console = new FakeInMemoryConsole();
     var log = new Mock<ILog>(); // Use real log to test colors in output
 
-    executionContext.Setup(context => context.CreateLog(systemInfo, console)).Returns(log.Object);
+    executionContext.Setup(context => context.CreateLog(console)).Returns(log.Object);
 
     await godotRepo.AddOrUpdateGodotEnvVariable(log.Object);
 

diff --git a/GodotEnv/src/Main.cs b/GodotEnv/src/Main.cs
@@ -123,6 +123,7 @@ public static async Task<int> Main(string[] args) {
       args: args,
       config: config,
       workingDir: workingDir,
+      systemInfo: systemInfo,
       addonsContext: addonsContext,
       godotContext: godotContext
     );
@@ -157,6 +158,7 @@ internal static ExecutionContext CreateExecutionContext(
     string[] args,
     ConfigFile config,
     string workingDir,
+    ISystemInfo systemInfo,
     IAddonsContext addonsContext,
     IGodotContext godotContext
   ) {
@@ -198,6 +200,7 @@ IGodotContext godotContext
       Version: version,
       WorkingDir: workingDir,
       Config: config,
+      SystemInfo: systemInfo,
       Addons: addonsContext,
       Godot: godotContext
     );

diff --git a/GodotEnv/src/common/models/ExecutionContext.cs b/GodotEnv/src/common/models/ExecutionContext.cs
@@ -25,6 +25,8 @@ public interface IExecutionContext {
 
   /// <summary>App configuration settings.</summary>
   ConfigFile Config { get; }
+  /// <summary>System information.</summary>
+  ISystemInfo SystemInfo { get; }
   /// <summary>Addons context.</summary>
   IAddonsContext Addons { get; }
   /// <summary>Godot context.</summary>
@@ -33,8 +35,7 @@ public interface IExecutionContext {
   /// <summary>Creates a log using the specified console.</summary>
   /// <param name="console">Output console.</param>
   /// <returns>Log.</returns>
-  ILog CreateLog(ISystemInfo systemInfo, IConsole console);
-  // ILog CreateLog(IConsole console, IGodotEnvironment environment);
+  ILog CreateLog(IConsole console);
 }
 
 public record ExecutionContext(
@@ -43,9 +44,9 @@ public record ExecutionContext(
   string Version,
   string WorkingDir,
   ConfigFile Config,
+  ISystemInfo SystemInfo,
   IAddonsContext Addons,
   IGodotContext Godot
 ) : IExecutionContext {
-  public ILog CreateLog(ISystemInfo systemInfo, IConsole console) => new Log(systemInfo, console);
-  // public ILog CreateLog(IConsole console, IGodotEnvironment environment) => new Log(console, environment);
+  public ILog CreateLog(IConsole console) => new Log(SystemInfo, console);
 }
diff --git a/GodotEnv/src/common/models/OSFamily.cs b/GodotEnv/src/common/models/OSFamily.cs
@@ -8,5 +8,6 @@ public enum OSFamily {
   Windows = 0,
   /// <summary>Unix.</summary>
   Unix = 1,
+  /// <summary>Unknown.</summary>
   Unknown = 2,
 }
diff --git a/GodotEnv/src/common/utilities/ProcessRunner.cs b/GodotEnv/src/common/utilities/ProcessRunner.cs
@@ -100,8 +100,6 @@ public async Task<ProcessResult> RunElevatedOnWindows(
     // doesn't have admin rights
     bool shouldElevate = !UACHelper.UACHelper.IsElevated;
 
-    // Console.WriteLine($"cmd '{exe}', args '{args}'");
-
     Process process = UACHelper.UACHelper.StartElevated(new ProcessStartInfo() {
       FileName = exe,
       Arguments = args,

diff --git a/GodotEnv/src/common/utilities/SystemInfo.cs b/GodotEnv/src/common/utilities/SystemInfo.cs
@@ -4,6 +4,9 @@ namespace GodotEnv.Common.Utilities;
 using System.Runtime.InteropServices;
 using Chickensoft.GodotEnv.Common.Models;
 
+/// <summary>
+/// Imutable system information (OS, CPU architecture, ...).
+/// </summary>
 public interface ISystemInfo {
   public OSType OS { get; }
 

diff --git a/GodotEnv/src/features/addons/commands/AddonsCommand.cs b/GodotEnv/src/features/addons/commands/AddonsCommand.cs
@@ -15,9 +15,7 @@ public AddonsCommand(IExecutionContext context) {
   }
 
   public ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var output = console.Output;
     log.Print("");
     log.Warn("Please use a subcommand to manage addons.");

diff --git a/GodotEnv/src/features/addons/commands/init/AddonsInitCommand.cs b/GodotEnv/src/features/addons/commands/init/AddonsInitCommand.cs
@@ -22,9 +22,7 @@ public AddonsInitCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var repo = ExecutionContext.Addons.AddonsFileRepo;
 
     log.Print("");

diff --git a/GodotEnv/src/features/addons/commands/install/AddonsInstallCommand.cs b/GodotEnv/src/features/addons/commands/install/AddonsInstallCommand.cs
@@ -41,9 +41,7 @@ public AddonsInstallCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
 
     var addons = ExecutionContext.Addons;
 

diff --git a/GodotEnv/src/features/godot/commands/GodotCommand.cs b/GodotEnv/src/features/godot/commands/GodotCommand.cs
@@ -15,9 +15,7 @@ public GodotCommand(IExecutionContext context) {
   }
 
   public ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var output = console.Output;
     log.Print("");
     log.Warn("Please use a subcommand to manage Godot installations.");

diff --git a/GodotEnv/src/features/godot/commands/GodotListCommand.cs b/GodotEnv/src/features/godot/commands/GodotListCommand.cs
@@ -43,8 +43,7 @@ private static async Task ListRemoteVersions(ILog log, IGodotRepository godotRep
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var godotRepo = ExecutionContext.Godot.GodotRepo;
 
     if (ListRemoteAvailable) {

diff --git a/GodotEnv/src/features/godot/commands/GodotUseCommand.cs b/GodotEnv/src/features/godot/commands/GodotUseCommand.cs
@@ -40,11 +40,10 @@ public GodotUseCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
     var godotRepo = ExecutionContext.Godot.GodotRepo;
     var platform = ExecutionContext.Godot.Platform;
 
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var output = console.Output;
 
     var version = SemanticVersion.Parse(RawVersion);

diff --git a/GodotEnv/src/features/godot/commands/cache/GodotCacheClearCommand.cs b/GodotEnv/src/features/godot/commands/cache/GodotCacheClearCommand.cs
@@ -22,16 +22,15 @@ public GodotCacheClearCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
     var godotRepo = ExecutionContext.Godot.GodotRepo;
     var platform = ExecutionContext.Godot.Platform;
 
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
 
     log.Print("");
     log.Info("Clearing Godot installation cache...");
     log.Print("");
-    ExecutionContext.Godot.GodotRepo.ClearCache();
+    godotRepo.ClearCache();
     log.Success("Godot installation cache cleared.");
     log.Print("");
 

diff --git a/GodotEnv/src/features/godot/commands/cache/GodotCacheCommand.cs b/GodotEnv/src/features/godot/commands/cache/GodotCacheCommand.cs
@@ -19,9 +19,7 @@ public GodotCacheCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
 
     log.Print("");
     log.Warn(

diff --git a/GodotEnv/src/features/godot/commands/env/GodotEnvCommand.cs b/GodotEnv/src/features/godot/commands/env/GodotEnvCommand.cs
@@ -20,9 +20,7 @@ public GodotEnvCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
 
     log.Print("");
     log.Warn(

diff --git a/GodotEnv/src/features/godot/commands/env/GodotEnvGetCommand.cs b/GodotEnv/src/features/godot/commands/env/GodotEnvGetCommand.cs
@@ -19,9 +19,7 @@ public GodotEnvGetCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var godotRepo = ExecutionContext.Godot.GodotRepo;
 
     var godotEnvVar = await godotRepo.GetGodotEnvVariable();

diff --git a/GodotEnv/src/features/godot/commands/env/GodotEnvPathCommand.cs b/GodotEnv/src/features/godot/commands/env/GodotEnvPathCommand.cs
@@ -19,9 +19,7 @@ public GodotEnvPathCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var godotRepo = ExecutionContext.Godot.GodotRepo;
 
     log.Print(godotRepo.GodotSymlinkPath);

diff --git a/GodotEnv/src/features/godot/commands/env/GodotEnvSetupCommand.cs b/GodotEnv/src/features/godot/commands/env/GodotEnvSetupCommand.cs
@@ -22,11 +22,10 @@ public GodotEnvSetupCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
     var godotRepo = ExecutionContext.Godot.GodotRepo;
     var platform = ExecutionContext.Godot.Platform;
 
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     await godotRepo.AddOrUpdateGodotEnvVariable(log);
   }
 }
diff --git a/GodotEnv/src/features/godot/commands/env/GodotEnvTargetCommand.cs b/GodotEnv/src/features/godot/commands/env/GodotEnvTargetCommand.cs
@@ -19,8 +19,7 @@ public GodotEnvTargetCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var godotRepo = ExecutionContext.Godot.GodotRepo;
 
     log.Print(godotRepo.GodotSymlinkTarget);

diff --git a/GodotEnv/src/features/godot/commands/install/GodotInstallCommand.cs b/GodotEnv/src/features/godot/commands/install/GodotInstallCommand.cs
@@ -43,11 +43,10 @@ public GodotInstallCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
     var godotRepo = ExecutionContext.Godot.GodotRepo;
     var platform = ExecutionContext.Godot.Platform;
 
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
     var token = console.RegisterCancellationHandler();
 
     var version = SemanticVersion.Parse(RawVersion);

diff --git a/GodotEnv/src/features/godot/commands/install/GodotUninstallCommand.cs b/GodotEnv/src/features/godot/commands/install/GodotUninstallCommand.cs
@@ -40,11 +40,10 @@ public GodotUninstallCommand(IExecutionContext context) {
   }
 
   public async ValueTask ExecuteAsync(IConsole console) {
-    var systemInfo = ExecutionContext.Godot.Platform.SystemInfo;
     var godotRepo = ExecutionContext.Godot.GodotRepo;
     var platform = ExecutionContext.Godot.Platform;
 
-    var log = ExecutionContext.CreateLog(systemInfo, console);
+    var log = ExecutionContext.CreateLog(console);
 
     var version = SemanticVersion.Parse(RawVersion);
     var isDotnetVersion = !NoDotnet;

diff --git a/GodotEnv/src/features/godot/domain/GodotRepository.cs b/GodotEnv/src/features/godot/domain/GodotRepository.cs
@@ -422,7 +422,6 @@ public async Task UpdateGodotSymlink(
       var godotSharpPath = GetGodotSharpPath(
         installation.Path, installation.Version, installation.IsDotnetVersion
       );
-      // log.Print($"    Linking GodotSharp: {GodotSharpSymlinkPath} -> {godotSharpPath}");
       await FileClient.CreateSymlink(
         GodotSharpSymlinkPath, godotSharpPath
       );