EES-4945 - implemented automapping and tests

Author: duncan-at-hiveit

src/GovUk.Education.ExploreEducationStatistics.Public.Data.Model/DataSetVersionImportStage.cs

@@ -10,6 +10,7 @@ public enum DataSetVersionImportStage
     CopyingCsvFiles,
     ImportingMetadata,
     CreatingMappings,
+    AutoMapping,
     ImportingData,
     WritingDataFiles,
     Completing

src/GovUk.Education.ExploreEducationStatistics.Public.Data.Model/DataSetVersionMapping.cs

@@ -24,9 +24,9 @@ public class DataSetVersionMapping : ICreatedUpdatedTimestamps<DateTimeOffset, D
     public FilterMappingPlan FilterMappingPlan { get; set; } = null!;
 
     public bool LocationMappingsComplete { get; set; }
-    
+
     public bool FilterMappingsComplete { get; set; }
-    
+
     public DateTimeOffset Created { get; set; }
 
     public DateTimeOffset? Updated { get; set; }
@@ -38,18 +38,18 @@ public void Configure(EntityTypeBuilder<DataSetVersionMapping> builder)
             builder.Property(mapping => mapping.Id)
                 .HasValueGenerator<UuidV7ValueGenerator>();
 
-            builder.HasIndex(mapping => new { mapping.SourceDataSetVersionId })
+            builder.HasIndex(mapping => new {mapping.SourceDataSetVersionId})
                 .HasDatabaseName("IX_DataSetVersionMappings_SourceDataSetVersionId")
                 .IsUnique();
 
