Merge pull request dotnet-architecture#6 from dotnet-architecture/ard…

…alis/tests

Adding unit tests

src/ApplicationCore/Exceptions/CatalogImageMissingException.cs

@@ -0,0 +1,18 @@
+using System;
+
+namespace ApplicationCore.Exceptions
+{
+    public class CatalogImageMissingException : Exception
+    {
+        public CatalogImageMissingException(string message,
+            Exception innerException = null)
+            : base(message, innerException: innerException)
+        {
+        }
+        public CatalogImageMissingException(Exception innerException)
+            : base("No catalog image found for the provided id.", 
+                  innerException: innerException)
+        {
+        }
+    }
+}

src/ApplicationCore/Interfaces/IAppLogger.cs

@@ -0,0 +1,7 @@
+namespace ApplicationCore.Interfaces
+{
+    public interface IAppLogger<T>
+    {
+        void LogWarning(string message, params object[] args);
+    }
+}

src/ApplicationCore/Interfaces/IBasketService.cs

@@ -14,5 +14,4 @@ public interface IIdentityParser<T>
     {
         T Parse(IPrincipal principal);
     }
-
 }

src/ApplicationCore/Interfaces/IImageService.cs

@@ -0,0 +1,7 @@
+namespace ApplicationCore.Interfaces
+{
+    public interface IImageService
+    {
+        byte[] GetImageBytesById(int id);
+    }
+}

src/Infrastructure/FileSystem/LocalFileImageService.cs

@@ -0,0 +1,30 @@
+using ApplicationCore.Exceptions;
+using ApplicationCore.Interfaces;
+using Microsoft.AspNetCore.Hosting;
+using System.IO;
+
+namespace Infrastructure.FileSystem
+{
+    public class LocalFileImageService : IImageService
+    {
+        private readonly IHostingEnvironment _env;
+
+        public LocalFileImageService(IHostingEnvironment env)
+        {
+            _env = env;
+        }
+        public byte[] GetImageBytesById(int id)
+        {
+            try
+            {
+                var contentRoot = _env.ContentRootPath + "//Pics";
+                var path = Path.Combine(contentRoot, id + ".png");
+                return File.ReadAllBytes(path);
+            }
+            catch (FileNotFoundException ex)
+            {
+                throw new CatalogImageMissingException(ex);
+            }
+        }
+    }
+}

src/Infrastructure/Infrastructure.csproj

@@ -14,5 +14,8 @@
     <PackageReference Include="Microsoft.Extensions.Logging.Debug" Version="1.0.2" />
     <PackageReference Include="StructureMap.Microsoft.DependencyInjection" Version="1.3.0" />
   </ItemGroup>
+  <ItemGroup>
+    <ProjectReference Include="..\ApplicationCore\ApplicationCore.csproj" />
+  </ItemGroup>
 
 </Project>

src/Infrastructure/Logging/LoggerAdapter.cs

@@ -0,0 +1,18 @@
+using ApplicationCore.Interfaces;
+using Microsoft.Extensions.Logging;
+
+namespace Infrastructure.Logging
+{
+    public class LoggerAdapter<T> : IAppLogger<T>
+    {
+        private readonly ILogger<T> _logger;
+        public LoggerAdapter(ILoggerFactory loggerFactory)
+        {
+            _logger = loggerFactory.CreateLogger<T>();
+        }
+        public void LogWarning(string message, params object[] args)
+        {
+            _logger.LogWarning(message, args);
+        }
+    }
+}

src/Web/Controllers/CatalogController.cs

@@ -3,34 +3,42 @@
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Mvc;
 using System;
-using System.IO;
 using System.Threading.Tasks;
