ARCH-001 Phase 25: consolidate Admin/Store PictureController (#826)

Author: KrzysztofPajak

src/Tests/Grand.Web.Admin.Tests/Controllers/BasePictureControllerTests.cs

@@ -0,0 +1,169 @@
+using Grand.Business.Core.Interfaces.Common.Security;
+using Grand.Business.Core.Interfaces.Storage;
+using Grand.Domain.Common;
+using Grand.Domain.Media;
+using Grand.Domain.Permissions;
+using Grand.Web.AdminShared.Controllers;
+using Microsoft.AspNetCore.Http;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+using Moq;
+
+namespace Grand.Web.Admin.Tests.Controllers;
+
+[TestClass]
+public class BasePictureControllerTests
+{
+    // Concrete subclass exists only to instantiate the abstract base for direct-call unit tests -
+    // same pattern as BaseTaxCategoryControllerTests/BaseEmailAccountControllerTests.
+    private class TestPictureController(
+        IPictureService pictureService,
+        IPermissionService permissionService,
+        IMediaFileStore mediaFileStore,
+        MediaSettings mediaSettings)
+        : BasePictureController(pictureService, permissionService, mediaFileStore, mediaSettings);
+
+    private Mock<IPictureService> _pictureServiceMock = null!;
+    private Mock<IPermissionService> _permissionServiceMock = null!;
+    private Mock<IMediaFileStore> _mediaFileStoreMock = null!;
+    private MediaSettings _mediaSettings = null!;
+
+    [TestInitialize]
+    public void Setup()
+    {
+        _pictureServiceMock = new Mock<IPictureService>();
+        _permissionServiceMock = new Mock<IPermissionService>();
+        _mediaFileStoreMock = new Mock<IMediaFileStore>();
+        _mediaSettings = new MediaSettings { AllowedFileTypes = ".jpg,.png" };
+    }
+
+    private TestPictureController CreateController()
+    {
+        return new TestPictureController(
+            _pictureServiceMock.Object,
+            _permissionServiceMock.Object,
+            _mediaFileStoreMock.Object,
+            _mediaSettings);
+    }
+
+    private static Mock<IFormFile> CreateFormFile(string fileName, string contentType = "image/jpeg")
+    {
+        var file = new Mock<IFormFile>();
+        file.Setup(f => f.FileName).Returns(fileName);
+        file.Setup(f => f.ContentType).Returns(contentType);
+        file.Setup(f => f.Length).Returns(1);
+        return file;
+    }
+
+    // The controller's anonymous JSON payloads are internal to Grand.Web.AdminShared - `dynamic`
+    // binding can't reach their properties across the assembly boundary, so read them via
+    // reflection, same pattern as BaseDiscountControllerTests/BaseMerchandiseReturnControllerTests.
+    private static T GetValue<T>(IActionResult result, string propertyName)
+    {
+        var value = ((JsonResult)result).Value!;
+        return (T)value.GetType().GetProperty(propertyName)!.GetValue(value)!;
+    }
+
+    [TestMethod]
+    public async Task AsyncUpload_NullFile_ReturnsFailureJson()
+    {
+        var controller = CreateController();
+
+        var result = await controller.AsyncUpload(null);
+
+        Assert.IsFalse(GetValue<bool>(result, "success"));
+        Assert.AreEqual("No file uploaded", GetValue<string>(result, "message"));
+        _pictureServiceMock.Verify(p => p.InsertPicture(It.IsAny<byte[]>(), It.IsAny<string>(), It.IsAny<string>(),
+            It.IsAny<string>(), It.IsAny<string>(), It.IsAny<bool>(), It.IsAny<Reference>(), It.IsAny<string>(),
+            It.IsAny<bool>()), Times.Never);
+    }
+
+    [TestMethod]
+    public async Task AsyncUpload_ReferenceWithoutObjectId_ReturnsFailureJson()
+    {
+        var controller = CreateController();
+        var file = CreateFormFile("picture.jpg");
+
+        var result = await controller.AsyncUpload(file.Object, Reference.Product, "");
+
+        Assert.IsFalse(GetValue<bool>(result, "success"));
+        Assert.AreEqual("Please save form before upload new picture", GetValue<string>(result, "message"));
+    }
+
+    [TestMethod]
+    public async Task AsyncUpload_DisallowedFileType_ReturnsFailureJson()
+    {
+        var controller = CreateController();
+        var file = CreateFormFile("picture.exe");
+
+        var result = await controller.AsyncUpload(file.Object);
+
+        Assert.IsFalse(GetValue<bool>(result, "success"));
+        _pictureServiceMock.Verify(p => p.InsertPicture(It.IsAny<byte[]>(), It.IsAny<string>(), It.IsAny<string>(),
+            It.IsAny<string>(), It.IsAny<string>(), It.IsAny<bool>(), It.IsAny<Reference>(), It.IsAny<string>(),
+            It.IsAny<bool>()), Times.Never);
+    }
+
+    [TestMethod]
+    public async Task AsyncUpload_AllowedFileType_InsertsPictureAndReturnsSuccessJson()
+    {
+        var controller = CreateController();
+        var file = CreateFormFile("picture.jpg");
+        using var fileStream = new MemoryStream([1, 2, 3]);
+        file.Setup(f => f.OpenReadStream()).Returns(fileStream);
+        var insertedPicture = new Picture { Id = "pic-1" };
+        _pictureServiceMock
+            .Setup(p => p.InsertPicture(It.IsAny<byte[]>(), "image/jpeg", null,
+                null, null, true, Reference.Product, "obj-1", false))
+            .ReturnsAsync(insertedPicture);
+        _pictureServiceMock
+            .Setup(p => p.GetPictureUrl(insertedPicture, 100, true, null))
+            .ReturnsAsync("/media/pic-1.jpg");
+
+        var result = await controller.AsyncUpload(file.Object, Reference.Product, "obj-1");
+
+        Assert.IsTrue(GetValue<bool>(result, "success"));
+        Assert.AreEqual("pic-1", GetValue<string>(result, "pictureId"));
+        Assert.AreEqual("/media/pic-1.jpg", GetValue<string>(result, "imageUrl"));
+    }
+
+    [TestMethod]
+    public async Task AsyncLogoUpload_PermissionDenied_ReturnsAccessDenied()
+    {
+        _permissionServiceMock.Setup(p => p.Authorize(StandardPermission.ManageSettings)).ReturnsAsync(false);
+        var controller = CreateController();
+        var file = CreateFormFile("logo.jpg");
+
+        var result = await controller.AsyncLogoUpload(file.Object);
+
+        var content = (ContentResult)result;
+        Assert.AreEqual("Access denied", content.Content);
+        _mediaFileStoreMock.Verify(m => m.GetFileInfo(It.IsAny<string>()), Times.Never);
+    }
+
+    [TestMethod]
+    public async Task AsyncLogoUpload_NullFile_ReturnsFailureJson()
+    {
+        _permissionServiceMock.Setup(p => p.Authorize(StandardPermission.ManageSettings)).ReturnsAsync(true);
+        var controller = CreateController();
+
+        var result = await controller.AsyncLogoUpload(null);
+
+        Assert.IsFalse(GetValue<bool>(result, "success"));
+        Assert.AreEqual("No file uploaded", GetValue<string>(result, "message"));
+    }
+
+    [TestMethod]
+    public async Task AsyncLogoUpload_DisallowedFileType_ReturnsFailureJson()
+    {
+        _permissionServiceMock.Setup(p => p.Authorize(StandardPermission.ManageSettings)).ReturnsAsync(true);
+        var controller = CreateController();
+        var file = CreateFormFile("logo.exe");
+
+        var result = await controller.AsyncLogoUpload(file.Object);
+
+        Assert.IsFalse(GetValue<bool>(result, "success"));
+        Assert.AreEqual("File no allowed", GetValue<string>(result, "message"));
+        _mediaFileStoreMock.Verify(m => m.GetFileInfo(It.IsAny<string>()), Times.Never);
+    }
+}

src/Tests/Grand.Web.Admin.Tests/Controllers/PictureControllerAttributeTests.cs

@@ -0,0 +1,50 @@
+using System.Linq;
+using Grand.Web.Admin.Controllers;
+using Grand.Web.AdminShared.Controllers;
+using Grand.Web.Common.Filters;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Grand.Web.Admin.Tests.Controllers;
+
+[TestClass]
+public class PictureControllerAttributeTests
+{
+    [TestMethod]
+    public void IsSubclassOfBasePictureController()
+    {
+        Assert.IsTrue(typeof(BasePictureController).IsAssignableFrom(typeof(PictureController)));
+        Assert.AreEqual(typeof(BasePictureController), typeof(PictureController).BaseType);
+    }
+
+    [TestMethod]
+    public void HasAuthorizeAdminAttribute()
+    {
+        var attr = typeof(PictureController).GetCustomAttributes(typeof(AuthorizeAdminAttribute), inherit: false);
+        Assert.AreEqual(1, attr.Length);
+    }
+
+    [TestMethod]
+    public void HasAreaAdminAttribute()
+    {
+        var attr = typeof(PictureController)
+            .GetCustomAttributes(typeof(AreaAttribute), inherit: false)
+            .Cast<AreaAttribute>().Single();
+        Assert.AreEqual("Admin", attr.RouteValue);
+    }
+
+    [TestMethod]
+    public void HasAutoValidateAntiforgeryTokenAttribute()
+    {
+        var attr = typeof(PictureController)
+            .GetCustomAttributes(typeof(AutoValidateAntiforgeryTokenAttribute), inherit: true);
+        Assert.AreEqual(1, attr.Length);
+    }
+
+    [TestMethod]
+    public void HasAuthorizeMenuAttribute()
+    {
+        var attr = typeof(PictureController).GetCustomAttributes(typeof(AuthorizeMenuAttribute), inherit: false);
+        Assert.AreEqual(1, attr.Length);
+    }
+}

src/Tests/Grand.Web.Store.Tests/Controllers/PictureControllerAttributeTests.cs

@@ -0,0 +1,50 @@
+using System.Linq;
+using Grand.Web.AdminShared.Controllers;
+using Grand.Web.Common.Filters;
+using Grand.Web.Store.Controllers;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Grand.Web.Store.Tests.Controllers;
+
+[TestClass]
+public class PictureControllerAttributeTests
+{
+    [TestMethod]
+    public void IsSubclassOfBasePictureController()
+    {
+        Assert.IsTrue(typeof(BasePictureController).IsAssignableFrom(typeof(PictureController)));
+        Assert.AreEqual(typeof(BasePictureController), typeof(PictureController).BaseType);
+    }
+
+    [TestMethod]
+    public void HasAuthorizeStoreAttribute()
+    {
+        var attr = typeof(PictureController).GetCustomAttributes(typeof(AuthorizeStoreAttribute), inherit: false);
+        Assert.AreEqual(1, attr.Length);
+    }
+
+    [TestMethod]
+    public void HasAreaStoreAttribute()
+    {
+        var attr = typeof(PictureController)
+            .GetCustomAttributes(typeof(AreaAttribute), inherit: false)
+            .Cast<AreaAttribute>().Single();
+        Assert.AreEqual("Store", attr.RouteValue);
+    }
+
+    [TestMethod]
+    public void HasAutoValidateAntiforgeryTokenAttribute()
+    {
+        var attr = typeof(PictureController)
+            .GetCustomAttributes(typeof(AutoValidateAntiforgeryTokenAttribute), inherit: true);
+        Assert.AreEqual(1, attr.Length);
+    }
+
+    [TestMethod]
+    public void HasAuthorizeMenuAttribute()
+    {
+        var attr = typeof(PictureController).GetCustomAttributes(typeof(AuthorizeMenuAttribute), inherit: false);
+        Assert.AreEqual(1, attr.Length);
+    }
+}