Merge pull request #1196 from cabinetoffice/DP-1060-PPON-Consortium-Code

DP-1060 - PPON - Consortium Code
cabinetoffice · Jan 30, 2025 · 8b07dd1 · 8b07dd1
2 parents 99c1d43 + dc92004
commit 8b07dd1
Show file tree

Hide file tree

Showing 10 changed files with 45 additions and 14 deletions.
diff --git a/Services/CO.CDP.EntityVerification.Tests/Events/EventsFactories.cs b/Services/CO.CDP.EntityVerification.Tests/Events/EventsFactories.cs
@@ -30,7 +30,8 @@ public static OrganisationRegistered GivenOrganisationRegisteredEvent(
                     Uri = null
                 }
             ],
-            Roles = ["supplier"]
+            Roles = ["supplier"],
+            Type = OrganisationInformation.OrganisationType.Organisation
         };
     }
 

diff --git a/Services/CO.CDP.EntityVerification.Tests/Ppon/OrganisationRegisteredSubscriberTests.cs b/Services/CO.CDP.EntityVerification.Tests/Ppon/OrganisationRegisteredSubscriberTests.cs
@@ -17,7 +17,7 @@ public async Task Action_GeneratesPponIdAndPersistsAndPublishes()
         var publisher = new Mock<IPublisher>();
         var generatedPpon = "92be415e5985421087bc8fee8c97d338";
 
-        pponService.Setup(x => x.GeneratePponId()).Returns(generatedPpon);
+        pponService.Setup(x => x.GeneratePponId(OrganisationInformation.OrganisationType.Organisation)).Returns(generatedPpon);
 
         var handler = new OrganisationRegisteredSubscriber(pponService.Object, pponRepository.Object, publisher.Object);
         var orgId = Guid.NewGuid();

diff --git a/Services/CO.CDP.EntityVerification.Tests/Ppon/PponServiceTests.cs b/Services/CO.CDP.EntityVerification.Tests/Ppon/PponServiceTests.cs
@@ -1,18 +1,31 @@
 using CO.CDP.EntityVerification.Ppon;
+using CO.CDP.OrganisationInformation;
 using System.Text.RegularExpressions;
 
 namespace CO.CDP.EntityVerification.Tests.Ppon;
 
 public class PponServiceTests
 {
     [Fact]
-    public void GeneratePponId_CreatesNewPponId_ReturnsPponIdWithValidLength()
+    public void GeneratePponId_CreatesNewPponIdForNonConsortium_ReturnsPponIdWithValidLength()
     {
         PponService ppon = new PponService();
-        string pponId = ppon.GeneratePponId();
+        string pponId = ppon.GeneratePponId(OrganisationType.Organisation);
         string pattern = @"^P[A-Z]{3}-\d{4}-[A-Z]{4}$";
         bool isMatch = Regex.IsMatch(pponId, pattern);
 
         Assert.True(isMatch);
     }
+
+    [Fact]
+    public void GeneratePponId_CreatesNewPponIdForConsortium_ReturnsPponIdWithValidLengthWithLastCharAsC()
+    {
+        PponService ppon = new PponService();
+        string pponId = ppon.GeneratePponId(OrganisationType.InformalConsortium);
+        string pattern = @"^P[A-Z]{3}-\d{4}-[A-Z]{3}C$";
+        bool isMatch = Regex.IsMatch(pponId, pattern);
+
+        Assert.True(isMatch);
+    }
+
 }
diff --git a/Services/CO.CDP.EntityVerification/Events/InboundEvents.cs b/Services/CO.CDP.EntityVerification/Events/InboundEvents.cs
@@ -1,3 +1,5 @@
+using CO.CDP.OrganisationInformation;
+
 namespace CO.CDP.EntityVerification.Events;
 
 public interface IEvent;
@@ -17,6 +19,8 @@ public record OrganisationRegistered : IEvent
     public IEnumerable<Identifier> AllIdentifiers() => AdditionalIdentifiers.Prepend(Identifier);
 
     public required List<string> Roles { get; init; }
+
+    public required OrganisationType Type { get; init; }
 }
 
 public record OrganisationUpdated : IEvent

diff --git a/Services/CO.CDP.EntityVerification/Ppon/IPponService.cs b/Services/CO.CDP.EntityVerification/Ppon/IPponService.cs
@@ -1,6 +1,8 @@
+using CO.CDP.OrganisationInformation;
+
 namespace CO.CDP.EntityVerification.Ppon;
 
 public interface IPponService
 {
-    string GeneratePponId();
+    string GeneratePponId(OrganisationType type);
 }
