Jsmith/commands (#1)

Incorporate mediator, command broker.

Author: jesmith026

EventDriven.CQRS.sln

@@ -12,31 +12,31 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{AF357BE9-9A6
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "EventDriven.CQRS.Abstractions", "src\EventDriven.CQRS.Abstractions\EventDriven.CQRS.Abstractions.csproj", "{1F665C29-BF1C-45BA-8CB9-829E85C34999}"
 EndProject
-Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "test", "test", "{269CD137-4093-4100-B33E-808586D335F6}"
-EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "reference-architecture", "reference-architecture", "{C4FD0AF1-927A-4860-A634-7CE342807692}"
 EndProject
-Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "EventDriven.CQRS.Tests", "test\EventDriven.CQRS.Tests\EventDriven.CQRS.Tests.csproj", "{9809006C-2F6B-44A1-8AE2-BC449368D209}"
-EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CustomerService", "reference-architecture\CustomerService\CustomerService.csproj", "{48983715-E6DF-462F-AF3C-769C1122794F}"
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrderService", "reference-architecture\OrderService\OrderService.csproj", "{16A5B2CB-8C46-4F3E-B7A1-97C47D9F66E7}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "json", "json", "{B11B21E0-7B89-4285-990A-D98793310B02}"
-ProjectSection(SolutionItems) = preProject
-	reference-architecture\json\customers.json = reference-architecture\json\customers.json
-	reference-architecture\json\orders.json = reference-architecture\json\orders.json
-EndProjectSection
+	ProjectSection(SolutionItems) = preProject
+		reference-architecture\json\customers.json = reference-architecture\json\customers.json
+		reference-architecture\json\orders.json = reference-architecture\json\orders.json
+	EndProjectSection
 EndProject
 Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Common", "reference-architecture\Common\Common.csproj", "{FC04D111-903D-49FF-84A6-8806C71E2168}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "dapr", "dapr", "{F0E48E00-7D72-4614-9C13-90A7B015B06F}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "components", "components", "{00BA9501-787E-465C-97D0-F51295D97802}"
-ProjectSection(SolutionItems) = preProject
-	reference-architecture\dapr\components\pubsub.yaml = reference-architecture\dapr\components\pubsub.yaml
-	reference-architecture\dapr\components\snssqs-pubsub.yaml = reference-architecture\dapr\components\snssqs-pubsub.yaml
-EndProjectSection
+	ProjectSection(SolutionItems) = preProject
+		reference-architecture\dapr\components\pubsub.yaml = reference-architecture\dapr\components\pubsub.yaml
+		reference-architecture\dapr\components\snssqs-pubsub.yaml = reference-architecture\dapr\components\snssqs-pubsub.yaml
+	EndProjectSection
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "CustomerService.Tests", "reference-architecture\CustomerService.Tests\CustomerService.Tests.csproj", "{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8}"
+EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OrderService.Tests", "reference-architecture\OrderService.Tests\OrderService.Tests.csproj", "{A7D3F069-598D-435D-8B33-522767AACB76}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -48,10 +48,6 @@ Global
 		{1F665C29-BF1C-45BA-8CB9-829E85C34999}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{1F665C29-BF1C-45BA-8CB9-829E85C34999}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{1F665C29-BF1C-45BA-8CB9-829E85C34999}.Release|Any CPU.Build.0 = Release|Any CPU
-		{9809006C-2F6B-44A1-8AE2-BC449368D209}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{9809006C-2F6B-44A1-8AE2-BC449368D209}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{9809006C-2F6B-44A1-8AE2-BC449368D209}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{9809006C-2F6B-44A1-8AE2-BC449368D209}.Release|Any CPU.Build.0 = Release|Any CPU
 		{48983715-E6DF-462F-AF3C-769C1122794F}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{48983715-E6DF-462F-AF3C-769C1122794F}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{48983715-E6DF-462F-AF3C-769C1122794F}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -64,19 +60,28 @@ Global
 		{FC04D111-903D-49FF-84A6-8806C71E2168}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{FC04D111-903D-49FF-84A6-8806C71E2168}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{FC04D111-903D-49FF-84A6-8806C71E2168}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8}.Release|Any CPU.Build.0 = Release|Any CPU
+		{A7D3F069-598D-435D-8B33-522767AACB76}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A7D3F069-598D-435D-8B33-522767AACB76}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A7D3F069-598D-435D-8B33-522767AACB76}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A7D3F069-598D-435D-8B33-522767AACB76}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
 	GlobalSection(NestedProjects) = preSolution
 		{1F665C29-BF1C-45BA-8CB9-829E85C34999} = {AF357BE9-9A6E-48A3-A995-E75F2147A43F}
