APPMAN-1314 display max funding on edit apprenticeship page

src/Approvals/SFA.DAS.Approvals.Api.UnitTests/Controllers/TrainingCourses/WhenGettingCourseFundingBandDetails.cs

@@ -0,0 +1,78 @@
+using System;
+using System.Net;
+using System.Threading;
+using System.Threading.Tasks;
+using AutoFixture.NUnit3;
+using FluentAssertions;
+using MediatR;
+using Microsoft.AspNetCore.Mvc;
+using Moq;
+using NUnit.Framework;
+using SFA.DAS.Approvals.Api.Controllers;
+using SFA.DAS.Approvals.Application.Courses.Queries;
+using SFA.DAS.Testing.AutoFixture;
+
+namespace SFA.DAS.Approvals.Api.UnitTests.Controllers.TrainingCourses
+{
+    public class WhenGettingCourseFundingBandDetails
+    {
+        [Test, MoqAutoData]
+        public async Task Then_Gets_FundingBand_From_Mediator(
+                   string courseCode,
+                   DateTime startDate,
+                   GetFundingBandResult mediatorResult,
+                   [Frozen] Mock<IMediator> mockMediator,
+                   [Greedy] TrainingCoursesController controller)
+        {
+            mockMediator
+                .Setup(mediator => mediator.Send(
+                    It.Is<GetFundingBandQuery>(x => x.CourseCode == courseCode && x.StartDate == startDate),
+                    It.IsAny<CancellationToken>()))
+                .ReturnsAsync(mediatorResult);
+
+            var controllerResult = await controller.GetFundingBand(courseCode, startDate) as ObjectResult;
+
+            Assert.That(controllerResult, Is.Not.Null);
+            controllerResult.StatusCode.Should().Be((int)HttpStatusCode.OK);
+            var model = controllerResult.Value as GetFundingBandResult;
+            Assert.That(model, Is.Not.Null);
+            model.Should().BeEquivalentTo(mediatorResult);
+        }
+
+        [Test, MoqAutoData]
+        public async Task And_Then_No_FundingBand_Is_Returned_From_Mediator(
+            string courseCode,
+            DateTime startDate,
+            [Frozen] Mock<IMediator> mockMediator,
+            [Greedy] TrainingCoursesController controller)
+        {
+            mockMediator
+                .Setup(mediator => mediator.Send(
+                    It.Is<GetFundingBandQuery>(x => x.CourseCode == courseCode && x.StartDate == startDate),
+                    It.IsAny<CancellationToken>()))
+                .ReturnsAsync((GetFundingBandResult)null);
+
+            var controllerResult = await controller.GetFundingBand(courseCode, startDate) as NotFoundResult;
+
+            controllerResult.StatusCode.Should().Be((int)HttpStatusCode.NotFound);
+        }
+
+        [Test, MoqAutoData]
+        public async Task And_Exception_Then_Returns_InternalServerError(
+            string courseCode,
+            DateTime startDate,
+            [Frozen] Mock<IMediator> mockMediator,
+            [Greedy] TrainingCoursesController controller)
+        {
+            mockMediator
+                .Setup(mediator => mediator.Send(
+                    It.IsAny<GetFundingBandQuery>(),
+                    It.IsAny<CancellationToken>()))
+                .Throws<InvalidOperationException>();
+
+            var controllerResult = await controller.GetFundingBand(courseCode, startDate) as StatusCodeResult;
+
+            controllerResult.StatusCode.Should().Be((int)HttpStatusCode.InternalServerError);
+        }
+    }
+}

src/Approvals/SFA.DAS.Approvals.Api/Controllers/TrainingCoursesController.cs

@@ -1,10 +1,12 @@
 using System;
 using System.Linq;
+using System.Net;
 using System.Threading.Tasks;
 using MediatR;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.Extensions.Logging;
 using SFA.DAS.Approvals.Api.Models;
+using SFA.DAS.Approvals.Application.Courses.Queries;
 using SFA.DAS.Approvals.Application.TrainingCourses.Queries;
 
 namespace SFA.DAS.Approvals.Api.Controllers
@@ -90,5 +92,27 @@ public async Task<IActionResult> GetStandard(string courseCode)
                 return BadRequest();
             }
         }
