feat: smservice: add general CrudSubmodelService and adapt -backend-mongodb to use it

Author: MateusMolina

basyx.submodelservice/basyx.submodelservice-backend-mongodb/pom.xml

@@ -48,5 +48,10 @@
 			<groupId>org.springframework.boot</groupId>
 			<artifactId>spring-boot-starter</artifactId>
 		</dependency>
+		<dependency>
+			<groupId>org.springframework.boot</groupId>
+			<artifactId>spring-boot-starter-test</artifactId>
+			<scope>test</scope>
+		</dependency>
 	</dependencies>
 </project>

basyx.submodelservice/basyx.submodelservice-backend-mongodb/src/main/java/org/eclipse/digitaltwin/basyx/submodelservice/backend/MongoDBSubmodelServiceFactory.java

@@ -0,0 +1,12 @@
+package org.eclipse.digitaltwin.basyx.submodelservice;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication(scanBasePackages = "org.eclipse.digitaltwin.basyx")
+public class DummyMongoDbSubmodelServiceComponent {
+ 
+    public static void main(String[] args) {
+        SpringApplication.run(DummyMongoDbSubmodelServiceComponent.class, args);
+    }
+}

basyx.submodelservice/basyx.submodelservice-backend-mongodb/src/main/java/org/eclipse/digitaltwin/basyx/submodelservice/backend/SingleSubmodelMongoDBBackendProvider.java

@@ -27,41 +27,46 @@
 package org.eclipse.digitaltwin.basyx.submodelservice;
 
 import org.eclipse.digitaltwin.aas4j.v3.model.Submodel;
-import org.eclipse.digitaltwin.basyx.common.mongocore.BasyxMongoMappingContext;
 import org.eclipse.digitaltwin.basyx.common.mongocore.MongoDBUtilities;
 import org.eclipse.digitaltwin.basyx.core.exceptions.FeatureNotSupportedException;
 import org.eclipse.digitaltwin.basyx.core.filerepository.FileRepository;
-import org.eclipse.digitaltwin.basyx.core.filerepository.MongoDBFileRepository;
-import org.junit.After;
+import org.junit.Before;
 import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.context.SpringBootTest;
 import org.springframework.data.mongodb.core.MongoTemplate;
-import org.springframework.data.mongodb.gridfs.GridFsTemplate;
-
-import com.mongodb.client.MongoClient;
-import com.mongodb.client.MongoClients;
+import org.springframework.test.context.junit4.SpringRunner;
 
 /**
  * Test for mongoDb submodel service backend
  * 
  * @author zhangzai, mateusmolina
  *
  */
