Refactor Rest Interface, added UUID to entry for retrieval.

Dennis Labordus · Dennis Labordus · commit 8d22c45fae62 · 2022-03-28T13:25:13.000+02:00
Signed-off-by: Dennis Labordus &lt;dennis.labordus@alliander.com&gt;
diff --git a/app/src/main/java/org/lfenergy/compas/scl/validator/rest/SclResourceConstants.java b/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";
 }
diff --git a/app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResource.java b/app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResource.java
@@ -4,17 +4,15 @@
 package org.lfenergy.compas.scl.validator.rest.v1;
 
 import io.quarkus.security.Authenticated;
-import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocGetRequest;
 import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocListResponse;
 import org.lfenergy.compas.scl.validator.service.NsdocService;
 
 import javax.enterprise.context.RequestScoped;
-import javax.validation.Valid;
-import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
-import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
+import javax.ws.rs.*;
 import javax.ws.rs.core.MediaType;
+import java.util.UUID;
+
+import static org.lfenergy.compas.scl.validator.rest.SclResourceConstants.ID_PARAM;
 
 @Authenticated
 @RequestScoped
@@ -27,7 +25,6 @@ public NsdocResource(NsdocService nsdocService) {
     }
 
     @GET
-    @Path("list")
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
     public NsdocListResponse list() {
@@ -37,10 +34,10 @@ public NsdocListResponse list() {
     }
 
     @GET
-    @Path("get")
+    @Path("{" + ID_PARAM + "}")
     @Consumes(MediaType.APPLICATION_XML)
     @Produces(MediaType.APPLICATION_XML)
-    public String get(@Valid NsdocGetRequest request) {
-        return nsdocService.get(request.getId());
+    public String get(@PathParam(ID_PARAM) UUID id) {
+        return nsdocService.get(id);
     }
 }
diff --git a/app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/model/NsdocGetRequest.java b/app/src/main/java/org/lfenergy/compas/scl/validator/rest/v1/model/NsdocGetRequest.java
diff --git a/app/src/test/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResourceTest.java b/app/src/test/java/org/lfenergy/compas/scl/validator/rest/v1/NsdocResourceTest.java
@@ -13,16 +13,17 @@
 import org.lfenergy.compas.scl.validator.exception.NsdocFileNotFoundException;
 import org.lfenergy.compas.scl.validator.exception.SclValidatorErrorCode;
 import org.lfenergy.compas.scl.validator.model.NsdocFile;
-import org.lfenergy.compas.scl.validator.rest.v1.model.NsdocGetRequest;
 import org.lfenergy.compas.scl.validator.service.NsdocService;
 
 import java.util.List;
+import java.util.UUID;
 
 import static io.restassured.RestAssured.given;
 import static io.restassured.path.xml.config.XmlPathConfig.xmlPathConfig;
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
 import static org.lfenergy.compas.scl.validator.SclValidatorConstants.SCL_VALIDATOR_SERVICE_V1_NS_URI;
+import static org.lfenergy.compas.scl.validator.rest.SclResourceConstants.ID_PARAM;
 import static org.mockito.Mockito.*;
 
 @QuarkusTest
@@ -40,7 +41,7 @@ void list_WhenCalled_ThenListReturned() {
         var response = given()
                 .contentType(ContentType.XML)
                 .when()
-                .get("/list")
+                .get()
                 .then()
                 .statusCode(200)
                 .extract()
@@ -56,20 +57,17 @@ void list_WhenCalled_ThenListReturned() {
 
     @Test
     void get_WhenCalled_ThenContentReturned() {
-        String id = "IEC 61850-7-3";
+        UUID id = UUID.randomUUID();
         String result = "<some><xml></xml></some>";
 
-        NsdocGetRequest request = new NsdocGetRequest();
-        request.setId(id);
-
         when(nsdocService.get(id))
                 .thenReturn(result);
 
         var response = given()
+                .pathParam(ID_PARAM, id)
                 .contentType(ContentType.XML)
-                .body(request)
                 .when()
-                .get("/get")
+                .get("/{" + ID_PARAM + "}")
                 .then()
                 .statusCode(200)
                 .extract()
@@ -83,19 +81,16 @@ void get_WhenCalled_ThenContentReturned() {
 
     @Test
     void get_WhenCalledWithUnknownFile_Then404Returned() {
-        String id = "IEC 61850-7-3";
-
-        NsdocGetRequest request = new NsdocGetRequest();
-        request.setId(id);
+        UUID id = UUID.randomUUID();
 
         when(nsdocService.get(id))
                 .thenThrow(new NsdocFileNotFoundException("Some Message"));
 
         var response = given()
+                .pathParam(ID_PARAM, id)
                 .contentType(ContentType.XML)
-                .body(request)
                 .when()
-                .get("/get")
+                .get("/{" + ID_PARAM + "}")
                 .then()
                 .statusCode(404)
                 .extract()
diff --git a/app/src/test/java/org/lfenergy/compas/scl/validator/rest/v1/model/NsdocGetRequestTest.java b/app/src/test/java/org/lfenergy/compas/scl/validator/rest/v1/model/NsdocGetRequestTest.java
diff --git a/service/src/main/java/org/lfenergy/compas/scl/validator/common/NsdocFinder.java b/service/src/main/java/org/lfenergy/compas/scl/validator/common/NsdocFinder.java
@@ -25,14 +25,14 @@ public class NsdocFinder {
     private static final Logger LOGGER = LoggerFactory.getLogger(NsdocFinder.class);
 
     private final String nsdocDirectory;
-    private final Map<String, NsdocFile> nsdocFiles;
+    private final Map<UUID, NsdocFile> nsdocFiles;
 
     public NsdocFinder(String nsdocDirectory) {
         this.nsdocDirectory = nsdocDirectory;
         this.nsdocFiles = getFilesFromDirectory(nsdocDirectory);
     }
 
-    private Map<String, NsdocFile> getFilesFromDirectory(String directoryName) {
+    private Map<UUID, NsdocFile> getFilesFromDirectory(String directoryName) {
         File directory = new File(directoryName);
         if (directory.exists() && directory.isDirectory()) {
             var files = directory.listFiles();
@@ -51,7 +51,8 @@ private NsdocFile convertToNsdocFile(File file) {
         try {
             var nsdocInfo = new NsdocInfo(file);
             var nsdocFile = new NsdocFile();
-            nsdocFile.setId(nsdocInfo.getId());
+            nsdocFile.setId(UUID.randomUUID());
+            nsdocFile.setNsDocId(nsdocInfo.getId());
             nsdocFile.setFilename(file.getName());
             nsdocFile.setChecksum(calculateChecksum(file));
             return nsdocFile;
@@ -73,11 +74,11 @@ private String calculateChecksum(File file) {
     public Collection<NsdocFile> getNsdocFiles() {
         return nsdocFiles.values()
                 .stream()
-                .sorted(Comparator.comparing(NsdocFile::getId))
+                .sorted(Comparator.comparing(NsdocFile::getNsDocId))
                 .collect(Collectors.toList());
     }
 
-    public String getNsdocFile(String id) {
+    public String getNsdocFile(UUID id) {
         try {
             if (nsdocFiles.containsKey(id)) {
                 var nsdocFile = nsdocFiles.get(id);
diff --git a/service/src/main/java/org/lfenergy/compas/scl/validator/common/NsdocInfo.java b/service/src/main/java/org/lfenergy/compas/scl/validator/common/NsdocInfo.java
@@ -5,7 +5,6 @@
 
 import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
 
-import javax.xml.stream.XMLEventReader;
 import javax.xml.stream.XMLInputFactory;
 import javax.xml.stream.XMLStreamException;
 import javax.xml.stream.events.StartElement;
@@ -25,8 +24,8 @@ public class NsdocInfo {
 
     public NsdocInfo(File file) {
         try (var fis = new FileInputStream(file)) {
-            XMLInputFactory xmlInputFactory = XMLInputFactory.newInstance();
-            XMLEventReader reader = xmlInputFactory.createXMLEventReader(fis);
+            var xmlInputFactory = XMLInputFactory.newInstance();
+            var reader = xmlInputFactory.createXMLEventReader(fis);
 
             while (id == null && reader.hasNext()) {
                 processEvent(reader.nextEvent());
diff --git a/service/src/main/java/org/lfenergy/compas/scl/validator/service/NsdocService.java b/service/src/main/java/org/lfenergy/compas/scl/validator/service/NsdocService.java
@@ -9,6 +9,7 @@
 import javax.enterprise.context.ApplicationScoped;
 import javax.inject.Inject;
 import java.util.Collection;
+import java.util.UUID;
 
 @ApplicationScoped
 public class NsdocService {
@@ -23,7 +24,7 @@ public Collection<NsdocFile> list() {
         return nsdocFinder.getNsdocFiles();
     }
 
-    public String get(String id) {
+    public String get(UUID id) {
         return nsdocFinder.getNsdocFile(id);
     }
 }
diff --git a/service/src/test/java/org/lfenergy/compas/scl/validator/common/NsdocInfoTest.java b/service/src/test/java/org/lfenergy/compas/scl/validator/common/NsdocInfoTest.java
@@ -0,0 +1,8 @@
+// SPDX-FileCopyrightText: 2022 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.common;
+
+class NsdocInfoTest {
+
+}
diff --git a/service/src/test/java/org/lfenergy/compas/scl/validator/service/NsdocServiceTest.java b/service/src/test/java/org/lfenergy/compas/scl/validator/service/NsdocServiceTest.java
@@ -12,6 +12,7 @@
 import org.mockito.junit.jupiter.MockitoExtension;
 
 import java.util.List;
+import java.util.UUID;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
@@ -44,7 +45,7 @@ void list_WhenCalled_ThenEmptyListReturned() {
 
     @Test
     void get_WhenCalled_ThenContentReturned() {
-        String id = "IEC 61850-7-3";
+        UUID id = UUID.randomUUID();
         String content = "<some><content/></some>";
 
         when(nsdocFinder.getNsdocFile(id)).thenReturn(content);
diff --git a/service/src/test/resources/nsdoc/invalid.nsdoc b/service/src/test/resources/nsdoc/invalid.nsdoc
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- SPDX-FileCopyrightText: 2022 Alliander -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<NSDoc>
+</NSDoc>
diff --git a/service/src/test/resources/nsdoc/testFile74.nsdoc b/service/src/test/resources/nsdoc/testFile74.nsdoc
@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- SPDX-FileCopyrightText: 2022 Alliander -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<NSDoc id="IEC 61850-7-4"
+       version="1010"
+       revision="X"
+       release="1"
+       lang="en">
+   <Doc id="IEC61850_7_4.LNGroupL::LLN0.cl.title"><![CDATA[Some LN title]]></Doc>
+   <Doc id="IEC61850_7_4.LNGroupL::LLN0.Beh.desc"><![CDATA[Some DO description]]></Doc>
+   <Doc id="IEC61850_7_4.AbstractLNsCommon::DomainLN.Beh.desc"><![CDATA[Some DomainLN Descriptions]]></Doc>
+</NSDoc>
diff --git a/validator/src/main/java/org/lfenergy/compas/scl/validator/model/NsdocFile.java b/validator/src/main/java/org/lfenergy/compas/scl/validator/model/NsdocFile.java
@@ -9,19 +9,28 @@
 import javax.xml.bind.annotation.XmlAccessType;
 import javax.xml.bind.annotation.XmlAccessorType;
 import javax.xml.bind.annotation.XmlElement;
+import java.util.UUID;
 
 import static org.lfenergy.compas.scl.validator.SclValidatorConstants.SCL_VALIDATOR_SERVICE_V1_NS_URI;
 
 @Schema(description = "Information about a single NSDoc file that is known by the service.")
 @XmlAccessorType(XmlAccessType.FIELD)
 public class NsdocFile {
+    @Schema(description = "The technical id of this NSDoc File.",
+            example = "123e4567-e89b-12d3-a456-426614174000")
+    @NotBlank
+    @XmlElement(name = "Id",
+            namespace = SCL_VALIDATOR_SERVICE_V1_NS_URI,
+            required = true)
+    private UUID id;
+
     @Schema(description = "The id of the NSDoc File.",
             example = "IEC 61850-7-3")
     @NotBlank
-    @XmlElement(name = "Id",
+    @XmlElement(name = "NsDocId",
             namespace = SCL_VALIDATOR_SERVICE_V1_NS_URI,
             required = true)
-    private String id;
+    private String nsDocId;
 
     @Schema(description = "The name of the NSDoc File.",
             example = "OfficialFile73.nsdoc")
@@ -38,14 +47,22 @@ public class NsdocFile {
             required = true)
     private String checksum;
 
-    public String getId() {
+    public UUID getId() {
         return id;
     }
 
-    public void setId(String id) {
+    public void setId(UUID id) {
         this.id = id;
     }
 
+    public String getNsDocId() {
+        return nsDocId;
+    }
+
+    public void setNsDocId(String nsDocId) {
+        this.nsDocId = nsDocId;
+    }
+
     public String getFilename() {
         return filename;
     }
diff --git a/validator/src/main/java/org/lfenergy/compas/scl/validator/util/TestSupportUtil.java b/validator/src/main/java/org/lfenergy/compas/scl/validator/util/TestSupportUtil.java
@@ -11,7 +11,11 @@ public final class TestSupportUtil {
     }
 
     public static String readSCL(String filename) throws IOException {
-        var inputStream = TestSupportUtil.class.getResourceAsStream("/scl/" + filename);
+        return readFile("/scl/" + filename);
+    }
+
+    public static String readFile(String filename) throws IOException {
+        var inputStream = TestSupportUtil.class.getResourceAsStream(filename);
         assert inputStream != null;
 
         return new String(inputStream.readAllBytes());
diff --git a/validator/src/test/java/org/lfenergy/compas/scl/validator/util/StaxUtilTest.java b/validator/src/test/java/org/lfenergy/compas/scl/validator/util/StaxUtilTest.java
diff --git a/validator/src/test/resources/testFile74.nsdoc b/validator/src/test/resources/testFile74.nsdoc

Original file line number	Diff line number	Diff line change
`@@ -9,4 +9,5 @@ public final class SclResourceConstants {`
`9`	`9`	`}`
`10`	`10`
`11`	`11`	`public static final String TYPE_PATH_PARAM = "type";`
	`12`	`+ public static final String ID_PARAM = "id";`
`12`	`13`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`import javax.enterprise.context.ApplicationScoped;`
`10`	`10`	`import javax.inject.Inject;`
`11`	`11`	`import java.util.Collection;`
	`12`	`+import java.util.UUID;`
`12`	`13`
`13`	`14`	`@ApplicationScoped`
`14`	`15`	`public class NsdocService {`
`@@ -23,7 +24,7 @@ public Collection<NsdocFile> list() {`
`23`	`24`	`return nsdocFinder.getNsdocFiles();`
`24`	`25`	`}`
`25`	`26`
`26`		`- public String get(String id) {`
	`27`	`+ public String get(UUID id) {`
`27`	`28`	`return nsdocFinder.getNsdocFile(id);`
`28`	`29`	`}`
`29`	`30`	`}`