Add status

Author: AsiaWi

Dfe.Data.SearchPrototype/Infrastructure/Establishment.cs

@@ -52,4 +52,9 @@ public class Establishment
     /// "0" if the establishment does not include the post 16 phase of education
     /// </summary>
     public string? ISPOST16 { get; set; }
+    /// <summary>
+    /// The status of the establishment of the retrieved establishment result
+    /// If "1" establishment status is open if "0" it's closed
+    /// </summary>
+    public string? ESTABLISHMENTSTATUSCODE { get; set; }
 }

Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResultToEstablishmentMapper.cs

@@ -45,10 +45,18 @@ public SearchForEstablishments.Establishment MapFrom(Establishment input)
         ArgumentException.ThrowIfNullOrEmpty(input.ESTABLISHMENTNAME, nameof(input.ESTABLISHMENTNAME));
         ArgumentException.ThrowIfNullOrEmpty(input.TYPEOFESTABLISHMENTNAME, nameof(input.ESTABLISHMENTNAME));
 
-        return new(urn: input.id,
+        var statusCode = input.ESTABLISHMENTSTATUSCODE == "1"
+                    ? StatusCode.Open
+                        : input.ESTABLISHMENTSTATUSCODE == "0"
+                        ? StatusCode.Closed
+                            : StatusCode.Unknown;
+
+        return new(
+            urn: input.id,
             name: input.ESTABLISHMENTNAME,
             address: _addressMapper.MapFrom(input),
             establishmentType: input.TYPEOFESTABLISHMENTNAME,
-            educationPhase: _educationPhaseMapper.MapFrom(input));
+            educationPhase: _educationPhaseMapper.MapFrom(input),
+            establishmentStatusCode: statusCode);
     }
 }

Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResultToEstablishmentMapperTests.cs

@@ -1,6 +1,7 @@
 using Dfe.Data.SearchPrototype.Common.Mappers;
 using Dfe.Data.SearchPrototype.Infrastructure.Mappers;
 using Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
+using Dfe.Data.SearchPrototype.SearchForEstablishments;
 using FluentAssertions;
 using Xunit;
 
@@ -19,11 +20,14 @@ public AzureSearchResultToEstablishmentMapperTests()
         _establishmentMapper = new AzureSearchResultToEstablishmentMapper(_addressMapper, _educationPhaseMapper);
     }
 
-    [Fact]
-    public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment()
+    [Theory]
+    [InlineData("1", StatusCode.Open)]
+    [InlineData("0", StatusCode.Closed)]
+    [InlineData("", StatusCode.Unknown)]
+    public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment(string statusCode, StatusCode expectedStatusCode)
     {
         // arrange
-        Establishment establishmentFake = EstablishmentTestDouble.Create();
+        Establishment establishmentFake = EstablishmentTestDouble.CreateWithStatusCode(statusCode);
 
         // act
         SearchForEstablishments.Establishment? result = _establishmentMapper.MapFrom(establishmentFake);
@@ -40,6 +44,7 @@ public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment()
         result.EducationPhase.IsPrimary.Should().Be(establishmentFake.ISPRIMARY == "1" ? true : false);
         result.EducationPhase.IsSecondary.Should().Be(establishmentFake.ISSECONDARY == "1" ? true : false);
         result.EducationPhase.IsPost16.Should().Be(establishmentFake.ISPOST16 == "1" ? true : false);
+        result.EstablishmentStatusCode.Should().Be(expectedStatusCode);
     }
 
     [Fact]

Dfe.Data.SearchPrototype/SearchForEstablishments/Establishment.cs

@@ -22,7 +22,10 @@ public class Establishment
     /// </summary>
     public string EstablishmentType {  get; }
     public EducationPhase EducationPhase { get; }
-
+    /// <summary>
+    /// The read-only status of the establishment.
+    /// </summary>
+    public StatusCode EstablishmentStatusCode { get; }
     /// <summary>
     /// Establishes an immutable establishment instance via the constructor arguments specified.
     /// </summary>
@@ -38,12 +41,16 @@ public class Establishment
     /// <param name="establishmentType">
     /// The type of the given establishment.
     /// </param>
-    public Establishment(string urn, string name, Address address, string establishmentType, EducationPhase educationPhase)
+    /// /// <param name="establishmentStatusCode">
+    /// The status of the given establishment.
+    /// </param>
+    public Establishment(string urn, string name, Address address, string establishmentType, EducationPhase educationPhase, StatusCode establishmentStatusCode)
     {
         Urn = urn;
         Name = name;
         Address = address;
         EstablishmentType = establishmentType;
         EducationPhase = educationPhase;
+        EstablishmentStatusCode = establishmentStatusCode;
     }
 }

Dfe.Data.SearchPrototype/SearchForEstablishments/StatusCode.cs

@@ -0,0 +1,8 @@
+namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
+
+public enum StatusCode
+{
+    Closed = 0,
+    Open = 1,
+    Unknown
+}

Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/EstablishmentTestDouble.cs

@@ -30,6 +30,9 @@ private static string GetEstablishmentPostcodeFake() =>
     private static string GetEstablishmentTypeFake() =>
         new Faker().Random.Word();
 
+    private static StatusCode GetEstablishmentStatusCodeFake() =>
+       (StatusCode)new Faker().Random.Int(0, 2);
+
     private static string GetEstablishmentEducationPhaseFake() =>
        new Faker().Random.Int(0, 1).ToString();
 
@@ -54,7 +57,8 @@ public static Establishment Create()
             name: GetEstablishmentNameFake(),
             address: address,
             establishmentType: GetEstablishmentTypeFake(),
-            educationPhase: educationPhase
+            educationPhase: educationPhase,
+            establishmentStatusCode: GetEstablishmentStatusCodeFake()
             );
     }
 }