Added tests for Registering the Product

oskardudycz · oskardudycz · commit d83bc9a638d3 · 2021-05-15T09:48:44.000+02:00
diff --git a/Sample/Warehouse/Warehouse.Api.Tests/Products/RegisteringProduct/RegisterProductTests.cs b/Sample/Warehouse/Warehouse.Api.Tests/Products/RegisteringProduct/RegisterProductTests.cs
@@ -1,6 +1,5 @@
 ﻿using System;
 using System.Net;
-using System.Net.Http;
 using System.Threading.Tasks;
 using Core.Testing;
 using FluentAssertions;
@@ -29,22 +28,68 @@ public RegisterProductTests(RegisterProductFixture fixture)
                 this.fixture = fixture;
             }
 
-            [Fact]
-            public async Task ValidRequest_ShouldReturn_OK()
+            [Theory]
+            [MemberData(nameof(ValidRequests))]
+            public async Task ValidRequest_ShouldReturn_201(RegisterProductRequest validRequest)
             {
                 // Given
-                const string sku = "test";
-                const string name = "test";
-                const string description = "test";
-                var request = new RegisterProductRequest(sku, name, description);
 
                 // When
-                var response = await fixture.Post(request);
+                var response = await fixture.Post(validRequest);
+
+                // Then
+                response.EnsureSuccessStatusCode()
+                    .StatusCode.Should().Be(HttpStatusCode.Created);
+
+                var createdId = await response.GetResultFromJson<Guid>();
+                createdId.Should().NotBeEmpty();
+            }
+
+            [Theory]
+            [MemberData(nameof(InvalidRequests))]
+            public async Task InvalidRequest_ShouldReturn_400(RegisterProductRequest invalidRequest)
+            {
+                // Given
+
+                // When
+                var response = await fixture.Post(invalidRequest);
 
                 // Then
-                response.EnsureSuccessStatusCode();
+                response.StatusCode.Should().Be(HttpStatusCode.BadRequest);
+            }
+
+            [Fact]
+            public async Task RequestForExistingSKUShouldFail_ShouldReturn_409()
+            {
+                // Given
+                var request = new RegisterProductRequest("AA2039485", ValidName, ValidDescription);
+
+                var response = await fixture.Post(request);
                 response.StatusCode.Should().Be(HttpStatusCode.Created);
+
+                // When
+                response = await fixture.Post(request);
+
+                // Then
+                response.StatusCode.Should().Be(HttpStatusCode.Conflict);
             }
+
+            private const string ValidName = "VALID_NAME";
+            private static string ValidSKU => $"CC{DateTime.Now.Ticks}";
+            private const string ValidDescription = "VALID_DESCRIPTION";
+
+            public static TheoryData<RegisterProductRequest> ValidRequests = new ()
+            {
+                new RegisterProductRequest(ValidSKU, ValidName, ValidDescription),
+                new RegisterProductRequest(ValidSKU, ValidName, null)
+            };
+
+            public static TheoryData<RegisterProductRequest> InvalidRequests = new()
+            {
+                new RegisterProductRequest(null, ValidName, ValidDescription),
+                new RegisterProductRequest("INVALID_SKU", ValidName, ValidDescription),
+                new RegisterProductRequest(ValidSKU, null, ValidDescription),
+            };
         }
     }
 }
diff --git a/Sample/Warehouse/Warehouse.Api.Tests/Warehouse.Api.Tests.csproj b/Sample/Warehouse/Warehouse.Api.Tests/Warehouse.Api.Tests.csproj
@@ -33,7 +33,8 @@
     </ItemGroup>
 
     <ItemGroup>
-      <Folder Include="Products" />
+      <Folder Include="Products\GettingProductDetails" />
+      <Folder Include="Products\GettingProducts" />
     </ItemGroup>
 
     <ItemGroup>
