remove education phase class to match field with new data (#37)

* remove education phase class to match field with new data

* Replace statusCode field to StatusName , amends done as necessary

* Correct few comments to follow with the previous changes

* Correct tests to add exception message. As we test each of the fields, tests passed before due to exception thrown, not necessarily due to exception thrown due to the field we've tested.

Author: AsiaWi

Dfe.Data.SearchPrototype/Infrastructure/Establishment.cs

@@ -38,23 +38,11 @@ public class Establishment
     /// </summary>
     public string? TYPEOFESTABLISHMENTNAME { get; set; }
     /// <summary>
-    /// "1" if the establishment includes the Primary phase of education
-    /// "0" if the establishment does not include the Primary phase of education
+    /// The education phase of the retrieved establishment result
     /// </summary>
-    public string? ISPRIMARY { get; set; }
+    public string? PHASEOFEDUCATION {  get; set; }
     /// <summary>
-    /// "1" if the establishment includes the secondary phase of education
-    /// "0" if the establishment does not include the secondary phase of education
+    /// Status of retrieved establishment result.
     /// </summary>
-    public string? ISSECONDARY { get; set; }
-    /// <summary>
-    /// "1" if the establishment includes the post 16 phase of education
-    /// "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; }
+    public string? ESTABLISHMENTSTATUSNAME { get; set; }
 }

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

@@ -10,19 +10,15 @@ namespace Dfe.Data.SearchPrototype.Infrastructure.Mappers;
 public sealed class AzureSearchResultToEstablishmentMapper : IMapper<Establishment, SearchForEstablishments.Models.Establishment>
 {
     private readonly IMapper<Establishment, Address> _addressMapper;
-    private readonly IMapper<Establishment, EducationPhase> _educationPhaseMapper;
 
     /// <summary>
     /// Constructor
     /// </summary>
     /// <param name="addressMapper">Address mapper instance</param>
-    /// <param name="educationPhaseMapper">EducationPhase mapper instance</param>
     public AzureSearchResultToEstablishmentMapper(
-        IMapper<Establishment, Address> addressMapper,
-        IMapper<Establishment, EducationPhase> educationPhaseMapper)
+        IMapper<Establishment, Address> addressMapper)
     {
         _addressMapper = addressMapper;
-        _educationPhaseMapper = educationPhaseMapper;
     }
 
     /// <summary>
@@ -43,20 +39,16 @@ public SearchForEstablishments.Models.Establishment MapFrom(Establishment input)
     {
         ArgumentException.ThrowIfNullOrEmpty(input.id, nameof(input.id));
         ArgumentException.ThrowIfNullOrEmpty(input.ESTABLISHMENTNAME, nameof(input.ESTABLISHMENTNAME));
-        ArgumentException.ThrowIfNullOrEmpty(input.TYPEOFESTABLISHMENTNAME, nameof(input.ESTABLISHMENTNAME));
-
-        var statusCode = input.ESTABLISHMENTSTATUSCODE == "1"
-                    ? EstablishmentStatusCode.Open
-                        : input.ESTABLISHMENTSTATUSCODE == "0"
-                        ? EstablishmentStatusCode.Closed
-                            : EstablishmentStatusCode.Unknown;
+        ArgumentException.ThrowIfNullOrEmpty(input.TYPEOFESTABLISHMENTNAME, nameof(input.TYPEOFESTABLISHMENTNAME));
+        ArgumentException.ThrowIfNullOrEmpty(input.PHASEOFEDUCATION, nameof(input.PHASEOFEDUCATION));
+        ArgumentException.ThrowIfNullOrEmpty(input.ESTABLISHMENTSTATUSNAME, nameof(input.ESTABLISHMENTSTATUSNAME));
 
         return new(
             urn: input.id,
             name: input.ESTABLISHMENTNAME,
             address: _addressMapper.MapFrom(input),
             establishmentType: input.TYPEOFESTABLISHMENTNAME,
-            educationPhase: _educationPhaseMapper.MapFrom(input),
-            establishmentStatusCode: statusCode);
+            phaseOfEducation: input.PHASEOFEDUCATION,
+            establishmentStatusName: input.ESTABLISHMENTSTATUSNAME);
     }
 }

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

@@ -15,14 +15,12 @@ public sealed class AzureSearchResponseToEstablishmentResultMapperTests
     IMapper<Establishment, SearchForEstablishments.Models.Establishment> _searchResultToEstablishmentMapper;
     IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> _searchResponseMapper;
     IMapper<Establishment, Address> _searchResultToAddressMapper;
-    IMapper<Establishment, EducationPhase> _searchResultToEducationPhaseMapper;
 
     public AzureSearchResponseToEstablishmentResultMapperTests()
     {
-        _searchResultToEducationPhaseMapper = new AzureSearchResultToEducationPhaseMapper();
         _searchResultToAddressMapper = new AzureSearchResultToAddressMapper();
         _searchResultToEstablishmentMapper =
-            new AzureSearchResultToEstablishmentMapper(_searchResultToAddressMapper, _searchResultToEducationPhaseMapper);
+            new AzureSearchResultToEstablishmentMapper(_searchResultToAddressMapper);
         _searchResponseMapper =
             new AzureSearchResponseToEstablishmentResultMapper(_searchResultToEstablishmentMapper);
     }

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

