[CONTINT-685] - initial tests for validation of OpenApi request

.secrets.baseline

@@ -296,5 +296,5 @@
       }
     ]
   },
-  "generated_at": "2024-10-07T15:02:23Z"
+  "generated_at": "2024-12-09T11:44:50Z"
 }

common-test/src/main/java/org/alfresco/hxi_connector/common/test/docker/util/DockerTags.java

@@ -50,7 +50,7 @@ public class DockerTags
     private static final String TRANSFORM_ROUTER_TAG_DEFAULT = "4.0.1";
     private static final String TRANSFORM_CORE_AIO_TAG_DEFAULT = "5.0.1";
     private static final String SFS_TAG_DEFAULT = "4.0.1";
-    private static final String HXI_CONNECTOR_TAG_DEFAULT = "1.0.0-SNAPSHOT";
+    private static final String HXI_CONNECTOR_TAG_DEFAULT = "1.0.2-SNAPSHOT";
     private static final String PROPERTIES_FILE = "docker-tags.properties";
 
     private static Properties properties;

live-ingester/pom.xml

@@ -130,6 +130,11 @@
             <artifactId>lombok</artifactId>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>com.atlassian.oai</groupId>
+            <artifactId>swagger-request-validator-core</artifactId>
+            <version>2.44.1</version>
+        </dependency>
     </dependencies>
 
     <build>

live-ingester/src/integration-test/java/org/alfresco/hxi_connector/live_ingester/domain/usecase/e2e/repository/CreateRequestIntegrationTest.java

@@ -30,6 +30,8 @@
 import org.junit.jupiter.api.Test;
 
 import org.alfresco.hxi_connector.live_ingester.util.E2ETestBase;
