Pattern validation for model properties, fixes #61

Pattern validation for model properties, fixes #61

Author: egil

src/Atc.Rest.ApiGenerator/Extensions/PropertyDeclarationSyntaxExtensions.cs

@@ -196,6 +196,23 @@ OpenApiDataTypeConstants.Integer when schema.HasFormatType() && schema.IsFormatT
             return propertyDeclaration;
         }
 
+        public static PropertyDeclarationSyntax AddValidationAttributeForPatternIfRequired(
+            this PropertyDeclarationSyntax propertyDeclaration,
+            OpenApiSchema schema)
+        {
+            if (schema == null)
+            {
+                throw new ArgumentNullException(nameof(schema));
+            }
+
+            if (schema.Type == OpenApiDataTypeConstants.String && schema.Pattern is not null)
+            {
+                propertyDeclaration = propertyDeclaration.AddValidationAttribute(new RegularExpressionAttribute(schema.Pattern));
+            }
+
+            return propertyDeclaration;
+        }
+
         private static PropertyDeclarationSyntax RangeAttributeInt(
             PropertyDeclarationSyntax propertyDeclaration,
             OpenApiSchema schema)

src/Atc.Rest.ApiGenerator/SyntaxFactories/SyntaxPropertyDeclarationFactory.cs

@@ -114,6 +114,8 @@ public static PropertyDeclarationSyntax CreateAuto(
 
             propertyDeclaration = propertyDeclaration.AddValidationAttributeForMinMaxIfRequired(schema.Value);
 
+            propertyDeclaration = propertyDeclaration.AddValidationAttributeForPatternIfRequired(schema.Value);
+
             return propertyDeclaration;
         }
 

test/Atc.Rest.ApiGenerator.Tests/SyntaxGenerators/Api/SyntaxGeneratorContractModelTests.cs

@@ -21,10 +21,10 @@ protected override ISyntaxCodeGenerator CreateApiGenerator(ApiProjectOptions api
         {
             // Verify spec file supported for unit test
             Assert.Single(apiProject.Document.Components.Schemas);
-            var schema = apiProject.Document.Components.Schemas.First().Value;
+            var schema = apiProject.Document.Components.Schemas.First();
 
             // Construct SUT
-            return new SyntaxGeneratorContractModel(apiProject, string.Empty, schema, FocusOnSegment);
+            return new SyntaxGeneratorContractModel(apiProject, schema.Key, schema.Value, FocusOnSegment);
         }
 
         [Theory(DisplayName = "Api Contract Model")]

test/Atc.Rest.ApiGenerator.Tests/SyntaxGenerators/Api/XUnitTestData/ContractModel/propertiesWithConstraints.yaml

@@ -0,0 +1,28 @@
+openapi: 3.0.0
+components:
+  schemas:
+    TestComponent:
+      title: TestComponent
+      description: 'Test component description'
+      type: object
+      properties:
+        noConstraint:
+          type: string
+        minLengthConstraint:
+          type: string
+          minLength: 42
+        maxLengthConstraint:
+          type: string
+          maxLength: 42
+        bothLengthsConstraint:
+          type: string
+          minLength: 3
+          maxLength: 42
+        patternConstraint:
+          type: string
+          pattern: '^[A-Z]$'
+        allConstraint:
+          type: string
+          minLength: 3
+          maxLength: 42
+          pattern: '^[A-Z]$'

test/Atc.Rest.ApiGenerator.Tests/SyntaxGenerators/Api/XUnitTestData/ContractModel/propertiesWithConstraints.yaml.verified.cs

@@ -0,0 +1,46 @@
+using System.CodeDom.Compiler;
+using System.ComponentModel.DataAnnotations;
+
+//------------------------------------------------------------------------------
+// This code was auto-generated by ApiGenerator x.x.x.x.
+//
+// Changes to this file may cause incorrect behavior and will be lost if
+// the code is regenerated.
+//------------------------------------------------------------------------------
+namespace TestProject.AtcTest.Contracts.Test
+{
+    /// <summary>
+    /// Test component description.
+    /// </summary>
+    [GeneratedCode("ApiGenerator", "x.x.x.x")]
+    public class TestComponent
+    {
+        public string NoConstraint { get; set; }
+
+        [MinLength(42)]
+        public string MinLengthConstraint { get; set; }
+
+        [StringLength(42)]
+        public string MaxLengthConstraint { get; set; }
+
+        [MinLength(3)]
+        [MaxLength(42)]
+        public string BothLengthsConstraint { get; set; }
+
+        [RegularExpression("^[A-Z]$")]
+        public string PatternConstraint { get; set; }
+
+        [MinLength(3)]
+        [MaxLength(42)]
+        [RegularExpression("^[A-Z]$")]
+        public string AllConstraint { get; set; }
+
+        /// <summary>
+        /// Converts to string.
+        /// </summary>
+        public override string ToString()
+        {
+            return $"{nameof(NoConstraint)}: {NoConstraint}, {nameof(MinLengthConstraint)}: {MinLengthConstraint}, {nameof(MaxLengthConstraint)}: {MaxLengthConstraint}, {nameof(BothLengthsConstraint)}: {BothLengthsConstraint}, {nameof(PatternConstraint)}: {PatternConstraint}, {nameof(AllConstraint)}: {AllConstraint}";
+        }
+    }
+}

test/Atc.Rest.ApiGenerator.Tests/SyntaxGenerators/Api/XUnitTestData/ContractModel/requiredArrayComponent.yaml.verified.cs

@@ -14,8 +14,7 @@ namespace TestProject.AtcTest.Contracts.Test
     /// CreateItemRequest.
     /// </summary>
     [GeneratedCode("ApiGenerator", "x.x.x.x")]
-    public class
-    
+    public class RequiredArrayComponent
     {
         [Required]
         public List<string> MyItems { get; set; }

test/Atc.Rest.ApiGenerator.Tests/SyntaxGenerators/Api/XUnitTestData/ContractModel/stringComponent.yaml.verified.cs

@@ -14,8 +14,7 @@ namespace TestProject.AtcTest.Contracts.Test
     /// A string component.
     /// </summary>
     [GeneratedCode("ApiGenerator", "x.x.x.x")]
-    public class
-    
+    public class StringComponent
     {
         /// <summary>
         /// normal string.