Merge pull request #438 from bcgov/tasks/ecer-2758

ECER-2758: Renewal Validation Infra

src/Directory.Packages.props

@@ -34,6 +34,7 @@
     <PackageVersion Include="Microsoft.PowerPlatform.Dataverse.Client" Version="1.1.22" />
     <PackageVersion Include="Microsoft.PowerPlatform.Dataverse.Client.Dynamics" Version="1.1.27" />
     <PackageVersion Include="MinimalApis.Extensions" Version="0.11.0" />
+    <PackageVersion Include="Moq" Version="4.20.70" />
     <PackageVersion Include="nClam" Version="9.0.0" />
     <PackageVersion Include="Serilog.AspNetCore" Version="8.0.2" />
     <PackageVersion Include="Shouldly" Version="4.2.1" />

src/ECER.Engines.Validation/Applications/ApplicationRenewalValidationEngine.cs

@@ -0,0 +1,80 @@
+using ECER.Managers.Registry.Contract.Applications;
+using ECER.Resources.Documents.Certifications;
+using System.Runtime.CompilerServices;
+
+namespace ECER.Engines.Validation.Applications;
+
+internal sealed partial class ApplicationRenewalValidationEngine : IApplicationValidationEngine
+{
+  private ICertificationRepository _certificateRepository;
+
+  public ApplicationRenewalValidationEngine(ICertificationRepository certificationRepository)
+  {
+    _certificateRepository = certificationRepository;
+  }
+
+  public async Task<ValidationResults> Validate(Application application)
+  {
+    await Task.CompletedTask;
+    var validationErrors = new List<string>();
+
+    if (application.CertificationTypes.Contains(CertificationType.EceAssistant))
+    {
+      validationErrors = await EceAssistant(application);
+    }
+    else if (application.CertificationTypes.Contains(CertificationType.OneYear))
+    {
+      validationErrors = await OneYear(application);
+    }
+    else if (application.CertificationTypes.Contains(CertificationType.FiveYears))
+    {
+      validationErrors = await FiveYears(application);
+    }
+    return new ValidationResults(validationErrors);
+  }
+
+  private enum CertificateStatus
+  {
+    Active,
+    ExpiredLessThanFiveYearsAgo,
+    ExpiredMoreThanFiveYearsAgo,
+    NoCertificateFound
+  }
+
+  private async Task<CertificateStatus> GetCertificateStatus(string applicantId)
+  {
+    try
+    {
+      var expiryDate = await getLastCertificateExpiryDate(applicantId);
+      var now = DateTime.Now;
+
+      if (expiryDate > now)
+      {
+        return CertificateStatus.Active;
+      }
+      else if (expiryDate <= now && expiryDate > now.AddYears(-5))
+      {
+        return CertificateStatus.ExpiredLessThanFiveYearsAgo;
+      }
+      else
+      {
+        return CertificateStatus.ExpiredMoreThanFiveYearsAgo;
+      }
+    }
+    catch (InvalidOperationException)
+    {
+      return CertificateStatus.NoCertificateFound;
+    }
+  }
+
+  private async Task<DateTime> getLastCertificateExpiryDate(string applicantId)
+  {
+    var certificates = await _certificateRepository.Query(new UserCertificationQuery() { ByApplicantId = applicantId });
+    var lastCertificate = certificates.OrderByDescending(d => d.ExpiryDate).FirstOrDefault();
+    if (lastCertificate == null || lastCertificate.ExpiryDate == null)
+    {
+      throw new InvalidOperationException("Certificate or datetime is null");
+    }
+    return (DateTime)lastCertificate.ExpiryDate;
+  }
+}

src/ECER.Engines.Validation/Applications/ApplicationSubmissionValidationEngine.cs

@@ -2,7 +2,7 @@
 
 namespace ECER.Engines.Validation.Applications;
 
