Merge pull request #257 from eclipse-basyx/release/1.3.1

Release/1.3.1

Author: FrankSchnicke

basyx.components/basyx.components.docker/basyx.components.AASServer/Dockerfile

@@ -1,7 +1,8 @@
 FROM openjdk:11-slim-bullseye
 
-# Install dependency for wait-for-it-env.sh
+# Install dependency for wait-for-it-env.sh & wget for health check
 RUN apt update && apt install -y jq && apt clean
+RUN apt install -y wget
 
 # Copy built jar to image using the jar name specified in the pom.xml (JAR_FILE)
 ARG JAR_FILE
@@ -18,6 +19,7 @@ COPY target/${JAR_FILE} /usr/share/basyxExecutable.jar
 COPY target/lib /usr/share/lib
 COPY src/main/resources/aas.properties /usr/share/config/aas.properties
 COPY src/main/resources/context.properties /usr/share/config/context.properties
+COPY src/main/resources/mqtt.properties /usr/share/config/mqtt.properties
 COPY src/test/resources/dockerMongodb.properties /usr/share/config/mongodb.properties
 
 # Expose the appropriate port. In case of Tomcat, this is 8080.

basyx.components/basyx.components.docker/basyx.components.AASServer/pom.xml

@@ -7,7 +7,7 @@
 	<parent>
 		<groupId>org.eclipse.basyx</groupId>
 		<artifactId>basyx.components.docker</artifactId>
-		<version>1.3.0</version>
+		<version>1.3.1</version>
 	</parent>
 
 	<artifactId>basyx.components.AASServer</artifactId>
@@ -80,14 +80,14 @@
 		<dependency>
 			<groupId>org.mongodb</groupId>
 			<artifactId>mongodb-driver-sync</artifactId>
-			<version>4.8.1</version>
+			<version>4.8.2</version>
 		</dependency>
 
 		<!-- Use Spring Data MongoDB for db data management -->
 		<dependency>
 			<groupId>org.springframework.data</groupId>
 			<artifactId>spring-data-mongodb</artifactId>
-			<version>3.4.6</version>
+			<version>3.4.7</version>
 		</dependency>
 
 		<!-- Adds additional classes of the BaSys SDK for tests -->
@@ -108,7 +108,7 @@
 		<dependency>
 			<groupId>io.moquette</groupId>
 			<artifactId>moquette-broker</artifactId>
-			<version>0.15</version>
+			<version>0.16</version>
 			<scope>test</scope>
 			<exclusions>
 				<exclusion>
@@ -121,14 +121,14 @@
 		<dependency>
 			<groupId>org.eclipse.basyx</groupId>
 			<artifactId>basyx.components.registry</artifactId>
-			<version>1.3.0</version>
+			<version>1.3.1</version>
 			<scope>test</scope>
 		</dependency>
 		<dependency>
 			<groupId>com.tngtech.keycloakmock</groupId>
 			<artifactId>mock</artifactId>
 			<scope>test</scope>
-			<version>0.12.0</version>
+			<version>0.13.0</version>
 		</dependency>
 
 		<dependency>

basyx.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/AASServerComponent.java