diff --git a/Services/CO.CDP.EntityVerification/Ppon/OrganisationRegisteredSubscriber.cs b/Services/CO.CDP.EntityVerification/Ppon/OrganisationRegisteredSubscriber.cs
@@ -15,7 +15,7 @@ public async Task Handle(OrganisationRegistered @event)
     {
         Persistence.Ppon newPpon = new()
         {
-            IdentifierId = pponService.GeneratePponId(),
+            IdentifierId = pponService.GeneratePponId(@event.Type),
             Name = @event.Name,
             OrganisationId = @event.Id,
             Identifiers = Identifier.GetPersistenceIdentifiers(@event.AllIdentifiers())

diff --git a/Services/CO.CDP.EntityVerification/Ppon/PponService.cs b/Services/CO.CDP.EntityVerification/Ppon/PponService.cs
@@ -1,31 +1,36 @@
+using CO.CDP.OrganisationInformation;
 using System.Text;
 
 namespace CO.CDP.EntityVerification.Ppon;
 
 public class PponService : IPponService
 {
     private readonly char[] ValidAlphaChars = "BCDGHJLMNPQRTVWXYZ".ToCharArray();
-    private readonly char[] ValidLastAlphaChars = "DGHJLMNPQRTVWXYZ".ToCharArray();
+    private readonly char[] ValidLastAlphaCharsForNonConsortium = "DGHJLMNPQRTVWXYZ".ToCharArray();
     private readonly char[] ValidNumericChars = "123456789".ToCharArray();
     private readonly Random RandomGenerator = new();
 
-    public string GeneratePponId()
+    public string GeneratePponId(OrganisationType type)
     {
-        // TODO: requires new param to indicate type of org e.g. Consortium will have a C as the last character in future.
-
-        return $"P{GenerateCodePattern().Substring(1)}";
+        return $"P{GenerateCodePattern(type).Substring(1)}";
     }
 
-    private string GenerateCodePattern()
+    private string GenerateCodePattern(OrganisationType type)
     {
         var builder = new StringBuilder();
         for (int i = 0; i < 12; i++)
         {
             if (i == 11)
             {
-                char nextChar = ValidLastAlphaChars[RandomGenerator.Next(ValidLastAlphaChars.Length)];
+                char nextChar = ValidLastAlphaCharsForNonConsortium[RandomGenerator.Next(ValidLastAlphaCharsForNonConsortium.Length)];
+
+                if (type == OrganisationType.InformalConsortium)
+                {
+                    nextChar = 'C';
+                }
 
                 builder.Append(nextChar);
+
             }
             else
             {

diff --git a/Services/CO.CDP.Organisation.WebApi.Tests/UseCase/RegisterOrganisationUseCaseTest.cs b/Services/CO.CDP.Organisation.WebApi.Tests/UseCase/RegisterOrganisationUseCaseTest.cs
@@ -308,7 +308,8 @@ public async Task ItPublishesOrganisationRegisteredEvent()
             AdditionalIdentifiers = command.AdditionalIdentifiers.AsEventValue(),
             Addresses = command.Addresses.AsEventValue(),
             ContactPoint = command.ContactPoint.AsEventValue(),
-            Roles = command.Roles.AsEventValue()
+            Roles = command.Roles.AsEventValue(),
+            Type = OrganisationType.Organisation
         });
     }
 

diff --git a/Services/CO.CDP.Organisation.WebApi/AutoMapper/WebApiToPersistenceProfile.cs b/Services/CO.CDP.Organisation.WebApi/AutoMapper/WebApiToPersistenceProfile.cs
@@ -314,6 +314,7 @@ private void OrganisationEventsMapping()
             .ForMember(m => m.AdditionalIdentifiers, o => o.MapFrom(m => m.Identifiers.Where(i => !i.Primary)))
             .ForMember(m => m.ContactPoint, o => o.MapFrom(m => m.ContactPoints.FirstOrDefault() ?? new Persistence.Organisation.ContactPoint()))
             .ForMember(m => m.Addresses, o => o.MapFrom(m => m.Addresses))
+            .ForMember(m => m.Type, o => o.MapFrom(m => m.Type))
             .ForMember(m => m.Roles, o => o.MapFrom(m => m.Roles.Select(r => r.AsCode())));
         CreateMap<Persistence.Organisation, OrganisationUpdated>()
             .ForMember(m => m.Id, o => o.MapFrom(m => m.Guid))

diff --git a/Services/CO.CDP.Organisation.WebApi/Events/OrganisationRegistered.cs b/Services/CO.CDP.Organisation.WebApi/Events/OrganisationRegistered.cs
@@ -1,3 +1,5 @@
+using CO.CDP.OrganisationInformation;
+
 namespace CO.CDP.Organisation.WebApi.Events;
 
 public record OrganisationRegistered
@@ -17,4 +19,6 @@ public record OrganisationRegistered
     public required ContactPoint ContactPoint { get; init; }
 
     public required List<string> Roles { get; init; }
+
+    public required OrganisationType Type { get; init; }
 }