From 3625f222bc61ff8b13b532afd4d2c1b175608eed Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Wed, 28 Aug 2024 11:45:19 +0100
Subject: [PATCH 1/6] added facets to models and some test refactoring

---
 ...esponseToEstablishmentResultMapperTests.cs | 58 +++++++++++++++----
 .../AzureSearchResultsTestDouble.cs           | 53 ++++++++++++++---
 .../TestDoubles/SearchServiceTestDouble.cs    |  2 +-
 .../Models/EstablishmentResults.cs            | 11 +++-
 .../Models/FacetResult.cs                     |  7 +++
 .../SearchForEstablishments/SearchContext.cs  | 17 +++++-
 6 files changed, 124 insertions(+), 24 deletions(-)
 create mode 100644 Dfe.Data.SearchPrototype/SearchForEstablishments/Models/FacetResult.cs

diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
index dc84cef..f1bfa5d 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
@@ -12,17 +12,14 @@ namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.Mappers;
 
 public sealed class AzureSearchResponseToEstablishmentResultMapperTests
 {
-    IMapper<Establishment, SearchForEstablishments.Models.Establishment> _searchResultToEstablishmentMapper;
     IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> _searchResponseMapper;
-    IMapper<Establishment, Address> _searchResultToAddressMapper;
 
     public AzureSearchResponseToEstablishmentResultMapperTests()
     {
-        _searchResultToAddressMapper = new AzureSearchResultToAddressMapper();
-        _searchResultToEstablishmentMapper =
-            new AzureSearchResultToEstablishmentMapper(_searchResultToAddressMapper);
         _searchResponseMapper =
-            new AzureSearchResponseToEstablishmentResultMapper(_searchResultToEstablishmentMapper);
+            new AzureSearchResponseToEstablishmentResultMapper(
+                new AzureSearchResultToEstablishmentMapper(
+                    new AzureSearchResultToAddressMapper()));
     }
 
     [Fact]
@@ -30,9 +27,9 @@ public void MapFrom_WithValidSearchResults_ReturnsConfiguredEstablishments()
     {
         // arrange
         List<SearchResult<Establishment>> searchResultDocuments =
-            SearchResultFake.SearchResults();
+            new SearchResultFakeBuilder().WithSearchResults().Create();
         Response<SearchResults<Establishment>> searchResponseFake =
-            ResponseFake.WithSearchResults(searchResultDocuments);
+            new ResponseFake().WithSearchResults(searchResultDocuments).Create();
 
         // act
         EstablishmentResults? mappedResult = _searchResponseMapper.MapFrom(searchResponseFake);
@@ -46,12 +43,46 @@ public void MapFrom_WithValidSearchResults_ReturnsConfiguredEstablishments()
         }
     }
 
+    [Fact]
+    public void MapFrom_WithNoFacets_ReturnsNullFacetDictionary()
+    {
+        // arrange
+        Response<SearchResults<Establishment>> searchResponseFake =
+            new ResponseFake()
+                .WithSearchResults(
+                    new SearchResultFakeBuilder().WithSearchResults().Create())
+                .Create();
+
+        // act
+        EstablishmentResults? mappedResult = _searchResponseMapper.MapFrom(searchResponseFake);
+
+        // assert
+        mappedResult.Should().NotBeNull();
+        mappedResult.Facets.Should().BeNull();
+    }
+
+    [Fact]
+    public void MapFrom_WithFacetResults_ReturnsFacetDictionary()
+    {
+        // arrange
+        var searchResultsDocuments = new SearchResultFakeBuilder()
+            .WithSearchResults()
+            .Create();
+
+        Response<SearchResults<Establishment>> searchResponseFake =
+            new ResponseFake().WithSearchResults(searchResultsDocuments).Create();
+    }
+
     [Fact]
     public void MapFrom_WithEmptySearchResults_ReturnsEmptyList()
     {
         // arrange
+        var searchResultsDocuments = new SearchResultFakeBuilder()
+            .WithEmptySearchResult()
+            .Create();
+
         Response<SearchResults<Establishment>> searchResponseFake =
-            ResponseFake.WithSearchResults(SearchResultFake.EmptySearchResult());
+            new ResponseFake().WithSearchResults(searchResultsDocuments).Create();
 
         // act
         EstablishmentResults? result = _searchResponseMapper.MapFrom(searchResponseFake);
@@ -81,10 +112,13 @@ public void MapFrom_WithANullSearchResult_ThrowsInvalidOperationException()
     {
         // arrange
         var searchResultDocuments =
-            SearchResultFake.SearchResults();
-        searchResultDocuments.Add(SearchResultFake.SearchResultWithDocument(null));
+            new SearchResultFakeBuilder()
+                .WithSearchResults()
+                .IncludeNullDocument()
+                .Create();
+
         Response<SearchResults<Establishment>> searchResponseFake =
-                    ResponseFake.WithSearchResults(searchResultDocuments);
+                    new ResponseFake().WithSearchResults(searchResultDocuments).Create();
 
         // act.
         _searchResponseMapper
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs
index 1f1c29f..ba405bf 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs
@@ -1,17 +1,22 @@
 using Azure;
 using Azure.Search.Documents.Models;
 using Moq;
+using System.Runtime.CompilerServices;
+using System.Runtime.InteropServices;
 
 namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
 
-public static class SearchResultFake
+public class SearchResultFakeBuilder
 {
-    public static List<SearchResult<Establishment>> EmptySearchResult()
+    private List<SearchResult<Establishment>>? _establishmentSearchResults;
+
+    public SearchResultFakeBuilder WithEmptySearchResult()
     {
-        return new List<SearchResult<Establishment>>();
+        _establishmentSearchResults = new List<SearchResult<Establishment>>();
+        return this;
     }
 
-    public static List<SearchResult<Establishment>> SearchResults()
+    public SearchResultFakeBuilder WithSearchResults()
     {
         int amount = new Bogus.Faker().Random.Number(1, 10);
         var searchResults = new List<SearchResult<Establishment>>();
@@ -23,22 +28,54 @@ public static List<SearchResult<Establishment>> SearchResults()
                     EstablishmentTestDouble.Create()
                     ));
         }
-        return searchResults;
+        _establishmentSearchResults = searchResults;
+        return this;
+    }
+
+    public SearchResultFakeBuilder IncludeNullDocument()
+    {
+        if(_establishmentSearchResults == null){
+            _establishmentSearchResults= new List<SearchResult<Establishment>>();
+        }
+        _establishmentSearchResults.Add(SearchModelFactory
+        .SearchResult<Establishment>(
+                null!, 1.00, new Dictionary<string, IList<string>>()));
+        return this;
     }
 
     public static SearchResult<Establishment> SearchResultWithDocument(Establishment? document) =>
         SearchModelFactory
             .SearchResult<Establishment>(
                 document!, 1.00, new Dictionary<string, IList<string>>());
+
+    public List<SearchResult<Establishment>> Create()
+    {
+        return _establishmentSearchResults ?? throw new NullReferenceException();
+    }
 }
 
