Merge

Signed-off-by: Flurb <[email protected]>

Author: Flurb

.github/workflows/release-project.yml

@@ -55,10 +55,17 @@ jobs:
           output_file: custom_maven_settings.xml
           servers: '[{ "id": "github-packages-compas", "username": "OWNER", "password": "${{ secrets.GITHUB_TOKEN }}" }]'
       - name: Set version with Maven
+        # Only set the version for the CoMPAS Modules, excluding the RiseClipse Modules.
         run: ./mvnw -B versions:set -DgroupId=org.lfenergy.compas.scl.validator -DnewVersion=${{ steps.extract_tagname.outputs.tagname }}
         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
+        # We need to pass the Repository information, because these are missing/need to be overwritten for the
+        # RiseClipse Submodules for which we can't update the POM files.
+        run: |
+          ./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
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

DEVELOPMENT.md

@@ -33,14 +33,20 @@ git submodule update
 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 way to make everything work in IntelliJ is importing the project in the following way.
+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.
+
+Next a way to make everything work in IntelliJ is importing the project in the following way.
 
 - 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;
+  - 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;
 
 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

README.md

@@ -30,13 +30,61 @@ described in the URL above that the URL can be overwritten locally with an HTTPS
 Check the [Development](DEVELOPMENT.md) page for more detail information how to work with this repository, because of
 the mixture with RiseClipse.
 
