code redactored with auth: Integration test fixing

Author: AJEETX

src/Api.Test/EndpointsTests/IntegrationTests/ProductControllerTest.cs

@@ -1,8 +1,16 @@
-using Newtonsoft.Json;
+using Microsoft.AspNetCore.Authentication;
+using Microsoft.AspNetCore.TestHost;
+using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
+using Newtonsoft.Json;
 using System;
 using System.Collections.Generic;
 using System.Linq;
+using System.Net.Http.Headers;
 using System.Net.Http.Json;
+using System.Security.Claims;
+using System.Text.Encodings.Web;
 using System.Threading.Tasks;
 using Xero.Demo.Api.Domain;
 using Xero.Demo.Api.Domain.Models;
@@ -12,6 +20,24 @@
 
 namespace Xero.Demo.Api.Tests.EndpointTests.IntegrationTests
 {
+    public class TestAuthHandler : AuthenticationHandler<AuthenticationSchemeOptions>
+    {
+        public TestAuthHandler(IOptionsMonitor<AuthenticationSchemeOptions> options, ILoggerFactory logger, UrlEncoder encoder, ISystemClock clock)
+            : base(options, logger, encoder, clock) { }
+
+        protected override Task<AuthenticateResult> HandleAuthenticateAsync()
+        {
+            var claims = new[] { new Claim(ClaimTypes.Role, CONSTANTS.Roles.Reader) };
+            var identity = new ClaimsIdentity(claims, "Test");
+            var principal = new ClaimsPrincipal(identity);
+            var ticket = new AuthenticationTicket(principal, "Test");
+
+            var result = AuthenticateResult.Success(ticket);
+
+            return Task.FromResult(result);
+        }
+    }
+
     [Trait("Category", "Integration")]
     public class ProductControllerTest : IDisposable
     {
@@ -28,7 +54,17 @@ public ProductControllerTest()
         public async Task GetAsync_Returns_200(string culture, string version)
         {
             // Given
-            var client = factory.CreateClient();
+            var client = factory.WithWebHostBuilder(builder =>
+            {
+                builder.ConfigureTestServices(services =>
+                {
+                    services.AddAuthentication("Test")
+                        .AddScheme<AuthenticationSchemeOptions, TestAuthHandler>(
+                            "Test", options => { });
+                });
+            })
+               .CreateClient();
+            client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Test");
 
             // When
             var response = await client.GetAsync(string.Format(SampleDataV1.productEndpoint, culture, version));

src/Api.Test/Setup/SetupStartup.cs

@@ -22,7 +22,6 @@ protected override void ConfigureWebHost(IWebHostBuilder builder)
                 services.Remove(descriptor);
 
                 services.AddDbContext<Database>(options => options.UseInMemoryDatabase("TestDB"));
-                //services.AddSingleton<IDatabase>(provider => provider.GetService<Database>());
 
                 var sp = services.BuildServiceProvider();
 

src/Api/Endpoints/Common/LoginController.cs

@@ -0,0 +1,50 @@
+using Microsoft.AspNetCore.Mvc;
+using Xero.Demo.Api.Domain;
+using Xero.Demo.Api.Domain.Extension;
+using Xero.Demo.Api.Xero.Demo.Domain.Services;
+using static Xero.Demo.Api.Domain.Models.CONSTANTS;
+
+namespace Xero.Demo.Api.Endpoints.Common
+{
+    [ApiVersion(ApiVersionNumbers.V1)]
+    [ApiVersion(ApiVersionNumbers.V2)]
+    public class LoginController : BaseApiController
+    {
+        private readonly IUserService _userService;
+
+        public LoginController(IUserService userService)
+        {
+            _userService = userService;
+        }
+
+        [HttpPost(Roles.Admin)]
+        public IActionResult AuthenticateAdmin(string culture = "en-US")
+        {
+            var response = _userService.Authenticate(Roles.Admin);
+
+            if (response == null) return BadRequest(ModelState.GetErrorMessages());
+
+            return Ok(response);
+        }
+
+        [HttpPost(Roles.Editor)]
+        public IActionResult AuthenticateEditor(string culture = "en-US")
+        {
+            var response = _userService.Authenticate(Roles.Editor);
+
+            if (response == null) return BadRequest(ModelState.GetErrorMessages());
+
+            return Ok(response);
+        }
+
+        [HttpPost(Roles.Reader)]
+        public IActionResult AuthenticateReader(string culture = "en-US")
+        {
+            var response = _userService.Authenticate(Roles.Reader);
+
+            if (response == null) return BadRequest(ModelState.GetErrorMessages());
+
+            return Ok(response);
+        }
+    }
+}

src/Api/Endpoints/Common/UsersController.cs

@@ -26,7 +26,7 @@ public ProductsController(Database db)
         /// <param name="product">Enter the product</param>
         /// <param name="culture">Enter the culture</param>
         /// <returns></returns>
-        [Authorize(Policy = "ShouldBeAnAdmin")]
+        [Authorize(Policy = Policy.ShouldBeAnAdmin)]
         [FeatureGate(Features.PRODUCT)]
         [ApiVersion(ApiVersionNumbers.V1)]
         [HttpPost("", Name = RouteNames.PostAsync)]

src/Api/Endpoints/V1/Products/Create.cs

@@ -19,7 +19,7 @@ public partial class ProductsController
         /// <param name="id">Enter the product id</param>
         /// <param name="culture"></param>
         /// <returns></returns>
-        [Authorize(Policy = "ShouldBeAnAdmin")]
+        [Authorize(Policy = Policy.ShouldBeAnAdmin)]
         [ApiVersion(ApiVersionNumbers.V1)]
         [HttpDelete("{id}", Name = RouteNames.DeleteAsync)]
         [ProducesResponseType(StatusCodes.Status204NoContent)]

src/Api/Endpoints/V1/Products/Delete.cs

@@ -18,15 +18,16 @@ public partial class ProductsController
         /// List of products.
         /// </summary>
         /// <returns>Returns list of products</returns>
-        [Authorize(Policy = "ShouldBeAReader")]
+        [Authorize(Policy = Policy.ShouldBeAReader)]
         [ApiVersion(ApiVersionNumbers.V1)]
         [HttpGet("", Name = RouteNames.GetAsync)]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(List<ProductDTO>))]
         [ProducesResponseType(StatusCodes.Status500InternalServerError)]
         public async Task<IActionResult> GetAsync(string culture = "en-US")
         {
+            // ### START ::: The localization can be accessed.
             //var language = AddLocalizationExtension._e[WELCOME];
-            //_logger.LogInformation(string.Format(AddLocalizationExtension._e[WELCOME].Value));
+            // ### END ::: The localization can be accessed.
 
             var products = await _db.Products.AsQueryable().ToListAsync();
 
@@ -46,7 +47,7 @@ public async Task<IActionResult> GetAsync(string culture = "en-US")
         /// </summary>
         /// <param name="id">Enter the id of product</param>
         /// <returns>Returns list of products</returns>
-        [Authorize(Policy = "ShouldBeAReader")]
+        [Authorize(Policy = Policy.ShouldBeAReader)]
         [ApiVersion(ApiVersionNumbers.V1)]
         [HttpGet("{id}", Name = RouteNames.GetByIdAsync)]
         [ProducesResponseType(StatusCodes.Status200OK, Type = typeof(ProductDTO))]

src/Api/Endpoints/V1/Products/Read.cs

@@ -18,7 +18,7 @@ public partial class ProductsController
         /// <param name="product">Enter the product</param>
         /// <param name="culture"></param>
         /// <returns></returns>
-        [Authorize(Policy = "ShouldBeAReader")]
+        [Authorize(Policy = Policy.ShouldBeAnEditor)]
         [ApiVersion(ApiVersionNumbers.V1)]
         [HttpPut("{id}", Name = RouteNames.PutAsync)]
         [ProducesResponseType(StatusCodes.Status204NoContent)]

src/Api/Endpoints/V1/Products/Update.cs

@@ -14,14 +14,6 @@ public static async Task Main(string[] args)
         {
             var webHost = CreateHostBuilder(args).Build();
 
-            using (var scope = webHost.Services.CreateScope())
-            {
-                var context = scope.ServiceProvider.GetRequiredService<Database>();
-
-                var productCount = await context.Products.CountAsync();
-                if (context != null && context.Database != null && productCount == 0)
-                    await context.Database.MigrateAsync();
-            }
             await webHost.RunAsync();
         }