-public static class ResponseFake
+public class ResponseFake
 {
-    public static Response<SearchResults<Establishment>> WithSearchResults(IEnumerable<SearchResult<Establishment>> searchResults)
+    private IEnumerable<SearchResult<Establishment>>? _searchResults;
+    private Dictionary<string, IList<FacetResult>>? _facetResults;
+
+    public ResponseFake WithSearchResults(IEnumerable<SearchResult<Establishment>> searchResults)
+    {
+        _searchResults = searchResults;
+        return this;
+    }
+
+    public ResponseFake WithFacets(Dictionary<string, IList<FacetResult>> facetResults)
+    {
+        _facetResults = facetResults;
+        return this;
+    }
+
+    public Response<SearchResults<Establishment>> Create()
     {
         var responseMock = new Mock<Response>();
         return Response.FromValue(
                 SearchModelFactory.SearchResults(
-                    searchResults, 100, null, null, responseMock.Object), responseMock.Object);
+                    _searchResults, 100, _facetResults, null, responseMock.Object), responseMock.Object);
     }
 }
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchServiceTestDouble.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchServiceTestDouble.cs
index ee379c4..21acc17 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchServiceTestDouble.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchServiceTestDouble.cs
@@ -31,7 +31,7 @@ public static ISearchByKeywordService MockSearchService(string keyword, string c
             Task.FromResult(
                 Response.FromValue(
                     SearchModelFactory.SearchResults(
-                        SearchResultFake.SearchResults(), 100, null, null, responseMock.Object), responseMock.Object));
+                        new SearchResultFakeBuilder().WithSearchResults().Create(), 100, null, null, responseMock.Object), responseMock.Object));
 
         return MockFor(validServiceResponseFake, keyword, collection);
     }
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
index dfe7a36..3118d34 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
@@ -10,8 +10,15 @@ public sealed class EstablishmentResults
     /// </summary>
     public IReadOnlyCollection<Establishment> Establishments => _establishments.AsReadOnly();
 
+    /// <summary>
+    /// The readonly dictionary of facet results
+    /// </summary>
+    public IReadOnlyDictionary<string, List<FacetResult>>? Facets => _facets?.AsReadOnly() ?? null;
+
     private readonly List<Establishment> _establishments;
 
+    private readonly Dictionary<string, List<FacetResult>>? _facets;
+
     /// <summary>
     /// Default constuctor
     /// </summary>
@@ -24,8 +31,10 @@ public EstablishmentResults()
     /// Constructor with the following parameters
     /// </summary>
     /// <param name="establishments">List of Establishments</param>
-    public EstablishmentResults(IEnumerable<Establishment> establishments)
+    /// <param name="facetResults">Dictionary of facets results returned</param>
+    public EstablishmentResults(IEnumerable<Establishment> establishments, Dictionary<string, List<FacetResult>>? facetResults = null)
     {
         _establishments = establishments.ToList();
+        _facets = facetResults;
     }
 }
\ No newline at end of file
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/FacetResult.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/FacetResult.cs
new file mode 100644
index 0000000..2d82bdc
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/FacetResult.cs
@@ -0,0 +1,7 @@
+namespace Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
+
+public class FacetResult
+{
+    public string Value { get; set; }
+    public int Count { get; set; }
+}
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
index a4d52c9..32b0b7d 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
@@ -10,6 +10,11 @@ public sealed class SearchContext
     /// </summary>
     public string SearchKeyword { get; }
 
+    /// <summary>
+    /// The facets to be returned
+    /// </summary>
+    public IList<string>? Facets { get; }
+
     /// <summary>
     /// The target collection on which to apply the search.
     /// </summary>
@@ -25,8 +30,11 @@ public sealed class SearchContext
     /// <param name="targetCollection">
     /// The target collection on which to apply the search.
     /// </param>
+    /// <param name="facets">
+    /// The facets to be returned.
+    /// </param>
     /// <exception cref="ArgumentNullException"></exception>
-    public SearchContext(string searchKeyword, string targetCollection)
+    public SearchContext(string searchKeyword, string targetCollection, IList<string>? facets = null)
     {
         SearchKeyword =
             string.IsNullOrWhiteSpace(searchKeyword) ?
@@ -35,6 +43,8 @@ public SearchContext(string searchKeyword, string targetCollection)
         TargetCollection =
             string.IsNullOrWhiteSpace(targetCollection) ?
                 throw new ArgumentNullException(nameof(targetCollection)) : targetCollection;
+
+        Facets = facets;
     }
 
     /// <summary>
@@ -46,8 +56,11 @@ public SearchContext(string searchKeyword, string targetCollection)
     /// <param name="targetCollection">
     /// The underlying collection on which to undertake the search.
     /// </param>
+    /// <param name="facets">
+    /// The facets to be returned.
+    /// </param>
     /// <returns>
     /// A configured T:Dfe.Data.SearchPrototype.Search.SearchContext instance.
     /// </returns>
-    public static SearchContext Create(string searchKeyword, string targetCollection) => new(searchKeyword, targetCollection);
+    public static SearchContext Create(string searchKeyword, string targetCollection, IList<string>? facets = null) => new(searchKeyword, targetCollection, facets);
 }
\ No newline at end of file

From 4a723cdcd63b19f27c875929a18abc63ed76bf55 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Wed, 28 Aug 2024 15:09:26 +0100
Subject: [PATCH 2/6] facet faker and failing test for mapper

---
 ...esponseToEstablishmentResultMapperTests.cs | 22 ++++++---
 .../AzureSearchResponseTestDoubleBuilder.cs   | 31 ++++++++++++
 .../TestDoubles/FacetsResultsFakeBuilder.cs   | 49 +++++++++++++++++++
 ...stDouble.cs => SearchResultFakeBuilder.cs} | 31 +-----------
 4 files changed, 97 insertions(+), 36 deletions(-)
 create mode 100644 Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseTestDoubleBuilder.cs
 create mode 100644 Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
 rename Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/{AzureSearchResultsTestDouble.cs => SearchResultFakeBuilder.cs} (63%)

diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
index f1bfa5d..f02de1b 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
@@ -29,7 +29,7 @@ public void MapFrom_WithValidSearchResults_ReturnsConfiguredEstablishments()
         List<SearchResult<Establishment>> searchResultDocuments =
             new SearchResultFakeBuilder().WithSearchResults().Create();
         Response<SearchResults<Establishment>> searchResponseFake =
-            new ResponseFake().WithSearchResults(searchResultDocuments).Create();
+            new AzureSearchResponseTestDoubleBuilder().WithSearchResults(searchResultDocuments).Create();
 
         // act
         EstablishmentResults? mappedResult = _searchResponseMapper.MapFrom(searchResponseFake);
@@ -48,7 +48,7 @@ public void MapFrom_WithNoFacets_ReturnsNullFacetDictionary()
     {
         // arrange
         Response<SearchResults<Establishment>> searchResponseFake =
-            new ResponseFake()
+            new AzureSearchResponseTestDoubleBuilder()
                 .WithSearchResults(
                     new SearchResultFakeBuilder().WithSearchResults().Create())
                 .Create();
@@ -68,9 +68,19 @@ public void MapFrom_WithFacetResults_ReturnsFacetDictionary()
         var searchResultsDocuments = new SearchResultFakeBuilder()
             .WithSearchResults()
             .Create();
-
+        var facetsResults = new FacetsResultsFakeBuilder().WithEducationPhaseFacet().Create();
         Response<SearchResults<Establishment>> searchResponseFake =
-            new ResponseFake().WithSearchResults(searchResultsDocuments).Create();
+            new AzureSearchResponseTestDoubleBuilder()
+                .WithSearchResults(searchResultsDocuments)
+                .WithFacets(facetsResults)
+                .Create();
+
+        // act
+        EstablishmentResults? mappedResult = _searchResponseMapper.MapFrom(searchResponseFake);
+
+        // assert
+        mappedResult.Should().NotBeNull();
+        mappedResult.Facets.Should().NotBeNull();
     }
 
     [Fact]
