Merge pull request #71 from com-pas/develop

New release

Author: Dennis Labordus

.github/dependabot.yml

@@ -27,3 +27,9 @@ updates:
     schedule:
       interval: "daily"
     open-pull-requests-limit: 5
+
+  - package-ecosystem: "docker"
+    directory: "/app/src/main/docker/"
+    schedule:
+      interval: "daily"
+    open-pull-requests-limit: 5

.github/workflows/build-project.yml

@@ -26,7 +26,7 @@ jobs:
           submodules: 'true'
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       - name: Cache Docker Register
         uses: actions/cache@v3
         with:
@@ -50,5 +50,9 @@ jobs:
         with:
           output_file: custom_maven_settings.xml
           servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
-      - name: Build with Maven
+      - name: Build with Maven (Pull Request)
+        if: ${{ github.event_name == 'pull_request' }}
+        run: ./mvnw -s custom_maven_settings.xml -B -Pjvm-image clean verify
+      - name: Build with Maven (Push)
+        if: ${{ github.event_name == 'push' }}
         run: ./mvnw -s custom_maven_settings.xml -B clean verify

.github/workflows/release-project.yml

@@ -20,9 +20,9 @@ jobs:
           submodules: 'true'
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v1
+        uses: docker/setup-buildx-action@v2
       - name: Login to Docker Hub
-        uses: docker/login-action@v1
+        uses: docker/login-action@v2
         with:
           username: ${{ secrets.DOCKER_HUB_USERNAME }}
           password: ${{ secrets.DOCKER_HUB_TOKEN }}
@@ -66,6 +66,6 @@ jobs:
           ./mvnw -B -s custom_maven_settings.xml \
                  -DaltDeploymentRepository=github-packages-compas::default::https://maven.pkg.github.com/com-pas/compas-scl-validator \
                  -Dmaven.deploy.skip=snapshots \
-                 -Prelease clean deploy
+                 -Pjvm-image,release clean deploy
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitmodules

@@ -6,18 +6,6 @@
 # Remark: the option to ignore 'untracked' files is needed, because the submodules don't contain a file '.gitignore'.
 # This cause the target directories to be untracked.
 #
-[submodule "riseclipse/riseclipse-developer"]
-	path = riseclipse/riseclipse-developer
-	url = [email protected]:riseclipse/riseclipse-developer.git
-	ignore = dirty
-[submodule "riseclipse/riseclipse-main"]
-	path = riseclipse/riseclipse-main
-	url = [email protected]:riseclipse/riseclipse-main.git
-	ignore = dirty
-[submodule "riseclipse/riseclipse-metamodel-scl2003"]
-	path = riseclipse/riseclipse-metamodel-scl2003
-	url = [email protected]:riseclipse/riseclipse-metamodel-scl2003.git
-	ignore = dirty
 [submodule "riseclipse/riseclipse-ocl-constraints-scl2003"]
 	path = riseclipse/riseclipse-ocl-constraints-scl2003
 	url = [email protected]:riseclipse/riseclipse-ocl-constraints-scl2003.git

DEVELOPMENT.md

@@ -8,51 +8,50 @@ SPDX-License-Identifier: Apache-2.0
 
 ## Git
 
-If the project is already cloned and a submodule is added use the following commands, first `git submodule init` and
-next `git submodule update`.
+If the project is already cloned and a submodule is added use the following commands to retrieve the files from the
+RiseClipse Repository:
+
+- `git submodule init`
+- `git submodule update`
 
 More about Git Submodules can be found [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules).
 
 **Remark**: The URLs to the submodules are configured in the file `.gitmodules`, but these are using the SSH URLs. There
 is a way described [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules) that the URL can be overwritten locally