+import org.alfresco.hxi_connector.live_ingester.util.insight_api.HxInsightRequest;
+import org.alfresco.hxi_connector.live_ingester.util.insight_api.RequestLoader;
 
 public class CreateRequestIntegrationTest extends E2ETestBase
 {
@@ -87,41 +89,8 @@ void testCreateRequest()
         containerSupport.raiseRepoEvent(repoEvent);
 
         // then
-        String expectedBody = """
-                [
-                  {
-                    "objectId": "d71dd823-82c7-477c-8490-04cb0e826e65",
-                    "sourceId" : "alfresco-dummy-source-id-0a63de491876",
-                    "eventType": "create",
-                    "sourceTimestamp": 1611227656423,
-                    "properties": {
-                      "cm:autoVersion": {"value": true},
-                      "createdAt": {"value": 1611227655695},
-                      "modifiedAt": {"value" : 1611227655695},
-                      "cm:versionType": {"value": "MAJOR"},
-                      "aspectsNames": {"value": ["cm:versionable", "cm:auditable"]},
-                      "cm:name": {
-                        "value": "purchase-order-scan.doc",
-                        "annotation" : "name"
-                      },
-                      "type": {"value": "cm:content"},
-                      "createdBy": {"value": "admin"},
-                      "modifiedBy": {"value": "admin"},
-                      "cm:content": {
-                        "file": {
-                          "content-metadata": {
-                            "size": 531152,
-                            "name": "purchase-order-scan.doc",
-                            "content-type": "application/msword"
-                          }
-                        }
-                      },
-                      "ALLOW_ACCESS": {"value": ["GROUP_EVERYONE"]},
-                      "DENY_ACCESS": {"value": []}
-                    }
-                  }
-                ]""";
-        containerSupport.expectHxIngestMessageReceived(expectedBody);
+        HxInsightRequest request = RequestLoader.load("/expected-hxinsight-requests/create-document-request.yml");
+        containerSupport.expectHxIngestMessageReceived(request.body());
 
         String expectedATSRequest = """
                 {

live-ingester/src/integration-test/java/org/alfresco/hxi_connector/live_ingester/domain/usecase/e2e/repository/OpenApiRequestValidationTest.java

@@ -0,0 +1,149 @@
+/*
+ * #%L
+ * Alfresco HX Insight Connector
+ * %%
+ * Copyright (C) 2023 - 2024 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.hxi_connector.live_ingester.domain.usecase.e2e.repository;
+
+import static com.atlassian.oai.validator.schema.SchemaValidator.ADDITIONAL_PROPERTIES_KEY;
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.util.List;
+
+import com.atlassian.oai.validator.OpenApiInteractionValidator;
+import com.atlassian.oai.validator.model.Request;
+import com.atlassian.oai.validator.model.SimpleRequest;
+import com.atlassian.oai.validator.report.LevelResolver;
+import com.atlassian.oai.validator.report.MessageResolver;
+import com.atlassian.oai.validator.report.ValidationReport;
+import com.atlassian.oai.validator.schema.SchemaValidator;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import io.swagger.parser.OpenAPIParser;
+import io.swagger.v3.oas.models.media.Schema;
+import io.swagger.v3.parser.core.models.ParseOptions;
+import org.junit.jupiter.api.BeforeAll;
+import org.junit.jupiter.api.Test;
+
+import org.alfresco.hxi_connector.live_ingester.util.insight_api.HxInsightRequest;
+import org.alfresco.hxi_connector.live_ingester.util.insight_api.RequestLoader;
+
+public class OpenApiRequestValidationTest
+{
+
+    private static final String OPEN_API_SPECIFICATION_URL = "http://hxai-data-platform-dev-swagger-ui.s3-website-us-east-1.amazonaws.com/docs/insight-ingestion-api-swagger.json";
+    private static OpenApiInteractionValidator classUnderTest;
+    private static Schema propertiesSchema;
+    private static SchemaValidator schemaValidator;
+
+    @BeforeAll
+    static void setUp()
+    {
+
+        classUnderTest = OpenApiInteractionValidator
+                .createForSpecificationUrl(OPEN_API_SPECIFICATION_URL)
+                .withLevelResolver(LevelResolver.create().withLevel(ADDITIONAL_PROPERTIES_KEY, ValidationReport.Level.IGNORE).build())
+                .build();
+
+        schemaValidator = validatorWithAdditionalPropertiesIgnored(OPEN_API_SPECIFICATION_URL);
+        propertiesSchema = new Schema().additionalProperties(
+                new Schema().oneOf(List.of(
+                        new Schema().$ref("#/components/schemas/File"),
+                        new Schema().$ref("#/components/schemas/Value"))));
+    }
+
+    @Test
+    void testRequestToPresignedUrls()
+    {
+        HxInsightRequest hxInsightRequest = RequestLoader.load("/expected-hxinsight-requests/get-presigned-url-request.yml");
+
+        Request request = makeRequest(hxInsightRequest);
+
+        assertThat(classUnderTest.validateRequest(request).getMessages()).isEmpty();
+    }
+
+    @Test
+    void testCreateRequestToIngestionEvents() throws Exception
+    {
+        HxInsightRequest hxInsightRequest = RequestLoader.load("/expected-hxinsight-requests/create-document-request.yml");
+
+        Request request = makeRequest(hxInsightRequest);
+
+        assertThat(classUnderTest.validateRequest(request).getMessages()).isEmpty();
+        validatePropertiesField(hxInsightRequest.body(), propertiesSchema);
+    }
+
+    @Test
+    void testUpdateRequestToIngestionEvents() throws Exception
+    {
+        HxInsightRequest hxInsightRequest = RequestLoader.load("/expected-hxinsight-requests/update-document-request.yml");
+
+        Request request = makeRequest(hxInsightRequest);
+
+        assertThat(classUnderTest.validateRequest(request).getMessages()).isEmpty();
+        validatePropertiesField(hxInsightRequest.body(), propertiesSchema);
+    }
+
+    @Test
+    void testDeleteRequestToIngestionEvents()
+    {
+        HxInsightRequest hxInsightRequest = RequestLoader.load("/expected-hxinsight-requests/delete-document-request.yml");
+
+        Request request = makeRequest(hxInsightRequest);
+
+        assertThat(classUnderTest.validateRequest(request).getMessages()).isEmpty();
+    }
+
+    private static SchemaValidator validatorWithAdditionalPropertiesIgnored(final String api)
+    {
+        final ParseOptions parseOptions = new ParseOptions();
+        parseOptions.setResolve(true);
+        return new SchemaValidator(
+                new OpenAPIParser().readLocation(api, null, parseOptions).getOpenAPI(),
+                new MessageResolver(
+                        LevelResolver
+                                .create()
+                                .withLevel(ADDITIONAL_PROPERTIES_KEY, ValidationReport.Level.IGNORE)
+                                .build()));
+    }
+
+    private static Request makeRequest(HxInsightRequest hxInsightRequest)
+    {
+        SimpleRequest.Builder builder = SimpleRequest.Builder.post(hxInsightRequest.url());
+        hxInsightRequest.headers().forEach(builder::withHeader);
+        return builder.withBody(hxInsightRequest.body()).build();
+    }
+
+    private void validatePropertiesField(String propertiesBody, Schema propertiesSchema) throws Exception
+    {
+        ObjectMapper objectMapper = new ObjectMapper();
+        JsonNode requestBodyNode = objectMapper.readTree(propertiesBody);
+        JsonNode propertiesNode = requestBodyNode.get(0).get("properties");
+
+        if (propertiesNode != null)
+        {
+            ValidationReport validationReport = schemaValidator.validate(propertiesNode.toString(), propertiesSchema, null);
+            assertThat(validationReport.getMessages()).isEmpty();
+        }
+    }
+}

live-ingester/src/integration-test/java/org/alfresco/hxi_connector/live_ingester/util/insight_api/HxInsightRequest.java

@@ -0,0 +1,31 @@
+/*
+ * #%L
+ * Alfresco HX Insight Connector
+ * %%
+ * Copyright (C) 2023 - 2024 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.hxi_connector.live_ingester.util.insight_api;
+
+import java.util.Map;
+
+public record HxInsightRequest(String url, Map<String, String> headers, String body)
+{}

live-ingester/src/integration-test/java/org/alfresco/hxi_connector/live_ingester/util/insight_api/RequestLoader.java

@@ -0,0 +1,74 @@
+/*
+ * #%L
+ * Alfresco HX Insight Connector
+ * %%
+ * Copyright (C) 2023 - 2024 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software.
+ * If the software was purchased under a paid Alfresco license, the terms of
+ * the paid license agreement will prevail.  Otherwise, the software is
+ * provided under the following open source license terms:
+ *
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.hxi_connector.live_ingester.util.insight_api;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.UncheckedIOException;
+import java.util.HashMap;
+import java.util.Map;
+
+import com.fasterxml.jackson.core.JsonProcessingException;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+
+import org.alfresco.hxi_connector.live_ingester.domain.exception.LiveIngesterRuntimeException;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class RequestLoader
+{
+    private final static ObjectMapper JSON_MAPPER = new ObjectMapper();
+    private final static ObjectMapper YAML_MAPPER = new ObjectMapper(new YAMLFactory());
+
+    public static HxInsightRequest load(String path)
+    {
+        Map<String, Object> data;
+        try (InputStream stream = HxInsightRequest.class.getResourceAsStream(path))
+        {
+            data = YAML_MAPPER.readValue(stream.readAllBytes(), HashMap.class);
+        }
+        catch (IOException e)
+        {
+            throw new UncheckedIOException(e);
+        }
+        Object body = data.get("body");
+        String bodyAsString = null;
+        if (body != null)
+        {
+            try
+            {
+                bodyAsString = JSON_MAPPER.writeValueAsString(body);
+            }
+            catch (JsonProcessingException e)
+            {
+                throw new LiveIngesterRuntimeException(e);
+            }
+        }
+        return new HxInsightRequest((String) data.get("url"), (Map) data.get("headers"), bodyAsString);
+    }
+}

live-ingester/src/integration-test/resources/expected-hxinsight-requests/create-document-request.yml

@@ -0,0 +1,39 @@
+url: /v1/ingestion-events
+headers:
+  authorization: string
+  content-type: application/json
+  hxp-environment: string
+  user-agent: string
+body: [
+  {
+    "objectId": "d71dd823-82c7-477c-8490-04cb0e826e65",
+    "sourceId" : "alfresco-dummy-source-id-0a63de491876",
+    "eventType": "create",
+    "sourceTimestamp": 1611227656423,
+    "properties": {
+      "cm:autoVersion": {"value": true},
+      "createdAt": {"value": 1611227655695},
+      "modifiedAt": {"value" : 1611227655695},
+      "cm:versionType": {"value": "MAJOR"},
+      "aspectsNames": {"value": ["cm:versionable", "cm:auditable"]},
+      "cm:name": {
+        "value": "purchase-order-scan.doc",
+        "annotation" : "name"
+      },
+      "type": {"value": "cm:content"},
+      "createdBy": {"value": "admin"},
+      "modifiedBy": {"value": "admin"},
+      "cm:content": {
+        "file": {
+          "content-metadata": {
+            "size": 531152,
+            "name": "purchase-order-scan.doc",
+            "content-type": "application/msword"
+          }
+        }
+      },
+      "ALLOW_ACCESS": {"value": ["GROUP_EVERYONE"]},
+      "DENY_ACCESS": {"value": []}
+    }
+  }
+]

live-ingester/src/integration-test/resources/expected-hxinsight-requests/delete-document-request.yml

@@ -0,0 +1,14 @@
+url: /v1/ingestion-events
+headers:
+  authorization: string
+  content-type: application/json
+  hxp-environment: string
+  user-agent: string
+body: [
+  {
+    "objectId": "d71dd823-82c7-477c-8490-04cb0e826e65",
+    "sourceId" : "alfresco-dummy-source-id-0a63de491876",
+    "eventType": "delete",
+    "sourceTimestamp": 1611656982995
+  }
+]