-		{9809006C-2F6B-44A1-8AE2-BC449368D209} = {269CD137-4093-4100-B33E-808586D335F6}
 		{48983715-E6DF-462F-AF3C-769C1122794F} = {C4FD0AF1-927A-4860-A634-7CE342807692}
 		{16A5B2CB-8C46-4F3E-B7A1-97C47D9F66E7} = {C4FD0AF1-927A-4860-A634-7CE342807692}
 		{B11B21E0-7B89-4285-990A-D98793310B02} = {C4FD0AF1-927A-4860-A634-7CE342807692}
 		{FC04D111-903D-49FF-84A6-8806C71E2168} = {C4FD0AF1-927A-4860-A634-7CE342807692}
 		{F0E48E00-7D72-4614-9C13-90A7B015B06F} = {AFFCBFA4-9D64-43AA-AC59-D4CC54BD9C72}
 		{00BA9501-787E-465C-97D0-F51295D97802} = {F0E48E00-7D72-4614-9C13-90A7B015B06F}
+		{A2B684E5-7DB5-4815-80E9-16F0EFBE15D8} = {C4FD0AF1-927A-4860-A634-7CE342807692}
+		{A7D3F069-598D-435D-8B33-522767AACB76} = {C4FD0AF1-927A-4860-A634-7CE342807692}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {427A0D03-63CA-48AE-AA95-D21800101398}

ReadMe.md

