Merge pull request #414 from swisspush/develop

PR for new release
swisspost · Dec 22, 2021 · 23ad7bc · 23ad7bc
2 parents e01e106 + 08bc1be
commit 23ad7bc
Show file tree

Hide file tree

Showing 31 changed files with 87 additions and 38 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -21,7 +21,7 @@ before_install:
   - source "$HOME/.sdkman/bin/sdkman-init.sh"
   - sdk install groovy 3.0.8
 install:
-    - mvn install -DskipTests -Dmaven.javadoc.skip=true -PpublicRepos -B -V
+    - mvn install -Dmaven.javadoc.skip=true -PpublicRepos -B -V
 before_script:
   - git config --global user.email "swisspush@post.ch"
   - git config --global user.name "Travis-CI"
@@ -30,9 +30,9 @@ script:
   # TODO: Instead of sleeping, should we rather make sure that the server Playground actually is running?
    - sleep 5s
    - mvn deploy -PuploadStaticFiles
-   #- mvn install -PuiIntegrationTests
+   - mvn install -PuiIntegrationTests
    - kill $(ps -ef | grep playground | awk '{ print $2 }')
-   #- mvn install -PnonUiIntegrationTests
+   - mvn install -PnonUiIntegrationTests
    # the exported credentials are needed in the maybe-release.sh
    - git config credential.helper "store --file=.git/credentials"
    - echo "https://${GH_TOKEN}:@github.com" > .git/credentials

diff --git a/gateleen-cache/pom.xml b/gateleen-cache/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-cache</artifactId>

diff --git a/gateleen-core/pom.xml b/gateleen-core/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-core</artifactId>

diff --git a/gateleen-delegate/pom.xml b/gateleen-delegate/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-delegate</artifactId>

diff --git a/gateleen-delta/pom.xml b/gateleen-delta/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-delta</artifactId>

diff --git a/gateleen-expansion/pom.xml b/gateleen-expansion/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-expansion</artifactId>

diff --git a/gateleen-hook-js/pom.xml b/gateleen-hook-js/pom.xml
@@ -4,7 +4,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
     <artifactId>gateleen-hook-js</artifactId>
     <packaging>jar</packaging>

diff --git a/gateleen-hook/pom.xml b/gateleen-hook/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-hook</artifactId>

diff --git a/gateleen-kafka/pom.xml b/gateleen-kafka/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-kafka</artifactId>

diff --git a/gateleen-logging/pom.xml b/gateleen-logging/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-logging</artifactId>

diff --git a/gateleen-merge/pom.xml b/gateleen-merge/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-merge</artifactId>

diff --git a/gateleen-monitoring/pom.xml b/gateleen-monitoring/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-monitoring</artifactId>

diff --git a/gateleen-packing/pom.xml b/gateleen-packing/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-packing</artifactId>

diff --git a/gateleen-player/pom.xml b/gateleen-player/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-player</artifactId>

diff --git a/gateleen-playground/pom.xml b/gateleen-playground/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-playground</artifactId>

diff --git a/gateleen-qos/pom.xml b/gateleen-qos/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-qos</artifactId>

diff --git a/gateleen-queue/pom.xml b/gateleen-queue/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-queue</artifactId>

diff --git a/gateleen-routing/pom.xml b/gateleen-routing/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-routing</artifactId>

diff --git a/gateleen-runconfig/pom.xml b/gateleen-runconfig/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-runconfig</artifactId>

diff --git a/gateleen-scheduler/pom.xml b/gateleen-scheduler/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-scheduler</artifactId>

diff --git a/gateleen-security/pom.xml b/gateleen-security/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-security</artifactId>

diff --git a/gateleen-test/pom.xml b/gateleen-test/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
     <artifactId>gateleen-test</artifactId>
     <packaging>jar</packaging>

diff --git a/gateleen-testhelper/pom.xml b/gateleen-testhelper/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-testhelper</artifactId>

diff --git a/gateleen-user/pom.xml b/gateleen-user/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-user</artifactId>

diff --git a/gateleen-validation/pom.xml b/gateleen-validation/pom.xml
@@ -6,7 +6,7 @@
     <parent>
         <groupId>org.swisspush.gateleen</groupId>
         <artifactId>gateleen</artifactId>
-        <version>1.2.7-SNAPSHOT</version>
+        <version>1.2.8-SNAPSHOT</version>
     </parent>
 
     <artifactId>gateleen-validation</artifactId>

