[ES-1911] Added Schema validation for identitityData

mock-identity-system/pom.xml

@@ -138,6 +138,41 @@
 				 </exclusion>
 			 </exclusions>
 		 </dependency>
+
+	 <dependency>
+		 <groupId>com.networknt</groupId>
+		 <artifactId>json-schema-validator</artifactId>
+		 <version>1.5.1</version>
+		 <exclusions>
+			 <exclusion>
+				 <groupId>com.fasterxml.jackson.core</groupId>
+				 <artifactId>jackson-core</artifactId>
+			 </exclusion>
+			 <exclusion>
+				 <groupId>com.fasterxml.jackson.core</groupId>
+				 <artifactId>jackson-annotations</artifactId>
+			 </exclusion>
+			 <exclusion>
+				 <groupId>com.fasterxml.jackson.core</groupId>
+				 <artifactId>jackson-databind</artifactId>
+			 </exclusion>
+		 </exclusions>
+	 </dependency>
+	 <dependency>
+		 <groupId>com.fasterxml.jackson.core</groupId>
+		 <artifactId>jackson-databind</artifactId>
+		 <version>2.12.1</version>
+	 </dependency>
+	 <dependency>
+		 <groupId>com.fasterxml.jackson.core</groupId>
+		 <artifactId>jackson-core</artifactId>
+		 <version>2.12.1</version>
+	 </dependency>
+	 <dependency>
+		 <groupId>com.fasterxml.jackson.core</groupId>
+		 <artifactId>jackson-annotations</artifactId>
+		 <version>2.12.1</version>
+	 </dependency>
   </dependencies>
   <build>
 		<plugins>

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/controller/IdentityController.java

@@ -5,18 +5,28 @@
  */
 package io.mosip.esignet.mock.identitysystem.controller;
 
+import javax.validation.ConstraintViolation;
+import javax.validation.ConstraintViolationException;
 import javax.validation.Valid;
 
 import io.mosip.esignet.mock.identitysystem.dto.*;
+import io.mosip.esignet.mock.identitysystem.dto.Error;
+import io.mosip.esignet.mock.identitysystem.validator.IdentitySchema;
+import io.mosip.kernel.core.exception.ErrorResponse;
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
 import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.validation.annotation.Validated;
 import org.springframework.web.bind.annotation.*;
 
 import io.mosip.esignet.mock.identitysystem.exception.MockIdentityException;
 import io.mosip.esignet.mock.identitysystem.service.IdentityService;
 import io.mosip.esignet.mock.identitysystem.util.HelperUtil;
 
+import java.util.ArrayList;
 import java.util.List;
+import java.util.Set;
 
 
 @RestController
