refactor(api)!: adjust environment-specific settings and test mocks

nanotaboada · Apr 19, 2024 · 471dc0e · 471dc0e
1 parent ae9e11c
commit 471dc0e
Show file tree

Hide file tree

Showing 9 changed files with 86 additions and 73 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -2,34 +2,31 @@
     "version": "0.2.0",
     "configurations": [
         {
-            // Use IntelliSense to find out which attributes exist for C# debugging
-            // Use hover for the description of the existing attributes
-            // For further information visit https://github.com/dotnet/vscode-csharp/blob/main/debugger-launchjson.md.
-            "name": ".NET Core Launch (web)",
+            "name": "Debug: ASP.NET Core (Swagger)",
             "type": "coreclr",
             "request": "launch",
             "preLaunchTask": "build",
-            // If you have changed target frameworks, make sure to update the program path.
-            "program": "${workspaceFolder}/bin/Debug/net7.0/Dotnet.Samples.AspNetCore.WebApi.dll",
-            "args": [],
-            "cwd": "${workspaceFolder}",
-            "stopAtEntry": false,
-            // Enable launching a web browser when ASP.NET Core starts. For more information: https://aka.ms/VSCode-CS-LaunchJson-WebBrowser
+            "program": "${workspaceFolder}/Dotnet.Samples.AspNetCore.WebApi/bin/Debug/net8.0/Dotnet.Samples.AspNetCore.WebApi.dll",
             "serverReadyAction": {
                 "action": "openExternally",
-                "pattern": "\\bNow listening on:\\s+(https?://\\S+)"
+                "pattern": "\\bNow listening on:\\s+https://localhost:([0-9]+)",
+                "uriFormat": "https://localhost:%s/swagger"
             },
             "env": {
-                "ASPNETCORE_ENVIRONMENT": "Development"
+                "ASPNETCORE_ENVIRONMENT": "Development",
+                "ASPNETCORE_URLS": "https://localhost:9000",
+                "ASPNETCORE_DETAILEDERRORS": "1",
+                "ASPNETCORE_SHUTDOWNTIMEOUTSECONDS": "3"
             },
             "sourceFileMap": {
                 "/Views": "${workspaceFolder}/Views"
             }
         },
         {
-            "name": ".NET Core Attach",
+            "name": "Attach: ASP.NET Core",
             "type": "coreclr",
-            "request": "attach"
+            "request": "attach",
+            "processId": "${command:pickProcess}"
         }
     ]
 }
diff --git a/Dotnet.Samples.AspNetCore.WebApi.Tests/PlayerControllerTests.cs b/Dotnet.Samples.AspNetCore.WebApi.Tests/PlayerControllerTests.cs
@@ -24,7 +24,7 @@ public async Task GivenPostAsync_WhenModelStateIsInvalid_ThenResponseStatusCodeS
         var service = new Mock<IPlayerService>();
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
         controller.ModelState.Merge(PlayerStubs.CreateModelError("FirstName", "Required"));
 
         // Act
@@ -46,7 +46,7 @@ public async Task GivenPostAsync_WhenServiceRetrieveByIdAsyncReturnsPlayer_ThenR
         service.Setup(service => service.RetrieveByIdAsync(It.IsAny<long>())).ReturnsAsync(player);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.PostAsync(player);
@@ -72,9 +72,9 @@ public async Task GivenPostAsync_WhenServiceRetrieveByIdAsyncReturnsNull_ThenRes
         service.Setup(service => service.CreateAsync(It.IsAny<Player>()));
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger)
+        var controller = new PlayersController(service.Object, logger.Object)
         {
-            Url = PlayerMocks.UrlHelperMock()
+            Url = PlayerMocks.UrlHelperMock().Object,
         };
 
         // Act
@@ -102,7 +102,7 @@ public async Task GivenGetAsync_WhenServiceRetrieveAsyncReturnsListOfPlayers_The
         service.Setup(service => service.RetrieveAsync()).ReturnsAsync(players);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.GetAsync();
@@ -126,7 +126,7 @@ public async Task GivenGetAsync_WhenServiceRetrieveAsyncReturnsEmptyList_ThenRes
         service.Setup(service => service.RetrieveAsync()).ReturnsAsync(players);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.GetAsync();
@@ -149,7 +149,7 @@ public async Task GivenGetByIdAsync_WhenServiceRetrieveByIdAsyncReturnsNull_Then
             .ReturnsAsync(null as Player);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.GetByIdAsync(It.IsAny<long>());
@@ -171,7 +171,7 @@ public async Task GivenGetByIdAsync_WhenServiceRetrieveByIdAsyncReturnsPlayer_Th
         service.Setup(service => service.RetrieveByIdAsync(It.IsAny<long>())).ReturnsAsync(player);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.GetByIdAsync(It.IsAny<long>());
