Skip to content

Open-source eCommerce platform for C# and ASP.NET Core 10 with MongoDB. Build multi-store shops and multi-vendor marketplaces with B2B/B2C, REST API, plugins, Vue 3 and Docker.

feat(arch001): add BaseOrderManagementController skeleton with Payments/workflow region

KrzysztofPajakbf57ada123c0
diff --git a/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderManagementControllerTests.cs b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderManagementControllerTests.cs
new file mode 100644
index 000000000..6a6cf5c2d
--- /dev/null
+++ b/src/Tests/Grand.Web.Admin.Tests/Controllers/BaseOrderManagementControllerTests.cs
@@ -0,0 +1,112 @@
+using Grand.Business.Core.Commands.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Business.Core.Interfaces.Common.Pdf;
+using Grand.Domain.Orders;
+using Grand.Infrastructure;
+using Grand.Mediator;
+using Grand.Web.AdminShared.Controllers;
+using Grand.Web.AdminShared.Interfaces;
+using Grand.Web.AdminShared.Models.Orders;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.AspNetCore.Mvc.Routing;
+using Microsoft.AspNetCore.Mvc.ViewFeatures;
+using Microsoft.Extensions.Logging;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Moq;
+
+namespace Grand.Web.Admin.Tests.Controllers;
+
+[TestClass]
+public class BaseOrderManagementControllerTests
+{
+ private class TestOrderManagementController(
+ IOrderViewModelService orderViewModelService,
+ IOrderService orderService,
+ IOrderStatusService orderStatusService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor,
+ IPdfService pdfService,
+ IMediator mediator,
+ IAdminDataScope<Order> scope)
+ : BaseOrderManagementController(orderViewModelService, orderService, orderStatusService,
+ translationService, contextAccessor, pdfService, mediator, scope);
+
+ private TestOrderManagementController _controller;
+ private Mock<IOrderService> _orderServiceMock;
+ private Mock<IOrderViewModelService> _orderViewModelServiceMock;
+ private Mock<IMediator> _mediatorMock;
+ private Mock<IAdminDataScope<Order>> _scopeMock;
+
+ [TestInitialize]
+ public void Setup()
+ {
+ _orderServiceMock = new Mock<IOrderService>();
+ _orderViewModelServiceMock = new Mock<IOrderViewModelService>();
+ _mediatorMock = new Mock<IMediator>();
+ _scopeMock = new Mock<IAdminDataScope<Order>>();
+
+ var translationServiceMock = new Mock<ITranslationService>();
+ translationServiceMock.Setup(t => t.GetResource(It.IsAny<string>())).Returns("resource");
+
+ _controller = new TestOrderManagementController(
+ _orderViewModelServiceMock.Object, _orderServiceMock.Object,
+ new Mock<IOrderStatusService>().Object, translationServiceMock.Object,
+ new Mock<IContextAccessor>().Object, new Mock<IPdfService>().Object,
+ _mediatorMock.Object, _scopeMock.Object);
+
+ var httpContext = new DefaultHttpContext();
+ var loggerFactoryMock = new Mock<ILoggerFactory>();
+ loggerFactoryMock.Setup(l => l.CreateLogger(It.IsAny<string>())).Returns(new Mock<ILogger>().Object);
+ var urlHelperFactoryMock = new Mock<IUrlHelperFactory>();
+ urlHelperFactoryMock.Setup(f => f.GetUrlHelper(It.IsAny<ActionContext>())).Returns(new Mock<IUrlHelper>().Object);
+ var requestServicesMock = new Mock<IServiceProvider>();
+ requestServicesMock.Setup(s => s.GetService(typeof(ILoggerFactory))).Returns(loggerFactoryMock.Object);
+ requestServicesMock.Setup(s => s.GetService(typeof(IUrlHelperFactory))).Returns(urlHelperFactoryMock.Object);
+ httpContext.RequestServices = requestServicesMock.Object;
+ _controller.ControllerContext = new ControllerContext { HttpContext = httpContext };
+ _controller.TempData = new TempDataDictionary(httpContext, new Mock<ITempDataProvider>().Object);
+ }
+
+ [TestMethod]
+ public async Task CancelOrder_ScopeDenies_RedirectsToList_NoCommandSent()
+ {
+ var order = new Order { Id = "o1" };
+ _orderServiceMock.Setup(s => s.GetOrderById("o1")).ReturnsAsync(order);
+ _scopeMock.Setup(s => s.HasAccess(order)).ReturnsAsync(false);
+
+ var result = await _controller.CancelOrder("o1");
+
+ Assert.AreEqual("List", (result as RedirectToActionResult)?.ActionName);
+ _mediatorMock.Verify(m => m.Send(It.IsAny<CancelOrderCommand>(), default), Times.Never);
+ }
+
+ [TestMethod]
+ public async Task CancelOrder_Authorized_SendsCancelCommand_RedirectsToEdit()
+ {
+ var order = new Order { Id = "o1" };
+ _orderServiceMock.Setup(s => s.GetOrderById("o1")).ReturnsAsync(order);
+ _scopeMock.Setup(s => s.HasAccess(order)).ReturnsAsync(true);
+
+ var result = await _controller.CancelOrder("o1");
+
+ var redirect = result as RedirectToActionResult;
+ Assert.AreEqual("Edit", redirect?.ActionName);
+ _mediatorMock.Verify(m => m.Send(
+ It.Is<CancelOrderCommand>(c => c.Order == order && c.NotifyCustomer), default), Times.Once);
+ }
+
+ [TestMethod]
+ public async Task ChangeOrderStatus_ScopeDenies_RedirectsToList_NoUpdate()
+ {
+ var order = new Order { Id = "o1" };
+ _orderServiceMock.Setup(s => s.GetOrderById("o1")).ReturnsAsync(order);
+ _scopeMock.Setup(s => s.HasAccess(order)).ReturnsAsync(false);
+
+ var result = await _controller.ChangeOrderStatus("o1", new OrderModel { OrderStatusId = 30 });
+
+ Assert.AreEqual("List", (result as RedirectToActionResult)?.ActionName);
+ _orderServiceMock.Verify(s => s.UpdateOrder(It.IsAny<Order>()), Times.Never);
+ }
+}
diff --git a/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderManagementController.cs b/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderManagementController.cs
new file mode 100644
index 000000000..39544ab53
--- /dev/null
+++ b/src/Web/Grand.Web.AdminShared/Controllers/BaseOrderManagementController.cs
@@ -0,0 +1,114 @@
+using Grand.Business.Core.Commands.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Checkout.Orders;
+using Grand.Business.Core.Interfaces.Common.Localization;
+using Grand.Business.Core.Interfaces.Common.Pdf;
+using Grand.Domain.Orders;
+using Grand.Domain.Permissions;
+using Grand.Infrastructure;
+using Grand.Mediator;
+using Grand.Web.AdminShared.Interfaces;
+using Grand.Web.AdminShared.Models.Orders;
+using Grand.Web.Common.Security.Authorization;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Grand.Web.AdminShared.Controllers;
+
+/// <summary>
+/// Every mutating Order action. Base for Admin and Store only — Vendor's concrete controller
+/// inherits <see cref="BaseOrderController" /> directly, so none of these actions exist on its
+/// type at all (not permission-gated, genuinely absent — see ARCH-001 Order consolidation spec
+/// §3.5).
+/// </summary>
+public abstract class BaseOrderManagementController(
+ IOrderViewModelService orderViewModelService,
+ IOrderService orderService,
+ IOrderStatusService orderStatusService,
+ ITranslationService translationService,
+ IContextAccessor contextAccessor,
+ IPdfService pdfService,
+ IMediator mediator,
+ IAdminDataScope<Order> scope)
+ : BaseOrderController(orderViewModelService, orderService, translationService, contextAccessor,
+ pdfService, scope)
+{
+ // Exposed for Grand.Web.Admin's concrete OrderController subclass (Task 17), which calls
+ // Mediator.Send(...) directly - primary-constructor parameters aren't visible to derived
+ // classes by name in C#.
+ protected IMediator Mediator => mediator;
+
+ #region Payments and other order workflow
+
+ [PermissionAuthorizeAction(PermissionActionName.Cancel)]
+ [HttpGet]
+ public async Task<IActionResult> CancelOrder(string id)
+ {
+ var (order, denied) = await LoadAuthorizedOrder(id);
+ if (denied != null) return denied;
+
+ try
+ {
+ await mediator.Send(new CancelOrderCommand { Order = order, NotifyCustomer = true });
+ Success("Successfully canceled order");
+ return RedirectToAction("Edit", "Order", new { id });
+ }
+ catch (Exception exc)
+ {
+ Error(exc);
+ return RedirectToAction("Edit", "Order", new { id });
+ }
+ }
+
+ [PermissionAuthorizeAction(PermissionActionName.Edit)]
+ [HttpPost]
+ public async Task<IActionResult> SaveOrderTags(OrderModel orderModel)
+ {
+ var (order, denied) = await LoadAuthorizedOrder(orderModel.Id);
+ if (denied != null) return denied;
+
+ try
+ {
+ await orderViewModelService.SaveOrderTags(order, orderModel.OrderTags);
+ var model = new OrderModel();
+ await orderViewModelService.PrepareOrderDetailsModel(model, order);
+ return RedirectToAction("Edit", "Order", new { id = order.Id });
+ }
+ catch (Exception exception)
+ {
+ Error(exception, false);
+ return RedirectToAction("Edit", "Order", new { id = order.Id });
+ }
+ }
+
+ [PermissionAuthorizeAction(PermissionActionName.Edit)]
+ [HttpPost]
+ public async Task<IActionResult> ChangeOrderStatus(string id, OrderModel model)
+ {
+ var (order, denied) = await LoadAuthorizedOrder(id);
+ if (denied != null) return denied;
+
+ try
+ {
+ var status = await orderStatusService.GetByStatusId(model.OrderStatusId);
+ ArgumentNullException.ThrowIfNull(status);
+
+ order.OrderStatusId = model.OrderStatusId;
+ await orderService.UpdateOrder(order);
+
+ await orderService.InsertOrderNote(new OrderNote {
+ Note = $"Order status has been edited. New status: {status.Name}",
+ DisplayToCustomer = false,
+ OrderId = order.Id
+ });
+ model = new OrderModel();
+ await orderViewModelService.PrepareOrderDetailsModel(model, order);
+ return RedirectToAction("Edit", "Order", new { id });
+ }
+ catch (Exception exc)
+ {
+ Error(exc, false);
+ return RedirectToAction("Edit", "Order", new { id });
+ }
+ }
+
+ #endregion
+}