+using ApplicationCore.Interfaces;
+using ApplicationCore.Exceptions;
+using Microsoft.Extensions.Logging;
 
 namespace Microsoft.eShopWeb.Controllers
 {
     public class CatalogController : Controller
     {
         private readonly IHostingEnvironment _env;
-        private readonly ICatalogService _catalogSvc;
+        private readonly ICatalogService _catalogService;
+        private readonly IImageService _imageService;
+        private readonly IAppLogger<CatalogController> _logger;
 
-        public CatalogController(IHostingEnvironment env, ICatalogService catalogSvc)
+        public CatalogController(IHostingEnvironment env,
+            ICatalogService catalogService,
+            IImageService imageService,
+            IAppLogger<CatalogController> logger)
         {
             _env = env;
-            _catalogSvc = catalogSvc;
-        }   
-
+            _catalogService = catalogService;
+            _imageService = imageService;
+            _logger = logger;
+        }
 
         // GET: /<controller>/
         public async Task<IActionResult> Index(int? BrandFilterApplied, int? TypesFilterApplied, int? page)
         {
             var itemsPage = 10;           
-            var catalog = await _catalogSvc.GetCatalogItems(page ?? 0, itemsPage, BrandFilterApplied, TypesFilterApplied);        
+            var catalog = await _catalogService.GetCatalogItems(page ?? 0, itemsPage, BrandFilterApplied, TypesFilterApplied);        
 
             var vm = new CatalogIndex()
             {
                 CatalogItems = catalog.Data,
-                Brands = await _catalogSvc.GetBrands(),
-                Types = await _catalogSvc.GetTypes(),
+                Brands = await _catalogService.GetBrands(),
+                Types = await _catalogService.GetTypes(),
                 BrandFilterApplied = BrandFilterApplied ?? 0,
                 TypesFilterApplied = TypesFilterApplied ?? 0,
                 PaginationInfo = new PaginationInfo()
@@ -48,18 +56,23 @@ public async Task<IActionResult> Index(int? BrandFilterApplied, int? TypesFilter
             return View(vm);
         }
 
-        [HttpGet("{id}")]
-        [Route("[controller]/pic/{id}")]
-        // GET: /<controller>/pic/{id}
+        [HttpGet("[controller]/pic/{id}")]
         public IActionResult GetImage(int id)
         {
-            var contentRoot = _env.ContentRootPath + "//Pics";
-            var path = Path.Combine(contentRoot, id + ".png");
-            Byte[] b = System.IO.File.ReadAllBytes(path);
-            return File(b, "image/png");
-
+            byte[] imageBytes;
+            try
+            {
+                imageBytes = _imageService.GetImageBytesById(id);
+            }
+            catch (CatalogImageMissingException ex)
+            {
+                _logger.LogWarning($"No image found for id: {id}");
+                return NotFound();
+            }
+            return File(imageBytes, "image/png");
         }
-
+
+
         public IActionResult Error()
         {
             return View();

src/Web/Startup.cs

@@ -11,6 +11,9 @@
 using Microsoft.AspNetCore.Identity.EntityFrameworkCore;
 using System.Text;
 using Microsoft.AspNetCore.Http;
+using ApplicationCore.Interfaces;
+using Infrastructure.FileSystem;
+using Infrastructure.Logging;
 
 namespace Microsoft.eShopWeb
 {
@@ -65,6 +68,8 @@ public void ConfigureServices(IServiceCollection services)
             services.AddScoped<ICatalogService, CachedCatalogService>();
             services.AddScoped<CatalogService>();
             services.Configure<CatalogSettings>(Configuration);
+            services.AddSingleton<IImageService, LocalFileImageService>();
+            services.AddScoped(typeof(IAppLogger<>), typeof(LoggerAdapter<>));
             services.AddMvc();
 
             _services = services;

tests/IntegrationTests/IntegrationTests.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>    
     <TargetFramework>netcoreapp1.1</TargetFramework>
@@ -10,4 +10,12 @@
     <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Web\Web.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
+  </ItemGroup>
+
 </Project>

tests/IntegrationTests/Web/Controllers/CatalogControllerGetImage.cs

@@ -0,0 +1,17 @@
+using Microsoft.eShopWeb.Controllers;
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Xunit;
+
+namespace IntegrationTests.Web.Controllers
+{
+    public class CatalogControllerGetImage
+    {
+        [Fact]
+        public void ReturnsFileContentResultGivenValidId()
+        {
+            //var controller = new CatalogController()
+        }
+    }
+}

tests/UnitTests/UnitTests.csproj

@@ -1,13 +1,25 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>    
     <TargetFramework>netcoreapp1.1</TargetFramework>
   </PropertyGroup>
 
   <ItemGroup>
+    <PackageReference Include="Microsoft.AspNetCore" Version="1.1.0" />
+    <PackageReference Include="Microsoft.AspNetCore.Mvc" Version="1.1.0" />
+
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="15.0.0" />
+    <PackageReference Include="Moq" Version="4.7.8" />
     <PackageReference Include="xunit" Version="2.2.0" />
     <PackageReference Include="xunit.runner.visualstudio" Version="2.2.0" />
   </ItemGroup>
 
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\Web\Web.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <Service Include="{82a7f48d-3b50-4b1e-b82e-3ada8210c358}" />
+  </ItemGroup>
+
 </Project>

tests/UnitTests/Web/Controllers/CatalogControllerGetImage.cs

@@ -0,0 +1,83 @@
+using ApplicationCore.Exceptions;
+using ApplicationCore.Interfaces;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.eShopWeb.Controllers;
+using Microsoft.Extensions.Logging;
+using Moq;
+using Xunit;
+
+namespace UnitTests
+{
+    public class CatalogControllerGetImage
+    {
+        private Mock<IImageService> _mockImageService = new Mock<IImageService>();
+        private Mock<IAppLogger<CatalogController>> _mockLogger = new Mock<IAppLogger<CatalogController>>();
+        private CatalogController _controller;
+        private int _testImageId = 123;
+        private byte[] _testBytes = { 0x01, 0x02, 0x03 };
+
+        public CatalogControllerGetImage()
+        {
+            _controller = new CatalogController(null, null, _mockImageService.Object,
+                _mockLogger.Object);
+        }
+
+        [Fact]
+        public void CallsImageServiceWithId()
+        {
+            SetupImageWithTestBytes();
+
+            _controller.GetImage(_testImageId);
+            _mockImageService.Verify();
+        }
+
+        [Fact]
+        public void ReturnsFileResultWithBytesGivenSuccess()
+        {
+            SetupImageWithTestBytes();
+
+            var result = _controller.GetImage(_testImageId);
+
+            var fileResult = Assert.IsType<FileContentResult>(result);
+            var bytes = Assert.IsType<byte[]>(fileResult.FileContents);
+        }
+
+        [Fact]
+        public void ReturnsNotFoundResultGivenImageMissingException()
+        {
+            SetupMissingImage();
+
+            var result = _controller.GetImage(_testImageId);
+
+            var actionResult = Assert.IsType<NotFoundResult>(result);
+        }
+
+        [Fact]
+        public void LogsWarningGivenImageMissingException()
+        {
+            SetupMissingImage();
+            _mockLogger.Setup(l => l.LogWarning(It.IsAny<string>()))
+                .Verifiable();
+
+            _controller.GetImage(_testImageId);
+
+            _mockLogger.Verify();
+        }
+
+        private void SetupMissingImage()
+        {
+            _mockImageService
+                .Setup(i => i.GetImageBytesById(_testImageId))
+                .Throws(new CatalogImageMissingException("missing image"));
+        }
+
+        private void SetupImageWithTestBytes()
+        {
+            _mockImageService
+                .Setup(i => i.GetImageBytesById(_testImageId))
+                .Returns(_testBytes)
+                .Verifiable();
+        }
+    }
+}