Merge branch 'develop' into dependabot/maven/junit-jupiter.version-5.8.1

Rob Tjalma · Rob Tjalma · commit f8fcfb2e547c · 2021-10-08T17:03:55.000+02:00
Signed-off-by: Rob Tjalma &lt;rob@tjalma.com&gt;
diff --git a/.github/workflows/build-project.yml b/.github/workflows/build-project.yml
@@ -15,14 +15,14 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Set up JDK 1.11
-      uses: actions/setup-java@v2.3.0
+      uses: actions/setup-java@v2.3.1
       with:
         distribution: 'zulu'
         java-version: '11'
     - name: Create custom Maven Settings.xml
-      uses: whelk-io/maven-settings-xml-action@v18
+      uses: whelk-io/maven-settings-xml-action@v20
       with:
         output_file: custom_maven_settings.xml
         servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
     - name: Build with Maven
-      run: ./mvnw -s custom_maven_settings.xml -B clean verify
+      run: ./mvnw -s custom_maven_settings.xml -B clean verify -Pnative
diff --git a/.github/workflows/release-project.yml b/.github/workflows/release-project.yml
@@ -24,13 +24,13 @@ jobs:
         shell: bash
         # Extra the tagname form the git reference, value of GITHUB_REF will be something like refs/tags/<tag_name>.
         run: echo "##[set-output name=tagname;]$(echo ${GITHUB_REF##*/})"
-      - name: Set up JDK 11
-        uses: actions/setup-java@v2.3.0
+      - name: Set up JDK 1.11
+        uses: actions/setup-java@v2.3.1
         with:
           distribution: 'zulu'
           java-version: '11'
       - name: Create custom Maven Settings.xml
-        uses: whelk-io/maven-settings-xml-action@v18
+        uses: whelk-io/maven-settings-xml-action@v20
         with:
           output_file: custom_maven_settings.xml
           servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
@@ -39,6 +39,6 @@ jobs:
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
       - name: Deploy with Maven to GitHub Packages and Docker Hub
-        run: ./mvnw -B -s custom_maven_settings.xml -Prelease clean deploy
+        run: ./mvnw -B -s custom_maven_settings.xml -Prelease,native clean deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/sonarcloud-analysis.yml b/.github/workflows/sonarcloud-analysis.yml
@@ -17,7 +17,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Set up JDK 11
-        uses: actions/setup-java@v2.3.0
+        uses: actions/setup-java@v2.3.1
         with:
           distribution: 'zulu'
           java-version: '11'
@@ -34,7 +34,7 @@ jobs:
           key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
           restore-keys: ${{ runner.os }}-m2
       - name: Create custom Maven Settings.xml
-        uses: whelk-io/maven-settings-xml-action@v18
+        uses: whelk-io/maven-settings-xml-action@v20
         with:
           output_file: custom_maven_settings.xml
           servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
diff --git a/README.md b/README.md
@@ -83,12 +83,15 @@ Below environment variable(s) can be used to configure the connection to BaseX,
 | BASEX_USERNAME                   | basex.username            | Username under which the application logs in. | admin            |
 | BASEX_PASSWORD                   | basex.password            | Password of the username used above.          | admin            |
 
-Below environment variable(s) can be used to configure which claims are used to fill the UserInfo response.
-
-| Environment variable             | Java Property                  | Description                                   | Example          |
-| -------------------------------- | ------------------------------ | --------------------------------------------- | ---------------- |
-| USERINFO_NAME_CLAIMNAME          | compas.userinfo.name.claimname | The Name of the user logged in.               | name             |
-| USERINFO_WHO_CLAIMNAME           | compas.userinfo.who.claimname  | The Name of the user used in the Who History. | name             |
+Below environment variable(s) can be used to configure which claims and information are used to fill the UserInfo
+response.
+
+| Environment variable             | Java Property                   | Description                                                 | Example          |
+| -------------------------------- | ------------------------------- | ----------------------------------------------------------- | ---------------- |
+| USERINFO_NAME_CLAIMNAME          | compas.userinfo.name.claimname  | The Name of the user logged in.                             | name             |
+| USERINFO_WHO_CLAIMNAME           | compas.userinfo.who.claimname   | The Name of the user used in the Who History.               | name             |
+| USERINFO_SESSION_WARNING         | compas.userinfo.session.warning | Number of minutes a Session Warning can be displayed.       | 20               |
+| USERINFO_SESSION_EXPIRES         | compas.userinfo.session.expires | Number of minutes a Session Expires to display in Frontend. | 30               |
 
 ## Security
 