+
+        [HttpGet]
+        [Route("{courseCode}/funding-band")]
+        public async Task<IActionResult> GetFundingBand(string courseCode, [FromQuery] DateTime? startDate)
+        {
+            try
+            {
+                _logger.LogInformation("Getting Funding Band details for course {courseId} with start date of {startDate}", courseCode, startDate);
+                var result = await _mediator.Send(new GetFundingBandQuery { CourseCode = courseCode, StartDate = startDate });
+                if (result == null)
+                {
+                    return NotFound();
+                }
+
+                return Ok(result);
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "Error gettingFunding Band details {courseId}", courseCode);
+                return new StatusCodeResult((int)HttpStatusCode.InternalServerError);
+            }
+        }
     }
 }

src/Approvals/SFA.DAS.Approvals.UnitTests/Application/Apprentices/Queries/GetFundingBandQueryHandlerTests.cs

@@ -0,0 +1,75 @@
+using System.Collections.Generic;
+using System;
+using System.Threading;
+using System.Threading.Tasks;
+using AutoFixture;
+using FluentAssertions;
+using Moq;
+using NUnit.Framework;
+using SFA.DAS.Approvals.Application.Courses.Queries;
+using SFA.DAS.Approvals.InnerApi.CommitmentsV2Api.Requests.Courses;
+using SFA.DAS.Approvals.InnerApi.CommitmentsV2Api.Responses;
+using SFA.DAS.SharedOuterApi.Configuration;
+using SFA.DAS.SharedOuterApi.Interfaces;
+
+namespace SFA.DAS.Approvals.UnitTests.Application.Apprentices.Queries;
+
+[TestFixture]
+public class GetFundingBandQueryHandlerTests
+{
+    private GetFundingBandQueryHandler _handler;
+    private Mock<ICommitmentsV2ApiClient<CommitmentsV2ApiConfiguration>> _apiClient;
+
+    private GetTrainingProgrammeResponse _trainingProgrammeResponse;
+    private GetFundingBandQuery _query;
+
+    [SetUp]
+    public void Setup()
+    {
+        var fixture = new Fixture();
+
+        _query = fixture.Create<GetFundingBandQuery>();
+        _trainingProgrammeResponse = new GetTrainingProgrammeResponse();
+        _trainingProgrammeResponse.TrainingProgramme = new TrainingProgramme
+        {
+            CourseCode = _query.CourseCode,
+            StandardUId = "XXXX",
+            StandardPageUrl = "https://test123",
+            FundingPeriods = new List<TrainingProgrammeFundingPeriod>()
+            {
+                new TrainingProgrammeFundingPeriod
+                    {EffectiveFrom = DateTime.MinValue, EffectiveTo = DateTime.MaxValue, FundingCap = 1234}
+            }
+        };
+
+        _apiClient = new Mock<ICommitmentsV2ApiClient<CommitmentsV2ApiConfiguration>>();
+
+        _apiClient.Setup(x =>
+                x.Get<GetTrainingProgrammeResponse>(It.Is<GetCalculatedVersionOfTrainingProgrammeRequest>(r =>
+                    r.CourseCode == _query.CourseCode && r.StartDate == _query.StartDate.Value)))
+            .ReturnsAsync(_trainingProgrammeResponse);
+
+        _handler = new GetFundingBandQueryHandler(_apiClient.Object);
+    }
+
+    [Test]
+    public async Task Handle_Returns_FundingInfo_From_Commitments_Api()
+    {
+        var result = await _handler.Handle(_query, CancellationToken.None);
+        result.StandardPageUrl.Should().Be(_trainingProgrammeResponse.TrainingProgramme.StandardPageUrl);
+        result.Version.Should().Be(_trainingProgrammeResponse.TrainingProgramme.Version);
+    }
+
+    [Test]
+    public async Task Handle_Returns_null_if_FundingInfo_not_found()
+    {
+        _apiClient.Setup(x =>
+                x.Get<GetTrainingProgrammeResponse>(It.Is<GetCalculatedVersionOfTrainingProgrammeRequest>(r =>
+                    r.CourseCode == _query.CourseCode && r.StartDate == _query.StartDate.Value)))
+            .ReturnsAsync((GetTrainingProgrammeResponse) null);
+
+        var result = await _handler.Handle(_query, CancellationToken.None);
+        Assert.That(result, Is.Null);
+    }
+}
+

