Some refactoring and added more tests.

Dennis Labordus · Dennis Labordus · commit ee3d1767cc79 · 2022-03-02T12:12:58.000+01:00
Signed-off-by: Dennis Labordus &lt;dennis.labordus@alliander.com&gt;
diff --git a/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/OclFileLoader.java b/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/OclFileLoader.java
@@ -92,9 +92,6 @@ private void logErrorMessage(URI oclUri, List<Diagnostic> errors) {
 
     public void prepareValidator(ComposedEValidator validator) {
         URI uri = URI.createFileURI(oclTempFile.toFile().getAbsolutePath());
-        if (uri == null) {
-            throw new SclValidatorException(PREPARE_OCL_TEMP_FILES_FAILED, "Unable to create URI for temporary file");
-        }
         CompleteOCLEObjectValidator oclValidator = new CompleteOCLEObjectValidator(SclPackage.eINSTANCE, uri);
         validator.addChild(oclValidator);
     }
diff --git a/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/SclRiseClipseValidator.java b/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/impl/SclRiseClipseValidator.java
@@ -19,6 +19,7 @@
 import org.lfenergy.compas.scl.validator.collector.OclFileCollector;
 import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
 import org.lfenergy.compas.scl.validator.model.ValidationError;
+import org.lfenergy.compas.scl.validator.util.OclFileUtil;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -27,7 +28,7 @@
 import java.util.List;
 
 import static org.lfenergy.compas.scl.validator.exception.SclValidatorErrorCode.OCL_MODEL_PACKAGE_NOT_FOUND;
-import static org.lfenergy.compas.scl.validator.impl.MessageUtil.cleanupMessage;
+import static org.lfenergy.compas.scl.validator.util.MessageUtil.cleanupMessage;
 
 public class SclRiseClipseValidator implements SclValidator {
     private static final Logger LOGGER = LoggerFactory.getLogger(SclRiseClipseValidator.class);
diff --git a/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/util/MessageUtil.java b/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/util/MessageUtil.java
@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.validator.impl;
+package org.lfenergy.compas.scl.validator.util;
 
 public class MessageUtil {
     MessageUtil() {
diff --git a/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/util/OclFileUtil.java b/riseclipse/validator-riseclipse/src/main/java/org/lfenergy/compas/scl/validator/util/OclFileUtil.java
@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.validator.impl;
+package org.lfenergy.compas.scl.validator.util;
 
 import org.eclipse.emf.common.util.URI;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
diff --git a/riseclipse/validator-riseclipse/src/test/data/ocl/Busbar.ocl b/riseclipse/validator-riseclipse/src/test/data/ocl/Busbar.ocl
@@ -1,6 +1,8 @@
-// SPDX-FileCopyrightText: 2022 Alliander N.V.
-//
-// SPDX-License-Identifier: Apache-2.0
+/*
+   SPDX-FileCopyrightText: 2022 Alliander N.V.
+
+   SPDX-License-Identifier: Apache-2.0
+*/
 
 /*
 *************************************************************************
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/OclFileLoaderTest.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/OclFileLoaderTest.java
@@ -0,0 +1,89 @@
+// SPDX-FileCopyrightText: 2022 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.impl;
+
+import org.eclipse.emf.common.util.URI;
+import org.eclipse.ocl.pivot.validation.ComposedEValidator;
+import org.eclipse.ocl.xtext.completeocl.validation.CompleteOCLEObjectValidator;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
+import org.mockito.junit.jupiter.MockitoExtension;
+
+import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+import static org.lfenergy.compas.scl.validator.exception.SclValidatorErrorCode.NO_URI_PASSED;
+import static org.lfenergy.compas.scl.validator.util.TestSupportUtil.createSclOcl;
+import static org.mockito.Mockito.*;
+
+@ExtendWith(MockitoExtension.class)
+class OclFileLoaderTest {
+    private OclFileLoader loader;
+    private Path tempFile;
+
+    @BeforeEach
+    void setup() throws IOException {
+        var tempDirectory = "./target/data/temp";
+        var tempDirectoryPath = Path.of(tempDirectory);
+        loader = new OclFileLoader(createSclOcl(), tempDirectoryPath);
+        tempFile = Files.walk(tempDirectoryPath)
+                .filter(path -> path.toString().contains(File.separator + "allConstraints"))
+                .findFirst()
+                .orElseThrow();
+    }
+
+    @Test
+    void addOCLDocument_WhenCalledWithNull_ThenExceptionThrown() throws IOException {
+        var exception = assertThrows(SclValidatorException.class,
+                () -> loader.addOCLDocument(null));
+
+        assertEquals(NO_URI_PASSED, exception.getErrorCode());
+    }
+
+    @Test
+    void addOCLDocument_WhenCalledWithValidOcl_ThenOclFileIsAddedToTempFile() throws IOException {
+        var oclFile = findOCL("example.ocl");
+
+        loader.addOCLDocument(oclFile);
+
+        assertEquals(1, Files.lines(tempFile).count());
+    }
+
+    @Test
+    void addOCLDocument_WhenCalledWithInvalidOcl_ThenOclFileIsNotAddedToTempFile() throws IOException {
+        var oclFile = findOCL("invalid.ocl");
+
+        loader.addOCLDocument(oclFile);
+
+        assertEquals(0, Files.lines(tempFile).count());
+    }
+
+    @Test
+    void prepareValidator_whenCalledWithValidator_ThenValidatorIsAdded() {
+        var validator = mock(ComposedEValidator.class);
+        loader.prepareValidator(validator);
+
+        verify(validator, times(1)).addChild(any(CompleteOCLEObjectValidator.class));
+    }
+
+    @AfterEach
+    void cleanup() {
+        loader.cleanup();
+    }
+
+    private URI findOCL(String filename) {
+        var url = getClass().getResource("/ocl/" + filename);
+        if (url != null) {
+            return URI.createFileURI(url.getPath());
+        }
+        throw new NullPointerException("File /ocl/" + filename + " not found!");
+    }
+}
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/SclModelLoaderTest.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/SclModelLoaderTest.java
@@ -0,0 +1,43 @@
+// SPDX-FileCopyrightText: 2022 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.impl;
+
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.lfenergy.compas.scl.validator.exception.SclValidatorException;
+
+import java.io.IOException;
+
+import static org.junit.jupiter.api.Assertions.*;
+import static org.lfenergy.compas.scl.validator.exception.SclValidatorErrorCode.LOADING_SCL_FILE_ERROR_CODE;
+import static org.lfenergy.compas.scl.validator.util.TestSupportUtil.createSclOcl;
+import static org.lfenergy.compas.scl.validator.util.TestSupportUtil.readSCL;
+
+class SclModelLoaderTest {
+    private SclModelLoader loader;
+
+    @BeforeEach
+    void setup() {
+        loader = new SclModelLoader(createSclOcl());
+    }
+
+    @Test
+    void load_WhenCalledWithValidSCXML_ThenResourceLoaded() throws IOException {
+        var sclData = readSCL("example.scd");
+
+        var result = loader.load(sclData);
+
+        assertNotNull(result);
+    }
+
+    @Test
+    void load_WhenCalledWithInvalidSCXML_ThenExceptionThrown() throws IOException {
+        var sclData = readSCL("invalid.scd");
+
+        var exception = assertThrows(SclValidatorException.class,
+                () -> loader.load(sclData));
+
+        assertEquals(LOADING_SCL_FILE_ERROR_CODE, exception.getErrorCode());
+    }
+}
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/SclRiseClipseValidatorTest.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/impl/SclRiseClipseValidatorTest.java
@@ -5,18 +5,16 @@
 
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
-import org.junit.jupiter.api.extension.ExtendWith;
 import org.lfenergy.compas.scl.extensions.model.SclFileType;
 import org.lfenergy.compas.scl.validator.collector.CompasOclFileCollector;
-import org.mockito.junit.jupiter.MockitoExtension;
 
 import java.io.IOException;
 import java.nio.file.Path;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
 import static org.junit.jupiter.api.Assertions.assertNotNull;
+import static org.lfenergy.compas.scl.validator.util.TestSupportUtil.readSCL;
 
-@ExtendWith(MockitoExtension.class)
 class SclRiseClipseValidatorTest {
     private SclRiseClipseValidator sclValidator;
 
@@ -29,18 +27,11 @@ public void setup() {
     @Test
     void validate_WhenCalled_ThenEmptyListReturned() throws IOException {
         var type = SclFileType.CID;
-        var sclData = readSCL();
+        var sclData = readSCL("example.scd");
 
         var result = sclValidator.validate(type, sclData);
 
         assertNotNull(result);
         assertEquals(15, result.size());
     }
-
-    private String readSCL() throws IOException {
-        var inputStream = getClass().getResourceAsStream("/scl/scl_test_file.scd");
-        assert inputStream != null;
-
-        return new String(inputStream.readAllBytes());
-    }
 }
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/MessageUtilTest.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/MessageUtilTest.java
@@ -1,12 +1,12 @@
 // SPDX-FileCopyrightText: 2022 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.validator.impl;
+package org.lfenergy.compas.scl.validator.util;
 
 import org.junit.jupiter.api.Test;
 
 import static org.junit.jupiter.api.Assertions.*;
-import static org.lfenergy.compas.scl.validator.impl.MessageUtil.cleanupMessage;
+import static org.lfenergy.compas.scl.validator.util.MessageUtil.cleanupMessage;
 
 class MessageUtilTest {
     @Test
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/OclFileUtilTest.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/OclFileUtilTest.java
@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2022 Alliander N.V.
 //
 // SPDX-License-Identifier: Apache-2.0
-package org.lfenergy.compas.scl.validator.impl;
+package org.lfenergy.compas.scl.validator.util;
 
 import org.eclipse.emf.common.util.URI;
 import org.junit.jupiter.api.Test;
diff --git a/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/TestSupportUtil.java b/riseclipse/validator-riseclipse/src/test/java/org/lfenergy/compas/scl/validator/util/TestSupportUtil.java
@@ -0,0 +1,31 @@
+// SPDX-FileCopyrightText: 2022 Alliander N.V.
+//
+// SPDX-License-Identifier: Apache-2.0
+package org.lfenergy.compas.scl.validator.util;
+
+import fr.centralesupelec.edf.riseclipse.iec61850.scl.SclPackage;
+import org.eclipse.emf.ecore.impl.EPackageRegistryImpl;
+import org.eclipse.ocl.pivot.utilities.OCL;
+
+import java.io.IOException;
+
+public final class TestSupportUtil {
+    TestSupportUtil() {
+        throw new UnsupportedOperationException("FileTestUtil class");
+    }
+
+    public static String readSCL(String filename) throws IOException {
+        var inputStream = TestSupportUtil.class.getResourceAsStream("/scl/" + filename);
+        assert inputStream != null;
+
+        return new String(inputStream.readAllBytes());
+    }
+
+    public static OCL createSclOcl() {
+        // Create an EPackage.Registry for the SclPackage.
+        var registry = new EPackageRegistryImpl();
+        registry.put(SclPackage.eNS_URI, SclPackage.eINSTANCE);
+        // Create an OCL that creates a ResourceSet using the minimal EPackage.Registry
+        return OCL.newInstance(registry);
+    }
+}
diff --git a/riseclipse/validator-riseclipse/src/test/resources/ocl/example.ocl b/riseclipse/validator-riseclipse/src/test/resources/ocl/example.ocl
@@ -0,0 +1,42 @@
+/*
+   SPDX-FileCopyrightText: 2022 Alliander N.V.
+
+   SPDX-License-Identifier: Apache-2.0
+*/
+
+/*
+*************************************************************************
+**  Copyright (c) 2016-2021 CentraleSupélec & EDF.
+**  All rights reserved. This program and the accompanying materials
+**  are made available under the terms of the Eclipse Public License v2.0
+**  which accompanies this distribution, and is available at
+**  https://www.eclipse.org/legal/epl-v20.html
+** 
+**  This file is part of the RiseClipse tool
+**  
+**  Contributors:
+**      Computer Science Department, CentraleSupélec
+**      EDF R&D
+**  Contacts:
+**      dominique.marcadet@centralesupelec.fr
+**      aurelie.dehouck-neveu@edf.fr
+**  Web site:
+**      https://riseclipse.github.io/
+*************************************************************************
+*/
+
+import scl: 'http://www.iec.ch/61850/2003/SCL'
+
+package scl
+
+context Bay
+-- extends EquipmentContainer
+
+    -- The name attribute is verified in Naming.ocl
+    inv Busbar_nothing
+    :
+        true
+
+
+endpackage
+
diff --git a/riseclipse/validator-riseclipse/src/test/resources/ocl/invalid.ocl b/riseclipse/validator-riseclipse/src/test/resources/ocl/invalid.ocl
@@ -0,0 +1,42 @@
+/*
+   SPDX-FileCopyrightText: 2022 Alliander N.V.
+
+   SPDX-License-Identifier: Apache-2.0
+*/
+
+/*
+*************************************************************************
+**  Copyright (c) 2016-2021 CentraleSupélec & EDF.
+**  All rights reserved. This program and the accompanying materials
+**  are made available under the terms of the Eclipse Public License v2.0
+**  which accompanies this distribution, and is available at
+**  https://www.eclipse.org/legal/epl-v20.html
+** 
+**  This file is part of the RiseClipse tool
+**  
+**  Contributors:
+**      Computer Science Department, CentraleSupélec
+**      EDF R&D
+**  Contacts:
+**      dominique.marcadet@centralesupelec.fr
+**      aurelie.dehouck-neveu@edf.fr
+**  Web site:
+**      https://riseclipse.github.io/
+*************************************************************************
+*/
+
+import scl: 'http://www.iec.ch/61850/2003/SCL'
+
+package scl
+
+context Bay
+-- extends EquipmentContainer
+
+    -- The name attribute is verified in Naming.ocl
+    inv Busbar_nothing
+    :
+        true
+
+
+endpackage_invalid
+
diff --git a/riseclipse/validator-riseclipse/src/test/resources/scl/example.scd b/riseclipse/validator-riseclipse/src/test/resources/scl/example.scd
diff --git a/riseclipse/validator-riseclipse/src/test/resources/scl/invalid.scd b/riseclipse/validator-riseclipse/src/test/resources/scl/invalid.scd
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!-- SPDX-FileCopyrightText: 2020 RTE FRANCE -->
+<!-- -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<SCL xmlns="http://www.iec.ch/61850/2003/SCL" version="2007"
+     revision="B" release="4">
+    <Header id="f9283708-bf4f-412c-a1d6-f947b9ac3000" version="1.0.0" revision="Revision" toolID="toolID"
+            nameStructure="IEDName">
+    </Headers>
+</SCL>
diff --git a/validator/src/main/java/org/lfenergy/compas/scl/validator/exception/SclValidatorErrorCode.java b/validator/src/main/java/org/lfenergy/compas/scl/validator/exception/SclValidatorErrorCode.java
@@ -17,7 +17,6 @@ public class SclValidatorErrorCode {
     public static final String CREATE_OCL_TEMP_FILES_FAILED = "SVS-2001";
     public static final String CREATE_OCL_TEMP_DIR_FAILED = "SVS-2002";
     public static final String WRITE_TO_OCL_TEMP_FILES_FAILED = "SVS-2003";
-    public static final String PREPARE_OCL_TEMP_FILES_FAILED = "SVS-2004";
     public static final String OCL_MODEL_PACKAGE_NOT_FOUND = "SVS-2005";
     public static final String NO_URI_PASSED = "SVS-2006";
 }

Original file line number	Diff line number	Diff line change
`@@ -92,9 +92,6 @@ private void logErrorMessage(URI oclUri, List<Diagnostic> errors) {`
`92`	`92`
`93`	`93`	`public void prepareValidator(ComposedEValidator validator) {`
`94`	`94`	`URI uri = URI.createFileURI(oclTempFile.toFile().getAbsolutePath());`
`95`		`- if (uri == null) {`
`96`		`- throw new SclValidatorException(PREPARE_OCL_TEMP_FILES_FAILED, "Unable to create URI for temporary file");`
`97`		`- }`
`98`	`95`	`CompleteOCLEObjectValidator oclValidator = new CompleteOCLEObjectValidator(SclPackage.eINSTANCE, uri);`
`99`	`96`	`validator.addChild(oclValidator);`
`100`	`97`	`}`