@@ -11,23 +11,18 @@ public sealed class AzureSearchResultToEstablishmentMapperTests
 {
     IMapper<Establishment, SearchForEstablishments.Models.Establishment> _establishmentMapper;
     IMapper<Establishment, Address> _addressMapper;
-    IMapper<Establishment, EducationPhase> _educationPhaseMapper;
 
     public AzureSearchResultToEstablishmentMapperTests()
     {
         _addressMapper = new AzureSearchResultToAddressMapper();
-        _educationPhaseMapper = new AzureSearchResultToEducationPhaseMapper();
-        _establishmentMapper = new AzureSearchResultToEstablishmentMapper(_addressMapper, _educationPhaseMapper);
+        _establishmentMapper = new AzureSearchResultToEstablishmentMapper(_addressMapper);
     }
 
-    [Theory]
-    [InlineData("1", EstablishmentStatusCode.Open)]
-    [InlineData("0", EstablishmentStatusCode.Closed)]
-    [InlineData("", EstablishmentStatusCode.Unknown)]
-    public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment(string statusCode, EstablishmentStatusCode expectedStatusCode)
+    [Fact]
+    public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment()
     {
         // arrange
-        Establishment establishmentFake = EstablishmentTestDouble.CreateWithStatusCode(statusCode);
+        Establishment establishmentFake = EstablishmentTestDouble.Create();
 
         // act
         SearchForEstablishments.Models.Establishment? result = _establishmentMapper.MapFrom(establishmentFake);
@@ -41,10 +36,9 @@ public void MapFrom_With_Valid_Search_Result_Returns_Configured_Establishment(st
         result.Address.Address3.Should().Be(establishmentFake.ADDRESS3);
         result.Address.Town.Should().Be(establishmentFake.TOWN);
         result.Address.Postcode.Should().Be(establishmentFake.POSTCODE);
-        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);
+        result.EstablishmentType.Should().Be(establishmentFake.TYPEOFESTABLISHMENTNAME);
+        result.PhaseOfEducation.Should().Be(establishmentFake.PHASEOFEDUCATION);
+        result.EstablishmentStatusName.Should().Be(establishmentFake.ESTABLISHMENTSTATUSNAME);
     }
 
     [Fact]
@@ -64,65 +58,111 @@ public void MapFrom_With_Null_Search_Result_Throws_Expected_Argument_Null_Except
     [Fact]
     public void MapFrom_With_Null_id_Throws_Expected_Argument_Exception()
     {
-        // arrange.
-        const string EstablishmentName = "Test Establishment";
-
-        // act.
+        // arrange
         var establishmentFake = new Establishment()
         {
             id = null!,
-            ESTABLISHMENTNAME = EstablishmentName
+            ESTABLISHMENTNAME = "Test Establishment",
+            TYPEOFESTABLISHMENTNAME = "secondaryFake",
+            ESTABLISHMENTSTATUSNAME = "fake status",
+            PHASEOFEDUCATION = "fake primary"
         };
 
-        // act.
+        // act, assert
         _establishmentMapper
             .Invoking(mapper =>
                 mapper.MapFrom(establishmentFake))
                     .Should()
-                        .Throw<ArgumentException>();
+                        .Throw<ArgumentException>()
+                        .WithMessage("Value cannot be null. (Parameter 'id')");
     }
 
     [Fact]
     public void MapFrom_With_Null_Name_Throws_Expected_Argument_Exception()
     {
-        // arrange.
-        const string EstablishmentId = "123456";
-
-        // act.
+        // arrange
         var establishmentFake = new Establishment()
         {
-            id = EstablishmentId,
+            id = "123456",
+            TYPEOFESTABLISHMENTNAME = "secondaryFake",
+            ESTABLISHMENTSTATUSNAME = "fake status",
+            PHASEOFEDUCATION = "fake primary",
             ESTABLISHMENTNAME = null!
         };
 
-        // act.
+        // act, assert
         _establishmentMapper
             .Invoking(mapper =>
                 mapper.MapFrom(establishmentFake))
                     .Should()
-                        .Throw<ArgumentException>();
+                        .Throw<ArgumentException>()
+                        .WithMessage("Value cannot be null. (Parameter 'ESTABLISHMENTNAME')");
     }
 
     [Fact]
-    public void MapFrom_With_NullIsPrimary_Throws_Expected_Argument_Exception()
+    public void MapFrom_With_NullPhaseOfEducation_Throws_Expected_Argument_Exception()
     {
-        // arrange.
-        const string EstablishmentId = "123456";
+        // arrange
+        var establishmentFake = new Establishment()
+        {
+            id = "123456",
+            ESTABLISHMENTNAME = "Test Establishment",
+            TYPEOFESTABLISHMENTNAME = "secondaryFake",
+            ESTABLISHMENTSTATUSNAME = "fake status",
+            PHASEOFEDUCATION = null!
+        };
 
-        // act.
+        // act, assert
+        _establishmentMapper
+            .Invoking(mapper =>
+                mapper.MapFrom(establishmentFake))
+                    .Should()
+                        .Throw<ArgumentException>()
+                        .WithMessage("Value cannot be null. (Parameter 'PHASEOFEDUCATION')");
+    }
+
+    [Fact]
+    public void MapFrom_With_NullTypeOfEstablishment_Throws_Expected_Argument_Exception()
+    {
+        // arrange
         var establishmentFake = new Establishment()
         {
-            id = EstablishmentId,
+            id = "1111",
             ESTABLISHMENTNAME = "Test Establishment",
-            ISPRIMARY = null!
+            PHASEOFEDUCATION = "primaryFake",
+            ESTABLISHMENTSTATUSNAME = "closedFake",
+            TYPEOFESTABLISHMENTNAME = null!
         };
 
-        // act.
+        // act, assert
+        _establishmentMapper
+            .Invoking(mapper =>
+                mapper.MapFrom(establishmentFake))
+                    .Should()
+                        .Throw<ArgumentException>()
+                        .WithMessage("Value cannot be null. (Parameter 'TYPEOFESTABLISHMENTNAME')");
+    }
+
+    [Fact]
+    public void MapFrom_With_NullEstablishmentStatus_Throws_Expected_Argument_Exception()
+    {
+        // arrange
+        var establishmentFake = new Establishment()
+        {
+            id = "1111",
+            ESTABLISHMENTNAME = "Test Establishment",
+            PHASEOFEDUCATION = "primaryFake",
+            TYPEOFESTABLISHMENTNAME = "fakeType",
+            ESTABLISHMENTSTATUSNAME = null!
+        };
+
+        // act, assert
         _establishmentMapper
             .Invoking(mapper =>
                 mapper.MapFrom(establishmentFake))
                     .Should()
-                        .Throw<ArgumentException>();
+                        .Throw<ArgumentException>()
+                        .WithMessage("Value cannot be null. (Parameter 'ESTABLISHMENTSTATUSNAME')");
     }
 
     [Theory]
@@ -139,14 +179,13 @@ public void MapFrom_With_NullAddressValues_Returns_Configured_Establishment(
             id = "000000",
             ESTABLISHMENTNAME = "fakename",
             TYPEOFESTABLISHMENTNAME = "FakeType",
-            ISPRIMARY = "1",
-            ISPOST16 = "0",
-            ISSECONDARY = "0",
+            PHASEOFEDUCATION = "fakePhaseOfEducation",
             STREET = street,
             LOCALITY = locality,
             ADDRESS3 = address3,
             TOWN = town,
-            POSTCODE = postcode
+            POSTCODE = postcode,
+            ESTABLISHMENTSTATUSNAME = "fakeStatus"
         };
 
         // act

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

@@ -29,18 +29,13 @@ private static string GetEstablishmentTypeFake() =>
         new Bogus.Faker().Random.Word();
 
     private static string GetEstablishmentEducationPhaseFake() =>
-       new Bogus.Faker().Random.Int(0, 1).ToString();
+       new Bogus.Faker().Random.Word();
 
-    private static string GetEstablishmentStatusCodeFake() =>
-        new Bogus.Faker().Random.Int(0, 1).ToString();
+    private static string GetEstablishmentStatusNameFake() =>
+        new Bogus.Faker().Random.Word();
 
     public static Establishment Create()
     {
-        var educationPhase = new EducationPhase(
-          isPrimary: GetEstablishmentEducationPhaseFake(),
-          isSecondary: GetEstablishmentEducationPhaseFake(),
-          isPost16: GetEstablishmentEducationPhaseFake());
-
         return new Establishment()
         {
             id = GetEstablishmentIdentifierFake(),
@@ -51,18 +46,9 @@ public static Establishment Create()
             TOWN = GetEstablishmentTownFake(),
             POSTCODE = GetEstablishmentPostcodeFake(),
             TYPEOFESTABLISHMENTNAME = GetEstablishmentTypeFake(),
-            ESTABLISHMENTSTATUSCODE = GetEstablishmentStatusCodeFake(),
-            ISPRIMARY = GetEstablishmentEducationPhaseFake(),
-            ISSECONDARY = GetEstablishmentEducationPhaseFake(),
-            ISPOST16 = GetEstablishmentEducationPhaseFake()
+            ESTABLISHMENTSTATUSNAME = GetEstablishmentStatusNameFake(),
+            PHASEOFEDUCATION = GetEstablishmentEducationPhaseFake()
         };
     }
 
-    public static Establishment CreateWithStatusCode(string status)
-    {
-        var searchResultFake = Create();
-        searchResultFake.ESTABLISHMENTSTATUSCODE = status;
-        return searchResultFake;
-    }
-
 }