-with an HTTPS URL of the GIT Repository. Because of the subdirectory where the submodules are in, this doesn't work
-exactly that way. Use the following commands to update the URLs locally to HTTPS.
+with an HTTPS URL of the GIT Repository.
+
+Because of the subdirectory where the submodules are in, this doesn't work exactly that way. Use the following commands
+to update the URLs locally to HTTPS.
 
 ```
-git config submodule.riseclipse/riseclipse-developer.url https://github.com/riseclipse/riseclipse-developer.git
-git config submodule.riseclipse/riseclipse-main.url https://github.com/riseclipse/riseclipse-main.git
-git config submodule.riseclipse/riseclipse-metamodel-scl2003.url https://github.com/riseclipse/riseclipse-metamodel-scl2003.git
 git config submodule.riseclipse/riseclipse-ocl-constraints-scl2003.url https://github.com/riseclipse/riseclipse-ocl-constraints-scl2003.git
 
 git submodule init
 git submodule update
 ```
 
-## IntelliJ
+### Git update Submodules
 
-Importing the project is a bit harder for the SCL Validator then normal. It's caused because of the submodules that are
-needed from RiseClipse. These projects are Eclipse projects using Eclipse Tycho to build and Eclipse project structure.
+A submodule in Git is fixed to a specific commit of the remote repository. To update the reference to the latest commit
+in the remote repository execute the following command from the root directory of the project.
 
-The first step to make it work in IntelliJ is that an Eclipse version needs to be available on your local machine. The
-version we know that's working can be found [here](https://www.eclipse.org/downloads/packages/release/2019-06/r)
-Download (and install/unzip) Eclipse.
+```
+git submodule update --remote
+```
 
-Next a way to make everything work in IntelliJ is importing the project in the following way.
+Next commit and push the changes to the Git Repository of CoMPAS. The build now uses the latest commit of the main
+branch.
 
-- First step is to just import everything like it are Maven projects;
-- Next we need to add a Global Library in IntelliJ. Open the Module Settings and select "Global Libraries". And a new
-  libraries and name it "ECLIPSE". Point it to the directory "<ECLIPSE_INSTALL_DIR>/plugins";
-- Next step is to re-import the RiseClipse Submodule as Eclipse;
-  - In IntelliJ select "File" -> "New" -> "Module from Existing Sources...";
-  - Select one of the RiseClipse Submodules, for instance "riseclipse-metamodel-scl2003";
-  - Next select "Eclipse" by "Import module from External Model";
-  - Follow the rest of the wizard, only to remember to select all subprojects that are available in the directory;
+## Eclipse
 
-Now the module should be correctly imported in IntelliJ to be used. Check the Module Settings of one of the subprojects
-to check if the directory "src" is a Java Source Directory, for instance the module
-"riseclipse/riseclipse-metamodel-scl2003/fr.centralesupelec.edf.riseclipse.iec61850.scl.utilities".
+### Eclipse Dependencies
 