diff --git a/Sample/Warehouse/Warehouse.Api.Tests/WarehouseTestWebHostBuilder.cs b/Sample/Warehouse/Warehouse.Api.Tests/WarehouseTestWebHostBuilder.cs
@@ -1,4 +1,5 @@
-﻿using Microsoft.AspNetCore.Builder;
+﻿using Core.WebApi.Middlewares.ExceptionHandling;
+using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
@@ -13,23 +14,23 @@ public static IWebHostBuilder Configure(IWebHostBuilder webHostBuilder)
             webHostBuilder
                 .ConfigureServices(services =>
                 {
-                    services.AddMvcCore()
+                    services.AddRouting()
                         .AddAuthorization()
                         .AddCors()
-                        .AddDataAnnotations()
-                        .AddFormatterMappings();
-
-                    services.AddWarehouseServices();
+                        .AddWarehouseServices();
                 })
                 .Configure(app =>
                 {
                     app.UseHttpsRedirection()
+                        .UseMiddleware(typeof(ExceptionHandlingMiddleware))
                         .UseRouting()
                         .UseAuthorization()
                         .UseEndpoints(endpoints => { endpoints.UseWarehouseEndpoints(); });
 
                     // Kids, do not try this at home!
-                    app.ApplicationServices.GetRequiredService<WarehouseDBContext>().Database.Migrate();
+                    var database = app.ApplicationServices.GetRequiredService<WarehouseDBContext>().Database;
+                    database.Migrate();
+                    database.ExecuteSqlRaw("TRUNCATE TABLE \"Product\"");
                 });
 
             return webHostBuilder;
diff --git a/Sample/Warehouse/Warehouse.Api/Program.cs b/Sample/Warehouse/Warehouse.Api/Program.cs
@@ -1,8 +1,8 @@
+using Core.WebApi.Middlewares.ExceptionHandling;
 using Microsoft.AspNetCore.Builder;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
-using Microsoft.OpenApi.Models;
 using Warehouse;
 
 var builder = Host.CreateDefaultBuilder(args)