@@ -197,7 +197,7 @@ public async Task GivenPutAsync_WhenModelStateIsInvalid_ThenResponseStatusCodeSh
         var service = new Mock<IPlayerService>();
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
         controller.ModelState.Merge(PlayerStubs.CreateModelError("FirstName", "Required"));
 
         // Act
@@ -220,7 +220,7 @@ public async Task GivenPutAsync_WhenServiceRetrieveByIdAsyncReturnsNull_ThenResp
             .ReturnsAsync(null as Player);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.PutAsync(It.IsAny<long>(), It.IsAny<Player>());
@@ -244,7 +244,7 @@ public async Task GivenPutAsync_WhenServiceRetrieveByIdAsyncReturnsPlayer_ThenRe
         service.Setup(service => service.UpdateAsync(It.IsAny<Player>()));
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.PutAsync(id, player);
@@ -272,7 +272,7 @@ public async Task GivenDeleteAsync_WhenServiceRetrieveByIdAsyncReturnsNull_ThenR
             .ReturnsAsync(null as Player);
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.DeleteAsync(It.IsAny<long>());
@@ -295,7 +295,7 @@ public async Task GivenDeleteAsync_WhenServiceRetrieveByIdAsyncReturnsPlayer_The
         service.Setup(service => service.DeleteAsync(It.IsAny<long>()));
         var logger = PlayerMocks.LoggerMock<PlayersController>();
 
-        var controller = new PlayersController(service.Object, logger);
+        var controller = new PlayersController(service.Object, logger.Object);
 
         // Act
         var result = await controller.DeleteAsync(It.IsAny<long>());

diff --git a/Dotnet.Samples.AspNetCore.WebApi.Tests/PlayerServiceTests.cs b/Dotnet.Samples.AspNetCore.WebApi.Tests/PlayerServiceTests.cs
@@ -21,6 +21,7 @@ public PlayerServiceTests()
         _context = PlayerStubs.CreateContext(_dbContextOptions);
         PlayerStubs.CreateTable(_context);
         PlayerStubs.SeedContext(_context);
+        Environment.SetEnvironmentVariable("ASPNETCORE_ENVIRONMENT", "Development");
     }
 
     public void Dispose()
@@ -31,52 +32,62 @@ public void Dispose()
     }
 
     [Fact]
-    [Trait("Category", "Retrieve")]
+    [Trait("Category", "RetrieveAsync")]
     public async Task GivenRetrieveAsync_WhenInvoked_ThenShouldReturnAllPlayers()
     {
         // Arrange
-        var players = PlayerDataBuilder.SeedWithDeserializedJson();
+        var players = PlayerDataBuilder.SeedWithStarting11();
         var logger = PlayerMocks.LoggerMock<PlayerService>();
         var memoryCache = PlayerMocks.MemoryCacheMock(It.IsAny<object>());
+        var value = It.IsAny<object>();
 
-        var service = new PlayerService(_context, logger, memoryCache);
+        var service = new PlayerService(_context, logger.Object, memoryCache.Object);
 
         // Act
         var result = await service.RetrieveAsync();
 
         // Assert
+        memoryCache.Verify(
+            cache => cache.TryGetValue(It.IsAny<object>(), out value),
+            Times.Exactly(1)
+        );
         result.Should().BeEquivalentTo(players);
     }
 
     [Fact]
-    [Trait("Category", "Retrieve")]
+    [Trait("Category", "RetrieveAsync")]
     public async Task GivenRetrieveAsync_WhenInvokedTwice_ThenSecondExecutionTimeShouldBeLessThanFirst()
     {
         // Arrange
-        var players = PlayerDataBuilder.SeedWithDeserializedJson();
+        var players = PlayerDataBuilder.SeedWithStarting11();
         var logger = PlayerMocks.LoggerMock<PlayerService>();
         var memoryCache = PlayerMocks.MemoryCacheMock(players);
+        var value = It.IsAny<object>();
 
-        var service = new PlayerService(_context, logger, memoryCache);
+        var service = new PlayerService(_context, logger.Object, memoryCache.Object);
 
         // Act
         var first = await ExecutionTimeAsync(() => service.RetrieveAsync());
         var second = await ExecutionTimeAsync(() => service.RetrieveAsync());
 
         // Assert
+        memoryCache.Verify(
+            cache => cache.TryGetValue(It.IsAny<object>(), out value),
+            Times.Exactly(2) // first + second
+        );
         second.Should().BeLessThan(first);
     }
 
     [Fact]