+## Custom OCL Files
+
+There is a way to add custom OCL Files to the validator, for instance to force company specific rules. In the Docker
+Image there is a volume `/data/ocl` which can be used to add these files, see our compas-deployment project for an
+example how to.
+
+In this directory, you can use subdirectories like `SemanticConstraints` as RiseClipse is doing. And there is a special
+filter that when you create a directory `FileSpecifics`. In this directory you can create for instance a directory `CID`
+to put constraints specific for an SCL File Type. Known types are `SSD`, `IID`, `ICD`, `SCD`, `CID`, `SED`, `ISD`,
+`STD`.
+
+For instance,
+
+```
+data
+└── ocl
+    ├── FileSpecifics
+    │         └── CID
+    │             └── Busbar.ocl
+    └── SemanticConstraints
+        └── Busbar.ocl
+```
+
+If you are using the validator are library (using JAR Files) there is a property to configure the directory, see
+[Common Environment variables](#common-environment-variables)
+
+## NSDoc Files
+
+Because NSDoc File can't be distributed in an OpenSource Project these need to be added during deployment. In the Docker
+Image there is a volume `/data/nsdoc` which can be used to add these files, see our compas-deployment project for an
+example how to.
+
+Only direct files found in this directory will be processed. Invalid NSDoc Files will be ignored. A directory can look
+like this for instance,
+
+```
+data
+└── nsdoc
+    ├── IEC_61850-7-2_2007B3-en.nsdoc
+    ├── IEC_61850-7-3_2007B3-en.nsdoc
+    └── IEC_61850-7-4_2007B3-en.nsdoc
+    
+```
+
+If you are using the validator are library (using JAR Files) there is a property to configure the directory, see
+[Common Environment variables](#common-environment-variables)
+
 ## Common Environment variables
 
 Below environment variable(s) can be used to configure the validator.
 
-| Environment variable                  | Java Property                         | Description                                       | Example   |
-|---------------------------------------|---------------------------------------|---------------------------------------------------|-----------|
-| COMPAS_VALIDATOR_OCL_CUSTOM_DIRECTORY | compas.validator.ocl.custom.directory | Reference to a directory to load custom OCL Files | /data/ocl |
+| Environment variable                  | Java Property                         | Description                                                 | Example     |
+|---------------------------------------|---------------------------------------|-------------------------------------------------------------|-------------|
+| COMPAS_VALIDATOR_OCL_CUSTOM_DIRECTORY | compas.validator.ocl.custom.directory | Reference to a directory to load custom OCL Files           | /data/ocl   |
+| COMPAS_VALIDATOR_NSDOC_DIRECTORY      | compas.validator.nsdoc.directory      | Reference to a directory where the NSDoc Files can be found | /data/nsdoc | 
 
 ## Security
 

app/pom.xml

@@ -22,11 +22,6 @@ SPDX-License-Identifier: Apache-2.0
         <quarkus.container-image.name>compas-scl-validator</quarkus.container-image.name>
     </properties>
 
-    <dependencyManagement>
-        <dependencies>
-        </dependencies>
-    </dependencyManagement>
-
     <dependencies>
         <dependency>
             <groupId>org.lfenergy.compas.scl.validator</groupId>

app/src/main/docker/Dockerfile.jvm

@@ -49,10 +49,12 @@ COPY --chown=1001 target/quarkus-app/app/ /deployments/app/
 COPY --chown=1001 target/quarkus-app/quarkus/ /deployments/quarkus/
 
 RUN mkdir -p /data/ocl \
+    && mkdir -p /data/nsdoc \
     && mkdir -p /data/temp \
     && chown -R 1001 /data \
     && chmod -R "g+rwX" /data
 VOLUME /data/ocl
+VOLUME /data/nsdoc
 
 EXPOSE 8080
 USER 1001

app/src/main/docker/Dockerfile.native

@@ -22,10 +22,12 @@ RUN chown 1001 /work \
 COPY --chown=1001:root target/*-runner /work/application
 
 RUN mkdir -p /data/ocl \
+    && mkdir -p /data/nsdoc \
     && mkdir -p /data/temp \
     && chown -R 1001 /data \
     && chmod -R "g+rwX" /data
 VOLUME /data/ocl
+VOLUME /data/nsdoc
 
 EXPOSE 8080
 USER 1001

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

@@ -3,10 +3,12 @@
 // SPDX-License-Identifier: Apache-2.0
 package org.lfenergy.compas.scl.validator.rest;
 
+import io.quarkus.runtime.Startup;
 import org.lfenergy.compas.core.commons.ElementConverter;
 import org.lfenergy.compas.scl.validator.xsd.SclXsdValidator;
 import org.lfenergy.compas.scl.validator.collector.CompasOclFileCollector;
 import org.lfenergy.compas.scl.validator.collector.OclFileCollector;
+import org.lfenergy.compas.scl.validator.common.NsdocFinder;
 import org.lfenergy.compas.scl.validator.impl.SclRiseClipseValidator;
 
 import javax.enterprise.context.ApplicationScoped;
@@ -40,4 +42,10 @@ public SclRiseClipseValidator createSclRiseClipseValidator(OclFileCollector oclF
     public SclXsdValidator createSclXsdValidator() {
         return new SclXsdValidator();
     }
+
+    @Startup
+    @ApplicationScoped
+    public NsdocFinder createNsdocFinder(ValidatorProperties properties) {
+        return new NsdocFinder(properties.nsdocDirectory());
+    }
 }

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

@@ -9,4 +9,5 @@ public final class SclResourceConstants {
     }
 
     public static final String TYPE_PATH_PARAM = "type";
+    public static final String ID_PARAM = "id";
 }

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

@@ -13,6 +13,9 @@ public interface ValidatorProperties {
     @WithName("ocl.custom.directory")
     String oclCustomDirectory();
 
+    @WithName("nsdoc.directory")
+    String nsdocDirectory();
+
     @WithName("temp.directory")
     Path tempDirectory();
 }

app/src/main/java/org/lfenergy/compas/scl/validator/rest/exception/NsdocNotFoundExceptionHandler.java

@@ -0,0 +1,21 @@
+// SPDX-FileCopyrightText: 2021 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.rest.exception;
+
+import org.lfenergy.compas.core.jaxrs.model.ErrorResponse;
+import org.lfenergy.compas.scl.validator.exception.NsdocFileNotFoundException;
+
+import javax.ws.rs.core.Response;
+import javax.ws.rs.ext.ExceptionMapper;
+import javax.ws.rs.ext.Provider;
+
+@Provider
+public class NsdocNotFoundExceptionHandler implements ExceptionMapper<NsdocFileNotFoundException> {
+    @Override
+    public Response toResponse(NsdocFileNotFoundException exception) {
+        var response = new ErrorResponse();
+        response.addErrorMessage(exception.getErrorCode(), exception.getMessage());
+        return Response.status(Response.Status.NOT_FOUND).entity(response).build();
+    }
+}