Fix bug in RegistryIntegration where AAS/SM are still added to Reposi…

…tories when the registration fails (#503)

* test: add AasEnvironment component test using the registry integ. features

* fix: RegistryIntegragation: when add descriptor fails, nothing is added to repo

basyx.aasenvironment/basyx.aasenvironment.component/src/test/java/org/eclipse/digitaltwin/basyx/aasenvironment/component/TestEnvironmentWithRegistryIntegration.java

@@ -0,0 +1,112 @@
+/*******************************************************************************
+ * Copyright (C) 2024 the Eclipse BaSyx Authors
+ * 
+ * Permission is hereby granted, free of charge, to any person obtaining
+ * a copy of this software and associated documentation files (the
+ * "Software"), to deal in the Software without restriction, including
+ * without limitation the rights to use, copy, modify, merge, publish,
+ * distribute, sublicense, and/or sell copies of the Software, and to
+ * permit persons to whom the Software is furnished to do so, subject to
+ * the following conditions:
+ * 
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * 
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ * 
+ * SPDX-License-Identifier: MIT
+ ******************************************************************************/
+
+package org.eclipse.digitaltwin.basyx.aasenvironment.component;
+
+import static org.junit.Assert.assertThrows;
+import static org.junit.Assert.assertTrue;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+import org.apache.poi.openxml4j.exceptions.InvalidFormatException;
+import org.eclipse.digitaltwin.aas4j.v3.dataformat.core.DeserializationException;
+import org.eclipse.digitaltwin.basyx.aasenvironment.AasEnvironment;
+import org.eclipse.digitaltwin.basyx.aasenvironment.environmentloader.CompleteEnvironment;
+import org.eclipse.digitaltwin.basyx.aasenvironment.environmentloader.CompleteEnvironment.EnvironmentType;
+import org.eclipse.digitaltwin.basyx.aasrepository.AasRepository;
+import org.eclipse.digitaltwin.basyx.aasrepository.feature.registry.integration.AasRepositoryRegistryLink;
+import org.eclipse.digitaltwin.basyx.core.pagination.PaginationInfo;
+import org.eclipse.digitaltwin.basyx.submodelrepository.SubmodelRepository;
+import org.eclipse.digitaltwin.basyx.submodelrepository.feature.registry.integration.SubmodelRepositoryRegistryLink;
+import org.junit.AfterClass;
+import org.junit.BeforeClass;
+import org.junit.Test;
+import org.springframework.boot.builder.SpringApplicationBuilder;
+import org.springframework.context.ConfigurableApplicationContext;
+import org.springframework.core.io.ClassPathResource;
+
+/**
+ * 
+ * Test the {@link AasEnvironment} with aas and submodel registry integration
+ * features enabled
+ * 
+ * @author mateusmolina
+ */
+public class TestEnvironmentWithRegistryIntegration {
+
+    static final String FAULTY_AAS_PATH = "faulty_aas_reginteg.aasx";
+
+    static ConfigurableApplicationContext appContext;
+
+    static AasEnvironment aasEnvironment;
+    static AasRepositoryRegistryLink aasRepositoryRegistryLink;
+    static SubmodelRepositoryRegistryLink smRepositoryRegistryLink;
+    static AasRepository aasRepository;
+    static SubmodelRepository smRepository;
+
+    @BeforeClass
+    public static void startAASEnvironment() {
+        appContext = new SpringApplicationBuilder(AasEnvironmentComponent.class).profiles("reginteg").run(new String[] {});
+
+        aasEnvironment = appContext.getBean(AasEnvironment.class);
+        aasRepositoryRegistryLink = appContext.getBean(AasRepositoryRegistryLink.class);
+        smRepositoryRegistryLink = appContext.getBean(SubmodelRepositoryRegistryLink.class);
+        aasRepository = appContext.getBean(AasRepository.class);
+        smRepository = appContext.getBean(SubmodelRepository.class);
+
+        assertRepositoriesAreEmpty();
+    }
+
+    @AfterClass
+    public static void stopAASEnvironment() {
+        appContext.close();
+    }
+
+    @AfterClass
+    public static void clearRegistries() throws Exception {
+        smRepositoryRegistryLink.getRegistryApi().deleteAllSubmodelDescriptors();
+        aasRepositoryRegistryLink.getRegistryApi().deleteAllShellDescriptors();
+    }
+
+    @Test
+    public void whenUploadDescriptorToRegistryFails_thenNoAasOrSmAreAddedToRepository() throws InvalidFormatException, DeserializationException, IOException {
+        CompleteEnvironment completeEnvironment = CompleteEnvironment.fromInputStream(getIsFromClasspath(FAULTY_AAS_PATH), EnvironmentType.AASX);
+
+        assertThrows(IllegalArgumentException.class, () -> aasEnvironment.loadEnvironment(completeEnvironment));
+
+        assertRepositoriesAreEmpty();
+    }
+
+    private static InputStream getIsFromClasspath(String fileName) throws IOException {
+        return new ClassPathResource(fileName).getInputStream();
+    }
+
+    private static void assertRepositoriesAreEmpty() {
+        assertTrue(aasRepository.getAllAas(PaginationInfo.NO_LIMIT).getResult().isEmpty());
+        assertTrue(smRepository.getAllSubmodels(PaginationInfo.NO_LIMIT).getResult().isEmpty());
+    }
+
+}

basyx.aasenvironment/basyx.aasenvironment.component/src/test/resources/application-reginteg.properties

@@ -0,0 +1,7 @@
+basyx.aasrepository.feature.registryintegration=http://localhost:8050
+basyx.submodelrepository.feature.registryintegration=http://localhost:8060
+
+basyx.externalurl=http://localhost:8080
+
+# Override for empty environment
+basyx.environment=

basyx.aasrepository/basyx.aasrepository-feature-registry-integration/src/main/java/org/eclipse/digitaltwin/basyx/aasrepository/feature/registry/integration/RegistryIntegrationAasRepository.java

@@ -78,9 +78,9 @@ public AssetAdministrationShell getAas(String shellId) throws ElementDoesNotExis
 
 	@Override
 	public void createAas(AssetAdministrationShell shell) throws CollidingIdentifierException {
-		decorated.createAas(shell);
-
 		integrateAasWithRegistry(shell, aasRepositoryRegistryLink.getAasRepositoryBaseURLs());
+
+		decorated.createAas(shell);
 	}
 
 	@Override

basyx.submodelrepository/basyx.submodelrepository-feature-registry-integration/src/main/java/org/eclipse/digitaltwin/basyx/submodelrepository/feature/registry/integration/RegistryIntegrationSubmodelRepository.java

@@ -91,9 +91,9 @@ public void updateSubmodel(String submodelId, Submodel submodel) throws ElementD
 
 	@Override
 	public void createSubmodel(Submodel submodel) throws CollidingIdentifierException {
-		decorated.createSubmodel(submodel);
-
 		integrateSubmodelWithRegistry(submodel, submodelRepositoryRegistryLink.getSubmodelRepositoryBaseURLs());
+
+		decorated.createSubmodel(submodel);
 	}
 
 	@Override