diff --git a/app/pom.xml b/app/pom.xml
@@ -18,7 +18,10 @@ SPDX-License-Identifier: Apache-2.0
     <packaging>jar</packaging>
 
     <properties>
-        <quarkus.platform.version>2.2.3.Final</quarkus.platform.version>
+        <quarkus.platform.version>2.3.0.Final</quarkus.platform.version>
+
+        <quarkus.container-image.group>lfenergycompas</quarkus.container-image.group>
+        <quarkus.container-image.name>compas-scl-data-service</quarkus.container-image.name>
     </properties>
 
     <dependencyManagement>
@@ -50,7 +53,7 @@ SPDX-License-Identifier: Apache-2.0
         </dependency>
         <dependency>
             <groupId>org.lfenergy.compas.core</groupId>
-            <artifactId>rest-commons</artifactId>
+            <artifactId>jaxrs-commons</artifactId>
         </dependency>
 
         <dependency>
@@ -156,7 +159,9 @@ SPDX-License-Identifier: Apache-2.0
 
             <properties>
                 <quarkus.package.type>native</quarkus.package.type>
-                <quarkus.native.container-build>true</quarkus.native.container-build> <!-- Allows for creating a Linux executable without GraalVM being installed -->
+                <!-- Allows for creating a Linux executable without GraalVM being installed -->
+                <quarkus.native.container-build>true</quarkus.native.container-build>
+                <quarkus.native.additional-build-args>-H:ReflectionConfigurationFiles=reflection-config.json</quarkus.native.additional-build-args>
             </properties>
 
             <build>
@@ -202,8 +207,6 @@ SPDX-License-Identifier: Apache-2.0
             <properties>
                 <!-- Properties only used for publishing a native docker image (default to Docker Hub) -->
                 <quarkus.container-image.build>true</quarkus.container-image.build>
-                <quarkus.container-image.group>lfenergycompas</quarkus.container-image.group>
-                <quarkus.container-image.name>compas-scl-data-service</quarkus.container-image.name>
                 <quarkus.container-image.push>true</quarkus.container-image.push>
                 <quarkus.container-image.additional-tags>latest</quarkus.container-image.additional-tags>
             </properties>
diff --git a/app/src/main/docker/Dockerfile.jvm b/app/src/main/docker/Dockerfile.jvm
@@ -42,6 +42,7 @@ RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \
 
 # Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size.
 ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