@@ -29,7 +39,7 @@ public class IdentityController {
 	@PostMapping(value = "identity", consumes = { MediaType.APPLICATION_JSON_VALUE }, produces = {
 			MediaType.APPLICATION_JSON_VALUE })
 	public ResponseWrapper<IdentityStatus> createIdentity
-	(@Valid @RequestBody RequestWrapper<CreateIdentity> requestWrapper) throws MockIdentityException {
+	(@RequestBody @Valid RequestWrapper<CreateIdentity> requestWrapper) throws MockIdentityException {
 
 		ResponseWrapper response = new ResponseWrapper<IdentityStatus>();
 		IdentityStatus identityStatus = new IdentityStatus();
@@ -43,7 +53,7 @@ public class IdentityController {
 	@PutMapping(value = "identity", consumes = { MediaType.APPLICATION_JSON_VALUE }, produces = {
 			MediaType.APPLICATION_JSON_VALUE })
 	public ResponseWrapper<IdentityStatus> updateIdentity
-			(@Valid @RequestBody RequestWrapper<UpdateIdentity> requestWrapper) throws MockIdentityException {
+			(@RequestBody @Valid RequestWrapper<UpdateIdentity> requestWrapper) throws MockIdentityException {
 
 		ResponseWrapper response = new ResponseWrapper<IdentityStatus>();
 		IdentityStatus identityStatus = new IdentityStatus();
@@ -74,4 +84,25 @@ public ResponseWrapper<VerifiedClaimStatus> createVerifiedClaim(@Valid @RequestB
 		return response;
 
 	}
+
+	@ExceptionHandler(ConstraintViolationException.class)
+	public ResponseEntity handleMethodArgumentNotValidException(ConstraintViolationException ex) {
+		List<Error> errors = new ArrayList<>();
+		if(ex != null) {
+			Set<ConstraintViolation<?>> violations = ((ConstraintViolationException) ex).getConstraintViolations();
+			for(ConstraintViolation<?> cv : violations) {
+				errors.add(new Error(cv.getMessage(), cv.getPropertyPath().toString() + ": " + cv.getMessage()));
+			}
+			return new ResponseEntity<ResponseWrapper>(getResponseWrapper(errors), HttpStatus.OK);
+		}
+		return ResponseEntity.status(HttpStatus.BAD_REQUEST)
+				.body(errors);
+	}
+
+	private ResponseWrapper getResponseWrapper(List<Error> errors) {
+		ResponseWrapper responseWrapper = new ResponseWrapper<>();
+		responseWrapper.setResponseTime(HelperUtil.getCurrentUTCDateTime());
+		responseWrapper.setErrors(errors);
+		return responseWrapper;
+	}
 }

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/dto/CreateIdentity.java

@@ -5,8 +5,8 @@
  */
 package io.mosip.esignet.mock.identitysystem.dto;
 
-import io.mosip.esignet.mock.identitysystem.validator.IdData;
+import io.mosip.esignet.mock.identitysystem.validator.IdentitySchema;
 
-@IdData(action = "CREATE")
+@IdentitySchema(action = "CREATE")
 public class CreateIdentity extends IdentityData {
 }

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/dto/IdentityData.java

@@ -8,18 +8,13 @@
 
 import java.util.List;
 
-import javax.validation.constraints.NotBlank;
-
 import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
-import io.mosip.esignet.mock.identitysystem.util.ErrorConstants;
-import io.mosip.esignet.mock.identitysystem.validator.IdData;
 import lombok.Data;
 
 @Data
 @JsonIgnoreProperties(ignoreUnknown = true)
 public class IdentityData {
-
-	@NotBlank(message = ErrorConstants.INVALID_INDIVIDUAL_ID)
+
 	String individualId;
 
 	String pin;

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/dto/UpdateIdentity.java

@@ -5,8 +5,8 @@
  */
 package io.mosip.esignet.mock.identitysystem.dto;
 
-import io.mosip.esignet.mock.identitysystem.validator.IdData;
+import io.mosip.esignet.mock.identitysystem.validator.IdentitySchema;
 
-@IdData(action = "UPDATE")
+@IdentitySchema(action = "UPDATE")
 public class UpdateIdentity extends IdentityData {
 }

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/util/ErrorConstants.java

@@ -40,4 +40,5 @@ public class ErrorConstants {
 	public static final String INVALID_TRUST_FRAMEWORK = "invalid_trust_framework";
 	public static final String INVALID_VERIFIED_DATE = "invalid_verified_date";
 	public static final String CLAIM_ALREADY_EXISTS="Claim already exists";
+	public static final String INVALID_IDENTITY_DATA= "invalid_identity_data";
 }

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/validator/IdentitySchema.java

@@ -0,0 +1,23 @@
+package io.mosip.esignet.mock.identitysystem.validator;
+
+
+import io.mosip.esignet.mock.identitysystem.util.ErrorConstants;
+
+import javax.validation.Constraint;
+import javax.validation.Payload;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ElementType.TYPE_USE, ElementType.FIELD, ElementType.PARAMETER})
+@Retention(RetentionPolicy.RUNTIME)
+@Constraint(validatedBy = IdentitySchemaValidator.class)
+public @interface IdentitySchema {
+
+    String message() default ErrorConstants.INVALID_IDENTITY_DATA;
+    Class<?>[] groups() default {};
+    Class<? extends Payload>[] payload() default {};
+
+    String action();
+}

mock-identity-system/src/main/java/io/mosip/esignet/mock/identitysystem/validator/IdentitySchemaValidator.java

@@ -0,0 +1,109 @@
+package io.mosip.esignet.mock.identitysystem.validator;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.networknt.schema.*;
+import io.mosip.esignet.mock.identitysystem.dto.IdentityData;
+import io.mosip.esignet.mock.identitysystem.dto.RequestWrapper;
+import lombok.extern.slf4j.Slf4j;
+import org.jose4j.lang.StringUtil;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.ResourceLoader;
+import org.springframework.stereotype.Component;
+
+import javax.validation.ConstraintValidator;
+import javax.validation.ConstraintValidatorContext;
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+import java.util.stream.Collectors;
+
+@Component
+@Slf4j
+public class IdentitySchemaValidator implements ConstraintValidator<IdentitySchema, Object> {
+
+    @Value("${mosip.mock.ida.identity.schema.url}")
+    private String identitySchemaUrl;
+
+    @Value("#{${mosip.mock.ida.update-identity.non-mandatory.fields}}")
+    private Set<String> nonMandatoryFieldsOnUpdate;
+
+    private String action;
+
+    private volatile JsonSchema schema;
+
+    @Autowired
+    ObjectMapper objectMapper;
+
+    @Autowired
+    ResourceLoader resourceLoader;
+
+
+    @Override
+    public void initialize(IdentitySchema constraintAnnotation) {
+        this.action = constraintAnnotation.action();
+    }
+
+    @Override
+    public boolean isValid(Object object, ConstraintValidatorContext context) {
+
+        if (!(object instanceof IdentityData)) {
+            return false;
+        }
+        IdentityData identityData=(IdentityData) object;
+        JsonNode identityJsonNode = objectMapper.valueToTree(identityData);
+        Set<ValidationMessage> validationErrors = validateIdentityData(identityJsonNode);
+
+        // Handle validation errors
+        if (!validationErrors.isEmpty()) {
+            addValidationErrorCode(validationErrors,context);
+            return false;
+        }
+        return true;
+    }
+
+    private Set<ValidationMessage> validateIdentityData(JsonNode identityJsonNode) {
+        Set<ValidationMessage> errors = getSchema().validate(identityJsonNode);
+        // If not a create operation, filter out specific errors
+        if (action.equals("UPDATE")) {
+            // Ignore validation errors with code 1029 (null value) and for exempted fields when validating updateIdentity
+            errors = errors.stream()
+                    .filter(error -> !error.getCode().equals("1029") ||
+                            !nonMandatoryFieldsOnUpdate.contains(error.
+                                    getInstanceLocation().getName(0)))
+                    .collect(Collectors.toSet());
+        }
+        return errors;
+    }
+
+    private void addValidationErrorCode(Set<ValidationMessage> errors, ConstraintValidatorContext context) {
+        context.disableDefaultConstraintViolation();
+        errors.forEach(error->context.
+                buildConstraintViolationWithTemplate("invalid_"+error.getInstanceLocation().getName(0).toLowerCase())
+                .addConstraintViolation());
+    }
+
+    private JsonSchema getSchema()  {
+        if(schema !=null ) return schema;
+        synchronized (this) {
+            if (schema == null) {
+                InputStream schemaResponse = getResource(identitySchemaUrl);
+                JsonSchemaFactory jsonSchemaFactory = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V202012);
+                schema = jsonSchemaFactory.getSchema(schemaResponse);
+            }
+        }
+        return schema;
+    }
+
+    private InputStream getResource(String url) {
+        try{
+            Resource resource = resourceLoader.getResource(url);
+            return resource.getInputStream();
+        }catch (IOException e){
+            log.error("Failed to parse data: {}", url, e);
+        }
+        throw new RuntimeException("invalid_configuration");
+    }
+}

mock-identity-system/src/main/resources/application-default.properties

@@ -103,12 +103,10 @@ spring.jpa.hibernate.ddl-auto=none
 spring.jpa.properties.hibernate.jdbc.lob.non_contextual_creation=true
 mosip.esignet.mock.authenticator.ida.otp-channels=email,phone
 
-mosip.mock.identity.create.required.fields=individualId,fullName,givenName,familyName,gender,dateOfBirth,email,phone,streetAddress,locality,region,postalCode,country
-mosip.mock.identity.update.required.fields=individualId
 
 mosip.esignet.mock.supported-fields=individualId,pin,givenName,familyName,gender,dateOfBirth,email,phone,streetAddress,locality,region,postalCode,country
 mosip.mock.ida.kba.default.field-language=eng
-mosip.mock.ida.kyc.psut.field=psut
+
 
 #Related to health check of hsm
 mosip.kernel.keymgr.hsm.health.check.enabled=false