src/Approvals/SFA.DAS.Approvals/Application/Courses/Queries/GetFundingBandQuery.cs

@@ -0,0 +1,11 @@
+using System;
+using MediatR;
+
+namespace SFA.DAS.Approvals.Application.Courses.Queries
+{
+    public class GetFundingBandQuery : IRequest<GetFundingBandResult>
+    {
+        public string CourseCode { get; set; }
+        public DateTime? StartDate { get; set; }
+    }
+}

src/Approvals/SFA.DAS.Approvals/Application/Courses/Queries/GetFundingBandQueryHandler.cs

@@ -0,0 +1,48 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Threading;
+using System.Threading.Tasks;
+using MediatR;
+using SFA.DAS.Approvals.InnerApi.CommitmentsV2Api.Requests.Courses;
+using SFA.DAS.Approvals.InnerApi.CommitmentsV2Api.Responses;
+using SFA.DAS.SharedOuterApi.Configuration;
+using SFA.DAS.SharedOuterApi.Interfaces;
+
+namespace SFA.DAS.Approvals.Application.Courses.Queries;
+
+public class GetFundingBandQueryHandler : IRequestHandler<GetFundingBandQuery, GetFundingBandResult>
+{
+    private readonly ICommitmentsV2ApiClient<CommitmentsV2ApiConfiguration> _apiClient;
+
+    public GetFundingBandQueryHandler(ICommitmentsV2ApiClient<CommitmentsV2ApiConfiguration> apiClient)
+    {
+        _apiClient = apiClient;
+    }
+
+    public async Task<GetFundingBandResult> Handle(GetFundingBandQuery request, CancellationToken cancellationToken)
+    {
+        var result = await _apiClient.Get<GetTrainingProgrammeResponse>(new GetCalculatedVersionOfTrainingProgrammeRequest(request.CourseCode, request.StartDate));
+
+        if (result?.TrainingProgramme == null)
+            return null;
+
+        return new GetFundingBandResult
+        {
+            StandardUId = result.TrainingProgramme.StandardUId,
+            Version = result.TrainingProgramme.Version,
+            StandardPageUrl = result.TrainingProgramme.StandardPageUrl,
+            ProposedMaxFunding = GetFundingBandForDate(result.TrainingProgramme.FundingPeriods, request.StartDate),
+        };
+    }
+
+    private static int? GetFundingBandForDate(List<TrainingProgrammeFundingPeriod> bands, DateTime? forDate)
+    {
+        forDate ??= DateTime.Today;
+        var match = bands.FirstOrDefault(x =>
+            x.EffectiveFrom <= forDate && (x.EffectiveTo ?? DateTime.Today.AddYears(5)) >= forDate);
+        return match?.FundingCap;
+    }
+}
+
+

src/Approvals/SFA.DAS.Approvals/Application/Courses/Queries/GetFundingBandResult.cs

@@ -0,0 +1,9 @@
+namespace SFA.DAS.Approvals.Application.Courses.Queries;
+
+public class GetFundingBandResult
+{
+    public string StandardUId { get; set; }
+    public string Version { get; set; }
+    public string StandardPageUrl { get; set; }
+    public int? ProposedMaxFunding { get; set; }
+}

src/Approvals/SFA.DAS.Approvals/InnerApi/CommitmentsV2Api/Requests/Courses/GetCalculatedVersionOfTrainingProgrammeRequest.cs

@@ -0,0 +1,19 @@
+using System;
+using SFA.DAS.SharedOuterApi.Interfaces;
+
+namespace SFA.DAS.Approvals.InnerApi.CommitmentsV2Api.Requests.Courses
+{
+    public class GetCalculatedVersionOfTrainingProgrammeRequest : IGetApiRequest
+    {
+        public readonly string CourseCode;
+        public readonly DateTime StartDate;
+
+        public GetCalculatedVersionOfTrainingProgrammeRequest(string courseCode, DateTime? startDate)
+        {
+            CourseCode = courseCode;
+            StartDate = startDate.HasValue ? startDate.Value : DateTime.Today;
+        }
+
+        public string GetUrl => $"api/TrainingProgramme/calculate-version/{CourseCode}?startDate={StartDate.ToString("yyyy-MM-dd")}";
+    }
+}