diff --git a/...tion/src/main/java/org/swisspush/gateleen/validation/DefaultValidationSchemaProvider.java b/...tion/src/main/java/org/swisspush/gateleen/validation/DefaultValidationSchemaProvider.java
@@ -2,8 +2,8 @@
 
 import com.networknt.schema.JsonSchema;
 import com.networknt.schema.JsonSchemaFactory;
-import com.networknt.schema.SpecVersion;
 import io.vertx.core.Future;
+import io.vertx.core.MultiMap;
 import io.vertx.core.Vertx;
 import io.vertx.core.buffer.Buffer;
 import io.vertx.core.http.HttpClientRequest;
@@ -26,6 +26,7 @@ public class DefaultValidationSchemaProvider implements ValidationSchemaProvider
     private final Logger log = LoggerFactory.getLogger(DefaultValidationSchemaProvider.class);
 
     private final Map<String, SchemaEntry> cachedSchemas;
+    private final MultiMap defaultRequestHeaders;
 
     private static final int TIMEOUT_MS = 30000;
     private static final String CONTENT_TYPE_HEADER = "Content-Type";
@@ -40,8 +41,22 @@ public class DefaultValidationSchemaProvider implements ValidationSchemaProvider
      * @param cacheCleanupInterval interval to define the cached schema cleanup
      */
     public DefaultValidationSchemaProvider(Vertx vertx, ClientRequestCreator clientRequestCreator, Duration cacheCleanupInterval) {
+        this(vertx, clientRequestCreator, cacheCleanupInterval, new HashMap<>());
+    }
+
+    /**
+     * Constructor for {@link DefaultValidationSchemaProvider}
+     *
+     * @param vertx the Vert.x instance
+     * @param clientRequestCreator the {@link ClientRequestCreator} to fetch the schema
+     * @param cacheCleanupInterval interval to define the cached schema cleanup
+     * @param defaultRequestHeaders default request headers to add to every schema fetch request
+     */
+    public DefaultValidationSchemaProvider(Vertx vertx, ClientRequestCreator clientRequestCreator, Duration cacheCleanupInterval,
+                                           Map<String, String> defaultRequestHeaders) {
         this.clientRequestCreator = clientRequestCreator;
         this.cachedSchemas = new HashMap<>();
+        this.defaultRequestHeaders = new VertxHttpHeaders().addAll(defaultRequestHeaders);
 
         vertx.setPeriodic(cacheCleanupInterval.toMillis(), event -> cleanupCachedSchemas());
     }
@@ -51,6 +66,10 @@ private void cleanupCachedSchemas() {
         cachedSchemas.entrySet().removeIf(entry -> entry.getValue().expiration().isBefore(Instant.now()));
     }
 
+    private MultiMap defaultRequestHeaders() {
+        return defaultRequestHeaders;
+    }
+
     @Override
     public Future<Optional<JsonSchema>> schemaFromLocation(SchemaLocation schemaLocation) {
         Future<Optional<JsonSchema>> future = Future.future();
@@ -65,7 +84,7 @@ public Future<Optional<JsonSchema>> schemaFromLocation(SchemaLocation schemaLoca
             }
         }
 
-        VertxHttpHeaders headers = new VertxHttpHeaders();
+        MultiMap headers = defaultRequestHeaders();
         headers.add("Accept", "application/json");
         headers.add(SELF_REQUEST_HEADER, "true");
 
