194580 - productversions integration with scs stub

UKHO.ExchangeSetService.API/UKHO.ExchangeSetService.API.FunctionalTests/FunctionalTests/S-100/S100EssEndPointsAuthorizationScenarios.cs → UKHO.ExchangeSetService.API/UKHO.ExchangeSetService.API.FunctionalTests/FunctionalTests/S-100/S100EssEndPointsScenarios.cs

@@ -8,7 +8,7 @@
 
 namespace UKHO.ExchangeSetService.API.FunctionalTests.FunctionalTests.S_100
 {
-    public class S100EssEndPointsAuthorizationScenarios : ObjectStorage
+    public class S100EssEndPointsScenarios : ObjectStorage
     {
         private string sinceDateTime;
         private UpdatesSinceModel sinceDateTimePayload;
@@ -21,10 +21,8 @@ public void OneTimeSetUp()
             sinceDateTimePayload = DataHelper.GetSinceDateTime(sinceDateTime);
             ProductVersionData =
             [
-                DataHelper.GetProductVersionModelData("101GB40079ABCDEFG", 7, 10),
-                DataHelper.GetProductVersionModelData("102NO32904820801012", 36, 0),
-                DataHelper.GetProductVersionModelData("104US00_CHES_TYPE1_20210630_0600", 7, 10),
-                DataHelper.GetProductVersionModelData("111US00_ches_dcf8_20190703T00Z", 36, 0)
+                DataHelper.GetProductVersionModelData("102NO32904820801012",7, 1),
+                DataHelper.GetProductVersionModelData("104US00_CHES_TYPE1_20210630_0600", 1, 0),
             ];
             productNames = DataHelper.GetProductNamesForS100();
         }
@@ -56,7 +54,7 @@ public async Task WhenICallS100ProductNamesEndPointWithValidTokenAndOneOfTheInva
             var apiResponse = await ExchangeSetApiClient.GetProductIdentifiersDataAsync(productNames, null, EssJwtToken, "s100");
             Assert.That((int)apiResponse.StatusCode, Is.EqualTo(202), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 202.");
             var expectedRequestedProductsNotInExchangeSet = new Dictionary<string, string> { { "102NO32904820801012", "invalidProduct" } };
-            await apiResponse.VerifyEssS100ApiResponseBodyDetails(4, 4, 0, expectedRequestedProductsNotInExchangeSet);
+            await apiResponse.VerifyEssS100ApiResponseBodyDetails(4, 3, 0, expectedRequestedProductsNotInExchangeSet);
         }
 
         //PBI 194403: Azure AD Authorization
@@ -76,11 +74,11 @@ public async Task WhenICallS100ProductNamesEndPointWithValidTokenAndDuplicatePro
         //PBI 194579: Integrate S-100 ESS API Endpoint /productNames with corresponding SCS Stub
         [Test]
         [Category("QCOnlyTest-AIOEnabled")]
-        public async Task WhenICallS100ProductNamesEndPointWithValidTokenAndNonExistingProduct_ThenResponseCodeReturnedIs500InternalServerError()
+        public async Task WhenICallS100ProductNamesEndPointWithValidTokenAndNonExistingProduct_ThenResponseCodeReturnedIs400BadRequest()
         {
             var nonExistingProduct = new List<string>() { "103GB40079ABCDEFG" };
             var apiResponse = await ExchangeSetApiClient.GetProductIdentifiersDataAsync(nonExistingProduct, null, EssJwtToken, "s100");
-            Assert.That((int)apiResponse.StatusCode, Is.EqualTo(500), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 500.");
+            Assert.That((int)apiResponse.StatusCode, Is.EqualTo(400), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 500.");
         }
 
         //PBI 194403: Azure AD Authorization
@@ -93,18 +91,55 @@ public async Task WhenICallS100ProductNamesEndPointWithInvalidToken_ThenResponse
         }
 
         //PBI 194403: Azure AD Authorization
+        //PBI 194580: Integrate S-100 ESS API Endpoint /productVersions with corresponding SCS Stub
         [Test]
         [Category("QCOnlyTest-AIOEnabled")]
-        public async Task WhenICallS100ProductVersionsEndPointWithValidToken_ThenResponseCodeReturnedIs202Accepted()
+        public async Task WhenICallS100ProductVersionsEndPointWithValidTokenAndOneOfTheInvalidProduct_ThenResponseCodeReturnedIs202Accepted()
         {
             var apiResponse = await ExchangeSetApiClient.GetProductVersionsAsync(ProductVersionData, null, EssJwtToken, "s100");
             Assert.That((int)apiResponse.StatusCode, Is.EqualTo(202), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 202.");
+            var expectedRequestedProductsNotInExchangeSet = new Dictionary<string, string> { { "104US00_CHES_TYPE1_20210630_0600", "invalidProduct" } };
+            await apiResponse.VerifyEssS100ApiResponseBodyDetails(2, 1, 0, expectedRequestedProductsNotInExchangeSet);
+        }
+
+        //PBI 194403: Azure AD Authorization
+        //PBI 194580: Integrate S-100 ESS API Endpoint /productVersions with corresponding SCS Stub
+        [Test]
+        [Category("QCOnlyTest-AIOEnabled")]
+        public async Task WhenICallS100ProductVersionsEndPointWithValidTokenAndNonExistingProduct_ThenResponseCodeReturnedIs400BadRequest()
+        {
+            List<ProductVersionModel> nonExistingProductVersionData = [ DataHelper.GetProductVersionModelData("103GB40079ABCDEFG", 10, 0) ];
+            var apiResponse = await ExchangeSetApiClient.GetProductVersionsAsync(nonExistingProductVersionData, null, EssJwtToken, "s100");
+            Assert.That((int)apiResponse.StatusCode, Is.EqualTo(400), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 500.");
+        }
+
+        //PBI 194403: Azure AD Authorization
+        //PBI 194580: Integrate S-100 ESS API Endpoint /productVersions with corresponding SCS Stub
+        [Test]
+        [Category("QCOnlyTest-AIOEnabled")]
+        public async Task WhenICallS100ProductVersionsEndPointWithValidTokenAndProductWithNoUpdates_ThenResponseCodeReturnedIs202Accepted()
+        {
+            List<ProductVersionModel> nonModifiedProductVersionData = [DataHelper.GetProductVersionModelData("101GB40079ABCDEFG", 4, 1)];
+            var apiResponse = await ExchangeSetApiClient.GetProductVersionsAsync(nonModifiedProductVersionData, null, EssJwtToken, "s100");
+            Assert.That((int)apiResponse.StatusCode, Is.EqualTo(202), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 202.");
+            await apiResponse.VerifyEssS100ApiResponseBodyDetails(1, 0, 1);
+        }
+
+        //PBI 194403: Azure AD Authorization
+        //PBI 194580: Integrate S-100 ESS API Endpoint /productVersions with corresponding SCS Stub
+        [Test]
+        [Category("QCOnlyTest-AIOEnabled")]
+        public async Task WhenICallS100ProductVersionsEndPointWithValidTokenAndProductHavingInvalidEdition_ThenResponseCodeReturnedIs400BadRequest()
+        {
+            List<ProductVersionModel> invalidEditionProductVersionData = [DataHelper.GetProductVersionModelData("102NO32904820801012", -2, 0)];
+            var apiResponse = await ExchangeSetApiClient.GetProductVersionsAsync(invalidEditionProductVersionData, null, EssJwtToken, "s100");
+            Assert.That((int)apiResponse.StatusCode, Is.EqualTo(400), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 400.");
         }
 
         //PBI 194403: Azure AD Authorization
         [Test]
         [Category("QCOnlyTest-AIOEnabled")]
-        public async Task WhenICallS100ProductVersionsEndPointWithInvalidToken_ThenResponseCodeReturnedIs401unauthorized()
+        public async Task WhenICallS100ProductVersionsEndPointWithInvalidToken_ThenResponseCodeReturnedIs401Unauthorized()
         {
             var apiResponse = await ExchangeSetApiClient.GetProductVersionsAsync(ProductVersionData, null, "InvalidEssJwtToken", "s100");
             Assert.That((int)apiResponse.StatusCode, Is.EqualTo(401), $"Incorrect status code is returned {apiResponse.StatusCode}, instead of the expected 401.");

UKHO.ExchangeSetService.API/UKHO.ExchangeSetService.API.FunctionalTests/Helper/ModelStructureCheck.cs

@@ -6,6 +6,7 @@
 using System.Net.Http;
 using System.Threading.Tasks;
 using UKHO.ExchangeSetService.API.FunctionalTests.Models;
+using static UKHO.ExchangeSetService.API.FunctionalTests.Models.EssS100ResponseModel;
 
 namespace UKHO.ExchangeSetService.API.FunctionalTests.Helper
 {
@@ -204,7 +205,6 @@ public static async Task CheckModelStructureForAioSuccessResponse(this HttpRespo
         /// <param name="exchangeSetProductCount"></param>
         /// <param name="requestedProductsAlreadyUpToDateCount"></param>
         /// <param name="requestedProductsNotInExchangeSet"></param>
-        /// <returns></returns>
         public static async Task VerifyEssS100ApiResponseBodyDetails(this HttpResponseMessage apiResponse, int requestedProductCount, int exchangeSetProductCount, int requestedProductsAlreadyUpToDateCount, Dictionary<string, string> requestedProductsNotInExchangeSet = null)
         {
             var responseBody = JsonConvert.DeserializeObject<ExchangeSetBatch>(await apiResponse.Content.ReadAsStringAsync());

UKHO.ExchangeSetService.API/UKHO.ExchangeSetService.API.FunctionalTests/Models/EssS100ResponseModel.cs

@@ -3,27 +3,30 @@
 
 namespace UKHO.ExchangeSetService.API.FunctionalTests.Models
 {
-    public class ExchangeSetLinks
+    public class EssS100ResponseModel
     {
-        public Uri ExchangeSetBatchStatusUri { get; set; }
-        public Uri ExchangeSetBatchDetailsUri { get; set; }
-        public Uri ExchangeSetFileUri { get; set; }
-    }
+        public class ExchangeSetLinks
+        {
+            public Uri ExchangeSetBatchStatusUri { get; set; }
+            public Uri ExchangeSetBatchDetailsUri { get; set; }
+            public Uri ExchangeSetFileUri { get; set; }
+        }
 
-    public class RequestedProductNotInExchangeSet
-    {
-        public string ProductName { get; set; }
-        public string Reason { get; set; }
-    }
+        public class RequestedProductNotInExchangeSet
+        {
+            public string ProductName { get; set; }
+            public string Reason { get; set; }
+        }
 
-    public class ExchangeSetBatch
-    {
-        public ExchangeSetLinks Links { get; set; }
-        public DateTime? ExchangeSetUrlExpiryDateTime { get; set; }
-        public int RequestedProductCount { get; set; }
-        public int ExchangeSetProductCount { get; set; }
-        public int RequestedProductsAlreadyUpToDateCount { get; set; }
-        public List<RequestedProductNotInExchangeSet> RequestedProductsNotInExchangeSet { get; set; }
-        public string FssBatchId { get; set; }
+        public class ExchangeSetBatch
+        {
+            public ExchangeSetLinks Links { get; set; }
+            public DateTime? ExchangeSetUrlExpiryDateTime { get; set; }
+            public int RequestedProductCount { get; set; }
+            public int ExchangeSetProductCount { get; set; }
+            public int RequestedProductsAlreadyUpToDateCount { get; set; }
+            public List<RequestedProductNotInExchangeSet> RequestedProductsNotInExchangeSet { get; set; }
+            public string FssBatchId { get; set; }
+        }
     }
 }

UKHO.ExchangeSetService.API/UKHO.ExchangeSetService.API.UnitTests/Controllers/V2/ExchangeSetControllerTests.cs

@@ -100,7 +100,7 @@ public async Task WhenValidProductVersionsIsPassed_ThenPostProductVersionsReturn
                 new () { ProductName = "102NO32904820801012", EditionNumber = 36, UpdateNumber = 0 },
             };
 
-            A.CallTo(() => _fakeExchangeSetStandardService.ProcessProductVersionsRequest(A<IEnumerable<ProductVersionRequest>>.Ignored, A<string>.Ignored, A<string>.Ignored, A<string>.Ignored, A<CancellationToken>.Ignored))
+            A.CallTo(() => _fakeExchangeSetStandardService.ProcessProductVersionsRequestAsync(A<IEnumerable<ProductVersionRequest>>.Ignored, A<ApiVersion>.Ignored, A<string>.Ignored, A<string>.Ignored, A<string>.Ignored, A<CancellationToken>.Ignored))
              .Returns(ServiceResponseResult<ExchangeSetStandardServiceResponse>
              .Accepted(null));
 
@@ -110,13 +110,13 @@ public async Task WhenValidProductVersionsIsPassed_ThenPostProductVersionsReturn
 
             A.CallTo(_fakeLogger).Where(call => call.Method.Name == "Log"
             && call.GetArgument<LogLevel>(0) == LogLevel.Information
-            && call.GetArgument<EventId>(1) == EventIds.PostProductVersionsRequestStart.ToEventId()
-            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard}").MustHaveHappened();
+            && call.GetArgument<EventId>(1) == EventIds.ESSPostProductVersionsRequestStart.ToEventId()
+            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions V2 endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard}").MustHaveHappened();
 
             A.CallTo(_fakeLogger).Where(call => call.Method.Name == "Log"
             && call.GetArgument<LogLevel>(0) == LogLevel.Information
-            && call.GetArgument<EventId>(1) == EventIds.PostProductVersionsRequestCompleted.ToEventId()
-            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard} Elapsed {Elapsed}").MustHaveHappened();
+            && call.GetArgument<EventId>(1) == EventIds.ESSPostProductVersionsRequestCompleted.ToEventId()
+            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions V2 endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard} Elapsed {Elapsed}").MustHaveHappened();
         }
 
         [Test]
@@ -128,7 +128,7 @@ public async Task WhenInvalidProductVersionsIsPassed_ThenPostProductVersionsRetu
                 new () { ProductName = "", EditionNumber = 10, UpdateNumber = 2 },
             };
 
-            A.CallTo(() => _fakeExchangeSetStandardService.ProcessProductVersionsRequest(A<IEnumerable<ProductVersionRequest>>.Ignored, A<string>.Ignored, A<string>.Ignored, A<string>.Ignored, A<CancellationToken>.Ignored))
+            A.CallTo(() => _fakeExchangeSetStandardService.ProcessProductVersionsRequestAsync(A<IEnumerable<ProductVersionRequest>>.Ignored, A<ApiVersion>.Ignored, A<string>.Ignored, A<string>.Ignored, A<string>.Ignored, A<CancellationToken>.Ignored))
                 .Returns(ServiceResponseResult<ExchangeSetStandardServiceResponse>.BadRequest(new ErrorDescription { CorrelationId = Guid.NewGuid().ToString(), Errors = [new() { Source = "requestBody", Description = "Either body is null or malformed." }] }));
 
             var result = await _controller.PostProductVersions(ExchangeSetStandard, productVersionRequest, _callbackUri);
@@ -137,13 +137,13 @@ public async Task WhenInvalidProductVersionsIsPassed_ThenPostProductVersionsRetu
 
             A.CallTo(_fakeLogger).Where(call => call.Method.Name == "Log"
             && call.GetArgument<LogLevel>(0) == LogLevel.Information
-            && call.GetArgument<EventId>(1) == EventIds.PostProductVersionsRequestStart.ToEventId()
-            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard}").MustHaveHappened();
+            && call.GetArgument<EventId>(1) == EventIds.ESSPostProductVersionsRequestStart.ToEventId()
+            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions V2 endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard}").MustHaveHappened();
 
             A.CallTo(_fakeLogger).Where(call => call.Method.Name == "Log"
             && call.GetArgument<LogLevel>(0) == LogLevel.Information
-            && call.GetArgument<EventId>(1) == EventIds.PostProductVersionsRequestCompleted.ToEventId()
-            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard} Elapsed {Elapsed}").MustHaveHappened();
+            && call.GetArgument<EventId>(1) == EventIds.ESSPostProductVersionsRequestCompleted.ToEventId()
+            && call.GetArgument<IEnumerable<KeyValuePair<string, object>>>(2)!.ToDictionary(c => c.Key, c => c.Value)["{OriginalFormat}"].ToString() == "ProductVersions V2 endpoint request for _X-Correlation-ID:{correlationId} and ExchangeSetStandard:{exchangeSetStandard} Elapsed {Elapsed}").MustHaveHappened();
         }
 
         [Test]