@@ -82,7 +92,7 @@ public void MapFrom_WithEmptySearchResults_ReturnsEmptyList()
             .Create();
 
         Response<SearchResults<Establishment>> searchResponseFake =
-            new ResponseFake().WithSearchResults(searchResultsDocuments).Create();
+            new AzureSearchResponseTestDoubleBuilder().WithSearchResults(searchResultsDocuments).Create();
 
         // act
         EstablishmentResults? result = _searchResponseMapper.MapFrom(searchResponseFake);
@@ -118,7 +128,7 @@ public void MapFrom_WithANullSearchResult_ThrowsInvalidOperationException()
                 .Create();
 
         Response<SearchResults<Establishment>> searchResponseFake =
-                    new ResponseFake().WithSearchResults(searchResultDocuments).Create();
+                    new AzureSearchResponseTestDoubleBuilder().WithSearchResults(searchResultDocuments).Create();
 
         // act.
         _searchResponseMapper
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseTestDoubleBuilder.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseTestDoubleBuilder.cs
new file mode 100644
index 0000000..c33af17
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseTestDoubleBuilder.cs
@@ -0,0 +1,31 @@
+using Azure.Search.Documents.Models;
+using Azure;
+using Moq;
+
+namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
+
+public class AzureSearchResponseTestDoubleBuilder
+{
+    private IEnumerable<SearchResult<Establishment>>? _searchResults;
+    private Dictionary<string, IList<FacetResult>>? _facetResults;
+
+    public AzureSearchResponseTestDoubleBuilder WithSearchResults(IEnumerable<SearchResult<Establishment>> searchResults)
+    {
+        _searchResults = searchResults;
+        return this;
+    }
+
+    public AzureSearchResponseTestDoubleBuilder WithFacets(Dictionary<string, IList<FacetResult>> facetResults)
+    {
+        _facetResults = facetResults;
+        return this;
+    }
+
+    public Response<SearchResults<Establishment>> Create()
+    {
+        var responseMock = new Mock<Response>();
+        return Response.FromValue(
+                SearchModelFactory.SearchResults(
+                    _searchResults, 100, _facetResults, null, responseMock.Object), responseMock.Object);
+    }
+}
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
new file mode 100644
index 0000000..e611c94
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
@@ -0,0 +1,49 @@
+using Azure.Search.Documents.Models;
+
+namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
+
+public class FacetsResultsFakeBuilder
+{
+    private Dictionary<string, IList<FacetResult>>? _facets;
+
+    public FacetsResultsFakeBuilder WithEducationPhaseFacet()
+    {
+        var facetResults = new List<FacetResult>();
+        int resultsCountAnyNumber = new Bogus.Faker().Random.Int(0, 50);
+        var facetResult = new Dictionary<string, object>()
+        {
+            ["value"] = "Primary"
+        };
+        facetResults.Add(SearchModelFactory.FacetResult(resultsCountAnyNumber, facetResult));
+        facetResult = new Dictionary<string, object>()
+        {
+            ["value"] = "Secondary"
+        };
+        facetResults.Add(SearchModelFactory.FacetResult(resultsCountAnyNumber, facetResult));
+        facetResult = new Dictionary<string, object>()
+        {
+            ["value"] = "Post16"
+        };
+        facetResults.Add(SearchModelFactory.FacetResult(resultsCountAnyNumber, facetResult));
+        Dictionary<string, IList<FacetResult>> facet = new() { ["EducationPhase"] = facetResults };
+
+        if (_facets == null)
+        {
+            _facets = new Dictionary<string, IList<FacetResult>>();
+        }
+        foreach(var kvp in facet)
+        {
+            _facets.Add(kvp.Key, kvp.Value);
+        }
+        return this;
+    }
+
+    public Dictionary<string, IList<FacetResult>> Create()
+    {
+        if (_facets == null)
+        {
+            throw new NullReferenceException("Facet fake has no facets set");
+        }
+        return _facets;
+    }
+}
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchResultFakeBuilder.cs
similarity index 63%
rename from Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs
rename to Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchResultFakeBuilder.cs
index ba405bf..005a7af 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResultsTestDouble.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/SearchResultFakeBuilder.cs
@@ -1,8 +1,4 @@
-using Azure;
-using Azure.Search.Documents.Models;
-using Moq;
-using System.Runtime.CompilerServices;
-using System.Runtime.InteropServices;
+using Azure.Search.Documents.Models;
 
 namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
 
@@ -54,28 +50,3 @@ public List<SearchResult<Establishment>> Create()
     }
 }
 
-public class ResponseFake
-{
-    private IEnumerable<SearchResult<Establishment>>? _searchResults;
-    private Dictionary<string, IList<FacetResult>>? _facetResults;
-
-    public ResponseFake WithSearchResults(IEnumerable<SearchResult<Establishment>> searchResults)
-    {
-        _searchResults = searchResults;
-        return this;
-    }
-
-    public ResponseFake WithFacets(Dictionary<string, IList<FacetResult>> facetResults)
-    {
-        _facetResults = facetResults;
-        return this;
-    }
-
-    public Response<SearchResults<Establishment>> Create()
-    {
-        var responseMock = new Mock<Response>();
-        return Response.FromValue(
-                SearchModelFactory.SearchResults(
-                    _searchResults, 100, _facetResults, null, responseMock.Object), responseMock.Object);
-    }
-}

From 90c83d1f048a327c9e1864cfef0f100ce9b21153 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Wed, 28 Aug 2024 17:06:32 +0100
Subject: [PATCH 3/6] ongoing changes- checking in so can change branches

---
 ...archResponseToEstablishmentResultMapper.cs |  8 ++++--
 .../AzureSearchResultToEstablishmentMapper.cs |  1 +
 ...esponseToEstablishmentResultMapperTests.cs | 10 ++++++-
 .../TestDoubles/FacetsResultsFakeBuilder.cs   | 27 +++++++++++++++++++
 .../Models/EstablishmentResults.cs            |  2 +-
 .../SearchByKeywordResponse.cs                |  3 +++
 .../SearchResponseStatus.cs                   | 12 +++++++++
 7 files changed, 59 insertions(+), 4 deletions(-)

diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResponseToEstablishmentResultMapper.cs b/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResponseToEstablishmentResultMapper.cs
index 48627d1..0341fad 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResponseToEstablishmentResultMapper.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResponseToEstablishmentResultMapper.cs
@@ -46,9 +46,10 @@ public AzureSearchResponseToEstablishmentResultMapper(IMapper<Establishment, Sea
     public EstablishmentResults MapFrom(Response<SearchResults<Establishment>> input)
     {
         ArgumentNullException.ThrowIfNull(input);
+        Dictionary<string, List<SearchForEstablishments.Models.FacetResult>>? facetResults;
 
         var results = input.Value.GetResults();
-
+        var facets = input.Value.Facets;
         if (results.Any())
         {
             var mappedResults = results.Select(result =>
@@ -57,7 +58,10 @@ public EstablishmentResults MapFrom(Response<SearchResults<Establishment>> input
                     : throw new InvalidOperationException(
                         "Search result document object cannot be null.")
                 );
-            return new EstablishmentResults(mappedResults);
+            //if (facets.Any()) {
+            //    facetResults = _azureFacetResultsToApplicationFacetResultsMapper.MapFrom(facets);
+            //}
+            return new EstablishmentResults(mappedResults, facetResults);
         }
         else
         {
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResultToEstablishmentMapper.cs b/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResultToEstablishmentMapper.cs
index 0732510..1bae09a 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResultToEstablishmentMapper.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Mappers/AzureSearchResultToEstablishmentMapper.cs
@@ -37,6 +37,7 @@ public AzureSearchResultToEstablishmentMapper(
     /// </exception>
     public SearchForEstablishments.Models.Establishment MapFrom(Establishment input)
     {
+        // TODO - only throw for really essential stuff
         ArgumentException.ThrowIfNullOrEmpty(input.id, nameof(input.id));
         ArgumentException.ThrowIfNullOrEmpty(input.ESTABLISHMENTNAME, nameof(input.ESTABLISHMENTNAME));
         ArgumentException.ThrowIfNullOrEmpty(input.TYPEOFESTABLISHMENTNAME, nameof(input.TYPEOFESTABLISHMENTNAME));
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
index f02de1b..5b8cbb8 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureSearchResponseToEstablishmentResultMapperTests.cs
@@ -68,7 +68,11 @@ public void MapFrom_WithFacetResults_ReturnsFacetDictionary()
         var searchResultsDocuments = new SearchResultFakeBuilder()
             .WithSearchResults()
             .Create();
-        var facetsResults = new FacetsResultsFakeBuilder().WithEducationPhaseFacet().Create();
+        var facetsResults = new FacetsResultsFakeBuilder()
+            .WithEducationPhaseFacet()
+            .WithAutoGeneratedFacet()
+            .Create();
+
         Response<SearchResults<Establishment>> searchResponseFake =
             new AzureSearchResponseTestDoubleBuilder()
                 .WithSearchResults(searchResultsDocuments)
@@ -81,6 +85,10 @@ public void MapFrom_WithFacetResults_ReturnsFacetDictionary()
         // assert
         mappedResult.Should().NotBeNull();
         mappedResult.Facets.Should().NotBeNull();
+        foreach (var facet in facetsResults)
+        {
+            mappedResult.Facets![facet.Key].Should().NotBeEmpty();
+        }
     }
 
     [Fact]
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
index e611c94..2f084bb 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/FacetsResultsFakeBuilder.cs
@@ -38,6 +38,33 @@ public FacetsResultsFakeBuilder WithEducationPhaseFacet()
         return this;
     }
 
+    public FacetsResultsFakeBuilder WithAutoGeneratedFacet()
+    {
+        var facetResults = new List<FacetResult>();
+        int resultsCountAnyNumber = new Bogus.Faker().Random.Int(0, 50);
+        var facetValuesCount = new Bogus.Faker().Random.Int(0, 10);
+        for(int i=0; i<facetValuesCount; i++)
+        {
+            var facetResult = new Dictionary<string, object>()
+            {
+                ["value"] = new Bogus.Faker().Name.JobTitle()
+            };
+            facetResults.Add(SearchModelFactory.FacetResult(resultsCountAnyNumber, facetResult));
+        }
+
+        Dictionary<string, IList<FacetResult>> facet = new() { [new Bogus.Faker().Name.JobType()] = facetResults };
+
+        if (_facets == null)
+        {
+            _facets = new Dictionary<string, IList<FacetResult>>();
+        }
+        foreach (var kvp in facet)
+        {
+            _facets.Add(kvp.Key, kvp.Value);
+        }
+        return this;
+    }
+
     public Dictionary<string, IList<FacetResult>> Create()
     {
         if (_facets == null)
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
index 3118d34..51f4630 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/EstablishmentResults.cs
@@ -11,7 +11,7 @@ public sealed class EstablishmentResults
     public IReadOnlyCollection<Establishment> Establishments => _establishments.AsReadOnly();
 
     /// <summary>
-    /// The readonly dictionary of facet results
+    /// The readonly dictionary of facet results keyed to the faceted field
     /// </summary>
     public IReadOnlyDictionary<string, List<FacetResult>>? Facets => _facets?.AsReadOnly() ?? null;
 
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
index 369f384..32dbc97 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
@@ -13,6 +13,9 @@ public sealed class SearchByKeywordResponse
     /// The readonly collection of T:Dfe.Data.SearchPrototype.Search.Establishment search results.
     /// </summary>
     public IReadOnlyCollection<Establishment> EstablishmentResults { get;}
+    /// <summary>
+    /// The Dfe.Data.SearchPrototype.SearchForEstablishments.SearchResponseStatus
+    /// </summary>
     public SearchResponseStatus Status { get; set; }
 
     /// <summary>
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchResponseStatus.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchResponseStatus.cs
index 623f2f0..ad82ae9 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchResponseStatus.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchResponseStatus.cs
@@ -1,8 +1,20 @@
 namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 
+/// <summary>
+/// The status of the search response
+/// </summary>
 public enum SearchResponseStatus
 {
+    /// <summary>
+    /// The search request completed successfully
+    /// </summary>
     Success,
+    /// <summary>
+    /// The request was not valid
+    /// </summary>
     InvalidRequest,
+    /// <summary>
+    /// The request was submitted and resulted in an error
+    /// </summary>
     SearchServiceError
 }

From e1e41b2ceb4035987350b8969655b12ad2180b09 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Thu, 29 Aug 2024 19:07:29 +0100
Subject: [PATCH 4/6] Fixes to searchByKeywordResponse

---
 .../ResultsToResponseMapper.cs                | 14 +++++++---
 .../SearchByKeywordResponse.cs                | 27 +++++++++----------
 .../SearchByKeywordUseCase.cs                 | 10 ++-----
 .../ResultsToResponseMapperTests.cs           |  6 ++---
 4 files changed, 29 insertions(+), 28 deletions(-)

diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
index 1a4a61d..e219297 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
@@ -1,5 +1,6 @@
 using Dfe.Data.SearchPrototype.Common.Mappers;
 using Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
+using System.Reflection.Metadata.Ecma335;
 
 namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 
@@ -22,10 +23,17 @@ public class ResultsToResponseMapper : IMapper<EstablishmentResults, SearchByKey
     /// </returns>
     public SearchByKeywordResponse MapFrom(EstablishmentResults input)
     {
-        if(input == null)
+        SearchResponseStatus status = (input == null)
+            ? SearchResponseStatus.SearchServiceError
+            :  SearchResponseStatus.Success;
+
+        if (status == SearchResponseStatus.Success)
+        {
+            return new(status) { EstablishmentResults = input };
+        }
+        else
         {
-            return new() { Status = SearchResponseStatus.SearchServiceError };
+            return new(status);
         }
-        else return new(input.Establishments) { Status = SearchResponseStatus.Success };
     }
 }
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
index e3abd67..a8f71f5 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordResponse.cs
@@ -2,9 +2,6 @@
 
 namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 
-
-
-
 /// <summary>
 /// This is the object that carries the response (output) back from the
 /// T:Dfe.Data.SearchPrototype.SearchForEstablishments.SearchByKeywordUseCase instance.
@@ -12,27 +9,28 @@ namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 public sealed class SearchByKeywordResponse
 {
     /// <summary>
-    /// The readonly collection of T:Dfe.Data.SearchPrototype.Search.Establishment search results.
+    /// The result object that encapsulates the <see cref="Establishment"/> search results 
+    /// returned by the Establishment search
     /// </summary>
-    public IReadOnlyCollection<Establishment> EstablishmentResults { get;}
+    public EstablishmentResults? EstablishmentResults { get; init; }
 
     /// <summary>
-    /// The readonly collection of T:Dfe.Data.SearchPrototype.Search.EstablishmentFacet returned by the Establishment search
+    /// The result object that encapsulates the <see cref="EstablishmentFacet"/> returned by the Establishment search
     /// </summary>
-    public IReadOnlyCollection<EstablishmentFacet>? EstablishmentFacetResults { get; }
+    public EstablishmentFacets? EstablishmentFacetResults { get; init; }
 
     /// <summary>
-    /// The return status of the call to the
-    /// T:Dfe.Data.SearchPrototype.SearchForEstablishments.SearchByKeywordUseCase instance
+    /// The return status of the call to the <see cref="SearchByKeywordUseCase"/> instance
     /// </summary>
-    public SearchResponseStatus Status { get; set; }
+    public SearchResponseStatus Status { get; }
 
     /// <summary>
-    /// Default constructor
+    /// 
     /// </summary>
-    public SearchByKeywordResponse()
+    /// <param name="status"></param>
+    public SearchByKeywordResponse(SearchResponseStatus status)
     {
-        EstablishmentResults = new List<Establishment>();
+        Status = status;
     }
 
     /// <summary>
@@ -45,9 +43,10 @@ public SearchByKeywordResponse()
     /// <param name="facetResults">
     /// The readonly collection of T:Dfe.Data.SearchPrototype.Search.EstablishmentFacet
     /// </param>
-    public SearchByKeywordResponse(IReadOnlyCollection<Establishment> establishments, IReadOnlyCollection<EstablishmentFacet>? facetResults = null)
+    public SearchByKeywordResponse(EstablishmentResults establishments, EstablishmentFacets facetResults, SearchResponseStatus status)
     {
         EstablishmentResults = establishments;
         EstablishmentFacetResults = facetResults;
+        Status = status;
     }
 }
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
index bd81c5a..e7e59b9 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
@@ -49,10 +49,7 @@ public SearchByKeywordUseCase(
     public async Task<SearchByKeywordResponse> HandleRequest(SearchByKeywordRequest request)
     {
         if ((request == null) || (request.Context == null)) {
-            return new SearchByKeywordResponse()
-            {
-                Status = SearchResponseStatus.InvalidRequest
-            };
+            return new SearchByKeywordResponse(SearchResponseStatus.InvalidRequest);
         };
 
         try
@@ -62,10 +59,7 @@ public async Task<SearchByKeywordResponse> HandleRequest(SearchByKeywordRequest
         }
         catch (Exception) // something went wrong in the infrastructure
         {
-            return new SearchByKeywordResponse()
-            {
-                Status = SearchResponseStatus.SearchServiceError
-            };
+            return new SearchByKeywordResponse(SearchResponseStatus.SearchServiceError);
         }
     }
 }
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
index efbe368..900fddd 100644
--- a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
@@ -22,9 +22,9 @@ public void MapFrom_ValidInput_ReturnsCorrectResponse()
         //assert.
         response.Should().NotBeNull();
         response.Status.Should().Be(SearchResponseStatus.Success);
-        response.EstablishmentResults.Should().HaveCountGreaterThanOrEqualTo(1);
-        response.EstablishmentResults!.First().Urn.Should().Be(input.Establishments.First().Urn);
-        response.EstablishmentResults!.First().Name.Should().Be(input.Establishments.First().Name);
+        response.EstablishmentResults!.Establishments.Should().HaveCountGreaterThanOrEqualTo(1);
+        response.EstablishmentResults!.Establishments.First().Urn.Should().Be(input.Establishments.First().Urn);
+        response.EstablishmentResults!.Establishments.First().Name.Should().Be(input.Establishments.First().Name);
     }
 
     [Fact]

From 3b7ca6f521cb45c8098e08c4edc8b5b5fc521a83 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Thu, 29 Aug 2024 20:09:15 +0100
Subject: [PATCH 5/6] encapsulate facet results and establishments results into
 class for use by Adapter and mapper

---
 .../CognitiveSearchServiceAdapter.cs          | 11 +++----
 .../CognitiveSearchServiceAdapterTests.cs     | 17 ++++++-----
 ...ResponseToSearchResultsMapperTestDouble.cs | 16 +++++-----
 .../ISearchServiceAdapter.cs                  |  2 +-
 .../Models/SearchResults.cs                   | 16 ++++++++++
 .../ResultsToResponseMapper.cs                |  7 ++---
 .../SearchByKeywordUseCase.cs                 |  6 ++--
 .../ResultsToResponseMapperTests.cs           | 29 +++++++++++++++----
 .../SearchByKeywordUseCaseTests.cs            |  6 ++--
 .../EstablishmentFacetsTestDouble.cs          | 16 ++++++++++
 .../TestDoubles/SearchResultsTestDouble.cs    | 20 +++++++++++++
 .../SearchServiceAdapterTestDouble.cs         |  2 +-
 12 files changed, 110 insertions(+), 38 deletions(-)
 create mode 100644 Dfe.Data.SearchPrototype/SearchForEstablishments/Models/SearchResults.cs
 create mode 100644 Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/EstablishmentFacetsTestDouble.cs
 create mode 100644 Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchResultsTestDouble.cs

diff --git a/Dfe.Data.SearchPrototype/Infrastructure/CognitiveSearchServiceAdapter.cs b/Dfe.Data.SearchPrototype/Infrastructure/CognitiveSearchServiceAdapter.cs
index 720bdbf..5eb9686 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/CognitiveSearchServiceAdapter.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/CognitiveSearchServiceAdapter.cs
@@ -1,12 +1,13 @@
 using Azure;
 using Azure.Search.Documents;
-using Azure.Search.Documents.Models;
 using Dfe.Data.Common.Infrastructure.CognitiveSearch.SearchByKeyword;
 using Dfe.Data.SearchPrototype.Common.Mappers;
 using Dfe.Data.SearchPrototype.Infrastructure.Options;
 using Dfe.Data.SearchPrototype.SearchForEstablishments;
 using Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
 
+using AzureModels = Azure.Search.Documents.Models;
+
 namespace Dfe.Data.SearchPrototype.Infrastructure;
 
 /// <summary>
@@ -17,7 +18,7 @@ public sealed class CognitiveSearchServiceAdapter<TSearchResult> : ISearchServic
 {
     private readonly ISearchByKeywordService _searchByKeywordService;
     private readonly ISearchOptionsFactory _searchOptionsFactory;
-    private readonly IMapper<Response<SearchResults<TSearchResult>>, EstablishmentResults> _searchResponseMapper;
+    private readonly IMapper<Response<AzureModels.SearchResults<TSearchResult>>, SearchResults> _searchResponseMapper;
 
     /// <summary>
     /// The following dependencies include the core cognitive search service definition,
@@ -35,7 +36,7 @@ public sealed class CognitiveSearchServiceAdapter<TSearchResult> : ISearchServic
     public CognitiveSearchServiceAdapter(
         ISearchByKeywordService searchByKeywordService,
         ISearchOptionsFactory searchOptionsFactory,
-        IMapper<Response<SearchResults<TSearchResult>>, EstablishmentResults> searchResponseMapper)
+        IMapper<Response<AzureModels.SearchResults<TSearchResult>>, SearchResults> searchResponseMapper)
     {
         _searchOptionsFactory = searchOptionsFactory;
         _searchByKeywordService = searchByKeywordService;
@@ -62,14 +63,14 @@ public CognitiveSearchServiceAdapter(
     /// Exception thrown if the data cannot be mapped
     /// </exception>
 
-    public async Task<EstablishmentResults> SearchAsync(SearchContext searchContext)
+    public async Task<SearchResults> SearchAsync(SearchContext searchContext)
     {
         SearchOptions searchOptions =
             _searchOptionsFactory.GetSearchOptions(searchContext.TargetCollection) ??
             throw new ApplicationException(
                 $"Search options cannot be derived for {searchContext.TargetCollection}.");
 
-        Response<SearchResults<TSearchResult>> searchResults =
+        Response<AzureModels.SearchResults<TSearchResult>> searchResults =
             await _searchByKeywordService.SearchAsync<TSearchResult>(
                 searchContext.SearchKeyword,
                 searchContext.TargetCollection,
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/CognitiveSearchServiceAdapterTests.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/CognitiveSearchServiceAdapterTests.cs
index a594a0a..7455b4f 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/CognitiveSearchServiceAdapterTests.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/CognitiveSearchServiceAdapterTests.cs
@@ -17,17 +17,17 @@ public sealed class CognitiveSearchServiceAdapterTests
     private static CognitiveSearchServiceAdapter<Establishment> CreateServiceAdapterWith(
         ISearchByKeywordService searchByKeywordService,
         ISearchOptionsFactory searchOptionsFactory,
-        IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> searchResponseMapper
+        IMapper<Response<SearchResults<Establishment>>, SearchResults> searchResponseMapper
        ) =>
            new(searchByKeywordService, searchOptionsFactory, searchResponseMapper);
 
     [Fact]
-    public async Task Search_WithValidSearchContext_ReturnsConfiguredResults()
+    public async Task Search_WithValidSearchContext_CallsMapper()
     {
         // arrange
         var mockService = SearchServiceTestDouble.MockSearchService("SearchKeyword", "TargetCollection");
         var mockSearchOptionsFactory = SearchOptionsFactoryTestDouble.MockSearchOptionsFactory();
-        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new EstablishmentResults());
+        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new SearchResults());
 
         ISearchServiceAdapter cognitiveSearchServiceAdapter =
             CreateServiceAdapterWith(
@@ -36,14 +36,13 @@ public async Task Search_WithValidSearchContext_ReturnsConfiguredResults()
                 mockMapper);
 
         // act
-        EstablishmentResults? response =
+        SearchResults? response =
             await cognitiveSearchServiceAdapter.SearchAsync(
                 new SearchContext(
                     searchKeyword: "SearchKeyword",
                     targetCollection: "TargetCollection"));
 
         // assert
-        response.Establishments.Should().NotBeNull();
         Mock.Get(mockService).Verify(SearchServiceTestDouble.SearchRequest("SearchKeyword", "TargetCollection"),Times.Once());
         Mock.Get(mockSearchOptionsFactory).Verify(SearchOptionsFactoryTestDouble.SearchOption(), Times.Once());
         Mock.Get(mockMapper).Verify(AzureSearchResponseToSearchResultsMapperTestDouble.MapFrom(), Times.Once());
@@ -54,7 +53,7 @@ public Task Search_WithNoSearchOptions_ThrowsApplicationException()
     {
         var mockService = SearchServiceTestDouble.MockSearchService("SearchKeyword", "TargetCollection");
         var mockSearchOptionsFactory = SearchOptionsFactoryTestDouble.MockForNoOptions();
-        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new EstablishmentResults());
+        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new SearchResults());
 
         // arrange
         ISearchServiceAdapter cognitiveSearchServiceAdapter =
@@ -81,7 +80,7 @@ public async Task Search_WithNoResultsReturned_ReturnsEmptyResults()
         // arrange
         var mockService = SearchServiceTestDouble.MockSearchService("SearchKeyword", "TargetCollection");
         var mockSearchOptionsFactory = SearchOptionsFactoryTestDouble.MockSearchOptionsFactory();
-        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new EstablishmentResults());
+        var mockMapper = AzureSearchResponseToSearchResultsMapperTestDouble.MockFor(new SearchResults());
 
         ISearchServiceAdapter cognitiveSearchServiceAdapter =
             CreateServiceAdapterWith(
@@ -95,7 +94,9 @@ public async Task Search_WithNoResultsReturned_ReturnsEmptyResults()
                             targetCollection: "TargetCollection"));
 
         // assert
-        response.Establishments.Should().BeEmpty();
+        response.Should().NotBeNull();
+        response.Establishments.Should().BeNull();
+        response.Facets.Should().BeNull();
     }
 
     [Fact]
diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseToSearchResultsMapperTestDouble.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseToSearchResultsMapperTestDouble.cs
index 1d28f33..d608d0c 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseToSearchResultsMapperTestDouble.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/TestDoubles/AzureSearchResponseToSearchResultsMapperTestDouble.cs
@@ -9,23 +9,23 @@ namespace Dfe.Data.SearchPrototype.Infrastructure.Tests.TestDoubles;
 
 internal static class AzureSearchResponseToSearchResultsMapperTestDouble
 {
-    public static IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> DefaultMock() =>
-        Mock.Of<IMapper<Response<SearchResults<Establishment>>, EstablishmentResults>>();
-    public static Expression<Func<IMapper<Response<SearchResults<Establishment>>, EstablishmentResults>, EstablishmentResults>> MapFrom() =>
+    public static IMapper<Response<SearchResults<Establishment>>, SearchResults> DefaultMock() =>
+        Mock.Of<IMapper<Response<SearchResults<Establishment>>, SearchResults>>();
+    public static Expression<Func<IMapper<Response<SearchResults<Establishment>>, SearchResults>, SearchResults>> MapFrom() =>
         mapper => mapper.MapFrom(It.IsAny<Response<SearchResults<Establishment>>>());
 
-    public static IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> MockFor(EstablishmentResults establishments)
+    public static IMapper<Response<SearchResults<Establishment>>, SearchResults> MockFor(SearchResults searchResults)
     {
-        var mapperMock = new Mock<IMapper<Response<SearchResults<Establishment>>, EstablishmentResults>>();
+        var mapperMock = new Mock<IMapper<Response<SearchResults<Establishment>>, SearchResults>>();
 
-        mapperMock.Setup(MapFrom()).Returns(establishments);
+        mapperMock.Setup(MapFrom()).Returns(searchResults);
 
         return mapperMock.Object;
     }
 
-    public static IMapper<Response<SearchResults<Establishment>>, EstablishmentResults> MockMapperThrowingArgumentException()
+    public static IMapper<Response<SearchResults<Establishment>>, SearchResults> MockMapperThrowingArgumentException()
     {
-        var mapperMock = new Mock<IMapper<Response<SearchResults<Establishment>>, EstablishmentResults>>();
+        var mapperMock = new Mock<IMapper<Response<SearchResults<Establishment>>, SearchResults>>();
 
         mapperMock.Setup(MapFrom()).Throws(new ArgumentException());
 
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/ISearchServiceAdapter.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/ISearchServiceAdapter.cs
index 74c7417..3127cc1 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/ISearchServiceAdapter.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/ISearchServiceAdapter.cs
@@ -19,5 +19,5 @@ public interface ISearchServiceAdapter
     /// A configured "T:Dfe.Data.SearchPrototype.Search.Domain.AgregateRoot.Establishments"
     /// object hydrated from the results of the azure search.
     /// </returns>
-    Task<EstablishmentResults> SearchAsync(SearchContext searchContext);
+    Task<SearchResults> SearchAsync(SearchContext searchContext);
 }
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/SearchResults.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/SearchResults.cs
new file mode 100644
index 0000000..e01e35c
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/Models/SearchResults.cs
@@ -0,0 +1,16 @@
+namespace Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
+
+/// <summary>
+/// The search results
+/// </summary>
+public class SearchResults
+{
+    /// <summary>
+    /// The <see cref="EstablishmentResults"/> returned from the Establishment search
+    /// </summary>
+    public EstablishmentResults? Establishments { get; init; }
+    /// <summary>
+    /// The <see cref="EstablishmentFacets"/> resturned from the Establishment search
+    /// </summary>
+    public EstablishmentFacets? Facets { get; init; }
+}
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
index e219297..f906b56 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/ResultsToResponseMapper.cs
@@ -1,6 +1,5 @@
 using Dfe.Data.SearchPrototype.Common.Mappers;
 using Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
-using System.Reflection.Metadata.Ecma335;
 
 namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 
@@ -8,7 +7,7 @@ namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 /// Facilitates mapping from the received T:Dfe.Data.SearchPrototype.Search.EstablishmentResults
 /// into the required T:Dfe.Data.SearchPrototype.SearchForEstablishments.SearchByKeywordResponse object.
 /// </summary>
-public class ResultsToResponseMapper : IMapper<EstablishmentResults, SearchByKeywordResponse>
+public class ResultsToResponseMapper : IMapper<SearchResults, SearchByKeywordResponse>
 {
     /// <summary>
     /// The mapping input is the T:Dfe.Data.SearchPrototype.Search.EstablishmentResults which, if successful,
@@ -21,7 +20,7 @@ public class ResultsToResponseMapper : IMapper<EstablishmentResults, SearchByKey
     /// <returns>
     /// A configured T:Dfe.Data.SearchPrototype.SearchForEstablishments.SearchByKeywordResponse instance.
     /// </returns>
-    public SearchByKeywordResponse MapFrom(EstablishmentResults input)
+    public SearchByKeywordResponse MapFrom(SearchResults input)
     {
         SearchResponseStatus status = (input == null)
             ? SearchResponseStatus.SearchServiceError
@@ -29,7 +28,7 @@ public SearchByKeywordResponse MapFrom(EstablishmentResults input)
 
         if (status == SearchResponseStatus.Success)
         {
-            return new(status) { EstablishmentResults = input };
+            return new(status) { EstablishmentResults = input!.Establishments, EstablishmentFacetResults = input.Facets };
         }
         else
         {
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
index e7e59b9..9e74496 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchByKeywordUseCase.cs
@@ -13,7 +13,7 @@ namespace Dfe.Data.SearchPrototype.SearchForEstablishments;
 public sealed class SearchByKeywordUseCase : IUseCase<SearchByKeywordRequest, SearchByKeywordResponse>
 {
     private readonly ISearchServiceAdapter _searchServiceAdapter;
-    private readonly IMapper<EstablishmentResults, SearchByKeywordResponse> _resultsToResponseMapper;
+    private readonly IMapper<SearchResults, SearchByKeywordResponse> _resultsToResponseMapper;
 
     /// <summary>
     /// The following dependencies include the core cognitive search service definition,
@@ -29,7 +29,7 @@ public sealed class SearchByKeywordUseCase : IUseCase<SearchByKeywordRequest, Se
     /// </param>
     public SearchByKeywordUseCase(
         ISearchServiceAdapter searchServiceAdapter,
-        IMapper<EstablishmentResults, SearchByKeywordResponse> resultsToResponseMapper)
+        IMapper<SearchResults, SearchByKeywordResponse> resultsToResponseMapper)
     {
         _searchServiceAdapter = searchServiceAdapter;
         _resultsToResponseMapper = resultsToResponseMapper;
@@ -54,7 +54,7 @@ public async Task<SearchByKeywordResponse> HandleRequest(SearchByKeywordRequest
 
         try
         {
-            EstablishmentResults establishmentResults = await _searchServiceAdapter.SearchAsync(request.Context);
+            SearchResults establishmentResults = await _searchServiceAdapter.SearchAsync(request.Context);
             return _resultsToResponseMapper.MapFrom(establishmentResults);
         }
         catch (Exception) // something went wrong in the infrastructure
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
index 900fddd..0784584 100644
--- a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/ResultsToResponseMapperTests.cs
@@ -13,8 +13,8 @@ public sealed class ResultsToResponseMapperTests
     public void MapFrom_ValidInput_ReturnsCorrectResponse()
     {
         // arrange.
-        EstablishmentResults input = EstablishmentResultsTestDouble.Create();
-        IMapper<EstablishmentResults, SearchByKeywordResponse> mapper = new ResultsToResponseMapper();
+        var input = SearchResultsTestDouble.Create();
+        IMapper<SearchResults, SearchByKeywordResponse> mapper = new ResultsToResponseMapper();
 
         // act.
         SearchByKeywordResponse response =  mapper.MapFrom(input);
@@ -23,15 +23,34 @@ public void MapFrom_ValidInput_ReturnsCorrectResponse()
         response.Should().NotBeNull();
         response.Status.Should().Be(SearchResponseStatus.Success);
         response.EstablishmentResults!.Establishments.Should().HaveCountGreaterThanOrEqualTo(1);
-        response.EstablishmentResults!.Establishments.First().Urn.Should().Be(input.Establishments.First().Urn);
-        response.EstablishmentResults!.Establishments.First().Name.Should().Be(input.Establishments.First().Name);
+        response.EstablishmentResults!.Establishments.First().Urn.Should().Be(input.Establishments!.Establishments.First().Urn);
+        response.EstablishmentResults!.Establishments.First().Name.Should().Be(input.Establishments.Establishments.First().Name);
+        response.EstablishmentFacetResults!.Facets.Should().HaveCountGreaterThanOrEqualTo(1);
+        response.EstablishmentFacetResults!.Facets.First().Name.Should().Be(input.Facets!.Facets.First().Name);
+    }
+
+    [Fact]
+    public void MapFrom_EmptyResults_ReturnsSuccessResponse()
+    {
+        // arrange.
+        var input = SearchResultsTestDouble.CreateWithNoResults();
+        IMapper<SearchResults, SearchByKeywordResponse> mapper = new ResultsToResponseMapper();
+
+        // act.
+        SearchByKeywordResponse response = mapper.MapFrom(input);
+
+        //assert.
+        response.Should().NotBeNull();
+        response.Status.Should().Be(SearchResponseStatus.Success);
+        response.EstablishmentResults.Should().BeNull();
+        response.EstablishmentFacetResults.Should().BeNull();
     }
 
     [Fact]
     public void MapFrom_NullInput_ReturnsErrorResponse()
     {
         // arrange.
-        IMapper<EstablishmentResults, SearchByKeywordResponse> mapper = new ResultsToResponseMapper();
+        IMapper<SearchResults, SearchByKeywordResponse> mapper = new ResultsToResponseMapper();
 
         // act
         SearchByKeywordResponse response = mapper.MapFrom(null!);
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/SearchByKeywordUseCaseTests.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/SearchByKeywordUseCaseTests.cs
index bf22945..aa808b9 100644
--- a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/SearchByKeywordUseCaseTests.cs
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/SearchByKeywordUseCaseTests.cs
@@ -12,14 +12,14 @@ public sealed class SearchByKeywordUseCaseTests
 {
     private readonly SearchByKeywordUseCase _useCase;
     private ISearchServiceAdapter _searchServiceAdapter;
-    private IMapper<EstablishmentResults, SearchByKeywordResponse> _mapper;
+    private IMapper<SearchResults, SearchByKeywordResponse> _mapper;
 
     public SearchByKeywordUseCaseTests()
     {
         // arrange
         _searchServiceAdapter =
             SearchServiceAdapterTestDouble.MockFor(
-                EstablishmentResultsTestDouble.Create());
+                SearchResultsTestDouble.Create());
 
         _mapper = new ResultsToResponseMapper();
         _useCase = new(_searchServiceAdapter, _mapper);
@@ -73,7 +73,7 @@ public async Task HandleRequest_NoResults_ReturnsSuccess()
         SearchByKeywordRequest request = new("searchkeyword", "target collection");
         Mock.Get(_searchServiceAdapter)
             .Setup(adapter => adapter.SearchAsync(It.IsAny<SearchContext>()))
-            .ReturnsAsync(EstablishmentResultsTestDouble.CreateWithNoResults);
+            .ReturnsAsync(SearchResultsTestDouble.CreateWithNoResults);
 
         // act
         var response = await _useCase.HandleRequest(request);
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/EstablishmentFacetsTestDouble.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/EstablishmentFacetsTestDouble.cs
new file mode 100644
index 0000000..c0a4bb0
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/EstablishmentFacetsTestDouble.cs
@@ -0,0 +1,16 @@
+using Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
+
+namespace Dfe.Data.SearchPrototype.Tests.SearchForEstablishments.TestDoubles;
+
+public static class EstablishmentFacetsTestDouble
+{
+    public static EstablishmentFacets Create()
+    {
+        var facets = new List<EstablishmentFacet>(
+            new List<EstablishmentFacet>()
+            {
+                new EstablishmentFacet("name", new List<FacetResult>() { new FacetResult("value1", 1)})
+            });
+        return new EstablishmentFacets(facets);
+    }
+}
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchResultsTestDouble.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchResultsTestDouble.cs
new file mode 100644
index 0000000..ca70edc
--- /dev/null
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchResultsTestDouble.cs
@@ -0,0 +1,20 @@
+using Dfe.Data.SearchPrototype.SearchForEstablishments.Models;
+
+namespace Dfe.Data.SearchPrototype.Tests.SearchForEstablishments.TestDoubles;
+
+public static class SearchResultsTestDouble
+{
+    public static SearchResults Create()
+    {
+        return new SearchResults()
+        {
+            Facets = EstablishmentFacetsTestDouble.Create(),
+            Establishments = EstablishmentResultsTestDouble.Create()
+        }; 
+    }
+
+    public static SearchResults CreateWithNoResults()
+    {
+        return new SearchResults();
+    }
+}
diff --git a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchServiceAdapterTestDouble.cs b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchServiceAdapterTestDouble.cs
index d8a6d96..bb10b89 100644
--- a/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchServiceAdapterTestDouble.cs
+++ b/Dfe.Data.SearchPrototype/Tests/SearchForEstablishments/TestDoubles/SearchServiceAdapterTestDouble.cs
@@ -6,7 +6,7 @@ namespace Dfe.Data.SearchPrototype.Tests.SearchForEstablishments.TestDoubles;
 
 public static class SearchServiceAdapterTestDouble
 {
-    public static ISearchServiceAdapter MockFor(EstablishmentResults establishmentResults)
+    public static ISearchServiceAdapter MockFor(SearchResults establishmentResults)
     {
         Mock<ISearchServiceAdapter> searchServiceAdapter = new();
 

From 7e964013554ecc387a167c29bd002a1b79f8ece1 Mon Sep 17 00:00:00 2001
From: CLAWLOR <catherine.lawlor@education.gov.uk>
Date: Fri, 30 Aug 2024 07:53:33 +0100
Subject: [PATCH 6/6] <CR>

---
 .../Mappers/AzureFacetResultToEstablishmentFacetsMapperTests.cs | 2 +-
 .../SearchForEstablishments/SearchContext.cs                    | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureFacetResultToEstablishmentFacetsMapperTests.cs b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureFacetResultToEstablishmentFacetsMapperTests.cs
index d037712..30382ba 100644
--- a/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureFacetResultToEstablishmentFacetsMapperTests.cs
+++ b/Dfe.Data.SearchPrototype/Infrastructure/Tests/Mappers/AzureFacetResultToEstablishmentFacetsMapperTests.cs
@@ -66,4 +66,4 @@ public void MapFrom_WithNonStringFacetResults_ThrowsInvalidCastException()
 
         exception.Message.Should().Be("Unable to cast object of type 'System.Boolean' to type 'System.String'.");
     }
-}
\ No newline at end of file
+}
diff --git a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
index 32b0b7d..70e9638 100644
--- a/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
+++ b/Dfe.Data.SearchPrototype/SearchForEstablishments/SearchContext.cs
@@ -63,4 +63,4 @@ public SearchContext(string searchKeyword, string targetCollection, IList<string
     /// A configured T:Dfe.Data.SearchPrototype.Search.SearchContext instance.
     /// </returns>
     public static SearchContext Create(string searchKeyword, string targetCollection, IList<string>? facets = null) => new(searchKeyword, targetCollection, facets);
-}
\ No newline at end of file
+}