-## Eclipse
+To make everything build and run Eclipse Dependencies are needed, but unlike the RiseClipse Dependencies these can't be
+found in the Maven Central Repository, but in an Eclipse P2 Repository. In RiseClipse there is a p2-to-m2 project that
+creates a local Maven Repository from the needed dependencies from the Eclipse P2 Repository. A CoMPAS Version of this
+maven module is created here, see [README.md](riseclipse/riseclipse-p2-to-m2/README.md) for more info.
+
+### Eclipse OCL
 
 Example about how to use Eclipse OCL was found
 [here](https://help.eclipse.org/latest/index.jsp?topic=%2Forg.eclipse.ocl.doc%2Fhelp%2FPivotStandalone.html).

README.md

@@ -7,7 +7,7 @@ SPDX-License-Identifier: Apache-2.0
 [![Maven Build Github Action Status](<https://img.shields.io/github/workflow/status/com-pas/compas-scl-validator/Build%20Project?logo=GitHub>)](https://github.com/com-pas/compas-scl-validator/actions?query=workflow%3A%22Build+Project%22)
 [![REUSE status](https://api.reuse.software/badge/github.com/com-pas/compas-scl-validator)](https://api.reuse.software/info/github.com/com-pas/compas-scl-validator)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=com-pas_compas-scl-validator&metric=alert_status)](https://sonarcloud.io/dashboard?id=com-pas_compas-scl-validator)
-[![LFX Security Status](https://img.shields.io/badge/dynamic/json?color=orange&label=LFX%20Security%20Tool&query=issues%5B%3F%28%40%5B%27repository-name%27%5D%20%3D%3D%20%27compas-scl-validator%27%29%5D%5B%27high-open-issues%27%5D&suffix=%20High%20open%20issues&url=https%3A%2F%2Fapi.security.lfx.linuxfoundation.org%2Fv1%2Fproject%2Fe8b6fdf9-2686-44c5-bbaa-6965d04ad3e1%2Fissues)](https://security.lfx.linuxfoundation.org/#/e8b6fdf9-2686-44c5-bbaa-6965d04ad3e1/issues)
+[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/5925/badge)](https://bestpractices.coreinfrastructure.org/projects/5925)
 [![Slack](https://raw.githubusercontent.com/com-pas/compas-architecture/master/public/LFEnergy-slack.svg)](http://lfenergy.slack.com/)
 
 # compas-scl-validator
@@ -28,19 +28,19 @@ automatically determine the URL to be used.
 
 ## Development
 
-For the RiseClipse implementation of the validator parts of the RiseClipse project are being used. Currently, these
-parts aren't distributed to any Maven Repository, so the Git Repositories need to be included. This is done using Git
-Submodules.
+Since version 1.2.x the JAR Files of RiseClipse are distributed through Maven Central Repository. The JAR Files can be
+retrieved from there and don't need to be build locally anymore. Only the OCL Files for the SCL validation still need to
+be downloaded from RiseClipse GIT Repository. This is still done using Git Submodules.
 
 To clone the project or update the project this means that the Git commands are sometimes a little different. To clone
 the project use the following command `git clone --recurse-submodules [email protected]:com-pas/compas-scl-validator.git`.
 This will also clone the submodules.
 
 Tip: The URL to the submodules are configured in the file `.gitmodules`, but these are using the SSH URL. There is a way
-described in the URL above that the URL can be overwritten locally with an HTTPS URL of the GIT Repository.
+described [here](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to overwrite the URL locally with an HTTPS URL of
+the GIT Repository.
 
-Check the [Development](DEVELOPMENT.md) page for more detail information how to work with this repository, because of
-the mixture with RiseClipse.
+Check the [Development](DEVELOPMENT.md) page for more detail information how to develop in this GIT repository.
 
 ## Custom OCL Files
 

app/pom.xml

@@ -47,31 +47,23 @@ SPDX-License-Identifier: Apache-2.0
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy</artifactId>
+            <artifactId>quarkus-resteasy-reactive</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-smallrye-jwt</artifactId>
+            <artifactId>quarkus-resteasy-reactive-jaxb</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-smallrye-openapi</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-smallrye-health</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-jaxb</artifactId>
+            <artifactId>quarkus-smallrye-jwt</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-resteasy-mutiny</artifactId>
+            <artifactId>quarkus-smallrye-openapi</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
-            <artifactId>quarkus-vertx</artifactId>
+            <artifactId>quarkus-smallrye-health</artifactId>
         </dependency>
         <dependency>
             <groupId>io.quarkus</groupId>
@@ -170,14 +162,50 @@ SPDX-License-Identifier: Apache-2.0
 
     <profiles>
         <profile>
-            <id>native</id>
+            <id>jvm-image</id>
 
             <properties>
+                <!-- Make a Docker Image, so the integration tests will be executed against the container -->
+                <quarkus.container-image.build>true</quarkus.container-image.build>
+            </properties>
+
+            <build>
+                <plugins>
+                    <plugin>
+                        <groupId>org.apache.maven.plugins</groupId>
+                        <artifactId>maven-failsafe-plugin</artifactId>
+                        <version>${surefire-plugin.version}</version>
+                        <executions>
+                            <execution>
+                                <goals>
+                                    <goal>integration-test</goal>
+                                    <goal>verify</goal>
+                                </goals>
+                                <configuration>
+                                    <systemPropertyVariables>
+                                        <java.util.logging.manager>
+                                            org.jboss.logmanager.LogManager
+                                        </java.util.logging.manager>
+                                        <maven.home>${maven.home}</maven.home>
+                                    </systemPropertyVariables>
+                                </configuration>
+                            </execution>
+                        </executions>
+                    </plugin>
+                </plugins>
+            </build>
+        </profile>
+
+        <profile>
+            <id>native-image</id>
+
+            <properties>
+                <!-- Make a Docker Image, so the integration tests will be executed against the container -->
+                <quarkus.container-image.build>true</quarkus.container-image.build>
+
                 <quarkus.package.type>native</quarkus.package.type>
                 <!-- Allows for creating a Linux executable without GraalVM being installed -->
                 <quarkus.native.container-build>true</quarkus.native.container-build>
-                <!-- Also make a Docker Image, so the native test will be executed against the container -->
-                <quarkus.container-image.build>true</quarkus.container-image.build>
                 <quarkus.native.additional-build-args>
                     --allow-incomplete-classpath
                 </quarkus.native.additional-build-args>
@@ -228,7 +256,9 @@ SPDX-License-Identifier: Apache-2.0
             <id>release</id>
 
             <properties>
+                <!-- Make a Docker Image from the component -->
                 <quarkus.container-image.build>true</quarkus.container-image.build>
+
                 <!-- Properties only used for publishing a native docker image (default to Docker Hub) -->
                 <quarkus.container-image.push>true</quarkus.container-image.push>
                 <quarkus.container-image.additional-tags>latest</quarkus.container-image.additional-tags>

app/src/main/docker/Dockerfile.jvm

@@ -21,7 +21,7 @@
 # docker run -i --rm -p 8080:8080 -p 5005:5005 -e JAVA_ENABLE_DEBUG="true" quarkus/app-jvm
 #
 ###
-FROM registry.access.redhat.com/ubi8/ubi-minimal:8.4 
+FROM registry.access.redhat.com/ubi8/ubi-minimal:8.6 
 
 ARG JAVA_PACKAGE=java-11-openjdk-headless
 ARG RUN_JAVA_VERSION=1.3.8

app/src/main/docker/Dockerfile.native

@@ -14,7 +14,7 @@
 # docker run -i --rm -p 8080:8080 quarkus/app
 #
 ###
-FROM registry.access.redhat.com/ubi8/ubi-minimal:8.4
+FROM registry.access.redhat.com/ubi8/ubi-minimal:8.6
 WORKDIR /work/
 RUN chown 1001 /work \
     && chmod "g+rwX" /work \

app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResource.java

@@ -4,7 +4,9 @@
 package org.lfenergy.compas.scl.validator.rest.v1;
 
 import io.quarkus.security.Authenticated;
+import io.smallrye.mutiny.Uni;
 import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocListResponse;
+import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocResponse;
 import org.lfenergy.compas.scl.validator.service.NsdocService;
 
 import javax.enterprise.context.RequestScoped;
@@ -27,17 +29,19 @@ public NsdocResource(NsdocService nsdocService) {
     @GET
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
-    public NsdocListResponse list() {
-        NsdocListResponse response = new NsdocListResponse();
+    public Uni<NsdocListResponse> list() {
+        var response = new NsdocListResponse();
         response.setNsdocFiles(nsdocService.list());
-        return response;
+        return Uni.createFrom().item(response);
     }
 
     @GET
     @Path("{" + ID_PARAM + "}")
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
-    public String get(@PathParam(ID_PARAM) UUID id) {
-        return nsdocService.get(id);
+    public Uni<NsdocResponse> get(@PathParam(ID_PARAM) UUID id) {
+        var response = new NsdocResponse();
+        response.setNsdocFile(nsdocService.get(id));
+        return Uni.createFrom().item(response);
     }
 }