@@ -28,6 +28,7 @@ The **EventDriven.CQRS.Abstractions** library contains interfaces and abstract b
 The **Reference Architecture** projects demonstrate how to apply these concepts to two microservices: `CustomerService` and `OrderService`. In addition, each service has *separate controllers for read and write operations*, thus segregating command and query responsibilities, with different sets of models, or Data Transfer Objects (DTO's).
 - **Query Controller**: Uses repository to retrieve entities and converts them to DTO's with AutoMapper.
 - **Command Controller**: Converts DTO's to domain entities using AutoMapper. Then hands control over to a command handler for executing business logic.
+- **Command Broker**: Dispatches the command object to the correct command handler.  
 - **Command Handler**: Uses a domain entity to process commands which generate one or more domain events, then requests entity to apply the domain events in order to mutate entity state. Persists entity state to a state store and optionally publishes an integration event which is handled by another microservice.
 - **Repository**: Persists entity state to a database.
 - **Event Bus**: Used to publish integration events, as well as subscribe to events using an event handler. Dapr is used to abstract away the underlying pub/sub implementation. The default is Redis (for local development), but Dapr can be configured to use other components, such as AWS SNS+SQS.
@@ -87,9 +88,9 @@ The **Reference Architecture** projects demonstrate how to apply these concepts
 
 1. Add **Domain** and **CustomerAggregate** folders to the project, then add a `Customer` class that extends `Entity`.
    - Add properties representing entity state.
-   - Create commands that are C# records and extend a `Command` base class.
+   - Create commands that are C# records and extend an `ICommand` interface with the result type as the generic.
     ```csharp
-    public record CreateCustomer(Customer Customer) : Command.Create(Customer.Id);
+    public record CreateCustomer(Customer Customer) : ICommand<CommandResult<Customer>>;
     ```
   - Create domain events that extend `DomainEvent`.
     ```csharp
@@ -112,7 +113,7 @@ The **Reference Architecture** projects demonstrate how to apply these concepts
    - Inject `ICustomerRepository`, `IEventBus` and `IMapper` into the ctor.
    - In the handler for `CreateCustomer`, write code to process the command, apply events, and persist the entity.
     ```csharp
-    public async Task<CommandResult<Customer>> Handle(CreateCustomer command)
+    public async Task<CommandResult<Customer>> Handle(CreateCustomer request, CancellationToken cancellationToken)
     {
         // Process command
         _logger.LogInformation("Handling command: {commandName}", nameof(CreateCustomer));
@@ -137,7 +138,7 @@ The **Reference Architecture** projects demonstrate how to apply these concepts
     ```
    - In the `UpdateCustomer` handler, see if the shipping address has changed, and if so, publish a `CustomerAddressUpdated` integration event, so that the order service can update the shipping address in the customer's orders.
     ```csharp
-    public async Task<CommandResult<Customer>> Handle(UpdateCustomer command)
+    public async Task<CommandResult<Customer>> Handle(UpdateCustomer request, CancellationToken cancellationToken)
     {
         // Compare shipping addresses
         _logger.LogInformation("Handling command: {commandName}", nameof(UpdateCustomer));
@@ -167,7 +168,7 @@ The **Reference Architecture** projects demonstrate how to apply these concepts
         }
     }
     ```
-3. Add a `CustomerCommandController` to the project that injects `CustomerCommandHandler` into the ctor.
+3. Add a `CustomerCommandController` to the project that injects `ICommandBroker` into the ctor.
    - Add Post, Put and Delete actions which accept a `Customer` DTO, map it to a `Customer` entity and invoke the appropriate command handler.
 4. Add a `CustomerQueryController` to the project that injects a `ICustomerRepository` into the ctor.
    - Use the repository to retrieve entities, then map those to `Customer` DTO objects.

global.json

@@ -0,0 +1,6 @@
+{
+  "sdk": {
+      "version": "5.0.100",
+      "rollForward": "latestFeature"
+  }
+}

reference-architecture/Common/Integration/Events/CustomerAddressUpdated.cs

@@ -1,8 +1,10 @@
 using System;
+using System.Diagnostics.CodeAnalysis;
 using Common.Integration.Models;
 using EventDriven.EventBus.Abstractions;
 
 namespace Common.Integration.Events
 {
+    [ExcludeFromCodeCoverage]
     public record CustomerAddressUpdated(Guid CustomerId, Address ShippingAddress) : IntegrationEvent;
 }

reference-architecture/Common/Integration/Models/Address.cs

@@ -1,4 +1,7 @@
+using System.Diagnostics.CodeAnalysis;
+
 namespace Common.Integration.Models
 {
+    [ExcludeFromCodeCoverage]
     public record Address(string Street, string City, string State, string Country, string PostalCode);
 }

reference-architecture/CustomerService.Tests/Controllers/CustomerCommandControllerTests.cs

@@ -0,0 +1,135 @@
+using System;
+using System.Threading.Tasks;
+using AutoMapper;
+using CustomerService.Controllers;
+using CustomerService.Domain.CustomerAggregate;
+using CustomerService.Domain.CustomerAggregate.Commands;
+using CustomerService.Tests.Fakes;
+using CustomerService.Tests.Utils;
+using EventDriven.CQRS.Abstractions.Commands;
+using Microsoft.AspNetCore.Mvc;
+using Moq;
+using Xunit;
+
+namespace CustomerService.Tests.Controllers
+{
+    public class CustomerCommandControllerTests
+    {
+        private readonly Mock<ICommandBroker> _commandBrokerMoq;
+        private readonly IMapper _mapper;
+
+        public CustomerCommandControllerTests()
+        {
+            _commandBrokerMoq = new Mock<ICommandBroker>();
+            _mapper = BaseUtils.GetMapper();
+        }
+
+        [Fact]
+        public void WhenInstantiated_ThenShouldBeOfCorrectType()
+        {
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            Assert.IsAssignableFrom<ControllerBase>(controller);
+            Assert.IsType<CustomerCommandController>(controller);
+        }
+
+        [Fact]
+        public async Task GivenWeAreCreatingACustomer_WhenSuccessful_ThenShouldProvideNewEntityWithPath()
+        {
+            var customerOut = _mapper.Map<Customer>(Customers.Customer1);
+
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<CreateCustomer, CommandResult<Customer>>(It.IsAny<CreateCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.Accepted, customerOut));
+
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            var actionResult = await controller.Create(Customers.Customer1);
+            var createdResult = actionResult as CreatedResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(createdResult);
+            Assert.Equal($"api/customer/{customerOut.Id}", createdResult.Location, true);
+        }
+
+        [Fact]
+        public async Task GivenWeAreCreatingACustomer_WhenFailure_ThenShouldReturnError()
+        {
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<CreateCustomer, CommandResult<Customer>>(It.IsAny<CreateCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.NotHandled));
+
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            var actionResult = await controller.Create(Customers.Customer1);
+            var statusCodeResult = actionResult as StatusCodeResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(statusCodeResult);
+            Assert.Equal(500, statusCodeResult.StatusCode);
+        }
+
+        [Fact]
+        public async Task GivenWeAreUpdatingACustomer_WhenSuccessful_ThenUpdatedEntityShouldBeReturned()
+        {
+            var customerIn = Customers.Customer2;
+            var customerOut = _mapper.Map<Customer>(Customers.Customer2);
+
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<UpdateCustomer, CommandResult<Customer>>(It.IsAny<UpdateCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.Accepted, customerOut));
+
+            var actionResult = await controller.Update(customerIn);
+            var objectResult = actionResult as OkObjectResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(objectResult);
+            Assert.Equal(customerIn.Id, ((DTO.Write.Customer) objectResult.Value).Id);
+        }
+
+        [Fact]
+        public async Task GivenWeAreUpdatingACustomer_WhenCustomerDoesNotExist_ThenShouldReturnNotFound()
+        {
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<UpdateCustomer, CommandResult<Customer>>(It.IsAny<UpdateCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.NotFound));
+
+            var actionResult = await controller.Update(Customers.Customer2);
+            var notFoundResult = actionResult as NotFoundResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(notFoundResult);
+        }
+
+        [Fact]
+        public async Task GivenWeAreUpdatingACustomer_WhenWeEncounterAConcurrencyIssue_ThenShouldReturnConflict()
+        {
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<UpdateCustomer, CommandResult<Customer>>(It.IsAny<UpdateCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.Conflict));
+
+            var actionResult = await controller.Update(Customers.Customer2);
+            var conflictResult = actionResult as ConflictResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(conflictResult);
+        }
+
+        [Fact]
+        public async Task GivenWeAreRemovingACustomer_WhenSuccessful_ThenShouldReturnSuccess()
+        {
+            var customerId = Guid.NewGuid();
+            var controller = new CustomerCommandController(_commandBrokerMoq.Object, _mapper);
+
+            _commandBrokerMoq.Setup(x => x.InvokeAsync<RemoveCustomer, CommandResult>(It.IsAny<RemoveCustomer>()))
+                             .ReturnsAsync(new CommandResult<Customer>(CommandOutcome.Accepted));
+
+            var actionResult = await controller.Remove(customerId);
+            var noContentResult = actionResult as NoContentResult;
+
+            Assert.NotNull(actionResult);
+            Assert.NotNull(noContentResult);
+        }
+    }
+}