Pull request #2: Feature/validate aasx

Merge in EAR/aas-serializer from feature/validate-aasx to master

* commit '957f83e2913ac699a8979da294e1b3729e35d7f1':
  Modify internal state of AASXDeserializer to be private
  Copy aasx-creation from deserializer-test and call validation on it.
  Implement AASX Validation, set a couple of methods in Deserializer to public
  Add Arno's gh account
  Add basic structure of the aasx-validator

Author: Arno Weiss

README.md

@@ -55,4 +55,4 @@ We always look for contributions, bug reports, feature requests etc. Simply open
 | Jens Müller | Fraunhofer IOSB | [JensMueller2709](https://github.com/JensMueller2709) |  |  |  | x |  |
 | Bastian Rössl | Fraunhofer IOSB-INA | [br-iosb](https://github.com/br-iosb) |  |  |  | x |  |
 | Frank Schnicke | Fraunhofer IESE | [frankschnicke](https://github.com/frankschnicke) |  |  | x |  | x |
-| Arno Weiss | Fraunhofer IWU | []() |  |  |  | x |  |
+| Arno Weiss | Fraunhofer IWU | [alw-iwu](https://github.com/alw-iwu) |  |  |  | x |  |

dataformat-aasx/src/main/java/io/adminshell/aas/v3/dataformat/aasx/AASXDeserializer.java

@@ -58,7 +58,7 @@ public class AASXDeserializer {
     private XmlDeserializer deserializer = new XmlDeserializer();
 
     private AssetAdministrationShellEnvironment environment;
-    private OPCPackage aasxRoot;
+    private final OPCPackage aasxRoot;
 
     public AASXDeserializer(InputStream inputStream) throws InvalidFormatException, IOException {
         aasxRoot = OPCPackage.open(inputStream);
@@ -70,28 +70,27 @@ public AASXDeserializer(XmlDeserializer deserializer, InputStream inputStream) t
     }
 
     public AssetAdministrationShellEnvironment read() throws InvalidFormatException, IOException, DeserializationException {
-
         // If the XML was already parsed return cached environment
         if (environment != null) {
             return environment;
         }
-
         environment = deserializer.read(getXMLResourceString(aasxRoot));
-
         return environment;
     }
 
     /**
      * Return the Content of the xml file in the aasx-package as String
      * 
-     * @param aasxPackage
-     *            - the root package of the AASX
+     * @param aasxPackage - the root package of the AASX
      * @return Content of XML as String
      * @throws InvalidFormatException
      * @throws IOException
      */
-    private String getXMLResourceString(OPCPackage aasxPackage) throws InvalidFormatException, IOException {
+    public String getXMLResourceString() throws InvalidFormatException, IOException {
+        return getXMLResourceString(this.aasxRoot);
+    }
 
+    private String getXMLResourceString(OPCPackage aasxPackage) throws InvalidFormatException, IOException {
         // Get the "/aasx/aasx-origin" Part. It is Relationship source for the
         // XML-Document
         PackagePart originPart = aasxPackage.getPart(PackagingURIHelper.createPartName(AASX_ORIGIN));
@@ -129,11 +128,9 @@ private String getXMLResourceString(OPCPackage aasxPackage) throws InvalidFormat
      * 
      */
     private List<String> parseReferencedFilePathsFromAASX() throws IOException, InvalidFormatException, DeserializationException {
+        read();
 
-        AssetAdministrationShellEnvironment environment = read();
-
-        List<String> paths = new ArrayList<String>();
-
+        List<String> paths = new ArrayList<>();
         for (Submodel sm : environment.getSubmodels()) {
             paths.addAll(parseElements(sm.getSubmodelElements()));
         }
@@ -147,8 +144,7 @@ private List<String> parseReferencedFilePathsFromAASX() throws IOException, Inva
      * @return the Paths from the File elements
      */
     private List<String> parseElements(Collection<SubmodelElement> elements) {
-        List<String> paths = new ArrayList<String>();
-
+        List<String> paths = new ArrayList<>();
         for (SubmodelElement element : elements) {
             if (element instanceof File) {
                 File file = (File) element;
@@ -168,13 +164,10 @@ private List<String> parseElements(Collection<SubmodelElement> elements) {
 
     public List<InMemoryFile> getRelatedFiles() throws InvalidFormatException, IOException, DeserializationException {
         List<String> filePaths = parseReferencedFilePathsFromAASX();
-
         List<InMemoryFile> files = new ArrayList<>();
-
         for (String filePath : filePaths) {
             files.add(readFile(aasxRoot, filePath));
         }
-
         return files;
     }
 

dataformat-aasx/src/main/java/io/adminshell/aas/v3/dataformat/aasx/AASXValidator.java

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.adminshell.aas.v3.dataformat.aasx;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Set;
+
+import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.xml.sax.SAXException;
+
+import io.adminshell.aas.v3.dataformat.xml.XmlSchemaValidator;
+
+/**
+ * Class to validate the XML file inside an AASX-package
+ */
+public class AASXValidator {
+
+    private XmlSchemaValidator xmlValidator;
+    private AASXDeserializer deserializer;
+
+    public AASXValidator(InputStream is) throws SAXException, IOException, InvalidFormatException {
+        this.xmlValidator = new XmlSchemaValidator();
+        this.deserializer = new AASXDeserializer(is);
+    }
+
+    /**
+     * Calls XML-Validator
+     * 
+     * @return Set of Strings containing message on AASX-XML-Validation result
+     * @throws IOException
+     * @throws InvalidFormatException
+     */
+    public Set<String> validateSchema() throws IOException, InvalidFormatException {
+        String file = deserializer.getXMLResourceString();
+        return xmlValidator.validateSchema(file);
+    }
+
+}

dataformat-aasx/src/test/java/io/adminshell/aas/v3/dataformat/aasx/deserialization/ValidationTest.java

@@ -0,0 +1,62 @@
+/*
+ * Copyright (c) 2021 Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e. V.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.adminshell.aas.v3.dataformat.aasx.deserialization;
+
+import static org.junit.Assert.assertEquals;
+import static org.junit.Assert.assertNull;
+
+import io.adminshell.aas.v3.dataformat.DeserializationException;
+import io.adminshell.aas.v3.dataformat.SerializationException;
+import io.adminshell.aas.v3.dataformat.aasx.AASXDeserializer;
+import io.adminshell.aas.v3.dataformat.aasx.AASXSerializer;
+import io.adminshell.aas.v3.dataformat.aasx.AASXValidator;
+import io.adminshell.aas.v3.dataformat.aasx.InMemoryFile;
+import io.adminshell.aas.v3.dataformat.aasx.serialization.AASSimple;
+import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.junit.Rule;
+import org.junit.Test;
+import org.junit.rules.TemporaryFolder;
+import org.xml.sax.SAXException;
+
+import javax.xml.parsers.ParserConfigurationException;
+import java.io.*;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Set;
+
+public class ValidationTest {
+
+    @Rule
+    public TemporaryFolder tempFolder = new TemporaryFolder();
+
+    @Test
+    public void validateXmlInsideAasx() throws SerializationException, IOException, InvalidFormatException, DeserializationException, ParserConfigurationException, SAXException {
+        List<InMemoryFile> fileList = new ArrayList<>();
+        byte[] operationManualContent = { 0, 1, 2, 3, 4 };
+        InMemoryFile inMemoryFile = new InMemoryFile(operationManualContent, "/aasx/OperatingManual.pdf");
+        fileList.add(inMemoryFile);
+
+        File file = tempFolder.newFile("output.aasx");
+
+        new AASXSerializer().write(AASSimple.ENVIRONMENT, fileList, new FileOutputStream(file));
+
+        InputStream in = new FileInputStream(file);
+        AASXValidator v = new AASXValidator(in);
+        Set<String> validationResult = v.validateSchema();
+        System.out.println(validationResult);
+        assertEquals(validationResult.size(),0);
+    }
+}