feat(#1175): improve random data generation for test data generator

citrusframework · Jul 5, 2024 · 8ef6181 · 8ef6181
1 parent 1ce0f75
commit 8ef6181
Show file tree

Hide file tree

Showing 51 changed files with 3,885 additions and 839 deletions.
diff --git a/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiConstants.java b/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiConstants.java
@@ -0,0 +1,41 @@
+/*
+ * Copyright the original author or 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 org.citrusframework.openapi;
+
+public abstract class OpenApiConstants {
+
+    public static final String TYPE_ARRAY = "array";
+    public static final String TYPE_BOOLEAN = "boolean";
+    public static final String TYPE_INTEGER = "integer";
+    public static final String TYPE_NUMBER = "number";
+    public static final String TYPE_OBJECT = "object";
+    public static final String TYPE_STRING = "string";
+
+    public static final String FORMAT_INT32 = "int32";
+    public static final String FORMAT_INT64 = "int64";
+    public static final String FORMAT_FLOAT = "float";
+    public static final String FORMAT_DOUBLE = "double";
+    public static final String FORMAT_DATE = "date";
+    public static final String FORMAT_DATE_TIME = "date-time";
+    public static final String FORMAT_UUID = "uuid";
+
+    /**
+     * Prevent instantiation.
+     */
+    private OpenApiConstants() {
+    }
+}
diff --git a/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiRepository.java b/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiRepository.java
@@ -94,8 +94,8 @@ public void setResponseValidationEnabled(boolean responseValidationEnabled) {
     public void addRepository(Resource openApiResource) {
         OpenApiSpecification openApiSpecification = OpenApiSpecification.from(openApiResource);
         determineResourceAlias(openApiResource).ifPresent(openApiSpecification::addAlias);
-        openApiSpecification.setRequestValidationEnabled(requestValidationEnabled);
-        openApiSpecification.setResponseValidationEnabled(responseValidationEnabled);
+        openApiSpecification.setApiRequestValidationEnabled(requestValidationEnabled);
+        openApiSpecification.setApiResponseValidationEnabled(responseValidationEnabled);
         openApiSpecification.setRootContextPath(rootContextPath);
 
         this.openApiSpecifications.add(openApiSpecification);

diff --git a/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiSettings.java b/connectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiSettings.java
@@ -1,3 +1,19 @@
+/*
+ * Copyright the original author or 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 org.citrusframework.openapi;
 
 import static java.lang.Boolean.parseBoolean;
@@ -35,7 +51,7 @@ public static boolean isValidateOptionalFieldsGlobally() {
             System.getenv(VALIDATE_OPTIONAL_FIELDS_ENV) : "true"));
     }
 
-    public static boolean isRequestValidationEnabledlobally() {
+    public static boolean isRequestValidationEnabledGlobally() {
         return parseBoolean(System.getProperty(
             REQUEST_VALIDATION_ENABLED_PROPERTY, System.getenv(REQUEST_VALIDATION_ENABLED_ENV) != null ?
             System.getenv(REQUEST_VALIDATION_ENABLED_ENV) : "true"));

diff --git a/...ectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiSpecification.java b/...ectors/citrus-openapi/src/main/java/org/citrusframework/openapi/OpenApiSpecification.java
@@ -16,24 +16,14 @@
 
 package org.citrusframework.openapi;
 
-import com.atlassian.oai.validator.OpenApiInteractionValidator;
-import com.atlassian.oai.validator.OpenApiInteractionValidator.Builder;
+import static org.citrusframework.openapi.OpenApiSettings.isGenerateOptionalFieldsGlobally;
+import static org.citrusframework.openapi.OpenApiSettings.isRequestValidationEnabledGlobally;
+import static org.citrusframework.openapi.OpenApiSettings.isResponseValidationEnabledGlobally;
+import static org.citrusframework.openapi.OpenApiSettings.isValidateOptionalFieldsGlobally;
+
 import io.apicurio.datamodels.core.models.common.Info;
 import io.apicurio.datamodels.openapi.models.OasDocument;
 import io.apicurio.datamodels.openapi.models.OasOperation;
-import org.citrusframework.context.TestContext;
-import org.citrusframework.exceptions.CitrusRuntimeException;
-import org.citrusframework.http.client.HttpClient;
-import org.citrusframework.openapi.model.OasModelHelper;
-import org.citrusframework.openapi.model.OperationPathAdapter;
-import org.citrusframework.openapi.validation.OpenApiRequestValidator;
-import org.citrusframework.openapi.validation.OpenApiResponseValidator;
-import org.citrusframework.spi.Resource;
-import org.citrusframework.spi.Resources;
-import org.citrusframework.util.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
 import java.net.MalformedURLException;
 import java.net.URI;
 import java.net.URL;
@@ -45,11 +35,19 @@
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.function.Supplier;
-
-import static org.citrusframework.openapi.OpenApiSettings.isGenerateOptionalFieldsGlobally;
-import static org.citrusframework.openapi.OpenApiSettings.isRequestValidationEnabledlobally;
-import static org.citrusframework.openapi.OpenApiSettings.isResponseValidationEnabledGlobally;
-import static org.citrusframework.openapi.OpenApiSettings.isValidateOptionalFieldsGlobally;
+import org.citrusframework.context.TestContext;
+import org.citrusframework.exceptions.CitrusRuntimeException;
+import org.citrusframework.http.client.HttpClient;
+import org.citrusframework.openapi.model.OasModelHelper;
+import org.citrusframework.openapi.model.OperationPathAdapter;
+import org.citrusframework.openapi.util.OpenApiUtils;
+import org.citrusframework.openapi.validation.SwaggerOpenApiValidationContext;
+import org.citrusframework.openapi.validation.SwaggerOpenApiValidationContextLoader;
+import org.citrusframework.spi.Resource;
+import org.citrusframework.spi.Resources;
+import org.citrusframework.util.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 /**
  * OpenApi specification resolves URL or local file resources to a specification document.
@@ -97,33 +95,41 @@ public class OpenApiSpecification {
 
     private OasDocument openApiDoc;
 
+    private SwaggerOpenApiValidationContext swaggerOpenApiValidationContext;
+
     private boolean generateOptionalFields = isGenerateOptionalFieldsGlobally();
 
     private boolean validateOptionalFields = isValidateOptionalFieldsGlobally();
 
-    private boolean requestValidationEnabled = isRequestValidationEnabledlobally();
+    /**
+     * Flag to indicate, whether request validation is enabled on api level. Api level overrules global
+     * level and may be overruled by request level.
+     */
+    private boolean apiRequestValidationEnabled = isRequestValidationEnabledGlobally();
 
-    private boolean responseValidationEnabled = isResponseValidationEnabledGlobally();
+    /**
+     * Flag to indicate, whether response validation is enabled on api level. Api level overrules global
+     * level and may be overruled by request level.
+     */
+    private boolean apiResponseValidationEnabled = isResponseValidationEnabledGlobally();
 
     private final Set<String> aliases = Collections.synchronizedSet(new HashSet<>());
 
     /**
-     * Maps the identifier (id) of an operation to OperationPathAdapters. Two different keys may be used for each operation.
-     * Refer to {@link org.citrusframework.openapi.OpenApiSpecification#storeOperationPathAdapter} for more details.
+     * Maps the identifier (id) of an operation to OperationPathAdapters. Two different keys may be
+     * used for each operation. Refer to
+     * {@link org.citrusframework.openapi.OpenApiSpecification#storeOperationPathAdapter} for more
+     * details.
      */
     private final Map<String, OperationPathAdapter> operationIdToOperationPathAdapter = new ConcurrentHashMap<>();
 
     /**
-     * Stores the unique identifier (uniqueId) of an operation, derived from its HTTP method and path.
-     * This identifier can always be determined and is therefore safe to use, even for operations without
-     * an optional operationId defined.
+     * Stores the unique identifier (uniqueId) of an operation, derived from its HTTP method and
+     * path. This identifier can always be determined and is therefore safe to use, even for
+     * operations without an optional operationId defined.
      */
     private final Map<OasOperation, String> operationToUniqueId = new ConcurrentHashMap<>();
 
-    private OpenApiRequestValidator openApiRequestValidator;
-
-    private OpenApiResponseValidator openApiResponseValidator;
-
     public static OpenApiSpecification from(String specUrl) {
         OpenApiSpecification specification = new OpenApiSpecification();
         specification.setSpecUrl(specUrl);
@@ -134,21 +140,19 @@ public static OpenApiSpecification from(String specUrl) {
     public static OpenApiSpecification from(URL specUrl) {
         OpenApiSpecification specification = new OpenApiSpecification();
         OasDocument openApiDoc;
-        OpenApiInteractionValidator validator;
+        SwaggerOpenApiValidationContext swaggerOpenApiValidationContext;
         if (specUrl.getProtocol().startsWith(HTTPS)) {
             openApiDoc = OpenApiResourceLoader.fromSecuredWebResource(specUrl);
-            validator = new OpenApiInteractionValidator.Builder().withInlineApiSpecification(
-                OpenApiResourceLoader.rawFromSecuredWebResource(specUrl)).build();
+            swaggerOpenApiValidationContext  = SwaggerOpenApiValidationContextLoader.fromSecuredWebResource(specUrl);
         } else {
             openApiDoc = OpenApiResourceLoader.fromWebResource(specUrl);
-            validator = new OpenApiInteractionValidator.Builder().withInlineApiSpecification(
-                OpenApiResourceLoader.rawFromWebResource(specUrl)).build();
+            swaggerOpenApiValidationContext  = SwaggerOpenApiValidationContextLoader.fromWebResource(specUrl);
         }
 
         specification.setSpecUrl(specUrl.toString());
         specification.initPathLookups();
         specification.setOpenApiDoc(openApiDoc);
-        specification.setValidator(validator);
+        specification.setSwaggerOpenApiValidationContext(swaggerOpenApiValidationContext);
         specification.setRequestUrl(
             String.format("%s://%s%s%s", specUrl.getProtocol(), specUrl.getHost(),
                 specUrl.getPort() > 0 ? ":" + specUrl.getPort() : "",
@@ -160,11 +164,9 @@ public static OpenApiSpecification from(URL specUrl) {
     public static OpenApiSpecification from(Resource resource) {
         OpenApiSpecification specification = new OpenApiSpecification();
         OasDocument openApiDoc = OpenApiResourceLoader.fromFile(resource);
-        OpenApiInteractionValidator validator = new Builder().withInlineApiSpecification(
-            OpenApiResourceLoader.rawFromFile(resource)).build();
 
         specification.setOpenApiDoc(openApiDoc);
-        specification.setValidator(validator);
+        specification.setSwaggerOpenApiValidationContext(SwaggerOpenApiValidationContextLoader.fromFile(resource));
 
         String schemeToUse = Optional.ofNullable(OasModelHelper.getSchemes(openApiDoc))
             .orElse(Collections.singletonList(HTTP))
@@ -215,12 +217,11 @@ public synchronized OasDocument getOpenApiDoc(TestContext context) {
                 if (resolvedSpecUrl.startsWith(HTTPS)) {
                     initApiDoc(
                         () -> OpenApiResourceLoader.fromSecuredWebResource(specWebResource));
-                    setValidator(new OpenApiInteractionValidator.Builder().withInlineApiSpecification(
-                        OpenApiResourceLoader.rawFromSecuredWebResource(specWebResource)).build());
+
+                    setSwaggerOpenApiValidationContext(SwaggerOpenApiValidationContextLoader.fromSecuredWebResource(specWebResource));
                 } else {
                     initApiDoc(() -> OpenApiResourceLoader.fromWebResource(specWebResource));
-                    setValidator(new OpenApiInteractionValidator.Builder().withInlineApiSpecification(
-                        OpenApiResourceLoader.rawFromWebResource(specWebResource)).build());
+                    setSwaggerOpenApiValidationContext(SwaggerOpenApiValidationContextLoader.fromWebResource(specWebResource));
                 }
 
                 if (requestUrl == null) {
@@ -234,8 +235,7 @@ public synchronized OasDocument getOpenApiDoc(TestContext context) {
                 Resource resource = Resources.create(resolvedSpecUrl);
                 initApiDoc(
                     () -> OpenApiResourceLoader.fromFile(resource));
-                setValidator(new OpenApiInteractionValidator.Builder().withInlineApiSpecification(
-                    OpenApiResourceLoader.rawFromFile(resource)).build());
+                setSwaggerOpenApiValidationContext(SwaggerOpenApiValidationContextLoader.fromFile(resource));
 
                 if (requestUrl == null) {
                     String schemeToUse = Optional.ofNullable(OasModelHelper.getSchemes(openApiDoc))
@@ -255,6 +255,11 @@ public synchronized OasDocument getOpenApiDoc(TestContext context) {
         return openApiDoc;
     }
 
+    public SwaggerOpenApiValidationContext getSwaggerOpenApiValidationContext() {
+        return swaggerOpenApiValidationContext;
+    }
+
+
     // provided for testing
     URL toSpecUrl(String resolvedSpecUrl) {
         try {
@@ -269,12 +274,10 @@ void setOpenApiDoc(OasDocument openApiDoc) {
         initApiDoc(() -> openApiDoc);
     }
 
-    private void setValidator(OpenApiInteractionValidator openApiInteractionValidator) {
-        openApiRequestValidator = new OpenApiRequestValidator(openApiInteractionValidator);
-        openApiRequestValidator.setEnabled(requestValidationEnabled);
-
-        openApiResponseValidator = new OpenApiResponseValidator(openApiInteractionValidator);
-        openApiRequestValidator.setEnabled(responseValidationEnabled);
+    private void setSwaggerOpenApiValidationContext(SwaggerOpenApiValidationContext swaggerOpenApiValidationContext) {
+        this.swaggerOpenApiValidationContext = swaggerOpenApiValidationContext;
+        this.swaggerOpenApiValidationContext.setResponseValidationEnabled(apiResponseValidationEnabled);
+        this.swaggerOpenApiValidationContext.setRequestValidationEnabled(apiRequestValidationEnabled);
     }
 
     private void initApiDoc(Supplier<OasDocument> openApiDocSupplier) {
@@ -306,22 +309,25 @@ private void initPathLookups() {
     }
 
     /**
-     * Stores an {@link OperationPathAdapter} in {@link org.citrusframework.openapi.OpenApiSpecification#operationIdToOperationPathAdapter}.
-     * The adapter is stored using two keys: the operationId (optional) and the full path of the operation, including the method.
-     * The full path is always determinable and thus can always be safely used.
+     * Stores an {@link OperationPathAdapter} in
+     * {@link org.citrusframework.openapi.OpenApiSpecification#operationIdToOperationPathAdapter}.
+     * The adapter is stored using two keys: the operationId (optional) and the full path of the
+     * operation, including the method. The full path is always determinable and thus can always be
+     * safely used.
      *
      * @param operation The {@link OperationPathAdapter} to store.
-     * @param path The full path of the operation, including the method.
+     * @param path      The full path of the operation, including the method.
      */
     private void storeOperationPathAdapter(OasOperation operation, String path) {
 
         String basePath = OasModelHelper.getBasePath(openApiDoc);
         String fullOperationPath = StringUtils.appendSegmentToUrlPath(basePath, path);
 
         OperationPathAdapter operationPathAdapter = new OperationPathAdapter(path, rootContextPath,
-            StringUtils.appendSegmentToUrlPath(rootContextPath, path),  operation);
+            StringUtils.appendSegmentToUrlPath(rootContextPath, path), operation);
 
-        String uniqueOperationId = OpenApiUtils.createFullPathOperationIdentifier(fullOperationPath, operation);
+        String uniqueOperationId = OpenApiUtils.createFullPathOperationIdentifier(fullOperationPath,
+            operation);
         operationToUniqueId.put(operation, uniqueOperationId);
 
         operationIdToOperationPathAdapter.put(uniqueOperationId, operationPathAdapter);
@@ -358,25 +364,25 @@ public void setRequestUrl(String requestUrl) {
         this.requestUrl = requestUrl;
     }
 
-    public boolean isRequestValidationEnabled() {
-        return requestValidationEnabled;
+    public boolean isApiRequestValidationEnabled() {
+        return apiRequestValidationEnabled;
     }
 
-    public void setRequestValidationEnabled(boolean enabled) {
-        this.requestValidationEnabled = enabled;
-        if (this.openApiRequestValidator != null) {
-            this.openApiRequestValidator.setEnabled(enabled);
+    public void setApiRequestValidationEnabled(boolean enabled) {
+        this.apiRequestValidationEnabled = enabled;
+        if (this.swaggerOpenApiValidationContext != null) {
+            this.swaggerOpenApiValidationContext.setRequestValidationEnabled(enabled);
         }
     }
 
-    public boolean isResponseValidationEnabled() {
-        return responseValidationEnabled;
+    public boolean isApiResponseValidationEnabled() {
+        return apiResponseValidationEnabled;
     }
 
-    public void setResponseValidationEnabled(boolean enabled) {
-        this.responseValidationEnabled = enabled;
-        if (this.openApiResponseValidator != null) {
-            this.openApiResponseValidator.setEnabled(enabled);
+    public void setApiResponseValidationEnabled(boolean enabled) {
+        this.apiResponseValidationEnabled = enabled;
+        if (this.swaggerOpenApiValidationContext != null) {
+            this.swaggerOpenApiValidationContext.setResponseValidationEnabled(enabled);
         }
     }
 
@@ -449,14 +455,6 @@ public Optional<OperationPathAdapter> getOperation(String operationId, TestConte
         return Optional.ofNullable(operationIdToOperationPathAdapter.get(operationId));
     }
 
-    public Optional<OpenApiRequestValidator> getRequestValidator() {
-        return Optional.ofNullable(openApiRequestValidator);
-    }
-
-    public Optional<OpenApiResponseValidator> getResponseValidator() {
-        return Optional.ofNullable(openApiResponseValidator);
-    }
-
     public OpenApiSpecification withRootContext(String rootContextPath) {
         setRootContextPath(rootContextPath);
         return this;