-            builder.HasIndex(mapping => new { mapping.TargetDataSetVersionId })
+            builder.HasIndex(mapping => new {mapping.TargetDataSetVersionId})
                 .HasDatabaseName("IX_DataSetVersionMappings_TargetDataSetVersionId")
                 .IsUnique();
 
             builder.OwnsOne(v => v.LocationMappingPlan, locations =>
             {
                 locations.ToJson();
-                locations.OwnsMany(l => l.Mappings, locationMappings =>
+                locations.OwnsMany(l => l.Levels, locationMappings =>
                 {
                     locationMappings.OwnsMany(mapping => mapping.Mappings, locationMapping =>
                     {
@@ -59,9 +59,10 @@ public void Configure(EntityTypeBuilder<DataSetVersionMapping> builder)
                     });
                 });
 
-                locations.OwnsMany(locations => locations.Candidates, locationTargets =>
+                locations.OwnsMany(location => location.Levels, level =>
                 {
-                    locationTargets.OwnsMany(mapping => mapping.Candidates);
+                    level.OwnsMany(mapping => mapping.Mappings);
+                    level.OwnsMany(mapping => mapping.Candidates);
                 });
             });
 
@@ -75,7 +76,7 @@ public void Configure(EntityTypeBuilder<DataSetVersionMapping> builder)
                     filterMapping.Property(mapping => mapping.Type)
                         .HasConversion(new EnumToEnumValueConverter<MappingType>());
 
-                    filterMapping.OwnsMany(mapping => mapping.Options, filterOptionMapping =>
+                    filterMapping.OwnsMany(mapping => mapping.OptionMappings, filterOptionMapping =>
                     {
                         filterOptionMapping.OwnsOne(mapping => mapping.Source);
                         filterOptionMapping.Property(mapping => mapping.Type)
@@ -107,7 +108,7 @@ public enum MappingType
     /// The user has manually chosen a mapping candidate for this source element.
     /// </summary>
     ManualMapped,
-    
+
     /// <summary>
     /// The user has manually indicated that no mapping candidate exists for this source element.
     /// </summary>
@@ -117,7 +118,7 @@ public enum MappingType
     /// The server has automatically selected a likely mapping candidate for this source element.
     /// </summary>
     AutoMapped,
-    
+
     /// <summary>
     /// The server has automatically indicated that no likely mapping candidate exists for this source element.
     /// </summary>
@@ -127,13 +128,20 @@ public enum MappingType
 /// <summary>
 /// This base class represents an element from the DataSetVersions that can be mapped.
 /// </summary>
-public abstract class MappableElement
+public abstract record MappableElement
 {
     /// <summary>
     /// This is a synthetic identifier which is used to identify source and target
     /// elements in lieu of using actual database ids.
     /// </summary>
-    public string Key { get; set; }
+    public string Key { get; set; } = string.Empty;
+}
+
+public abstract record MappableElementWithOptions<TMappableOption>
+    : MappableElement
+    where TMappableOption : MappableElement
+{
+    public List<TMappableOption> Options { get; set; } = [];
 }
 
 /// <summary>
@@ -142,90 +150,110 @@ public abstract class MappableElement
 /// the type of mapping that has been performed (e.g. the user choosing a candidate Location from
 /// the target DataSetVersion) and the candidate key (if a candidate has been chosen).
 /// </summary>
-public abstract class LeafMapping<TMappableElement>
-    where TMappableElement : MappableElement
+public abstract record Mapping<TMappableElement>
+    where TMappableElement : class
 {
-    public MappingType Type { get; set; }
+    public MappingType Type { get; set; } = MappingType.None;
 
     public TMappableElement Source { get; set; } = null!;
 
     public string? CandidateKey { get; set; }
 }
 
-public abstract class ParentMapping<TMappableElement, TOption, TOptionMapping>
+/// <summary>
+/// This base class represents a mapping for a parent element which then itself also contains
+/// child elements (or "options") that can themselves be mapped.
+/// </summary>
+public abstract record ParentMapping<TMappableElement, TOption, TOptionMapping>
+    : Mapping<TMappableElement>
     where TMappableElement : MappableElement
     where TOption : MappableElement
-    where TOptionMapping : LeafMapping<TOption>
+    where TOptionMapping : Mapping<TOption>
 {
-    public MappingType Type { get; set; }
-
-    public TMappableElement Source { get; set; } = null!;
-
-    public List<TOptionMapping> Options { get; set; } = [];
-
-    public string? CandidateKey { get; set; }
+    public List<TOptionMapping> OptionMappings { get; set; } = [];
 }
 
-public class LocationOption : MappableElement
+/// <summary>
+/// This represents a location option that is potentially mappable to another location option
+/// from the same geographic level. 
+/// </summary>
+public record LocationOption : MappableElement
 {
     public string Label { get; set; } = string.Empty;
-    
-    protected string? Code { get; set; }
-
-    protected string? OldCode { get; set; }
-
-    protected string? Urn { get; set; }
-
-    protected string? LaEstab { get; set; }
-
-    protected string? Ukprn { get; set; }
 }
 
-public class LocationOptionMapping : LeafMapping<LocationOption>;
+/// <summary>
+/// This represents the mapping, or failure to map, of a source location option to a target
+/// location option from the same geographic level.
+/// </summary>
+public record LocationOptionMapping : Mapping<LocationOption>;
 
-public class LocationLevelMappingPlan
+/// <summary>
+/// This represents a single geographic level's worth of location mappings from the source
+/// data set version and potential candidates to map to from the target data set version. 
+/// </summary>
+public record LocationLevelMappings
 {
     public GeographicLevel Level { get; set; }
 
     public List<LocationOptionMapping> Mappings { get; set; } = [];
-}
-
-public class LocationLevelMappingCandidates
-{
-    public GeographicLevel Level { get; set; }
 
     public List<LocationOption> Candidates { get; set; } = [];
 }
 
+/// <summary>
+/// This represents the overall mapping plan for all the geographic levels
+/// and locations from the source data set version to the target version.
+/// </summary>
 public class LocationMappingPlan
 {
-    public List<LocationLevelMappingPlan> Mappings { get; set; }
-
-    public List<LocationLevelMappingCandidates> Candidates { get; set; }
+    public List<LocationLevelMappings> Levels { get; set; } = [];
 }
 
-public class FilterOption : MappableElement
+/// <summary>
+/// This represents a filter option that is potentially mappable to another filter option. 
+/// </summary>
+public record FilterOption : MappableElement
 {
     public string Label { get; set; } = string.Empty;
 }
 
-public class Filter : MappableElement
+/// <summary>
+/// This represents a filter that is potentially mappable to another filter.
+/// </summary>
+public record Filter : MappableElement
 {
     public string Label { get; set; } = string.Empty;
 }
 
-public class FilterMappingCandidate : MappableElement
+/// <summary>
+/// This represents a candidate filter and all of its candidate filter options from
+/// the target data set version that could be mapped to from filters and filter options
+/// from the source version.
+/// </summary>
+public record FilterMappingCandidate : MappableElementWithOptions<FilterOption>
 {
     public string Label { get; set; } = string.Empty;
-    
-    public List<FilterOption> Options { get; set; } = [];
 }
 
-public class FilterOptionMapping : LeafMapping<FilterOption>;
+/// <summary>
+/// This represents a potential mapping of a filter option from the source data set version
+/// to a filter option in the target version.  In order to be mappable, both filter options'
+/// parent filters must firstly be mapped to each other.  
+/// </summary>
+public record FilterOptionMapping : Mapping<FilterOption>;
 
-public class FilterMapping : ParentMapping<Filter, FilterOption, FilterOptionMapping>;
+/// <summary>
+/// This represents a potential mapping of a filter from the source data set version
+/// to a filter in the target version.  
+/// </summary>
+public record FilterMapping : ParentMapping<Filter, FilterOption, FilterOptionMapping>;
 
-public class FilterMappingPlan
+/// <summary>
+/// This represents the overall mapping plan for filters and filter options from the source
+/// data set version to filters and filter options in the target data set version.
+/// </summary>
+public record FilterMappingPlan
 {
     public List<FilterMapping> Mappings { get; set; } = [];