[Fix #418] Adding Jsr 303 validation support

fjtirado · fjtirado · commit 3b65612d602c · 2024-08-28T19:39:46.000+02:00
Notice that this will force us to add version and other mandatory field
we were not including in the examples

Signed-off-by: Javier &lt;ftirados@redhat.com&gt;
diff --git a/api/pom.xml b/api/pom.xml
@@ -33,7 +33,14 @@
             <groupId>jakarta.validation</groupId>
             <artifactId>jakarta.validation-api</artifactId>
         </dependency>
- 
+        <dependency>
+          <groupId>org.hibernate.validator</groupId>
+          <artifactId>hibernate-validator</artifactId>
+        </dependency>
+        <dependency>
+          <groupId>org.glassfish.expressly</groupId>
+          <artifactId>expressly</artifactId>
+        </dependency>
         <!-- test -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
@@ -65,11 +72,6 @@
             <artifactId>logback-classic</artifactId>
             <scope>test</scope>
         </dependency>
-        <dependency>
-            <groupId>org.assertj</groupId>
-            <artifactId>assertj-core</artifactId>
-            <scope>test</scope>
-        </dependency>
     </dependencies>
 
 
diff --git a/api/src/main/java/io/serverlessworkflow/api/ObjectMapperFactory.java b/api/src/main/java/io/serverlessworkflow/api/ObjectMapperFactory.java
@@ -17,8 +17,10 @@
 
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.databind.module.SimpleModule;
 import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
 import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator.Feature;
+import io.serverlessworkflow.serialization.BeanDeserializerModifierWithValidation;
 
 class ObjectMapperFactory {
 
@@ -36,10 +38,13 @@ public static final ObjectMapper yamlMapper() {
   }
 
   private static ObjectMapper configure(ObjectMapper mapper) {
+    SimpleModule validationModule = new SimpleModule();
+    validationModule.setDeserializerModifier(new BeanDeserializerModifierWithValidation());
     return mapper
         .configure(SerializationFeature.INDENT_OUTPUT, true)
         .configure(SerializationFeature.WRITE_EMPTY_JSON_ARRAYS, false)
-        .configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false);
+        .configure(SerializationFeature.WRITE_NULL_MAP_VALUES, false)
+        .registerModule(validationModule);
   }
 
   private ObjectMapperFactory() {}
diff --git a/api/src/main/java/io/serverlessworkflow/serialization/BeanDeserializerModifierWithValidation.java b/api/src/main/java/io/serverlessworkflow/serialization/BeanDeserializerModifierWithValidation.java
@@ -0,0 +1,35 @@
+/*
+ * Copyright 2020-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.serverlessworkflow.serialization;
+
+import com.fasterxml.jackson.databind.BeanDescription;
+import com.fasterxml.jackson.databind.DeserializationConfig;
+import com.fasterxml.jackson.databind.JsonDeserializer;
+import com.fasterxml.jackson.databind.deser.BeanDeserializer;
+import com.fasterxml.jackson.databind.deser.BeanDeserializerModifier;
+
+public class BeanDeserializerModifierWithValidation extends BeanDeserializerModifier {
+
+  private static final long serialVersionUID = 1L;
+
+  @Override
+  public JsonDeserializer<?> modifyDeserializer(
+      DeserializationConfig config, BeanDescription beanDesc, JsonDeserializer<?> deserializer) {
+    return deserializer instanceof BeanDeserializer
+        ? new BeanDeserializerWithValidation((BeanDeserializer) deserializer)
+        : deserializer;
+  }
+}
diff --git a/api/src/main/java/io/serverlessworkflow/serialization/BeanDeserializerWithValidation.java b/api/src/main/java/io/serverlessworkflow/serialization/BeanDeserializerWithValidation.java
@@ -0,0 +1,51 @@
+/*
+ * Copyright 2020-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.serverlessworkflow.serialization;
+
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.deser.BeanDeserializer;
+import com.fasterxml.jackson.databind.deser.BeanDeserializerBase;
+import jakarta.validation.ConstraintViolation;
+import jakarta.validation.ConstraintViolationException;
+import jakarta.validation.Validation;
+import jakarta.validation.Validator;
+import java.io.IOException;
+import java.util.Set;
+
+public class BeanDeserializerWithValidation extends BeanDeserializer {
+  private static final long serialVersionUID = 1L;
+  private static final Validator validator =
+      Validation.buildDefaultValidatorFactory().getValidator();
+
+  protected BeanDeserializerWithValidation(BeanDeserializerBase src) {
+    super(src);
+  }
+
+  private <T> void validate(T t) throws IOException {
+    Set<ConstraintViolation<T>> violations = validator.validate(t);
+    if (!violations.isEmpty()) {
+      throw new ConstraintViolationException(violations);
+    }
+  }
+
+  @Override
+  public Object deserialize(JsonParser p, DeserializationContext ctxt) throws IOException {
+    Object instance = super.deserialize(p, ctxt);
+    validate(instance);
+    return instance;
+  }
+}
diff --git a/api/src/main/java/io/serverlessworkflow/serialization/DeserializeHelper.java b/api/src/main/java/io/serverlessworkflow/serialization/DeserializeHelper.java
@@ -19,6 +19,7 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.fasterxml.jackson.core.TreeNode;
 import com.fasterxml.jackson.databind.JsonMappingException;
+import jakarta.validation.ConstraintViolationException;
 import java.io.IOException;
 import java.util.Collection;
 
@@ -33,7 +34,7 @@ public static <T> T deserializeOneOf(
       try {
         Object object = p.getCodec().treeToValue(node, unionType);
         return targetClass.getConstructor(unionType).newInstance(object);
-      } catch (IOException | ReflectiveOperationException io) {
+      } catch (IOException | ReflectiveOperationException | ConstraintViolationException io) {
         ex.addSuppressed(io);
       }
     }
diff --git a/api/src/test/resources/features/callFunction.yaml b/api/src/test/resources/features/callFunction.yaml
@@ -2,6 +2,7 @@ document:
   dsl: 1.0.0-alpha1
   namespace: default
   name: http-call-with-response-output
+  version: 1.0.0
 
 use:
   functions:
diff --git a/api/src/test/resources/features/callHttp.yaml b/api/src/test/resources/features/callHttp.yaml
@@ -2,6 +2,7 @@ document:
   dsl: 1.0.0-alpha1
   namespace: default
   name: http-call-with-response-output
+  version: 1.0.0
 do:
   - getPet:
       call: http
diff --git a/api/src/test/resources/features/callOpenAPI.yaml b/api/src/test/resources/features/callOpenAPI.yaml
@@ -2,6 +2,7 @@ document:
   dsl: 1.0.0-alpha1
   namespace: default
   name: openapi-call-with-content-output
+  version: 1.0.0
 do:
   - findPet:
       call: openapi
diff --git a/api/src/test/resources/features/composite.yaml b/api/src/test/resources/features/composite.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: do
+      version: 1.0.0
 do:
   - compositeExample:
       do:
diff --git a/api/src/test/resources/features/data-flow.yaml b/api/src/test/resources/features/data-flow.yaml
@@ -2,6 +2,7 @@ document:
   dsl: 1.0.0-alpha1
   namespace: default
   name: output-filtering
+  version: 1.0.0
 do:
   - getPet:
       call: http
diff --git a/api/src/test/resources/features/emit.yaml b/api/src/test/resources/features/emit.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: emit
+      version: 1.0.0
 do:
   - emitEvent:
       emit:
diff --git a/api/src/test/resources/features/flow.yaml b/api/src/test/resources/features/flow.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: implicit-sequence
+      version: 1.0.0
 do:
   - setRed:
       set:
diff --git a/api/src/test/resources/features/for.yaml b/api/src/test/resources/features/for.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: for
+      version: 1.0.0
 do:
   - loopColors:
       for:
diff --git a/api/src/test/resources/features/listen.yaml b/api/src/test/resources/features/listen.yaml
@@ -2,6 +2,7 @@ document:
   dsl: 1.0.0-alpha1
   namespace: default
   name: listen-task
+  version: 1.0.0
 do:
   - listenToSomething:
       listen:
diff --git a/api/src/test/resources/features/raise.yaml b/api/src/test/resources/features/raise.yaml
@@ -2,10 +2,12 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: raise-custom-error
+      version: 1.0.0
 do:
   - raiseError:
       raise:
         error:
           status: 400
           type: https://serverlessworkflow.io/errors/types/compliance
-          title: Compliance Error
+          title: Compliance Error
+          instance: raiseError
diff --git a/api/src/test/resources/features/set.yaml b/api/src/test/resources/features/set.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: set
+      version: 1.0.0
 do:
   - setShape:
       set:
diff --git a/api/src/test/resources/features/switch.yaml b/api/src/test/resources/features/switch.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: switch-match
+      version: 1.0.0
 do:
   - switchColor:
       switch:
diff --git a/api/src/test/resources/features/try.yaml b/api/src/test/resources/features/try.yaml
@@ -2,6 +2,7 @@ document:
       dsl: 1.0.0-alpha1
       namespace: default
       name: try-catch-404
+      version: 1.0.0
 do:
   - tryGetPet:
       try:
diff --git a/pom.xml b/pom.xml
@@ -76,7 +76,8 @@
     <version.org.junit.jupiter>5.11.0</version.org.junit.jupiter>
     <version.org.mockito>5.12.0</version.org.mockito>
     <version.org.slf4j>2.0.16</version.org.slf4j>
-    
+    <version.org.hibernate.validator>8.0.1.Final</version.org.hibernate.validator>
+    <version.org.glassfish.expressly>5.0.0</version.org.glassfish.expressly>
 
     <!-- Checkstyle props -->
     <checkstyle.failOnViolation>true</checkstyle.failOnViolation>
@@ -124,6 +125,17 @@
         <artifactId>json-schema-validator</artifactId>
         <version>${version.com.networknt}</version>
       </dependency>
+      <dependency>
+        <groupId>org.hibernate.validator</groupId>
+        <artifactId>hibernate-validator</artifactId>
+        <version>${version.org.hibernate.validator}</version>
+      </dependency>
+       <dependency>
+         <groupId>org.glassfish.expressly</groupId>
+         <artifactId>expressly</artifactId>
+         <version>${version.org.glassfish.expressly}</version>
+        </dependency>
+
       <dependency>
         <groupId>com.fasterxml.jackson.dataformat</groupId>
         <artifactId>jackson-dataformat-yaml</artifactId>