+ENV JAVA_MAX_MEM_RATIO="70"
 # We make four distinct layers so if there are application changes the library layers can be re-used
 COPY --chown=1001 target/quarkus-app/lib/ /deployments/lib/
 COPY --chown=1001 target/quarkus-app/*.jar /deployments/
diff --git a/app/src/main/docker/Dockerfile.legacy-jar b/app/src/main/docker/Dockerfile.legacy-jar
@@ -42,6 +42,7 @@ RUN microdnf install curl ca-certificates ${JAVA_PACKAGE} \
 
 # Configure the JAVA_OPTIONS, you can add -XshowSettings:vm to also display the heap size.
 ENV JAVA_OPTIONS="-Dquarkus.http.host=0.0.0.0 -Djava.util.logging.manager=org.jboss.logmanager.LogManager"
+ENV JAVA_MAX_MEM_RATIO="70"
 COPY target/lib/* /deployments/lib/
 COPY target/*-runner.jar /deployments/app.jar
 
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/UserInfoProperties.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/UserInfoProperties.java
@@ -13,4 +13,10 @@ public interface UserInfoProperties {
 
     @WithName("who.claimname")
     String who();
+
+    @WithName("session.warning")
+    int sessionWarning();
+
+    @WithName("session.expires")
+    int sessionExpires();
 }
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandler.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandler.java
@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.data.rest.exception;
 
-import org.lfenergy.compas.core.rest.model.ErrorResponse;
+import org.lfenergy.compas.core.jaxrs.model.ErrorResponse;
 import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
 
 import javax.ws.rs.core.Response;
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResource.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResource.java
@@ -66,6 +66,8 @@ public UserInfoResponse getUserInfo(@HeaderParam("Authorization") String authHea
 
         var response = new UserInfoResponse();
         response.setName(jsonWebToken.getClaim(userInfoProperties.name()));
+        response.setSessionWarning(userInfoProperties.sessionWarning());
+        response.setSessionExpires(userInfoProperties.sessionExpires());
         return response;
     }
 }
diff --git a/app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/model/UserInfoResponse.java b/app/src/main/java/org/lfenergy/compas/scl/data/rest/v1/model/UserInfoResponse.java
@@ -3,6 +3,8 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.data.rest.v1.model;
 
+import org.eclipse.microprofile.openapi.annotations.media.Schema;
+
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
@@ -13,14 +15,39 @@
 @XmlRootElement(name = "UserInfoResponse", namespace = SCL_DATA_SERVICE_V1_NS_URI)
 @XmlAccessorType(XmlAccessType.FIELD)
 public class UserInfoResponse {
+    @Schema(description = "The name of the user retrieved from the JWT Claim.")
     @XmlElement(name = "Name", namespace = SCL_DATA_SERVICE_V1_NS_URI)
     private String name;
 
+    @Schema(description = "The number of minutes when the frontend isn't used and a warning message will be shown.")
+    @XmlElement(name = "SessionWarning", namespace = SCL_DATA_SERVICE_V1_NS_URI)
+    private int sessionWarning;
+
+    @Schema(description = "The number of minutes when the session will expire and a expired message will be shown if the frontend isn't used.")
+    @XmlElement(name = "SessionExpires", namespace = SCL_DATA_SERVICE_V1_NS_URI)
+    private int sessionExpires;
+
     public String getName() {
         return name;
     }
 
     public void setName(String name) {
         this.name = name;
     }
+
+    public int getSessionWarning() {
+        return sessionWarning;
+    }
+
+    public void setSessionWarning(int sessionWarning) {
+        this.sessionWarning = sessionWarning;
+    }
+
+    public int getSessionExpires() {
+        return sessionExpires;
+    }
+
+    public void setSessionExpires(int sessionExpires) {
+        this.sessionExpires = sessionExpires;
+    }
 }
diff --git a/app/src/main/resources/application.properties b/app/src/main/resources/application.properties
@@ -4,6 +4,8 @@
 
 compas.userinfo.name.claimname    = ${USERINFO_NAME_CLAIMNAME:name}
 compas.userinfo.who.claimname     = ${USERINFO_WHO_CLAIMNAME:name}
+compas.userinfo.session.warning   = ${USERINFO_SESSION_WARNING:10}
+compas.userinfo.session.expires   = ${USERINFO_SESSION_EXPIRES:15}
 
 quarkus.http.cors                 = false
 quarkus.http.root-path            = /compas-scl-data-service/
diff --git a/app/src/main/resources/reflection-config.json b/app/src/main/resources/reflection-config.json
@@ -0,0 +1,7 @@
+[
+  {
+    "name" : "org.lfenergy.compas.scl.data.model.ObjectFactory",
+    "allDeclaredMethods" : true,
+    "allPublicMethods" : true
+  }
+]
diff --git a/app/src/main/resources/reflection-config.json.license b/app/src/main/resources/reflection-config.json.license
@@ -0,0 +1,3 @@
+SPDX-FileCopyrightText: 2021 Alliander N.V.
+
+SPDX-License-Identifier: Apache-2.0
diff --git a/app/src/native-test/java/org/lfenergy/compas/scl/data/NativeHealthCheckIT.java b/app/src/native-test/java/org/lfenergy/compas/scl/data/NativeHealthCheckIT.java
diff --git a/app/src/test/java/org/lfenergy/compas/scl/data/rest/NativeHealthCheckIT.java b/app/src/test/java/org/lfenergy/compas/scl/data/rest/NativeHealthCheckIT.java
@@ -0,0 +1,12 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+
+package org.lfenergy.compas.scl.data.rest;
+
+import io.quarkus.test.junit.NativeImageTest;
+
+@NativeImageTest
+class NativeHealthCheckIT extends HealthCheckTest {
+    // Execute the same tests but in native mode.
+}
diff --git a/app/src/test/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandlerTest.java b/app/src/test/java/org/lfenergy/compas/scl/data/rest/exception/CompasNoDataFoundExceptionHandlerTest.java
@@ -4,7 +4,7 @@
 package org.lfenergy.compas.scl.data.rest.exception;
 
 import org.junit.jupiter.api.Test;
-import org.lfenergy.compas.core.rest.model.ErrorResponse;
+import org.lfenergy.compas.core.jaxrs.model.ErrorResponse;
 import org.lfenergy.compas.scl.data.exception.CompasNoDataFoundException;
 
 import static javax.ws.rs.core.Response.Status.NOT_FOUND;
diff --git a/app/src/test/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResourceTest.java b/app/src/test/java/org/lfenergy/compas/scl/data/rest/v1/CompasCommonResourceTest.java
@@ -84,7 +84,8 @@ void getUserInfo_WhenCalled_ThenUserInfoResponseRetrieved() {
                 .response();
 
         var xmlPath = response.xmlPath();
-        var name = xmlPath.get("UserInfoResponse.Name");
-        assertEquals("Test User", name);
+        assertEquals("Test User", xmlPath.get("UserInfoResponse.Name"));
+        assertEquals(10, xmlPath.getInt("UserInfoResponse.SessionWarning"));
+        assertEquals(15, xmlPath.getInt("UserInfoResponse.SessionExpires"));
     }
 }
diff --git a/pom.xml b/pom.xml
@@ -24,7 +24,7 @@ SPDX-License-Identifier: Apache-2.0
         <surefire-plugin.version>3.0.0-M5</surefire-plugin.version>
         <sonarqube-plugin.version>3.2.0</sonarqube-plugin.version>
 
-        <compas.core.version>0.4.0</compas.core.version>
+        <compas.core.version>0.5.0</compas.core.version>
         <jakarta-bind-api.version>2.3.3</jakarta-bind-api.version>
         <jaxb-impl.version>2.3.5</jaxb-impl.version>
         <jakarta-cdi-api.version>2.0.2</jakarta-cdi-api.version>
@@ -87,7 +87,7 @@ SPDX-License-Identifier: Apache-2.0
             </dependency>
             <dependency>
                 <groupId>org.lfenergy.compas.core</groupId>
-                <artifactId>rest-commons</artifactId>
+                <artifactId>jaxrs-commons</artifactId>
                 <version>${compas.core.version}</version>
             </dependency>
 

Original file line number	Diff line number	Diff line change
`@@ -66,6 +66,8 @@ public UserInfoResponse getUserInfo(@HeaderParam("Authorization") String authHea`
`66`	`66`
`67`	`67`	`var response = new UserInfoResponse();`
`68`	`68`	`response.setName(jsonWebToken.getClaim(userInfoProperties.name()));`
	`69`	`+ response.setSessionWarning(userInfoProperties.sessionWarning());`
	`70`	`+ response.setSessionExpires(userInfoProperties.sessionExpires());`
`69`	`71`	`return response;`
`70`	`72`	`}`
`71`	`73`	`}`