validate deploy variable value schema validation

modules/api/src/main/java/org/eclipse/xpanse/api/exceptions/handler/RegistrationExceptionHandler.java

@@ -10,6 +10,7 @@
 import org.eclipse.xpanse.modules.models.response.Response;
 import org.eclipse.xpanse.modules.models.response.ResultType;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.IconProcessingFailedException;
+import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.InvalidValueSchemaException;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateAlreadyRegistered;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateNotRegistered;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateUpdateNotAllowed;
@@ -81,7 +82,7 @@ public Response handleTerraformScriptFormatInvalidException(
     }
 
     /**
-     * Exception handler for handleServiceUpdateNotAllowed.
+     * Exception handler for ServiceTemplateUpdateNotAllowed.
      */
     @ExceptionHandler({ServiceTemplateUpdateNotAllowed.class})
     @ResponseStatus(HttpStatus.BAD_REQUEST)
@@ -91,4 +92,16 @@ public Response handleServiceTemplateUpdateNotAllowed(
         return Response.errorResponse(ResultType.SERVICE_TEMPLATE_UPDATE_NOT_ALLOWED,
                 Collections.singletonList(ex.getMessage()));
     }
+
+    /**
+     * Exception handler for ServiceTemplateUpdateNotAllowed.
+     */
+    @ExceptionHandler({InvalidValueSchemaException.class})
+    @ResponseStatus(HttpStatus.BAD_REQUEST)
+    @ResponseBody
+    public Response handleInvalidValueSchemaException(
+            InvalidValueSchemaException ex) {
+        return Response.errorResponse(ResultType.VARIABLE_SCHEMA_DEFINITION_INVALID,
+                ex.getInvalidValueSchemaKeys());
+    }
 }

modules/api/src/test/java/org/eclipse/xpanse/api/exceptions/handler/RegistrationExceptionHandlerTest.java

@@ -14,6 +14,7 @@
 import java.util.List;
 import org.eclipse.xpanse.api.controllers.ServiceTemplateApi;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.IconProcessingFailedException;
+import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.InvalidValueSchemaException;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateAlreadyRegistered;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateNotRegistered;
 import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.ServiceTemplateUpdateNotAllowed;
@@ -105,4 +106,15 @@ void testServiceTemplateUpdateNotAllowed() throws Exception {
                 .andExpect(jsonPath("$.resultType").value("Service Template Update Not Allowed"))
                 .andExpect(jsonPath("$.details[0]").value("test error"));
     }
+
+    @Test
+    void testInvalidValueSchemaException() throws Exception {
+        when(serviceTemplateManage.listServiceTemplates(any(ServiceTemplateQueryModel.class)))
+                .thenThrow(new InvalidValueSchemaException(List.of("test error")));
+
+        this.mockMvc.perform(get("/xpanse/service_templates"))
+                .andExpect(status().is(400))
+                .andExpect(jsonPath("$.resultType").value("Variable Schema Definition Invalid"))
+                .andExpect(jsonPath("$.details[0]").value("test error"));
+    }
 }

modules/models/src/main/java/org/eclipse/xpanse/modules/models/response/ResultType.java

