Add BookingRef V2 flag enabled/disabled tests to all the Booking Integration tests

Author: jsed-nhs

src/api/Nhs.Appointments.Core/ReferenceNumber/V2/Provider.cs

@@ -13,8 +13,6 @@ public interface IProvider
 {
     Task<string> GetReferenceNumber();
 
-    bool IsValidBookingReference(string bookingReference);
-
     int DeriveSequenceMultiplier(string partitionKey);
 }
 
@@ -31,11 +29,6 @@ public class Provider(
     TimeProvider timeProvider)
     : IProvider
 {
-    //needed for backwards compatibility since we are now checking correctly formatted strings
-    private Regex BookingReferenceV1Regex => new (@"^\d{2}-\d{2}-\d{6}$", RegexOptions.None, TimeSpan.FromMilliseconds(100));
-    
-    private Regex BookingReferenceV2Regex => new (@"^\d{4}-\d{5}-\d{4}$", RegexOptions.None, TimeSpan.FromMilliseconds(100));
-    
     private IOptions<ReferenceNumberOptions> Options { get; } = options;
 
     //in generating the partition key, splitting the current day of the year into X buckets of this length
@@ -163,13 +156,28 @@ public int DeriveSequenceMultiplier(string partitionKey)
         //GCD(multiplier,SequenceMax) == 1 guaranteed
         return multiplier; 
     }
+    
+    internal static string FormatBookingReference(string raw)
+    {
+        return raw?.Length != 13
+            ? throw new ArgumentException("Must be 13 digits")
+            : $"{raw[..4]}-{raw.Substring(4, 5)}-{raw.Substring(9, 4)}";
+    }
+}
 
+public static class ProviderHelper
+{
+    //needed for backwards compatibility since we are now checking correctly formatted strings
+    private static Regex BookingReferenceV1Regex => new (@"^\d{2}-\d{2}-\d{6}$", RegexOptions.None, TimeSpan.FromMilliseconds(100));
+
+    private static Regex BookingReferenceV2Regex => new (@"^\d{4}-\d{5}-\d{4}$", RegexOptions.None, TimeSpan.FromMilliseconds(100));
+    
     /// <summary>
     ///     A quick way to check if the provided booking reference is valid,
     ///     before firing off to the DB to try and find a record with that identifier.
     ///     No valid records that fail this check should exist in the DB
     /// </summary>
-    public bool IsValidBookingReference(string bookingReference)
+    public static bool IsValidBookingReference(string bookingReference, ILogger logger)
     {
         //backwards compatibility with V1 bookings in flight
         if (BookingReferenceV1Regex.IsMatch(bookingReference))
@@ -199,11 +207,4 @@ public bool IsValidBookingReference(string bookingReference)
 
         return true;
     }
-
-    internal static string FormatBookingReference(string raw)
-    {
-        return raw?.Length != 13
-            ? throw new ArgumentException("Must be 13 digits")
-            : $"{raw[..4]}-{raw.Substring(4, 5)}-{raw.Substring(9, 4)}";
-    }
 }

tests/Nhs.Appointments.Api.Integration/BookingReferenceV2SerialToggleCollection.cs

@@ -0,0 +1,8 @@
+using Xunit;
+
+namespace Nhs.Appointments.Api.Integration;
+
+[CollectionDefinition("BookingReferenceV2SerialToggle")]
+public class BookingReferenceV2SerialToggleCollection : ICollectionFixture<object>
+{
+}

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/BookingBaseFeatureSteps.cs

@@ -10,14 +10,16 @@
 using Newtonsoft.Json;
 using Nhs.Appointments.Api.Models;
 using Nhs.Appointments.Core;
+using Nhs.Appointments.Core.ReferenceNumber.V2;
 using Nhs.Appointments.Persistance.Models;
+using Xunit;
 using Xunit.Gherkin.Quick;
 using AttendeeDetails = Nhs.Appointments.Core.AttendeeDetails;
 using ContactItem = Nhs.Appointments.Core.ContactItem;
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking;
 
-public abstract class BookingBaseFeatureSteps : AuditFeatureSteps
+public abstract class BookingBaseFeatureSteps(string flag, bool enabled) : AuditFeatureSteps, IAsyncLifetime
 {
     protected HttpResponseMessage Response { get; set; }
 
@@ -129,8 +131,9 @@ public async Task Assert(DataTable dataTable)
                 Id = bookingReference,
                 AdditionalData = new { isAppBooking = cells.ElementAt(11).Value }
             };