+@SpringBootTest
+@RunWith(SpringRunner.class)
 public class TestMongoDBSubmodelService extends SubmodelServiceSuite {
-	private final String COLLECTION = "submodelTestCollection";
-	private final String CONNECTION_URL = "mongodb://mongoAdmin:mongoPassword@localhost:27017";
-	private final MongoClient CLIENT = MongoClients.create(CONNECTION_URL);
-	private final MongoTemplate TEMPLATE = new MongoTemplate(CLIENT, "BaSyxTestDb");
-	private final GridFsTemplate GRIDFS_TEMPLATE = new GridFsTemplate(TEMPLATE.getMongoDatabaseFactory(), TEMPLATE.getConverter());
-	private FileRepository fileRepository = new MongoDBFileRepository(GRIDFS_TEMPLATE);
 
-	@After
+	static final String TEST_COLLECTION = "submodelServiceTestCollection";
+
+	@Autowired
+	private FileRepository fileRepository;
+
+	@Autowired
+	private SubmodelServiceFactory submodelServiceFactory;
+
+	@Autowired
+	private MongoTemplate mongoTemplate;
+
+	@Before
 	public void clear() {
-		MongoDBUtilities.clearCollection(TEMPLATE, COLLECTION);
+		MongoDBUtilities.clearCollection(mongoTemplate, TEST_COLLECTION);
 	}
 
 	@Override
 	protected SubmodelService getSubmodelService(Submodel submodel) {
-		return null; // todo temp
+		return submodelServiceFactory.create(submodel);
 	}
 
 	@Override

basyx.submodelservice/basyx.submodelservice-backend-mongodb/src/test/java/org/eclipse/digitaltwin/basyx/submodelservice/DummyMongoDbSubmodelServiceComponent.java

@@ -0,0 +1,10 @@
+basyx.backend = MongoDB
+
+basyx.submodelservice.mongodb.collectionName= submodelServiceTestCollection
+
+spring.data.mongodb.host=127.0.0.1
+spring.data.mongodb.port=27017
+spring.data.mongodb.database=aas-env
+spring.data.mongodb.authentication-database=admin
+spring.data.mongodb.username=mongoAdmin
+spring.data.mongodb.password=mongoPassword

basyx.submodelservice/basyx.submodelservice-backend-mongodb/src/test/java/org/eclipse/digitaltwin/basyx/submodelservice/TestMongoDBSubmodelService.java

@@ -9,6 +9,7 @@
 import org.eclipse.digitaltwin.aas4j.v3.model.SubmodelElement;
 import org.eclipse.digitaltwin.basyx.core.exceptions.ElementDoesNotExistException;
 import org.eclipse.digitaltwin.basyx.core.exceptions.ElementNotAFileException;
+import org.eclipse.digitaltwin.basyx.core.exceptions.FeatureNotSupportedException;
 import org.eclipse.digitaltwin.basyx.core.exceptions.FileDoesNotExistException;
 import org.eclipse.digitaltwin.basyx.core.pagination.CursorResult;
 import org.eclipse.digitaltwin.basyx.core.pagination.PaginationInfo;
@@ -64,11 +65,15 @@ public void createSubmodelElement(String idShortPath, SubmodelElement submodelEl
 
     @Override
     public void updateSubmodelElement(String idShortPath, SubmodelElement submodelElement) throws ElementDoesNotExistException {
+        deleteAssociatedFileIfAny(idShortPath);
+
         backend.updateSubmodelElement(submodelId, idShortPath, submodelElement);
     }
 
     @Override
     public void deleteSubmodelElement(String idShortPath) throws ElementDoesNotExistException {
+        deleteAssociatedFileIfAny(idShortPath);
+
         backend.deleteSubmodelElement(submodelId, idShortPath);
     }
 
@@ -79,7 +84,7 @@ public void patchSubmodelElements(List<SubmodelElement> submodelElementList) {
 
     @Override
     public OperationVariable[] invokeOperation(String idShortPath, OperationVariable[] input) throws ElementDoesNotExistException {
-        throw new UnsupportedOperationException("Unimplemented method 'invokeOperation'");
+        throw new FeatureNotSupportedException("Unimplemented method 'invokeOperation'");
     }
 
     @Override
@@ -106,4 +111,11 @@ public InputStream getFileByFilePath(String filePath) {
     private void hostSubmodel(Submodel submodel) {
         this.backend.save(submodel);
     }
+
+    private void deleteAssociatedFileIfAny(String idShortPath) {
+        try {
+            backend.deleteFileValue(submodelId, idShortPath);
+        } catch (Exception e) {
+        }
+    }
 }

basyx.submodelservice/basyx.submodelservice-backend-mongodb/src/test/resources/application.properties

@@ -3,11 +3,13 @@
 import org.eclipse.digitaltwin.aas4j.v3.model.Submodel;
 import org.eclipse.digitaltwin.basyx.submodelservice.SubmodelService;
 import org.eclipse.digitaltwin.basyx.submodelservice.SubmodelServiceFactory;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
 import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.stereotype.Component;
 
 @Component
 @ConditionalOnExpression("!T(org.springframework.util.StringUtils).isEmpty('${basyx.backend:}')")
+@ConditionalOnBean(SingleSubmodelBackend.class)
 public class CrudSubmodelServiceFactory implements SubmodelServiceFactory{
 
     private final SingleSubmodelBackend backend;