@@ -47,7 +47,8 @@ public enum ResultType {
     UNSUPPORTED_ENUM_VALUE("Unsupported Enum Value"),
     TERRAFORM_BOOT_REQUEST_FAILED("Terraform Boot Request Failed"),
     METRICS_DATA_NOT_READY("Metrics Data Not Ready"),
-    VARIABLE_VALIDATION_FAILED("Variable Validation Failed");
+    VARIABLE_VALIDATION_FAILED("Variable Validation Failed"),
+    VARIABLE_SCHEMA_DEFINITION_INVALID("Variable Schema Definition Invalid");
 
     private final String value;
 

modules/models/src/main/java/org/eclipse/xpanse/modules/models/service/utils/ServiceVariablesJsonSchemaGenerator.java

@@ -6,14 +6,17 @@
 
 package org.eclipse.xpanse.modules.models.service.utils;
 
+import com.networknt.schema.JsonMetaSchema;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Objects;
+import java.util.Set;
 import lombok.extern.slf4j.Slf4j;
 import org.eclipse.xpanse.modules.models.servicetemplate.DeployVariable;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.DeployVariableKind;
+import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.InvalidValueSchemaException;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.JsonObjectSchema;
 import org.springframework.stereotype.Component;
 import org.springframework.util.CollectionUtils;
@@ -27,7 +30,7 @@ public class ServiceVariablesJsonSchemaGenerator {
 
     private static final String VARIABLE_TYPE_KEY = "type";
     private static final String VARIABLE_DESCRIPTION_KEY = "description";
-    private static final String VARIABLE_EXAMPLE_KEY = "example";
+    private static final String VARIABLE_EXAMPLE_KEY = "examples";
 
     /**
      * Generate JsonSchema objects to describe validation rules and metadata information for a set
@@ -50,9 +53,7 @@ public JsonObjectSchema buildJsonObjectSchema(List<DeployVariable> deployVariabl
                 }
 
                 if (!CollectionUtils.isEmpty(variable.getValueSchema())) {
-                    variable.getValueSchema().forEach((validator, value) ->
-                            validationProperties.put(validator.toValue(), value)
-                    );
+                    validationProperties.putAll(variable.getValueSchema());
                 }
 
                 if (Objects.nonNull(variable.getDataType())) {
@@ -75,7 +76,24 @@ public JsonObjectSchema buildJsonObjectSchema(List<DeployVariable> deployVariabl
 
         jsonObjectSchema.setRequired(requiredList);
         jsonObjectSchema.setProperties(jsonObjectSchemaProperties);
+        validateSchemaDefinition(jsonObjectSchema);
         return jsonObjectSchema;
     }
 
+    private void validateSchemaDefinition(JsonObjectSchema jsonObjectSchema) {
+        Set<String> allowedKeys = JsonMetaSchema.getV202012().getKeywords().keySet();
+        List<String> invalidKeys = new ArrayList<>();
+        jsonObjectSchema.getProperties().forEach((deployVariable, variableValueSchema) ->
+                variableValueSchema.forEach((schemaDefKey, schemaDefValue) -> {
+                    if (!allowedKeys.contains(schemaDefKey)) {
+                        invalidKeys.add(String.format(
+                                "Value schema key %s in deploy variable  %s is invalid",
+                                schemaDefKey, deployVariable));
+                    }
+                }));
+        if (!invalidKeys.isEmpty()) {
+            throw new InvalidValueSchemaException(invalidKeys);
+        }
+    }
+
 }

modules/models/src/main/java/org/eclipse/xpanse/modules/models/servicetemplate/DeployVariable.java

@@ -12,7 +12,6 @@
 import java.io.Serializable;
 import java.util.Map;
 import lombok.Data;
-import org.eclipse.xpanse.modules.models.service.deploy.enums.VariableValidator;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.DeployVariableDataType;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.DeployVariableKind;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.SensitiveScope;
@@ -55,8 +54,10 @@ public class DeployVariable implements Serializable {
     @Schema(description = "Indicates if the variable is mandatory")
     private Boolean mandatory;
 
-    @Schema(description = "valueSchema of the variable")
-    private Map<VariableValidator, Object> valueSchema;
+    @Schema(description = "valueSchema of the variable. "
+            + "The key be any keyword that is part of the JSON schema definition which can be "
+            + "found here https://json-schema.org/draft/2020-12/schema")
+    private Map<String, Object> valueSchema;
 
     @Schema(description = "Sensitive scope of variable storage")
     private SensitiveScope sensitiveScope = SensitiveScope.NONE;

modules/models/src/main/java/org/eclipse/xpanse/modules/models/servicetemplate/exceptions/InvalidValueSchemaException.java

@@ -0,0 +1,24 @@
+/*
+ * SPDX-License-Identifier: Apache-2.0
+ * SPDX-FileCopyrightText: Huawei Inc.
+ */
+
+package org.eclipse.xpanse.modules.models.servicetemplate.exceptions;
+
+import java.util.List;
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+
+/**
+ * Exception thrown when a deployment variable schema definition is invalid.
+ */
+@EqualsAndHashCode(callSuper = true)
+@Data
+public class InvalidValueSchemaException extends RuntimeException {
+
+    private final List<String> invalidValueSchemaKeys;
+
+    public InvalidValueSchemaException(List<String> invalidValueSchemaKeys) {
+        this.invalidValueSchemaKeys = invalidValueSchemaKeys;
+    }
+}

modules/models/src/main/java/org/eclipse/xpanse/modules/models/servicetemplate/exceptions/TerraformScriptFormatInvalidException.java

@@ -10,7 +10,7 @@
 import lombok.EqualsAndHashCode;
 
 /**
- * Exception thrown when Terraform script is invalid.
+ * Exception thrown when a Terraform script is invalid.
  */
 @EqualsAndHashCode(callSuper = true)
 @Data

modules/models/src/test/java/org/eclipse/xpanse/modules/models/service/utils/ServiceVariablesJsonSchemaGeneratorAndValidatorTest.java

@@ -16,6 +16,7 @@
 import org.eclipse.xpanse.modules.models.service.deploy.exceptions.VariableInvalidException;
 import org.eclipse.xpanse.modules.models.servicetemplate.DeployVariable;
 import org.eclipse.xpanse.modules.models.servicetemplate.Ocl;
+import org.eclipse.xpanse.modules.models.servicetemplate.exceptions.InvalidValueSchemaException;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.JsonObjectSchema;
 import org.eclipse.xpanse.modules.models.servicetemplate.utils.OclLoader;
 import org.junit.jupiter.api.BeforeEach;
@@ -31,7 +32,7 @@
 @ExtendWith(SpringExtension.class)
 @ContextConfiguration(classes = {ServiceVariablesJsonSchemaGenerator.class,
         ServiceVariablesJsonSchemaValidator.class})
-public class ServiceVariablesJsonSchemaGeneratorAndValidatorTest {
+class ServiceVariablesJsonSchemaGeneratorAndValidatorTest {
 
     @Autowired
     ServiceVariablesJsonSchemaGenerator serviceVariablesJsonSchemaGenerator;
@@ -146,4 +147,12 @@ void validateWithDataType_test() {
         }
     }
 
+    @Test
+    void throwExceptionWhenValueSchemaIsInvalid() {
+        variables.get(0).getValueSchema().put("enums", List.of(1, 2, 3));
+        assertThrows(InvalidValueSchemaException.class, () -> {
+            serviceVariablesJsonSchemaGenerator.buildJsonObjectSchema(variables);
+        });
+    }
+
 }

modules/models/src/test/java/org/eclipse/xpanse/modules/models/servicetemplate/DeployVariableTest.java

@@ -10,7 +10,6 @@
 import static org.junit.jupiter.api.Assertions.assertNotEquals;
 
 import java.util.Map;
-import org.eclipse.xpanse.modules.models.service.deploy.enums.VariableValidator;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.DeployVariableDataType;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.DeployVariableKind;
 import org.eclipse.xpanse.modules.models.servicetemplate.enums.SensitiveScope;
@@ -29,7 +28,7 @@ class DeployVariableTest {
     private static final String description = "description";
     private static final String value = "value";
     private static final Boolean mandatory = true;
-    private static final Map<VariableValidator,Object> validatorMap  = Map.of(VariableValidator.MINLENGTH,"10");
+    private static final Map<String,Object> validatorMap  = Map.of("minLength","10");
     private static final SensitiveScope sensitiveScope = SensitiveScope.ONCE;
     private static DeployVariable deployVariable;
 

modules/servicetemplate/src/main/java/org/eclipse/xpanse/modules/servicetemplate/ServiceTemplateManage.java

@@ -169,15 +169,15 @@ public ServiceTemplateEntity registerServiceTemplate(Ocl ocl) {
             log.error(errorMsg);
             throw new ServiceTemplateAlreadyRegistered(errorMsg);
         }
+        JsonObjectSchema jsonObjectSchema =
+                serviceVariablesJsonSchemaGenerator.buildJsonObjectSchema(
+                        newEntity.getOcl().getDeployment().getVariables());
         validateTerraformScript(ocl);
         if (StringUtils.isNotBlank(getUserNamespace())) {
             newEntity.setNamespace(getUserNamespace());
         } else {
             newEntity.setNamespace(ocl.getNamespace());
         }
-        JsonObjectSchema jsonObjectSchema =
-                serviceVariablesJsonSchemaGenerator.buildJsonObjectSchema(
-                        newEntity.getOcl().getDeployment().getVariables());
         newEntity.setJsonObjectSchema(jsonObjectSchema);
         storage.store(newEntity);
         serviceTemplateOpenApiGenerator.generateServiceApi(newEntity);