-    [Trait("Category", "Retrieve")]
+    [Trait("Category", "RetrieveByIdAsync")]
     public async Task GivenRetrieveByIdAsync_WhenInvokedWithPlayerId_ThenShouldReturnThePlayer()
     {
         // Arrange
         var player = PlayerDataBuilder.SeedOneById(10);
         var logger = PlayerMocks.LoggerMock<PlayerService>();
         var memoryCache = PlayerMocks.MemoryCacheMock(It.IsAny<object>());
 
-        var service = new PlayerService(_context, logger, memoryCache);
+        var service = new PlayerService(_context, logger.Object, memoryCache.Object);
 
         // Act
         var result = await service.RetrieveByIdAsync(10);

diff --git a/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs b/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerMocks.cs
@@ -1,43 +1,44 @@
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Routing;
 using Microsoft.Extensions.Caching.Memory;
+using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
 using Moq;
 
 namespace Dotnet.Samples.AspNetCore.WebApi.Tests
 {
     public static class PlayerMocks
     {
-        public static ILogger<T> LoggerMock<T>()
+        public static Mock<ILogger<T>> LoggerMock<T>()
             where T : class
         {
-            var mock = new Mock<ILogger<T>>();
-
-            return mock.Object;
+            return new Mock<ILogger<T>>();
         }
 
-        public static IMemoryCache MemoryCacheMock(object? value)
+        public static Mock<IMemoryCache> MemoryCacheMock(object? value)
         {
             var fromCache = false;
             var mock = new Mock<IMemoryCache>();
-            mock.Setup(x => x.TryGetValue(It.IsAny<object>(), out value))
+            mock.Setup(cache => cache.TryGetValue(It.IsAny<object>(), out value))
                 .Returns(() =>
                 {
                     bool hasValue = fromCache;
                     fromCache = true; // Subsequent invocations will return true
                     return hasValue;
                 });
-            mock.Setup(x => x.CreateEntry(It.IsAny<object>())).Returns(Mock.Of<ICacheEntry>);
+            mock.Setup(cache => cache.CreateEntry(It.IsAny<object>()))
+                .Returns(Mock.Of<ICacheEntry>);
+            mock.Setup(cache => cache.Remove(It.IsAny<object>()));
 
-            return mock.Object;
+            return mock;
         }
 
-        public static IUrlHelper UrlHelperMock()
+        public static Mock<IUrlHelper> UrlHelperMock()
         {
             var mock = new Mock<IUrlHelper>();
-            mock.Setup(u => u.Action(It.IsAny<UrlActionContext>())).Returns(It.IsAny<string>());
+            mock.Setup(url => url.Action(It.IsAny<UrlActionContext>())).Returns(It.IsAny<string>());
 
-            return mock.Object;
+            return mock;
         }
     }
 }
diff --git a/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerStubs.cs b/Dotnet.Samples.AspNetCore.WebApi.Tests/Utilities/PlayerStubs.cs
@@ -54,7 +54,7 @@ public static PlayerContext CreateContext(DbContextOptions<PlayerContext> dbCont
 
         public static void SeedContext(PlayerContext context)
         {
-            context.AddRange(PlayerDataBuilder.SeedWithDeserializedJson());
+            context.AddRange(PlayerDataBuilder.SeedWithStarting11());
             context.SaveChanges();
         }
 

diff --git a/Dotnet.Samples.AspNetCore.WebApi/Data/players-sqlite3.db b/Dotnet.Samples.AspNetCore.WebApi/Data/players-sqlite3.db
diff --git a/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj b/Dotnet.Samples.AspNetCore.WebApi/Dotnet.Samples.AspNetCore.WebApi.csproj
@@ -20,7 +20,10 @@
   </ItemGroup>
 
   <ItemGroup>
-    <Folder Include="Controllers/" />
+    <Content Include="Data/players-sqlite3.db">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+      <PackageCopyToOutput>true</PackageCopyToOutput>
+    </Content>
   </ItemGroup>
 
 </Project>
diff --git a/Dotnet.Samples.AspNetCore.WebApi/Program.cs b/Dotnet.Samples.AspNetCore.WebApi/Program.cs
@@ -12,8 +12,11 @@
 
 builder.Services.AddControllers();
 
+var dataSource =
+    $"{AppDomain.CurrentDomain.SetupInformation.ApplicationBase}/Data/players-sqlite3.db";
+
 builder.Services.AddDbContext<PlayerContext>(options =>
-    options.UseSqlite(@"Data Source=Data/players-sqlite3.db")
+    options.UseSqlite($"Data Source={dataSource}")
 );
 
 // Learn more about configuring Swagger/OpenAPI at https://aka.ms/aspnetcore/swashbuckle