Merge pull request #5626 from dfe-analytical-services/EES-5882

EES-5882: Add Screener API response models.

Author: tomjonesdev

src/GovUk.Education.ExploreEducationStatistics.Admin/Models/DataScreenerResponse.cs

@@ -0,0 +1,32 @@
+#nullable enable
+
+using System;
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace GovUk.Education.ExploreEducationStatistics.Admin.Models;
+
+public class DataScreenerResponse
+{
+    // TODO (EES-5353): The screening result will need to be persisted somewhere in the backend.
+    // If a user attempts to confirm a data set for import, the result should be validated.
+    // A failed screening should block the import process.
+    [JsonIgnore]
+    public Guid Id { get; set; }
+
+    // TODO (EES-5353): Discuss if this can just be a boolean (e.g. "Passed", "IsSuccessful")
+    [JsonPropertyName("overall_stage")]
+    public ScreenerResult Result { get; set; }
+
+    [JsonPropertyName("overall_message")]
+    public required string Message { get; set; }
+
+    [JsonPropertyName("results_table")]
+    public List<DataScreenerTestResult> TestResults { get; set; } = [];
+}
+
+public enum ScreenerResult
+{
+    Passed,
+    Failed,
+}

src/GovUk.Education.ExploreEducationStatistics.Admin/Models/DataScreenerTestResult.cs

@@ -0,0 +1,37 @@
+#nullable enable
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+namespace GovUk.Education.ExploreEducationStatistics.Admin.Models;
+
+public class DataScreenerTestResult
+{
+    [JsonPropertyName("check")]
+    public required string TestFunctionName { get; set; }
+
+    [JsonPropertyName("result")]
+    public TestResult TestResult { get; set; }
+
+    // TODO (EES-5353): The screener currently returns a single string, so this list will fail to deserialise until the response has been updated
+    [JsonPropertyName("message")]
+    public List<string> Notes { get; set; } = [];
+
+    public Stage Stage { get; set; }
+}
+
+// TODO (EES-5353): Rename stages to be more descriptive
+public enum Stage
+{
+    InitialFileValidation = 1,
+    PreScreening1 = 2,
+    PreScreening2 = 3,
+    FullChecks = 4,
+    Passed = 5,
+}
+
+public enum TestResult
+{
+    PASS,
+    FAIL,
+    WARNING,
+}

src/GovUk.Education.ExploreEducationStatistics.Admin/Requests/DataScreenerRequest.cs

@@ -0,0 +1,16 @@
+#nullable enable
+
+namespace GovUk.Education.ExploreEducationStatistics.Admin.Requests;
+
+public record DataScreenerRequest
+{
+    public required string StorageContainerName { get; set; }
+
+    public required string DataFileName { get; set; }
+
+    public required string MetaFileName { get; set; }
+
+    public required string DataFilePath { get; set; }
+
+    public required string MetaFilePath { get; set; }
+}