feat: DTOSS-9178 - Add scope to validation errors (#34)

ianfnelson · web-flow · commit 65a9c09c9680 · 2025-05-29T18:38:44.000Z
diff --git a/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/MaxLengthValidator.cs b/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/MaxLengthValidator.cs
@@ -20,6 +20,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)
 
             yield return new ValidationError
             {
+                Scope = ValidationErrorScope.Record,
                 RowNumber = fileDataRecord.RowNumber,
                 Field = fieldName,
                 Error = error,
@@ -34,6 +35,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)
 
             yield return new ValidationError
             {
+                Scope = ValidationErrorScope.Record,
                 RowNumber = fileDataRecord.RowNumber,
                 Field = fieldName,
                 Error = error,
diff --git a/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/NhsNumValidator.cs b/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/NhsNumValidator.cs
@@ -11,6 +11,7 @@ protected override IEnumerable<ValidationError> RunAdditionalChecks(int rowNumbe
         {
             yield return new ValidationError
             {
+                Scope = ValidationErrorScope.Record,
                 RowNumber = rowNumber,
                 Field = FieldName,
                 Error = "NHS Num has invalid check digit",
diff --git a/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/RegexValidator.cs b/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/RegexValidator.cs
@@ -20,6 +20,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)
         {
             yield return new ValidationError
             {
+                Scope = ValidationErrorScope.Record,
                 RowNumber = fileDataRecord.RowNumber,
                 Field = FieldName,
                 Error = $"{FieldName} is missing",
@@ -32,6 +33,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)
         {
             yield return new ValidationError
             {
+                Scope = ValidationErrorScope.Record,
                 RowNumber = fileDataRecord.RowNumber,
                 Field = FieldName,
                 Error = $"{FieldName} is in an invalid format",
diff --git a/src/ServiceLayer.Mesh/ValidationError.cs b/src/ServiceLayer.Mesh/ValidationError.cs
@@ -9,4 +9,6 @@ public class ValidationError
     public required string Code { get; set; }
 
     public required string Error { get; set; }
+
+    public required ValidationErrorScope Scope { get; set; }
 }
diff --git a/src/ServiceLayer.Mesh/ValidationErrorScope.cs b/src/ServiceLayer.Mesh/ValidationErrorScope.cs
@@ -0,0 +1,9 @@
+namespace ServiceLayer.Mesh;
+
+public enum ValidationErrorScope
+{
+    File,
+    Record,
+    Header,
+    Trailer
+}
diff --git a/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/MaxLengthValidatorTests.cs b/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/MaxLengthValidatorTests.cs
@@ -27,7 +27,7 @@ public void Validate_NullValue_ShouldReturnMissingError(bool allowEmpty, string
         var errors = validator.Validate(record).ToList();
 
         // Assert
-        errors.ShouldContainValidationError(FieldName, expectedError, MissingCode, 1);
+        errors.ShouldContainValidationError(FieldName, expectedError, MissingCode, ValidationErrorScope.Record, 1);
     }
 
     [Fact]
@@ -46,7 +46,7 @@ public void Validate_EmptyValueDisallowed_ShouldReturnMissingError()
         var errors = validator.Validate(record).ToList();
 
         // Assert
-        errors.ShouldContainValidationError(FieldName, "TestField is missing or empty", MissingCode, 2);
+        errors.ShouldContainValidationError(FieldName, "TestField is missing or empty", MissingCode, ValidationErrorScope.Record,2);
     }
 
     [Fact]
@@ -86,7 +86,7 @@ public void Validate_ValueExceedingMaxLength_ShouldReturnTooLongError(int maxLen
         var errors = validator.Validate(record).ToList();
 
         // Assert
-        errors.ShouldContainValidationError(FieldName, $"TestField exceeds maximum length of {maxLength}", TooLongCode, 4);
+        errors.ShouldContainValidationError(FieldName, $"TestField exceeds maximum length of {maxLength}", TooLongCode, ValidationErrorScope.Record,4);
     }
 
     [Theory]
diff --git a/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/RegexValidatorTests.cs b/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/RegexValidatorTests.cs
@@ -27,7 +27,7 @@ public void Validate_NullValue_ShouldReturnMissingError()
         var errors = validator.Validate(record).ToList();
 
         // Assert
-        errors.ShouldContainValidationError(FieldName, $"{FieldName} is missing", MissingCode, 1);
+        errors.ShouldContainValidationError(FieldName, $"{FieldName} is missing", MissingCode, ValidationErrorScope.Record,1);
     }
 
     [Theory]
@@ -48,7 +48,7 @@ public void Validate_ValueNotMatchingPattern_ShouldReturnInvalidFormatError(stri
         var errors = validator.Validate(record).ToList();
 
         // Assert
-        errors.ShouldContainValidationError(FieldName, $"{FieldName} is in an invalid format", InvalidFormatCode, 2);
+        errors.ShouldContainValidationError(FieldName, $"{FieldName} is in an invalid format", InvalidFormatCode,ValidationErrorScope.Record, 2);
     }
 
     [Theory]
diff --git a/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/ValidationErrorAssertions.cs b/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/ValidationErrorAssertions.cs
@@ -7,6 +7,7 @@ public static void ShouldContainValidationError(
         string expectedField,
         string expectedError,
         string expectedCode,
+        ValidationErrorScope expectedScope = ValidationErrorScope.Record,
         int? expectedRowNumber = null)
     {
         var error = errors.FirstOrDefault(e =>
@@ -16,7 +17,7 @@ public static void ShouldContainValidationError(
             (expectedRowNumber == null || e.RowNumber == expectedRowNumber)
         );
 
-        Assert.True(error != null, $"Expected validation error with Field: '{expectedField}', Error: '{expectedError}', Code: '{expectedCode}'{(expectedRowNumber != null ? $", RowNumber: {expectedRowNumber}" : "")}, but none was found.");
+        Assert.True(error != null, $"Expected validation error with Scope: '{expectedScope}', Field: '{expectedField}', Error: '{expectedError}', Code: '{expectedCode}'{(expectedRowNumber != null ? $", RowNumber: {expectedRowNumber}" : "")}, but none was found.");
 
     }
 }
diff --git a/tests/ServiceLayer.Mesh.Tests/Functions/FileTransformFunctionTests.cs b/tests/ServiceLayer.Mesh.Tests/Functions/FileTransformFunctionTests.cs
@@ -139,8 +139,8 @@ public async Task Run_FileHasValidationErrors_ErrorLoggedAndStatusAndValidationE
 
         var validationErrors = new List<ValidationError>
         {
-            new() { Code = "NBSSAPPT001", Error = "error message", Field = "field", RowNumber = 1 },
-            new() { Code = "NBSSAPPT002", Error = "error message 2", Field = "field 2" }
+            new() { Scope = ValidationErrorScope.Record, Code = "NBSSAPPT001", Error = "error message", Field = "field", RowNumber = 1 },
+            new() { Scope = ValidationErrorScope.Header, Code = "NBSSAPPT002", Error = "error message 2", Field = "field 2" }
         };
 
         _fileTransformerMock.Setup(c => c.TransformFileAsync(expectedStream, file))

Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)`
`20`	`20`
`21`	`21`	`yield return new ValidationError`
`22`	`22`	`{`
	`23`	`+ Scope = ValidationErrorScope.Record,`
`23`	`24`	`RowNumber = fileDataRecord.RowNumber,`
`24`	`25`	`Field = fieldName,`
`25`	`26`	`Error = error,`
`@@ -34,6 +35,7 @@ public IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord)`
`34`	`35`
`35`	`36`	`yield return new ValidationError`
`36`	`37`	`{`
	`38`	`+ Scope = ValidationErrorScope.Record,`
`37`	`39`	`RowNumber = fileDataRecord.RowNumber,`
`38`	`40`	`Field = fieldName,`
`39`	`41`	`Error = error,`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@ protected override IEnumerable<ValidationError> RunAdditionalChecks(int rowNumbe`
`11`	`11`	`{`
`12`	`12`	`yield return new ValidationError`
`13`	`13`	`{`
	`14`	`+ Scope = ValidationErrorScope.Record,`
`14`	`15`	`RowNumber = rowNumber,`
`15`	`16`	`Field = FieldName,`
`16`	`17`	`Error = "NHS Num has invalid check digit",`
Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,6 @@ public class ValidationError`
`9`	`9`	`public required string Code { get; set; }`
`10`	`10`
`11`	`11`	`public required string Error { get; set; }`
	`12`	`+`
	`13`	`+ public required ValidationErrorScope Scope { get; set; }`
`12`	`14`	`}`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,9 @@ @@
 +namespace ServiceLayer.Mesh;
++
 +public enum ValidationErrorScope
 +{
 +    File,
 +    Record,
 +    Header,
 +    Trailer
 +}
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ public void Validate_NullValue_ShouldReturnMissingError(bool allowEmpty, string`
`27`	`27`	`var errors = validator.Validate(record).ToList();`
`28`	`28`
`29`	`29`	`// Assert`
`30`		`- errors.ShouldContainValidationError(FieldName, expectedError, MissingCode, 1);`
	`30`	`+ errors.ShouldContainValidationError(FieldName, expectedError, MissingCode, ValidationErrorScope.Record, 1);`
`31`	`31`	`}`
`32`	`32`
`33`	`33`	`[Fact]`
`@@ -46,7 +46,7 @@ public void Validate_EmptyValueDisallowed_ShouldReturnMissingError()`
`46`	`46`	`var errors = validator.Validate(record).ToList();`
`47`	`47`
`48`	`48`	`// Assert`
`49`		`- errors.ShouldContainValidationError(FieldName, "TestField is missing or empty", MissingCode, 2);`
	`49`	`+ errors.ShouldContainValidationError(FieldName, "TestField is missing or empty", MissingCode, ValidationErrorScope.Record,2);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`[Fact]`
`@@ -86,7 +86,7 @@ public void Validate_ValueExceedingMaxLength_ShouldReturnTooLongError(int maxLen`
`86`	`86`	`var errors = validator.Validate(record).ToList();`
`87`	`87`
`88`	`88`	`// Assert`
`89`		`- errors.ShouldContainValidationError(FieldName, $"TestField exceeds maximum length of {maxLength}", TooLongCode, 4);`
	`89`	`+ errors.ShouldContainValidationError(FieldName, $"TestField exceeds maximum length of {maxLength}", TooLongCode, ValidationErrorScope.Record,4);`
`90`	`90`	`}`
`91`	`91`
`92`	`92`	`[Theory]`
Original file line number	Diff line number	Diff line change
`@@ -7,6 +7,7 @@ public static void ShouldContainValidationError(`
`7`	`7`	`string expectedField,`
`8`	`8`	`string expectedError,`
`9`	`9`	`string expectedCode,`
	`10`	`+ ValidationErrorScope expectedScope = ValidationErrorScope.Record,`
`10`	`11`	`int? expectedRowNumber = null)`
`11`	`12`	`{`
`12`	`13`	`var error = errors.FirstOrDefault(e =>`
`@@ -16,7 +17,7 @@ public static void ShouldContainValidationError(`
`16`	`17`	`(expectedRowNumber == null \|\| e.RowNumber == expectedRowNumber)`
`17`	`18`	`);`
`18`	`19`
`19`		`- Assert.True(error != null, $"Expected validation error with Field: '{expectedField}', Error: '{expectedError}', Code: '{expectedCode}'{(expectedRowNumber != null ? $", RowNumber: {expectedRowNumber}" : "")}, but none was found.");`
	`20`	`+ Assert.True(error != null, $"Expected validation error with Scope: '{expectedScope}', Field: '{expectedField}', Error: '{expectedError}', Code: '{expectedCode}'{(expectedRowNumber != null ? $", RowNumber: {expectedRowNumber}" : "")}, but none was found.");`
`20`	`21`
`21`	`22`	`}`
`22`	`23`	`}`
Original file line number	Diff line number	Diff line change
`@@ -139,8 +139,8 @@ public async Task Run_FileHasValidationErrors_ErrorLoggedAndStatusAndValidationE`
`139`	`139`
`140`	`140`	`var validationErrors = new List<ValidationError>`
`141`	`141`	`{`
`142`		`- new() { Code = "NBSSAPPT001", Error = "error message", Field = "field", RowNumber = 1 },`
`143`		`- new() { Code = "NBSSAPPT002", Error = "error message 2", Field = "field 2" }`
	`142`	`+ new() { Scope = ValidationErrorScope.Record, Code = "NBSSAPPT001", Error = "error message", Field = "field", RowNumber = 1 },`
	`143`	`+ new() { Scope = ValidationErrorScope.Header, Code = "NBSSAPPT002", Error = "error message 2", Field = "field 2" }`
`144`	`144`	`};`
`145`	`145`
`146`	`146`	`_fileTransformerMock.Setup(c => c.TransformFileAsync(expectedStream, file))`