-
-            result.BookingReference.Should().MatchRegex("([0-9]){2}-([0-9]{2})-([0-9]{6})");
+            
+            ProviderHelper.IsValidBookingReference(result.BookingReference, null).Should().BeTrue();
+            
             var actualBooking = await Client.GetContainer("appts", "booking_data")
                 .ReadItemAsync<BookingDocument>(bookingReference, new PartitionKey(siteId));
             BookingAssertions.BookingsAreEquivalent(actualBooking, expectedBooking);
@@ -200,4 +203,17 @@ protected string ToRequestFormat(string naturalLanguageDateOnly, string naturalL
             $"{ParseNaturalLanguageDateOnly(naturalLanguageDateOnly):yyyy-MM-dd} {naturalLanguageTime}",
             "yyyy-MM-dd HH:mm", null).ToString("yyyy-MM-dd HH:mm");
     }
+    
+    private string Flag { get; } = flag;
+    private bool Enabled { get; } = enabled;
+
+    public async Task InitializeAsync()
+    {
+        await SetLocalFeatureToggleOverride(Flag, Enabled ? "True" : "False");
+    }
+
+    public async Task DisposeAsync()
+    {
+        await Task.CompletedTask;
+    }
 }

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/Cancel/CancelBookingBaseFeatureSteps.cs

@@ -10,7 +10,7 @@
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking.Cancel;
 
-public abstract class CancelBookingBaseFeatureSteps : BookingBaseFeatureSteps
+public abstract class CancelBookingBaseFeatureSteps(string flag, bool enabled) : BookingBaseFeatureSteps(flag, enabled)
 {
     private HttpResponseMessage _response;
     private HttpStatusCode _responseCode;

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/Cancel/CancelBookingFeatureSteps.cs

@@ -1,13 +1,26 @@
-using Xunit.Gherkin.Quick;
+using Nhs.Appointments.Core.Features;
+using Xunit;
+using Xunit.Gherkin.Quick;
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking.Cancel;
 
+
+[Collection("BookingReferenceV2SerialToggle")]
+[FeatureFile("./Scenarios/Booking/Cancel/Cancel.feature")]
+public class CancelBooking_BookingReferenceV2Enabled()
+    : CancelBookingBaseFeatureSteps(Flags.BookingReferenceV2, true);
+
+[Collection("BookingReferenceV2SerialToggle")]
 [FeatureFile("./Scenarios/Booking/Cancel/Cancel.feature")]
-public class CancelBookingFeatureSteps : CancelBookingBaseFeatureSteps
-{
-}
+public class CancelBooking_BookingReferenceV2Disabled() 
+    : CancelBookingBaseFeatureSteps(Flags.BookingReferenceV2, false);
+
+[Collection("BookingReferenceV2SerialToggle")]
+[FeatureFile("./Scenarios/Booking/Cancel/Autocancellation.feature")]
+public class AutoCancelBooking_BookingReferenceV2Enabled()
+    : CancelBookingBaseFeatureSteps(Flags.BookingReferenceV2, true);
 
+[Collection("BookingReferenceV2SerialToggle")]
 [FeatureFile("./Scenarios/Booking/Cancel/Autocancellation.feature")]
-public class CancelBookingAutocancellationFeatureSteps : CancelBookingBaseFeatureSteps
-{
-}
+public class AutoCancelBooking_BookingReferenceV2Disabled() 
+    : CancelBookingBaseFeatureSteps(Flags.BookingReferenceV2, false);

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/Confirm/ConfirmBookingToggleCollections.cs

@@ -6,10 +6,10 @@ namespace Nhs.Appointments.Api.Integration.Scenarios.Booking.Confirm;
 
 [Collection("ConfirmBookingSerialToggle")]
 [FeatureFile("./Scenarios/Booking/Confirm/ConfirmBooking_JointBookings_Enabled.feature")]
-public class ConfirmBooking_Enabled()
+public class ConfirmBooking_JointBookingsEnabled()
     : ConfirmBookingFeatureSteps(Flags.JointBookings, true);
 
 [Collection("ConfirmBookingSerialToggle")]
 [FeatureFile("./Scenarios/Booking/Confirm/ConfirmBooking_JointBookings_Disabled.feature")]
-public class ConfirmBooking_Disabled()
+public class ConfirmBooking_JointBookingsDisabled()
     : ConfirmBookingFeatureSteps(Flags.JointBookings, false);

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/MakeBookingFeatureSteps.cs

@@ -1,7 +1,16 @@
-using Xunit.Gherkin.Quick;
+using Nhs.Appointments.Core.Features;
+using Xunit;
+using Xunit.Gherkin.Quick;
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking
 {
+    [Collection("BookingReferenceV2SerialToggle")]
     [FeatureFile("./Scenarios/Booking/MakeBooking.feature")]
-    public class MakeBookingSingleServiceFeatureSteps : BookingBaseFeatureSteps;
+    public class MakeBooking_BookingReferenceV2Enabled()
+        : BookingBaseFeatureSteps(Flags.BookingReferenceV2, true);
+
+    [Collection("BookingReferenceV2SerialToggle")]
+    [FeatureFile("./Scenarios/Booking/MakeBooking.feature")]
+    public class MakeBooking_BookingReferenceV2Disabled() 
+        : BookingBaseFeatureSteps(Flags.BookingReferenceV2, false);
 }

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/Query/QueryBookingsToggleCollections.cs

@@ -6,10 +6,10 @@ namespace Nhs.Appointments.Api.Integration.Scenarios.Booking.Query;
 
 [Collection("QueryBookingsSerialToggle")]
 [FeatureFile("./Scenarios/Booking/Query/QueryBookings_CancelDay_Enabled.feature")]
-public class QueryBookings_Enabled()
+public class QueryBookings_CancelDayEnabled()
     : QueryBookingsFeatureSteps(Flags.CancelDay, true);
 
 [Collection("QueryBookingsSerialToggle")]
 [FeatureFile("./Scenarios/Booking/Query/QueryBookings_CancelDay_Disabled.feature")]
-public class QueryBookings_Disabled()
+public class QueryBookings_CancelDayDisabled()
     : QueryBookingsFeatureSteps(Flags.CancelDay, false);

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/QueryBookingByNhsNumber.cs

@@ -8,12 +8,13 @@
 using Gherkin.Ast;
 using Nhs.Appointments.Api.Json;
 using Nhs.Appointments.Core;
+using Nhs.Appointments.Core.Features;
+using Xunit;
 using Xunit.Gherkin.Quick;
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking
 {
-    [FeatureFile("./Scenarios/Booking/QueryBookingByNhsNumber.feature")]
-    public class QueryBookingByNhsNumber : BookingBaseFeatureSteps
+    public abstract class QueryBookingByNhsNumberFeatureSteps(string flag, bool enabled) : BookingBaseFeatureSteps(flag, enabled)
     {
         private List<Core.Booking> _actualResponse;
         private HttpResponseMessage _response;
@@ -78,4 +79,15 @@ public void AssertNoAvailability()
             _actualResponse.Should().BeEmpty();
         }
     }
+    
+    
+    [Collection("BookingReferenceV2SerialToggle")]
+    [FeatureFile("./Scenarios/Booking/QueryBookingByNhsNumber.feature")]
+    public class QueryBookingByNhsNumber_BookingReferenceV2Enabled()
+        : QueryBookingByNhsNumberFeatureSteps(Flags.BookingReferenceV2, true);
+
+    [Collection("BookingReferenceV2SerialToggle")]
+    [FeatureFile("./Scenarios/Booking/QueryBookingByNhsNumber.feature")]
+    public class QueryBookingByNhsNumber_BookingReferenceV2Disabled() 
+        : QueryBookingByNhsNumberFeatureSteps(Flags.BookingReferenceV2, false);
 }