@@ -107,7 +126,7 @@ public Future<Optional<JsonSchema>> schemaFromLocation(SchemaLocation schemaLoca
     private Optional<JsonSchema> parseSchema(SchemaLocation schemaLocation, Buffer data) {
         JsonSchema schema = null;
         try {
-            schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4).getSchema(data.toString());
+            schema = JsonSchemaFactory.getInstance().getSchema(data.toString());
             if (schemaLocation.keepInMemory() != null) {
                 cachedSchemas.put(schemaLocation.schemaLocation(), new SchemaEntry(schema, Instant.now().plusSeconds(schemaLocation.keepInMemory())));
             }

diff --git a/gateleen-validation/src/main/java/org/swisspush/gateleen/validation/Validator.java b/gateleen-validation/src/main/java/org/swisspush/gateleen/validation/Validator.java
@@ -4,7 +4,6 @@
 import com.fasterxml.jackson.databind.ObjectMapper;
 import com.networknt.schema.JsonSchema;
 import com.networknt.schema.JsonSchemaFactory;
-import com.networknt.schema.SpecVersion;
 import com.networknt.schema.ValidationMessage;
 import io.vertx.core.json.Json;
 import org.swisspush.gateleen.core.http.RequestLoggerFactory;
@@ -136,7 +135,7 @@ public static ValidationResult validateStatic(Buffer dataToBeValidated, String s
         if (SCHEMA_DECLARATION.equals(schemaObject.getString("$schema"))) {
             JsonSchema schema;
             try {
-                schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4).getSchema(schemaAsString);
+                schema = JsonSchemaFactory.getInstance().getSchema(schemaAsString);
             } catch (RuntimeException e) {
                 String message = "Cannot load schema";
                 log.warn(message, e);
@@ -206,7 +205,7 @@ private static void performValidation(String dataString, JsonObject data, Logger
         if (SCHEMA_DECLARATION.equals(data.getString("$schema"))) {
             JsonSchema schema;
             try {
-                schema = JsonSchemaFactory.getInstance(SpecVersion.VersionFlag.V4).getSchema(dataString);
+                schema = JsonSchemaFactory.getInstance().getSchema(dataString);
             } catch (RuntimeException e) {
                 String message = "Cannot load schema " + base;
                 log.warn(message, e);

diff --git a/.../src/test/java/org/swisspush/gateleen/validation/DefaultValidationSchemaProviderTest.java b/.../src/test/java/org/swisspush/gateleen/validation/DefaultValidationSchemaProviderTest.java
@@ -1,18 +1,23 @@
 package org.swisspush.gateleen.validation;
 
 import io.vertx.core.Handler;
+import io.vertx.core.MultiMap;
 import io.vertx.core.Vertx;
+import io.vertx.core.http.CaseInsensitiveHeaders;
 import io.vertx.core.http.HttpMethod;
 import io.vertx.ext.unit.TestContext;
 import io.vertx.ext.unit.junit.VertxUnitRunner;
 import org.junit.Before;
 import org.junit.Test;
 import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
 import org.mockito.Mockito;
 import org.swisspush.gateleen.core.http.ClientRequestCreator;
 import org.swisspush.gateleen.core.http.LocalHttpClient;
 
 import java.time.Duration;
+import java.util.HashMap;
+import java.util.Map;
 
 import static org.mockito.Matchers.*;
 import static org.mockito.Mockito.times;
@@ -38,13 +43,39 @@ public void setUp(){
     public void testSchemaFromLocation(TestContext context){
         schemaProvider.schemaFromLocation(new SchemaLocation("/path/to/schema", null));
 
+        ArgumentCaptor<MultiMap> headersCaptor = ArgumentCaptor.forClass(MultiMap.class);
         verify(clientRequestCreator, times(1)).createClientRequest(
                 eq(HttpMethod.GET),
                 eq("/path/to/schema"),
-                any(),
+                headersCaptor.capture(),
                 anyLong(),
                 any(Handler.class),
                 any(Handler.class)
         );
+
+        MultiMap headers = headersCaptor.getValue();
+        context.assertTrue(headers.contains("Accept", "application/json", true));
+        context.assertTrue(headers.contains("x-self-request", "true", true));
+    }
+
+    @Test
+    public void testSchemaFromLocationWithDefaultRequestHeaders(TestContext context){
+        schemaProvider = new DefaultValidationSchemaProvider(vertx, clientRequestCreator, Duration.ofSeconds(5), Map.of("foo", "bar"));
+        schemaProvider.schemaFromLocation(new SchemaLocation("/path/to/schema", null));
+
+        ArgumentCaptor<MultiMap> headersCaptor = ArgumentCaptor.forClass(MultiMap.class);
+        verify(clientRequestCreator, times(1)).createClientRequest(
+                eq(HttpMethod.GET),
+                eq("/path/to/schema"),
+                headersCaptor.capture(),
+                anyLong(),
+                any(Handler.class),
+                any(Handler.class)
+        );
+
+        MultiMap headers = headersCaptor.getValue();
+        context.assertTrue(headers.contains("foo", "bar", true));
+        context.assertTrue(headers.contains("Accept", "application/json", true));
+        context.assertTrue(headers.contains("x-self-request", "true", true));
     }
 }