Merge pull request #55 from chickensoft-games/fix/addons-errors

fix: better addons installation error reporting
chickensoft-games · Jan 20, 2024 · ac5597d · ac5597d
2 parents 84d949a + 88c98e8
commit ac5597d
Show file tree

Hide file tree

Showing 8 changed files with 77 additions and 129 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -2,7 +2,7 @@
   "[csharp]": {
     "editor.codeActionsOnSave": {
       "source.addMissingImports": "explicit",
-      "source.fixAll": "never",
+      "source.fixAll": "explicit",
       "source.organizeImports": "explicit"
     },
     "editor.formatOnPaste": true,
@@ -164,4 +164,4 @@
   },
   "dotnet.completion.showCompletionItemsFromUnimportedNamespaces": true,
   "dotnet.defaultSolution": "GodotEnv.sln"
-}
+}
diff --git a/GodotEnv.Tests/src/features/addons/commands/install/AddonsInstallCommandTest.cs b/GodotEnv.Tests/src/features/addons/commands/install/AddonsInstallCommandTest.cs
@@ -85,13 +85,11 @@ public async Task Executes() {
 
     logic.Setup(logic => logic.Bind()).Returns(binding.Object);
 
-    var logicContext = new Mock<AddonsLogic.IContext>();
-
     logic
       .Setup(logic => logic.Input(It.IsAny<AddonsLogic.Input.Install>()))
       .Returns(
         Task.FromResult<AddonsLogic.State>(
-          new AddonsLogic.State.InstallationSucceeded(logicContext.Object)
+          new AddonsLogic.State.InstallationSucceeded()
         )
       );
 
@@ -116,9 +114,8 @@ public void CheckSuccessThrowsOnStateCannotBeResolved() {
     var fileClient = new Mock<IFileClient>();
 
     var command = new AddonsInstallCommand(executionContext.Object);
-    var logicContext = new Mock<AddonsLogic.IContext>();
 
-    var state = new AddonsLogic.State.CannotBeResolved(logicContext.Object);
+    var state = new AddonsLogic.State.CannotBeResolved();
 
     Assert.Throws<CommandException>(
       () => command.CheckSuccess(state)
@@ -131,9 +128,8 @@ public void CheckSuccessThrowsOnStateUnresolved() {
     var fileClient = new Mock<IFileClient>();
 
     var command = new AddonsInstallCommand(executionContext.Object);
-    var logicContext = new Mock<AddonsLogic.IContext>();
 
-    var state = new AddonsLogic.State.Unresolved(logicContext.Object);
+    var state = new AddonsLogic.State.Unresolved();
 
     Assert.Throws<CommandException>(
       () => command.CheckSuccess(state)

diff --git a/...tEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.CannotBeResolvedTest.cs b/...tEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.CannotBeResolvedTest.cs
@@ -1,28 +1,19 @@
 namespace Chickensoft.GodotEnv.Tests;
 
-using Chickensoft.GodotEnv.Common.Utilities;
+using System.Linq;
 using Chickensoft.GodotEnv.Features.Addons.Commands;
-using Moq;
+using Shouldly;
 using Xunit;
 
 public class CannotBeResolvedTest {
   [Fact]
   public void ReportsOnEnter() {
-    var context = new Mock<AddonsLogic.IContext>();
-    var log = new Mock<ILog>();
+    var state = new AddonsLogic.State.CannotBeResolved();
+    var context = state.CreateFakeContext();
 
-    log.Setup(log => log.Err(It.IsAny<string>()));
-    context
-      .Setup(ctx => ctx.Output(It.IsAny<AddonsLogic.Output.Report>()))
-      .Callback<AddonsLogic.Output>(
-        output => ((AddonsLogic.Output.Report)output).Event.Report(log.Object)
-      );
+    state.Enter();
 
-    var state = new AddonsLogic.State.CannotBeResolved(context.Object);
-    var stateTester = AddonsLogic.Test(state);
-
-    stateTester.Enter();
-
-    context.VerifyAll();
+    var output =
+      context.Outputs.Single().ShouldBeOfType<AddonsLogic.Output.Report>();
   }
 }
diff --git a/...Tests/src/features/addons/commands/install/AddonsLogic.State.InstallationSucceededTest.cs b/...Tests/src/features/addons/commands/install/AddonsLogic.State.InstallationSucceededTest.cs
@@ -1,28 +1,18 @@
 namespace Chickensoft.GodotEnv.Tests;
 
-using Chickensoft.GodotEnv.Common.Utilities;
+using System.Linq;
 using Chickensoft.GodotEnv.Features.Addons.Commands;
-using Moq;
+using Shouldly;
 using Xunit;
 
 public class InstallationSucceededTest {
   [Fact]
   public void ReportsOnEnter() {
-    var context = new Mock<AddonsLogic.IContext>();
-    var log = new Mock<ILog>();
+    var state = new AddonsLogic.State.InstallationSucceeded();
+    var context = state.CreateFakeContext();
 
-    log.Setup(log => log.Err(It.IsAny<string>()));
-    context
-      .Setup(ctx => ctx.Output(It.IsAny<AddonsLogic.Output.Report>()))
-      .Callback<AddonsLogic.Output>(
-        output => ((AddonsLogic.Output.Report)output).Event.Report(log.Object)
-      );
+    state.Enter();
 
-    var state = new AddonsLogic.State.InstallationSucceeded(context.Object);
-    var stateTester = AddonsLogic.Test(state);
-
-    stateTester.Enter();
-
-    context.VerifyAll();
+    context.Outputs.Single().ShouldBeOfType<AddonsLogic.Output.Report>();
   }
 }
diff --git a/...tEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.NothingToInstallTest.cs b/...tEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.NothingToInstallTest.cs
@@ -1,28 +1,18 @@
 namespace Chickensoft.GodotEnv.Tests;
 
-using Chickensoft.GodotEnv.Common.Utilities;
+using System.Linq;
 using Chickensoft.GodotEnv.Features.Addons.Commands;
-using Moq;
+using Shouldly;
 using Xunit;
 
 public class NothingToInstallTest {
   [Fact]
   public void ReportsOnEnter() {
-    var context = new Mock<AddonsLogic.IContext>();
-    var log = new Mock<ILog>();
+    var state = new AddonsLogic.State.NothingToInstall();
+    var context = state.CreateFakeContext();
 
-    log.Setup(log => log.Err(It.IsAny<string>()));
-    context
-      .Setup(ctx => ctx.Output(It.IsAny<AddonsLogic.Output.Report>()))
-      .Callback<AddonsLogic.Output>(
-        output => ((AddonsLogic.Output.Report)output).Event.Report(log.Object)
-      );
+    state.Enter();
 
-    var state = new AddonsLogic.State.NothingToInstall(context.Object);
-    var stateTester = AddonsLogic.Test(state);
-
-    stateTester.Enter();
-
-    context.VerifyAll();
+    context.Outputs.Single().ShouldBeOfType<AddonsLogic.Output.Report>();
   }
 }
diff --git a/GodotEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.UnresolvedTest.cs b/GodotEnv.Tests/src/features/addons/commands/install/AddonsLogic.State.UnresolvedTest.cs
@@ -17,8 +17,6 @@ public void CanGoOn() =>
 
   [Fact]
   public async Task DoesNothingIfNothingToInstall() {
-    var context = new Mock<AddonsLogic.IContext>();
-
     var addonsRepo = new Mock<IAddonsRepository>();
     var addonsFileRepo = new Mock<IAddonsFileRepository>();
     var addonGraph = new Mock<IAddonGraph>();
@@ -28,15 +26,6 @@ public async Task DoesNothingIfNothingToInstall() {
       ProjectPath: projectPath, MaxDepth: null
     );
 
-    context.Setup(context => context.Get<IAddonsRepository>())
-      .Returns(addonsRepo.Object);
-
-    context.Setup(context => context.Get<IAddonsFileRepository>())
-      .Returns(addonsFileRepo.Object);
-
-    context.Setup(context => context.Get<IAddonGraph>())
-      .Returns(addonGraph.Object);
-
     var addonsFile = new AddonsFile(
       addons: new() { },
       cacheRelativePath: ".addons",
@@ -50,19 +39,22 @@ public async Task DoesNothingIfNothingToInstall() {
       projectPath, out addonsFilePath
     )).Returns(addonsFile);
 
-    var state = new AddonsLogic.State.Unresolved(context.Object);
+    var state = new AddonsLogic.State.Unresolved();
+    var context = state.CreateFakeContext();
+
+    context.Set(addonsRepo.Object);
+    context.Set(addonsFileRepo.Object);
+    context.Set(addonGraph.Object);
+
     var nextState = await state.On(input);
 
-    context.VerifyAll();
     addonsRepo.VerifyAll();
     addonsFileRepo.VerifyAll();
     addonGraph.VerifyAll();
   }
 
   [Fact]
   public async Task EndsInCannotBeResolvedIfFatalErrorEncountered() {
-    var context = new Mock<AddonsLogic.IContext>();
-
     var addonsRepo = new Mock<IAddonsRepository>();
     var addonsFileRepo = new Mock<IAddonsFileRepository>();
     var addonGraph = new Mock<IAddonGraph>();
@@ -72,15 +64,6 @@ public async Task EndsInCannotBeResolvedIfFatalErrorEncountered() {
       ProjectPath: projectPath, MaxDepth: null
     );
 
-    context.Setup(context => context.Get<IAddonsRepository>())
-      .Returns(addonsRepo.Object);
-
-    context.Setup(context => context.Get<IAddonsFileRepository>())
-      .Returns(addonsFileRepo.Object);
-
-    context.Setup(context => context.Get<IAddonGraph>())
-      .Returns(addonGraph.Object);
-
     var entry = new AddonsFileEntry(
       url: "https://github.com/chickensoft-games/addon"
     );
@@ -112,21 +95,23 @@ public async Task EndsInCannotBeResolvedIfFatalErrorEncountered() {
     addonGraph.Setup(graph => graph.Add(addon))
       .Returns(graphResult);
 
-    var state = new AddonsLogic.State.Unresolved(context.Object);
+    var state = new AddonsLogic.State.Unresolved();
+    var context = state.CreateFakeContext();
+    context.Set(addonsRepo.Object);
+    context.Set(addonsFileRepo.Object);
+    context.Set(addonGraph.Object);
+
     var nextState = await state.On(input);
 
     nextState.ShouldBeOfType<AddonsLogic.State.CannotBeResolved>();
 
-    context.VerifyAll();
     addonsRepo.VerifyAll();
     addonsFileRepo.VerifyAll();
     addonGraph.VerifyAll();
   }
 
   [Fact]
   public async Task DeterminesCanonicalAddonCorrectly() {
-    var context = new Mock<AddonsLogic.IContext>();
-
     var addonsRepo = new Mock<IAddonsRepository>();
     var addonsFileRepo = new Mock<IAddonsFileRepository>();
     var addonGraph = new Mock<IAddonGraph>();
@@ -136,15 +121,6 @@ public async Task DeterminesCanonicalAddonCorrectly() {
       ProjectPath: projectPath, MaxDepth: null
     );
 
-    context.Setup(context => context.Get<IAddonsRepository>())
-      .Returns(addonsRepo.Object);
-
-    context.Setup(context => context.Get<IAddonsFileRepository>())
-      .Returns(addonsFileRepo.Object);
-
-    context.Setup(context => context.Get<IAddonGraph>())
-      .Returns(addonGraph.Object);
-
     var entry = new AddonsFileEntry(
       url: "https://github.com/chickensoft-games/addon"
     );
@@ -213,21 +189,24 @@ public async Task DeterminesCanonicalAddonCorrectly() {
       ))
       .Returns(otherAddonAddonsFile);
 
-    var state = new AddonsLogic.State.Unresolved(context.Object);
+    var state = new AddonsLogic.State.Unresolved();
+
+    var context = state.CreateFakeContext();
+    context.Set(addonsRepo.Object);
+    context.Set(addonsFileRepo.Object);
+    context.Set(addonGraph.Object);
+
     var nextState = await state.On(input);
 
     nextState.ShouldBeOfType<AddonsLogic.State.InstallationSucceeded>();
 
-    context.VerifyAll();
     addonsRepo.VerifyAll();
     addonsFileRepo.VerifyAll();
     addonGraph.VerifyAll();
   }
 
   [Fact]
   public async Task InstallsSymlinkAddon() {
-    var context = new Mock<AddonsLogic.IContext>();
-
     var addonsRepo = new Mock<IAddonsRepository>();
     var addonsFileRepo = new Mock<IAddonsFileRepository>();
     var addonGraph = new Mock<IAddonGraph>();
@@ -237,15 +216,6 @@ public async Task InstallsSymlinkAddon() {
       ProjectPath: projectPath, MaxDepth: null
     );
 
-    context.Setup(context => context.Get<IAddonsRepository>())
-      .Returns(addonsRepo.Object);
-
-    context.Setup(context => context.Get<IAddonsFileRepository>())
-      .Returns(addonsFileRepo.Object);
-
-    context.Setup(context => context.Get<IAddonGraph>())
-      .Returns(addonGraph.Object);
-
     var entry = new AddonsFileEntry(
       url: "/symlink_addon/addon",
       source: AssetSource.Symlink
@@ -297,12 +267,16 @@ public async Task InstallsSymlinkAddon() {
     addonsRepo
       .Setup(repo => repo.InstallAddonWithSymlink(It.IsAny<IAddon>()));
 
-    var state = new AddonsLogic.State.Unresolved(context.Object);
+    var state = new AddonsLogic.State.Unresolved();
+    var context = state.CreateFakeContext();
+    context.Set(addonsRepo.Object);
+    context.Set(addonsFileRepo.Object);
+    context.Set(addonGraph.Object);
+
     var nextState = await state.On(input);
 
     nextState.ShouldBeOfType<AddonsLogic.State.InstallationSucceeded>();
 
-    context.VerifyAll();
     addonsRepo.VerifyAll();
     addonsFileRepo.VerifyAll();
     addonGraph.VerifyAll();

diff --git a/GodotEnv/Chickensoft.GodotEnv.csproj b/GodotEnv/Chickensoft.GodotEnv.csproj
@@ -42,8 +42,8 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Chickensoft.LogicBlocks" Version="2.4.0" />
-    <PackageReference Include="Chickensoft.LogicBlocks.Generator" Version="2.4.0" />
+    <PackageReference Include="Chickensoft.LogicBlocks" Version="4.2.1" />
+    <PackageReference Include="Chickensoft.LogicBlocks.Generator" Version="4.2.1" />
     <PackageReference Include="CliFx" Version="2.3.4" />
     <PackageReference Include="Downloader" Version="3.0.6" />
     <PackageReference Include="Humanizer" Version="2.14.1" />