fix: add json validation for survey unit temp zone

pom.xml

@@ -10,7 +10,7 @@
     <description>Modules for queen back-office</description>
 
     <properties>
-        <revision>4.3.0</revision>
+        <revision>4.3.1</revision>
         <changelist></changelist>
         <java.version>21</java.version>
         <maven.compiler.source>21</maven.compiler.source>

queen-application/src/main/java/fr/insee/queen/application/surveyunittempzone/controller/SurveyUnitTempZoneController.java

@@ -4,9 +4,12 @@
 import fr.insee.queen.application.configuration.auth.AuthorityPrivileges;
 import fr.insee.queen.application.surveyunittempzone.dto.output.SurveyUnitTempZoneDto;
 import fr.insee.queen.application.web.validation.IdValid;
+import fr.insee.queen.application.web.validation.json.JsonValid;
+import fr.insee.queen.application.web.validation.json.SchemaType;
 import fr.insee.queen.domain.surveyunittempzone.service.SurveyUnitTempZoneService;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.Parameter;
+import io.swagger.v3.oas.annotations.media.Schema;
 import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.constraints.NotNull;
 import lombok.AllArgsConstructor;
@@ -43,7 +46,11 @@ public class SurveyUnitTempZoneController {
     @PreAuthorize(AuthorityPrivileges.HAS_INTERVIEWER_PRIVILEGES)
     @ResponseStatus(HttpStatus.CREATED)
     public void postSurveyUnitByIdInTempZone(@IdValid @PathVariable(value = "id") String surveyUnitId,
-                                             @NotNull @RequestBody ObjectNode surveyUnit,
+                                             @NotNull
+                                             @RequestBody
+                                             @Schema(ref = SchemaType.Names.SURVEY_UNIT_TEMP_ZONE)
+                                             @JsonValid(SchemaType.SURVEY_UNIT_TEMP_ZONE)
+                                             ObjectNode surveyUnit,
                                              @CurrentSecurityContext(expression = "authentication.name") String userId) {
         surveyUnitTempZoneService.saveSurveyUnitToTempZone(surveyUnitId, userId, surveyUnit);
     }

queen-application/src/main/java/fr/insee/queen/application/surveyunittempzone/dto/output/SurveyUnitTempZoneDto.java

@@ -1,6 +1,7 @@
 package fr.insee.queen.application.surveyunittempzone.dto.output;
 
 import com.fasterxml.jackson.databind.node.ObjectNode;
+import fr.insee.queen.application.web.validation.json.SchemaType;
 import fr.insee.queen.domain.surveyunittempzone.model.SurveyUnitTempZone;
 import io.swagger.v3.oas.annotations.media.Schema;
 
@@ -12,6 +13,7 @@ public record SurveyUnitTempZoneDto(
         String surveyUnitId,
         String userId,
         Long date,
+        @Schema(ref = SchemaType.Names.SURVEY_UNIT_TEMP_ZONE)
         ObjectNode surveyUnit) {
 
     public static SurveyUnitTempZoneDto fromModel(SurveyUnitTempZone surveyUnit) {

queen-application/src/main/java/fr/insee/queen/application/web/validation/json/SchemaType.java

@@ -12,7 +12,8 @@ public enum SchemaType {
     METADATA(Names.METADATA),
     PERSONALIZATION(Names.PERSONALIZATION),
     NOMENCLATURE(Names.NOMENCLATURE),
-    VARIABLE_TYPE(Names.VARIABLE_TYPE);
+    VARIABLE_TYPE(Names.VARIABLE_TYPE),
+    SURVEY_UNIT_TEMP_ZONE(Names.SURVEY_UNIT_TEMP_ZONE);
 
     public static class Names {
         public static final String CAMPAIGN_INTEGRATION = "schema.campaign-integration.json";
@@ -24,6 +25,7 @@ public static class Names {
         public static final String PERSONALIZATION = "schema.personalization.json";
         public static final String NOMENCLATURE = "schema.nomenclature.json";
         public static final String VARIABLE_TYPE = "schema.variable-type.json";
+        public static final String SURVEY_UNIT_TEMP_ZONE = "schema.survey-unit-temp-zone.json";
 
         private Names() {
 

queen-application/src/main/resources/static/v3/schema.metadata.json

@@ -2,7 +2,6 @@
   "$schema": "http://json-schema.org/draft/2020-12/schema",
   "$id": "https://insee.fr/schema.metadata.json",
   "type": "object",
-  "required": ["inseeContext"],
   "additionalProperties": true,
   "properties": {
     "inseeContext": {

queen-application/src/main/resources/static/v3/schema.survey-unit-temp-zone.json

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://insee.fr/schema.survey-unit-temp-zone.json",
+  "title": "Survey unit temp zone schema",
+  "description": "Validation of survey unit temp zone",
+  "type": "object",
+  "additionalProperties": false,
+  "required": ["data", "stateData", "questionnaireId"],
+  "properties": {
+    "data": {
+      "$ref": "schema.data.json#"
+    },
+    "comment": {
+      "type": "object"
+    },
+    "personalization": {
+      "$ref": "schema.personalization.json#"
+    },
+    "questionnaireId": {
+      "type": "string",
+      "minLength": 1
+    },
+    "stateData": {
+      "$ref": "#/$defs/stateData"
+    }
+  },
+  "$defs": {
+    "stateData": {
+      "type": "object",
+      "required": ["date", "state", "currentPage"],
+      "additionalProperties": false,
+      "properties": {
+        "date": {
+          "type": "number"
+        },
+        "state": {
+          "enum": ["INIT", "COMPLETED", "VALIDATED", "TOEXTRACT", "EXTRACTED"]
+        },
+        "currentPage": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    }
+  }
+}

queen-application/src/test/java/fr/insee/queen/application/surveyunit/integration/SurveyUnitsTempZoneTests.java

@@ -51,8 +51,13 @@ void on_create_survey_unit_then_survey_unit_created() throws Exception {
                     }
                   },
                   "comment": {"plip": "plop"},
-                  "personalization": [{},{}],
-                  "questionnaireId":"questionnaire-11"
+                  "personalization": [{"name": "name", "value": "value"}],
+                  "questionnaireId":"questionnaire-11",
+                  "stateData": {
+                    "state": "EXTRACTED",
+                    "date": 123456789,
+                    "currentPage": "2.3"
+                  }
                 }""";
         mockMvc.perform(post("/api/survey-unit/" + surveyUnitId + "/temp-zone")
                         .accept(MediaType.APPLICATION_JSON)

queen-application/src/test/java/fr/insee/queen/application/web/validation/json/JsonValidatorComponentTest.java

@@ -2,6 +2,7 @@
 
 import com.fasterxml.jackson.databind.JsonNode;
 import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.node.JsonNodeFactory;
 import com.networknt.schema.ValidationMessage;
 import com.networknt.schema.ValidatorTypeCode;
 import fr.insee.queen.application.utils.JsonTestHelper;
@@ -182,6 +183,102 @@ void testMetadata02() throws IOException {
         assertForbiddenProperty(error, "$.variables[2]", "forbidden-property");
     }
 
+    @Test
+    @DisplayName("when validating valid survey unit temp zone, no errors returned")
+    void testTempZone01() throws IOException {
+        String surveyUnitTempZoneJson = JsonTestHelper.getResourceFileAsString("json-schema-validation/surveyunittempzone/valid-tempzone.json");
+        JsonNode surveyUnitTempZoneNode = mapper.readValue(surveyUnitTempZoneJson, JsonNode.class);
+        Set<ValidationMessage> errors = validatorComponent.validate(SchemaType.SURVEY_UNIT_TEMP_ZONE, surveyUnitTempZoneNode);
+        assertThat(errors).isEmpty();
+    }
+
+    @Test
+    @DisplayName("when validating survey unit temp zone with missing attributes, return json schema errors")
+    void testTempZone02() {
+        Set<ValidationMessage> errors = validatorComponent.validate(SchemaType.SURVEY_UNIT_TEMP_ZONE, JsonNodeFactory.instance.objectNode());
+        assertThat(errors).hasSize(3);
+
+        ValidationMessage[] messages = errors.toArray(ValidationMessage[]::new);
+
+        ValidationMessage error = messages[0];
+        assertRequiredProperty(error, "$", "data");
+
+        error = messages[1];
+        assertRequiredProperty(error, "$", "stateData");
+
+        error = messages[2];
+        assertRequiredProperty(error, "$", "questionnaireId");
+    }
+
+    @Test
+    @DisplayName("when validating survey unit temp zone with missing stateData attributes, return json schema errors")
+    void testTempZone03() throws IOException {
+        String surveyUnitTempZoneJson = JsonTestHelper.getResourceFileAsString("json-schema-validation/surveyunittempzone/invalid-missing-statedata-attributes-tempzone.json");
+        JsonNode surveyUnitTempZoneNode = mapper.readValue(surveyUnitTempZoneJson, JsonNode.class);
+        Set<ValidationMessage> errors = validatorComponent.validate(SchemaType.SURVEY_UNIT_TEMP_ZONE, surveyUnitTempZoneNode);
+        assertThat(errors).hasSize(3);
+
+        ValidationMessage[] messages = errors.toArray(ValidationMessage[]::new);
+
+        ValidationMessage error = messages[0];
+        assertRequiredProperty(error, "$.stateData", "date");
+
+        error = messages[1];
+        assertRequiredProperty(error, "$.stateData", "state");
+
+        error = messages[2];
+        assertRequiredProperty(error, "$.stateData", "currentPage");
+    }
+
+    @Test
+    @DisplayName("when validating survey unit temp zone with incorrect types, return json schema errors")
+    void testTempZone04() throws IOException {
+        String surveyUnitTempZoneJson = JsonTestHelper.getResourceFileAsString("json-schema-validation/surveyunittempzone/invalid-types.json");
+        JsonNode surveyUnitTempZoneNode = mapper.readValue(surveyUnitTempZoneJson, JsonNode.class);
+        Set<ValidationMessage> errors = validatorComponent.validate(SchemaType.SURVEY_UNIT_TEMP_ZONE, surveyUnitTempZoneNode);
+        assertThat(errors).hasSize(7);
+
+        ValidationMessage[] messages = errors.toArray(ValidationMessage[]::new);
+
+        ValidationMessage error = messages[0];
+        assertBadType(error, "$.comment");
+
+        error = messages[1];
+        assertBadType(error, "$.questionnaireId");
+
+        error = messages[2];
+        assertBadType(error, "$.stateData.date");
+
+        error = messages[3];
+        assertBadEnum(error, "$.stateData.state");
+
+        error = messages[4];
+        assertBadType(error, "$.stateData.currentPage");
+
+        error = messages[5];
+        assertForbiddenProperty(error, "$.stateData", "forbidden-property");
+
+        error = messages[6];
+        assertForbiddenProperty(error, "$", "forbidden-property");
+    }
+
+    @Test
+    @DisplayName("when validating survey unit temp zone with incorrect attributes length, return json schema errors")
+    void testTempZone05() throws IOException {
+        String surveyUnitTempZoneJson = JsonTestHelper.getResourceFileAsString("json-schema-validation/surveyunittempzone/invalid-lengths.json");
+        JsonNode surveyUnitTempZoneNode = mapper.readValue(surveyUnitTempZoneJson, JsonNode.class);
+        Set<ValidationMessage> errors = validatorComponent.validate(SchemaType.SURVEY_UNIT_TEMP_ZONE, surveyUnitTempZoneNode);
+        assertThat(errors).hasSize(2);
+
+        ValidationMessage[] messages = errors.toArray(ValidationMessage[]::new);
+
+        ValidationMessage error = messages[0];
+        assertBadLength(error, "$.questionnaireId");
+
+        error = messages[1];
+        assertBadLength(error, "$.stateData.currentPage");
+    }
+
     private void assertBadPattern(ValidationMessage error, String instanceLocation) {
         assertThat(error.getInstanceLocation()).hasToString(instanceLocation);
         ValidatorTypeCode typeCode = ValidatorTypeCode.fromValue(error.getType());
@@ -207,4 +304,16 @@ private void assertRequiredProperty(ValidationMessage error, String instanceLoca
         ValidatorTypeCode typeCode = ValidatorTypeCode.fromValue(error.getType());
         assertThat(typeCode).isEqualTo(ValidatorTypeCode.REQUIRED);
     }
+
+    private void assertBadEnum(ValidationMessage error, String instanceLocation) {
+        assertThat(error.getInstanceLocation()).hasToString(instanceLocation);
+        ValidatorTypeCode typeCode = ValidatorTypeCode.fromValue(error.getType());
+        assertThat(typeCode).isEqualTo(ValidatorTypeCode.ENUM);
+    }
+
+    private void assertBadLength(ValidationMessage error, String instanceLocation) {
+        assertThat(error.getInstanceLocation()).hasToString(instanceLocation);
+        ValidatorTypeCode typeCode = ValidatorTypeCode.fromValue(error.getType());
+        assertThat(typeCode).isEqualTo(ValidatorTypeCode.MIN_LENGTH);
+    }
 }

queen-application/src/test/resources/data/json-schema-validation/metadata/invalid-metadata.json

@@ -12,5 +12,5 @@
       "forbidden-property": true
     }
   ],
-  "inseeContext":"forbidden-value"
+  "inseeContext": "forbidden-value"
 }

queen-application/src/test/resources/data/json-schema-validation/surveyunittempzone/invalid-lengths.json

@@ -0,0 +1,45 @@
+{
+  "data": {
+    "EXTERNAL": {
+      "BOOLEAN_VAR": false,
+      "NULL_VAR": null,
+      "STRING_VAR": "string",
+      "NUM_VAR": 1,
+      "ARRAY_BOOLEAN": [true, false],
+      "ARRAY_NULL": [null, null],
+      "ARRAY_STRING": ["string", "string"],
+      "ARRAY_NUM": [1, 2]
+    },
+    "CALCULATED": {
+      "BOOLEAN_VAR": false,
+      "NULL_VAR": null,
+      "STRING_VAR": "string",
+      "NUM_VAR": 1,
+      "ARRAY_BOOLEAN": [true, false],
+      "ARRAY_NULL": [null, null],
+      "ARRAY_STRING": ["string", "string"],
+      "ARRAY_NUM": [1, 2]
+    },
+    "COLLECTED": {
+      "VALUE": {
+        "EDITED": false,
+        "FORCED": null,
+        "INPUTED": "string",
+        "COLLECTED": 1
+      },
+      "ARRAY": {
+        "EDITED": [true, false],
+        "FORCED": [null, null],
+        "INPUTED": ["string", "string"],
+        "PREVIOUS": [1, 2],
+        "INPUTTED": "string"
+      }
+    }
+  },
+  "stateData": {
+    "state": "INIT",
+    "date": 123456789,
+    "currentPage": ""
+  },
+  "questionnaireId": ""
+}

queen-application/src/test/resources/data/json-schema-validation/surveyunittempzone/invalid-missing-statedata-attributes-tempzone.json

@@ -0,0 +1,45 @@
+{
+  "data": {
+    "EXTERNAL": {
+      "BOOLEAN_VAR": false,
+      "NULL_VAR": null,
+      "STRING_VAR": "string",
+      "NUM_VAR": 1,
+      "ARRAY_BOOLEAN": [true, false],
+      "ARRAY_NULL": [null, null],
+      "ARRAY_STRING": ["string", "string"],
+      "ARRAY_NUM": [1, 2]
+    },
+    "CALCULATED": {
+      "BOOLEAN_VAR": false,
+      "NULL_VAR": null,
+      "STRING_VAR": "string",
+      "NUM_VAR": 1,
+      "ARRAY_BOOLEAN": [true, false],
+      "ARRAY_NULL": [null, null],
+      "ARRAY_STRING": ["string", "string"],
+      "ARRAY_NUM": [1, 2]
+    },
+    "COLLECTED": {
+      "VALUE": {
+        "EDITED": false,
+        "FORCED": null,
+        "INPUTED": "string",
+        "COLLECTED": 1
+      },
+      "ARRAY": {
+        "EDITED": [true, false],
+        "FORCED": [null, null],
+        "INPUTED": ["string", "string"],
+        "PREVIOUS": [1, 2],
+        "INPUTTED": "string"
+      }
+    }
+  },
+  "comment": {
+    "commentaire": "hello"
+  },
+  "stateData": {
+  },
+  "questionnaireId": "QUESTIONNAIRE-1"
+}