@@ -11,25 +11,15 @@
         webBuilder
             .ConfigureServices(services =>
             {
-                services.AddMvcCore()
-                    .AddApiExplorer()
-                    .AddAuthorization()
+                services.AddRouting()
                     .AddCors()
-                    .AddDataAnnotations()
-                    .AddFormatterMappings();
-
-                services
-                    .AddWarehouseServices()
-                    .AddSwaggerGen(c =>
-                    {
-                        c.SwaggerDoc("v1", new OpenApiInfo {Title = "Warehouse.Api", Version = "v1"});
-                    });
+                    .AddAuthorization()
+                    .AddWarehouseServices();
             })
             .Configure(app =>
             {
-                app.UseSwagger()
-                    .UseSwaggerUI(c => c.SwaggerEndpoint("/swagger/v1/swagger.json", "CashRegisters.Api v1"))
-                    .UseHttpsRedirection()
+                app.UseHttpsRedirection()
+                    .UseMiddleware(typeof(ExceptionHandlingMiddleware))
                     .UseRouting()
                     .UseAuthorization()
                     .UseEndpoints(endpoints =>
diff --git a/Sample/Warehouse/Warehouse.Api/Warehouse.Api.csproj b/Sample/Warehouse/Warehouse.Api/Warehouse.Api.csproj
@@ -17,6 +17,7 @@
     </ItemGroup>
 
     <ItemGroup>
+      <ProjectReference Include="..\..\..\Core.WebApi\Core.WebApi.csproj" />
       <ProjectReference Include="..\Warehouse\Warehouse.csproj" />
     </ItemGroup>
 
diff --git a/Sample/Warehouse/Warehouse.sln b/Sample/Warehouse/Warehouse.sln
@@ -12,6 +12,8 @@ Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Warehouse.Api", "Warehouse.
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Warehouse.Api.Tests", "Warehouse.Api.Tests\Warehouse.Api.Tests.csproj", "{6E5C1CF1-29FF-408E-9E01-E7109FB2ECA0}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Core.WebApi", "..\..\Core.WebApi\Core.WebApi.csproj", "{A7A09EBA-0B66-4402-A063-69B47D43A66D}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -20,6 +22,7 @@ Global
 	GlobalSection(NestedProjects) = preSolution
 		{DD7FF547-0FF1-4B10-9248-1E2700BA3770} = {F6A27B3D-4018-4E66-A008-3E1280C8C685}
 		{35632837-CB02-455C-9570-E79E476C1D90} = {F6A27B3D-4018-4E66-A008-3E1280C8C685}
+		{A7A09EBA-0B66-4402-A063-69B47D43A66D} = {F6A27B3D-4018-4E66-A008-3E1280C8C685}
 	EndGlobalSection
 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
 		{DD7FF547-0FF1-4B10-9248-1E2700BA3770}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
@@ -42,5 +45,9 @@ Global
 		{6E5C1CF1-29FF-408E-9E01-E7109FB2ECA0}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{6E5C1CF1-29FF-408E-9E01-E7109FB2ECA0}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{6E5C1CF1-29FF-408E-9E01-E7109FB2ECA0}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A7A09EBA-0B66-4402-A063-69B47D43A66D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A7A09EBA-0B66-4402-A063-69B47D43A66D}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A7A09EBA-0B66-4402-A063-69B47D43A66D}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A7A09EBA-0B66-4402-A063-69B47D43A66D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 EndGlobal
diff --git a/Sample/Warehouse/Warehouse/Core/Extensions/HttpExtensions.cs b/Sample/Warehouse/Warehouse/Core/Extensions/HttpExtensions.cs
@@ -43,7 +43,7 @@ public static async Task ReturnJSON<T>(this HttpContext context, T result, HttpS
         {
             context.Response.StatusCode = (int)statusCode;
 
-            if (result != null)
+            if (result == null)
                 return;
 
             await context.Response.WriteAsJsonAsync(result);
diff --git a/Sample/Warehouse/Warehouse/Products/GettingProducts/GetProducts.cs b/Sample/Warehouse/Warehouse/Products/GettingProducts/GetProducts.cs
@@ -58,7 +58,7 @@ public static GetProducts Create(string? filter, int? page)
             if (page <= 0)
                 throw new ArgumentOutOfRangeException(nameof(page));
 
-            return new GetProducts(filter, page.Value);
+            return new (filter, page.Value);
         }
 
         public void Deconstruct(out string? filter, out int page)
diff --git a/Sample/Warehouse/Warehouse/Products/Primitives/SKU.cs b/Sample/Warehouse/Warehouse/Products/Primitives/SKU.cs
@@ -16,7 +16,7 @@ public static SKU Create(string? value)
         {
             if (value == null)
                 throw new ArgumentNullException(nameof(SKU));
-            if (string.IsNullOrWhiteSpace(value) || Regex.IsMatch(value, "[A-Z]{2,4}[0-9]{4,12}"))
+            if (string.IsNullOrWhiteSpace(value) || !Regex.IsMatch(value, "[A-Z]{2,4}[0-9]{4,18}"))
                 throw new ArgumentOutOfRangeException(nameof(SKU));
 
             return new SKU(value);
diff --git a/Sample/Warehouse/Warehouse/Products/Product.cs b/Sample/Warehouse/Warehouse/Products/Product.cs
@@ -23,6 +23,9 @@ internal class Product
         /// </summary>
         public string? Description { get; set; }
 
+        // Note: this is needed because we're using SKU DTO.
+        // It would work if we had just primitives
+        // Should be fixed in .NET 6
         private Product(){}
 
         public Product(Guid id, SKU sku, string name, string? description)
diff --git a/Sample/Warehouse/Warehouse/Products/RegisteringProduct/RegisterProduct.cs b/Sample/Warehouse/Warehouse/Products/RegisteringProduct/RegisterProduct.cs
@@ -30,8 +30,7 @@ public async ValueTask Handle(RegisterProduct command, CancellationToken ct)
             );
 
             if (await productWithSKUExists(command.SKU, ct))
-                throw new ArgumentOutOfRangeException(
-                    nameof(command.SKU),
+                throw new InvalidOperationException(
                     $"Product with SKU `{command.SKU} already exists.");
 
             await addProduct(product, ct);
@@ -42,20 +41,10 @@ public record RegisterProduct
     {
         public Guid ProductId { get;}
 
-        /// <summary>
-        /// The Stock Keeping Unit (SKU), i.e. a merchant-specific identifier for a product or service, or the product to which the offer refers.
-        /// </summary>
-        /// <returns></returns>
         public SKU SKU { get; }
 
-        /// <summary>
-        /// The area where a cashier works
-        /// </summary>
         public string Name { get; }
 
-        /// <summary>
-        /// Current cashier working on the cash register
-        /// </summary>
         public string? Description { get; }
 
         private RegisterProduct(Guid productId, SKU sku, string name, string? description)
@@ -70,7 +59,6 @@ public static RegisterProduct Create(Guid? id, string? sku, string? name, string
         {
             if (!id.HasValue) throw new ArgumentNullException(nameof(id));
             if (name == null) throw new ArgumentNullException(nameof(name));
-            if (description == null) throw new ArgumentNullException(nameof(description));
 
             return new RegisterProduct(id.Value, SKU.Create(sku), name, description);
         }
diff --git a/Sample/Warehouse/Warehouse/Products/RegisteringProduct/Route.cs b/Sample/Warehouse/Warehouse/Products/RegisteringProduct/Route.cs
@@ -1,6 +1,5 @@
 ﻿using System;
 using Microsoft.AspNetCore.Builder;
-using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Routing;
 using Warehouse.Core.Commands;
 using Warehouse.Core.Extensions;
@@ -19,13 +18,6 @@ internal static IEndpointRouteBuilder UseRegisterProductEndpoint(this IEndpointR
         {
             endpoints.MapPost("api/products/", async context =>
             {
-                // var dbContext = WarehouseDBContextFactory.Create();
-                //
-                // var handler = new HandleRegisterProduct(
-                //     dbContext.AddAndSave,
-                //     dbContext.ProductWithSKUExists
-                // );
-
                 var (sku, name, description) = await context.FromBody<RegisterProductRequest>();
                 var productId = Guid.NewGuid();
 

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public static async Task ReturnJSON<T>(this HttpContext context, T result, HttpS`
`43`	`43`	`{`
`44`	`44`	`context.Response.StatusCode = (int)statusCode;`
`45`	`45`
`46`		`- if (result != null)`
	`46`	`+ if (result == null)`
`47`	`47`	`return;`
`48`	`48`
`49`	`49`	`await context.Response.WriteAsJsonAsync(result);`
Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public static GetProducts Create(string? filter, int? page)`
`58`	`58`	`if (page <= 0)`
`59`	`59`	`throw new ArgumentOutOfRangeException(nameof(page));`
`60`	`60`
`61`		`- return new GetProducts(filter, page.Value);`
	`61`	`+ return new (filter, page.Value);`
`62`	`62`	`}`
`63`	`63`
`64`	`64`	`public void Deconstruct(out string? filter, out int page)`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ public static SKU Create(string? value)`
`16`	`16`	`{`
`17`	`17`	`if (value == null)`
`18`	`18`	`throw new ArgumentNullException(nameof(SKU));`
`19`		`- if (string.IsNullOrWhiteSpace(value) \|\| Regex.IsMatch(value, "[A-Z]{2,4}[0-9]{4,12}"))`
	`19`	`+ if (string.IsNullOrWhiteSpace(value) \|\| !Regex.IsMatch(value, "[A-Z]{2,4}[0-9]{4,18}"))`
`20`	`20`	`throw new ArgumentOutOfRangeException(nameof(SKU));`
`21`	`21`
`22`	`22`	`return new SKU(value);`