tests/Nhs.Appointments.Api.Integration/Scenarios/Booking/RescheduleFeatureSteps.cs

@@ -12,8 +12,7 @@
 
 namespace Nhs.Appointments.Api.Integration.Scenarios.Booking
 {
-    [FeatureFile("./Scenarios/Booking/Reschedule.feature")]
-    public class RescheduleFeatureSteps : BookingBaseFeatureSteps
+    public abstract class RescheduleFeatureSteps(string flag, bool enabled) : BookingBaseFeatureSteps(flag, enabled)
     {
         private string _reschduledBookingReference;
 
@@ -51,4 +50,14 @@ public async Task AssertRescheduledBookingIsNotProvisional()
             actualBookingIndex.Resource.Status.Should().Be(AppointmentStatus.Booked);
         }
     }
+    
+    [Collection("BookingReferenceV2SerialToggle")]
+    [FeatureFile("./Scenarios/Booking/Reschedule.feature")]
+    public class RescheduleBooking_BookingReferenceV2Enabled()
+        : RescheduleFeatureSteps(Flags.BookingReferenceV2, true);
+
+    [Collection("BookingReferenceV2SerialToggle")]
+    [FeatureFile("./Scenarios/Booking/Reschedule.feature")]
+    public class RescheduleBooking_BookingReferenceV2Disabled() 
+        : RescheduleFeatureSteps(Flags.BookingReferenceV2, false);
 }