-internal sealed class ApplicationSubmissionValidationEngine : IApplicationSubmissionValidationEngine
+internal sealed class ApplicationSubmissionValidationEngine : IApplicationValidationEngine
 {
   private static readonly IEnumerable<CertificationType> fiveYearNestedCertificationTypes = new[] { CertificationType.Ite, CertificationType.Sne };
 

src/ECER.Engines.Validation/Applications/ApplicationValidationEngineResolver.cs

@@ -0,0 +1,29 @@
+using ECER.Managers.Registry.Contract.Applications;
+using Microsoft.Extensions.DependencyInjection;
+
+namespace ECER.Engines.Validation.Applications;
+
+public interface IApplicationValidationEngineResolver
+{
+  IApplicationValidationEngine Resolve(ApplicationTypes appType);
+}
+
+public class ApplicationValidationEngineResolver : IApplicationValidationEngineResolver
+{
+  private readonly IServiceProvider _serviceProvider;
+
+  public ApplicationValidationEngineResolver(IServiceProvider serviceProvider)
+  {
+    _serviceProvider = serviceProvider;
+  }
+
+  public IApplicationValidationEngine Resolve(ApplicationTypes appType)
+  {
+    return appType switch
+    {
+      ApplicationTypes.New => _serviceProvider.GetRequiredService<ApplicationSubmissionValidationEngine>(),
+      ApplicationTypes.Renewal => _serviceProvider.GetRequiredService<ApplicationRenewalValidationEngine>(),
+      _ => throw new ArgumentOutOfRangeException(nameof(appType), appType, null)
+    };
+  }
+}

src/ECER.Engines.Validation/Applications/IApplicationSubmissionValidationEngine.cs → src/ECER.Engines.Validation/Applications/IApplicationValidationEngine.cs

@@ -5,7 +5,7 @@ namespace ECER.Engines.Validation.Applications;
 /// <summary>
 /// Validates registry applications
 /// </summary>
-public interface IApplicationSubmissionValidationEngine
+public interface IApplicationValidationEngine
 {
   /// <summary>
   /// Validates if an application is completed

src/ECER.Engines.Validation/Applications/RenewalValidationConditions/EceAssistant.cs

@@ -0,0 +1,27 @@
+using ECER.Managers.Registry.Contract.Applications;
+
+namespace ECER.Engines.Validation.Applications;
+
+internal sealed partial class ApplicationRenewalValidationEngine
+{
+  private async Task<List<string>> EceAssistant(Application application)
+  {
+    await Task.CompletedTask;
+    var validationErrors = new List<string>();
+    switch (await GetCertificateStatus(application.RegistrantId))
+    {
+      case CertificateStatus.Active:
+        break;
+
+      case CertificateStatus.ExpiredLessThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.ExpiredMoreThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.NoCertificateFound:
+        break;
+    }
+    return validationErrors;
+  }
+}

src/ECER.Engines.Validation/Applications/RenewalValidationConditions/FiveYears.cs

@@ -0,0 +1,27 @@
+using ECER.Managers.Registry.Contract.Applications;
+
+namespace ECER.Engines.Validation.Applications;
+
+internal sealed partial class ApplicationRenewalValidationEngine
+{
+  private async Task<List<string>> FiveYears(Application application)
+  {
+    await Task.CompletedTask;
+    var validationErrors = new List<string>();
+    switch (await GetCertificateStatus(application.RegistrantId))
+    {
+      case CertificateStatus.Active:
+        break;
+
+      case CertificateStatus.ExpiredLessThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.ExpiredMoreThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.NoCertificateFound:
+        break;
+    }
+    return validationErrors;
+  }
+}

src/ECER.Engines.Validation/Applications/RenewalValidationConditions/OneYear.cs

@@ -0,0 +1,38 @@
+using ECER.Managers.Registry.Contract.Applications;
+
+namespace ECER.Engines.Validation.Applications;
+
+internal sealed partial class ApplicationRenewalValidationEngine
+{
+  private async Task<List<string>> OneYear(Application application)
+  {
+    await Task.CompletedTask;
+    var validationErrors = new List<string>();
+    switch (await GetCertificateStatus(application.RegistrantId))
+    {
+      case CertificateStatus.Active:
+
+        // each application should contain explanation letter
+        if (string.IsNullOrEmpty(application.ExplanationLetter))
+        {
+          validationErrors.Add("the application does not have explanation letter");
+        }
+        // each application should contain at least one character reference
+        if (!application.CharacterReferences.Any())
+        {
+          validationErrors.Add("the application does not have any character references");
+        }
+        break;
+
+      case CertificateStatus.ExpiredLessThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.ExpiredMoreThanFiveYearsAgo:
+        break;
+
+      case CertificateStatus.NoCertificateFound:
+        break;
+    }
+    return validationErrors;
+  }
+}

src/ECER.Engines.Validation/Configurer.cs

@@ -7,8 +7,15 @@ namespace ECER.Engines.Validation;
 
 public class Configurer : IConfigureComponents
 {
-    public void Configure([NotNull] ConfigurationContext configurationContext)
+  public void Configure([NotNull] ConfigurationContext configurationContext)
+  {
+    configurationContext.Services.AddTransient<ApplicationSubmissionValidationEngine>();
+    configurationContext.Services.AddTransient<ApplicationRenewalValidationEngine>();
+    configurationContext.Services.AddTransient<IApplicationValidationEngineResolver, ApplicationValidationEngineResolver>();
+
+    configurationContext.Services.AddTransient<IApplicationValidationEngine>(provider =>
     {
-        configurationContext.Services.AddTransient<IApplicationSubmissionValidationEngine, ApplicationSubmissionValidationEngine>();
-    }
+      return provider.GetRequiredService<ApplicationSubmissionValidationEngine>();
+    });
+  }
 }

src/ECER.Engines.Validation/ECER.Engines.Validation.csproj

@@ -5,5 +5,6 @@
   <ItemGroup>
     <ProjectReference Include="..\ECER.Infrastructure.Common\ECER.Infrastructure.Common.csproj" />
     <ProjectReference Include="..\ECER.Managers.Registry.Contract\ECER.Managers.Registry.Contract.csproj" />
+    <ProjectReference Include="..\ECER.Resources.Documents\ECER.Resources.Documents.csproj" />
   </ItemGroup>
 </Project>

src/ECER.Managers.Registry/ApplicationHandlers.cs

@@ -19,7 +19,7 @@ public class ApplicationHandlers(
     IPortalInvitationRepository portalInvitationRepository,
      IApplicationRepository applicationRepository,
      IMapper mapper,
-     IApplicationSubmissionValidationEngine validationEngine,
+     IApplicationValidationEngineResolver validationResolver,
      EcerContext ecerContext)
   : IRequestHandler<SaveDraftApplicationCommand, string>,
     IRequestHandler<CancelDraftApplicationCommand, string>,
@@ -109,6 +109,7 @@ public async Task<ApplicationSubmissionResult> Handle(SubmitApplicationCommand r
     }
     var draftApplication = draftApplicationResults.Items.First();
 
+    var validationEngine = validationResolver?.Resolve(draftApplication.ApplicationType);
     var validationErrors = await validationEngine?.Validate(draftApplication)!;
     if (validationErrors.ValidationErrors.Any())
     {

src/ECER.Resources.Documents/Certifications/ICertificationRepository.cs

@@ -9,6 +9,7 @@ public record UserCertificationQuery
 {
   public string? ById { get; set; }
   public string? ByApplicantId { get; set; }
+  public string? ByApplicationId { get; set; }
 }
 
 public record Certification(string Id)

src/ECER.Tests/ECER.Tests.csproj

@@ -1,6 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
+    <AssemblyName>ECER.Tests</AssemblyName>
     <IsPackable>false</IsPackable>
     <IsTestProject>true</IsTestProject>
     <NoWarn>CA1001;1701;1702;CA1707</NoWarn>
@@ -11,6 +12,7 @@
     <PackageReference Include="Bogus" />
     <PackageReference Include="MartinCostello.Logging.XUnit" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
+    <PackageReference Include="Moq" />
     <PackageReference Include="Shouldly" />
     <PackageReference Include="xunit" />
     <PackageReference Include="xunit.categories" />

src/ECER.Tests/Integration/Api/FileTests.cs

@@ -1,8 +1,7 @@
-using System.Net.Http.Headers;
-using Alba;
+using Alba;
 using Bogus;
-using ECER.Tests.Integration;
 using Shouldly;
+using System.Net.Http.Headers;
 using Xunit.Abstractions;
 using Xunit.Categories;
 

src/ECER.Tests/Integration/AuthenticationHelper.cs

@@ -1,6 +1,6 @@
-using System.Security.Claims;
-using Alba;
+using Alba;
 using ECER.Utilities.Security;
+using System.Security.Claims;
 
 namespace ECER.Tests.Integration;
 

src/ECER.Tests/Integration/RegistryApi/ApplicationTests.cs

@@ -1,13 +1,11 @@
 using Alba;
 using Bogus;
 using ECER.Clients.RegistryPortal.Server.Applications;
+using ECER.Clients.RegistryPortal.Server.Files;
 using Shouldly;
 using System.Net;
-using Xunit.Abstractions;
 using System.Net.Http.Headers;
-using Xunit.Categories;
-using ECER.Clients.RegistryPortal.Server.Files;
-using System;
+using Xunit.Abstractions;
 
 namespace ECER.Tests.Integration.RegistryApi;
 

src/ECER.Tests/Integration/RegistryApi/FileTests.cs

@@ -1,9 +1,8 @@
-using System.Net.Http.Headers;
-using Alba;
+using Alba;
 using Bogus;
+using System.Net.Http.Headers;
 using Xunit.Abstractions;
 using Xunit.Categories;
-using Xunit.Sdk;
 
 namespace ECER.Tests.Integration.RegistryApi;
 

src/ECER.Tests/Integration/RegistryApi/ProfileTests.cs

@@ -41,7 +41,7 @@ private PreviousName CreatePreviousName()
       faker.Name.FirstName(), faker.Name.LastName()
     );
   }
-  
+
   private UserProfile CreateNewUser()
   {
     var address = new Faker<Address>("en_CA")
@@ -53,7 +53,6 @@ private UserProfile CreateNewUser()
             f.Address.State(), f.Address.Country()
             ));
 
-
     return new Faker<UserProfile>("en_CA")
       .RuleFor(f => f.FirstName, f => f.Name.FirstName())
       .RuleFor(f => f.LastName, f => f.Name.LastName())

src/ECER.Tests/Integration/RegistryApi/UserInfoTests.cs

@@ -1,9 +1,9 @@
-using System.Net;
-using Alba;
+using Alba;
 using Bogus;
 using ECER.Clients.RegistryPortal.Server.Users;
 using ECER.Utilities.Security;
 using Shouldly;
+using System.Net;
 using Xunit.Abstractions;
 
 namespace ECER.Tests.Integration.RegistryApi;