@@ -540,7 +540,9 @@ private VABHTTPInterface<?> createAggregatorServlet() {
 
 	private IAASAggregator createAASAggregator() {
 		if (isMongoDBBackend()) {
-			return new MongoDBAASServerComponentFactory(createMongoDbConfiguration(), createAASServerDecoratorList(), registry).create();
+			try (final var ignored = ElevatedCodeAuthentication.enterElevatedCodeAuthenticationArea()) {
+				return new MongoDBAASServerComponentFactory(createMongoDbConfiguration(), createAASServerDecoratorList(), registry).create();
+			}
 		}
 		return new InMemoryAASServerComponentFactory(createAASServerDecoratorList(), registry).create();
 	}

basyx.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAPI.java

@@ -161,6 +161,9 @@ public void setAAS(AssetAdministrationShell aas) {
 		if (replaced == null) {
 			mongoOps.insert(aas, collection);
 		}
+		// Remove mongoDB-specific map attribute from AAS.
+		// mongoOps modify aas on save - thus _id has to be removed here...
+		aas.remove("_id");
 	}
 
 	@Override
@@ -170,7 +173,7 @@ public IAssetAdministrationShell getAAS() {
 		if (aas == null) {
 			throw new ResourceNotFoundException("The AAS " + aasId + " could not be found in the database.");
 		}
-		// Remove mongoDB-specific map attribute from AASDescriptor
+		// Remove mongoDB-specific map attribute from AAS
 		aas.remove("_id");
 		return aas;
 	}

basyx.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBSubmodelAPI.java

@@ -53,6 +53,7 @@
 import org.eclipse.basyx.vab.exception.provider.ResourceNotFoundException;
 import org.eclipse.basyx.vab.modelprovider.VABPathTools;
 import org.eclipse.basyx.vab.modelprovider.api.IModelProvider;
+import org.eclipse.basyx.vab.modelprovider.lambda.VABLambdaProvider;
 import org.eclipse.basyx.vab.modelprovider.map.VABMapProvider;
 import org.eclipse.basyx.vab.protocol.http.connector.HTTPConnectorFactory;
 import org.springframework.data.mongodb.core.MongoOperations;
@@ -205,12 +206,12 @@ public void setSubmodel(Submodel sm) {
 		String id = sm.getIdentification().getId();
 		this.setSubmodelId(id);
 
-		Query hasId = query(where(SMIDPATH).is(smId));
-		Object replaced = mongoOps.findAndReplace(hasId, sm, collection);
+		Submodel replaced = writeSubmodelInDB(sm);
 		if (replaced == null) {
 			mongoOps.insert(sm, collection);
 		}
-
+		// Remove mongoDB-specific map attribute from SM
+		// mongoOps modify sm on save - thus _id has to be removed here...
 		sm.remove("_id");
 	}
 
@@ -249,9 +250,7 @@ public void addSubmodelElement(ISubmodelElement elem) {
 		Submodel sm = (Submodel) getSubmodel();
 		// Add element
 		sm.addSubmodelElement(elem);
-		// Replace db entry
-		Query hasId = query(where(SMIDPATH).is(smId));
-		mongoOps.findAndReplace(hasId, sm, collection);
+		writeSubmodelInDB(sm);
 	}
 
 	private ISubmodelElement getTopLevelSubmodelElement(String idShort) {
@@ -278,9 +277,7 @@ private void deleteTopLevelSubmodelElement(String idShort) {
 		Submodel sm = (Submodel) getSubmodel();
 		// Remove element
 		sm.getSubmodelElements().remove(idShort);
-		// Replace db entry
-		Query hasId = query(where(SMIDPATH).is(smId));
-		mongoOps.findAndReplace(hasId, sm, collection);
+		writeSubmodelInDB(sm);
 	}
 
 	@Override
@@ -298,16 +295,12 @@ private void addNestedSubmodelElement(List<String> idShorts, ISubmodelElement el
 			ISubmodelElement parentElement = getNestedSubmodelElement(sm, idShorts);
 			if (parentElement instanceof SubmodelElementCollection) {
 				((SubmodelElementCollection) parentElement).addSubmodelElement(elem);
-				// Replace db entry
-				Query hasId = query(where(SMIDPATH).is(smId));
-				mongoOps.findAndReplace(hasId, sm, collection);
+				writeSubmodelInDB(sm);
 			}
 		} else {
 			// else => directly add it to the submodel
 			sm.addSubmodelElement(elem);
-			// Replace db entry
-			Query hasId = query(where(SMIDPATH).is(smId));
-			mongoOps.findAndReplace(hasId, sm, collection);
+			writeSubmodelInDB(sm);
 		}
 	}
 
@@ -317,33 +310,20 @@ public Collection<ISubmodelElement> getSubmodelElements() {
 		return sm.getSubmodelElements().values();
 	}
 
-	private void updateTopLevelSubmodelElement(String idShort, Object newValue) {
-		// Get sm from db
-		Submodel sm = (Submodel) getSubmodel();
-		// Unwrap value
-		newValue = unwrapParameter(newValue);
-		// Get and update property value
-		getElementProvider(sm, idShort).setValue(Property.VALUE, newValue);
-		// Replace db entry
-		Query hasId = query(where(SMIDPATH).is(smId));
-		mongoOps.findAndReplace(hasId, sm, collection);
-	}
-
 	@SuppressWarnings("unchecked")
-	private void updateNestedSubmodelElement(List<String> idShorts, Object newValue) {
+	private void updateSubmodelElementInDB(List<String> idShorts, Object newValue) {
 		Submodel sm = (Submodel) getSubmodel();
-
-		// Get parent SM element
 		ISubmodelElement element = getNestedSubmodelElement(sm, idShorts);
 
-		// Update value
-		IModelProvider mapProvider = new VABMapProvider((Map<String, Object>) element);
-		IModelProvider elemProvider = SubmodelElementProvider.getElementProvider(mapProvider);
-		elemProvider.setValue(Property.VALUE, newValue);
+		IModelProvider mapProvider = new VABLambdaProvider((Map<String, Object>) element);
+		SubmodelElementProvider smeProvider = new SubmodelElementProvider(mapProvider);
 
-		// Replace db entry
-		Query hasId = query(where(SMIDPATH).is(smId));
-		mongoOps.findAndReplace(hasId, sm, collection);
+		smeProvider.setValue(Property.VALUE, newValue);
+		ISubmodelElement updatedElement = SubmodelElementFacadeFactory.createSubmodelElement((Map<String, Object>) smeProvider.getValue(""));
+
+		sm.addSubmodelElement(updatedElement);
+
+		writeSubmodelInDB(sm);
 	}
 
 	private Object getTopLevelSubmodelElementValue(String idShort) {
@@ -354,8 +334,8 @@ private Object getTopLevelSubmodelElementValue(String idShort) {
 	@SuppressWarnings("unchecked")
 	private Object getNestedSubmodelElementValue(List<String> idShorts) {
 		ISubmodelElement lastElement = getNestedSubmodelElement(idShorts);
-		IModelProvider mapProvider = new VABMapProvider((Map<String, Object>) lastElement);
-		return SubmodelElementProvider.getElementProvider(mapProvider).getValue("/value");
+		IModelProvider mapProvider = new VABLambdaProvider((Map<String, Object>) lastElement);
+		return new SubmodelElementProvider(mapProvider).getValue("/value");
 	}
 
 	@SuppressWarnings("unchecked")
@@ -373,10 +353,10 @@ protected Object unwrapParameter(Object parameter) {
 	}
 
 	@SuppressWarnings("unchecked")
-	private IModelProvider getElementProvider(Submodel sm, String idShortPath) {
-		ISubmodelElement elem = sm.getSubmodelElement(idShortPath);
+	private static SubmodelElementProvider getElementProvider(Submodel sm, String idShort) {
+		ISubmodelElement elem = sm.getSubmodelElement(idShort);
 		IModelProvider mapProvider = new VABMapProvider((Map<String, Object>) elem);
-		return SubmodelElementProvider.getElementProvider(mapProvider);
+		return new SubmodelElementProvider(mapProvider);
 	}
 
 	private ISubmodelElement getNestedSubmodelElement(Submodel sm, List<String> idShorts) {
@@ -419,9 +399,7 @@ private void deleteNestedSubmodelElement(List<String> idShorts) {
 		// Remove element
 		SubmodelElementCollection coll = (SubmodelElementCollection) parentElement;
 		coll.deleteSubmodelElement(idShorts.get(idShorts.size() - 1));
-		// Replace db entry
-		Query hasId = query(where(SMIDPATH).is(smId));
-		mongoOps.findAndReplace(hasId, sm, collection);
+		writeSubmodelInDB(sm);
 	}
 
 	private Object invokeNestedOperationAsync(List<String> idShorts, Object... params) {
@@ -459,13 +437,20 @@ public void deleteSubmodelElement(String idShortPath) {
 
 	@Override
 	public void updateSubmodelElement(String idShortPath, Object newValue) {
-		if (idShortPath.contains("/")) {
-			String[] splitted = VABPathTools.splitPath(idShortPath);
-			List<String> idShorts = Arrays.asList(splitted);
-			updateNestedSubmodelElement(idShorts, newValue);
-		} else {
-			updateTopLevelSubmodelElement(idShortPath, newValue);
-		}
+		String[] splitted = VABPathTools.splitPath(idShortPath);
+		List<String> idShorts = Arrays.asList(splitted);
+		updateSubmodelElementInDB(idShorts, newValue);
+	}
+
+	/**
+	 * Returns the updated Submodel or null if not found
+	 * 
+	 * @param sm
+	 * @return
+	 */
+	private Submodel writeSubmodelInDB(Submodel sm) {
+		Query hasId = query(where(SMIDPATH).is(smId));
+		return mongoOps.findAndReplace(hasId, sm, collection);
 	}
 
 	@Override
@@ -482,10 +467,7 @@ public Object getSubmodelElementValue(String idShortPath) {
 	@SuppressWarnings("unchecked")
 	@Override
 	public Object invokeOperation(String idShortPath, Object... params) {
-
-		String elementPath = VABPathTools.getParentPath(idShortPath);
-
-		Operation operation = (Operation) SubmodelElementFacadeFactory.createSubmodelElement((Map<String, Object>) getSubmodelElement(elementPath));
+		Operation operation = (Operation) SubmodelElementFacadeFactory.createSubmodelElement((Map<String, Object>) getSubmodelElement(idShortPath));
 		if (!DelegatedInvocationManager.isDelegatingOperation(operation)) {
 			throw new MalformedRequestException("This backend supports only delegating operations.");
 		}

basyx.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mqtt/MqttAASServerFeature.java

@@ -66,6 +66,7 @@ public void initialize() {
 
 	protected MqttConnectOptions createMqttConnectOptions() {
 		MqttConnectOptions options = new MqttConnectOptions();
+		options.setAutomaticReconnect(true);
 		if (!Strings.isNullOrEmpty(mqttConfig.getUser())) {
 			options.setUserName(mqttConfig.getUser());
 			options.setPassword(mqttConfig.getPass().toCharArray());

basyx.components/basyx.components.docker/basyx.components.AASServer/src/main/resources/mqtt.properties

@@ -41,8 +41,6 @@ server=tcp://localhost:1883
 # ##################
 # Whitelist for filtering mqtt events for specific submodels / submodelelements
 
-whitelist.patientTemplate=true
-whitelist.element.patientTemplate.active=true
 # whitelist.element.{mySmIdentifier}.{elementIdShort}=true
 
 # ##################

basyx.components/basyx.components.docker/basyx.components.AASServer/src/test/java/org/eclipse/basyx/regression/AASServer/MqttAASServerSuite.java

@@ -27,7 +27,9 @@
 import static org.junit.Assert.assertEquals;
 import static org.junit.Assert.assertTrue;
 import static org.junit.Assert.fail;
+
 import java.io.IOException;
+
 import org.eclipse.basyx.aas.metamodel.map.AssetAdministrationShell;
 import org.eclipse.basyx.aas.metamodel.map.descriptor.CustomId;
 import org.eclipse.basyx.components.aas.AASServerComponent;
@@ -47,6 +49,7 @@
 import org.junit.AfterClass;
 import org.junit.Before;
 import org.junit.Test;
+
 import io.moquette.broker.Server;
 import io.moquette.broker.config.ClasspathResourceLoader;
 import io.moquette.broker.config.IConfig;
@@ -113,7 +116,7 @@ public void shellLifeCycle() {
 	}
 
 	@Test
-	public void submodelLifeCycle() {
+	public void submodelLifeCycle() throws InterruptedException {
 		IIdentifier shellIdentifierForSubmodel = new CustomId("shellSubmodelId");
 		AssetAdministrationShell shell = createShell(shellIdentifierForSubmodel.getId(), shellIdentifierForSubmodel);
 		manager.createAAS(shell, getURL());
@@ -128,6 +131,8 @@ public void submodelLifeCycle() {
 
 		manager.deleteSubmodel(shellIdentifierForSubmodel, submodelIdentifier);
 
+		waitForPropagation();
+
 		assertTrue(listener.getTopics().stream().anyMatch(t -> t.equals(MqttAASAPIHelper.TOPIC_REMOVESUBMODEL)));
 		assertTrue(listener.getTopics().stream().anyMatch(t -> t.equals(MqttSubmodelAggregatorHelper.TOPIC_DELETESUBMODEL)));
 		try {
@@ -139,6 +144,10 @@ public void submodelLifeCycle() {
 		manager.deleteAAS(shellIdentifierForSubmodel);
 	}
 
+	private void waitForPropagation() throws InterruptedException {
+		Thread.sleep(1000);
+	}
+
 	protected static BaSyxContextConfiguration createBaSyxContextConfiguration() {
 		BaSyxContextConfiguration config = new BaSyxContextConfiguration();
 		config.loadFromResource(BaSyxContextConfiguration.DEFAULT_CONFIG_PATH);