[4416] Ensure that all tests are running on the same tests data

Bug: #4416 Signed-off-by: Stéphane Bégaudeau <[email protected]>
eclipse-sirius · Jan 17, 2025 · a491c02 · a491c02
1 parent fba825c
commit a491c02
Show file tree

Hide file tree

Showing 148 changed files with 1,725 additions and 1,110 deletions.
diff --git a/CHANGELOG.adoc b/CHANGELOG.adoc
@@ -24,6 +24,10 @@
 
 === Breaking changes
 
+- https://github.com/eclipse-sirius/sirius-web/issues/4416[#4416] [sirius-web] Tests written for Sirius Web should now leverage the brand new annotation `@GivenSiriusWebServer` which will set up all the test data of the server.
+It will allow us to create more complex test data shared by all integration tests to detect additional problems.
+- https://github.com/eclipse-sirius/sirius-web/issues/4416[#4416] [sirius-web] The `IEditingContextMigrationParticipantPredicate` will now use the id of the editing context instead of the whole editing context in order to find out if the migration participant should be activated.
+
 
 === Dependency update
 
@@ -48,6 +52,9 @@ This may have some consequences for downstream applications which are embedding
 See https://github.com/mui/material-ui/issues/15618[this link] for additional details.
 - https://github.com/eclipse-sirius/sirius-web/issues/4360[#4360] [table] Prevent application crash when opening tables from a form
 - https://github.com/eclipse-sirius/sirius-web/issues/4359[#4359] [table] Fix an issue where two pagination forms where display in tables
+- https://github.com/eclipse-sirius/sirius-web/issues/4416[#4416] [sirius-web] Fix the way migration participant were executed.
+Before this contribution, migration participants were executed if the project being opened was a studio.
+Now they are executed for some data if the data was coming from a studio too.
 
 
 === New Features

diff --git a/packages/sirius-web/backend/pom.xml b/packages/sirius-web/backend/pom.xml
@@ -43,6 +43,7 @@
 		<module>sirius-web</module>
 
 		<module>sirius-web-tests</module>
+		<module>sirius-web-tests-data</module>
         <module>sirius-web-e2e-tests</module>
     </modules>
 </project>
diff --git a/.../src/main/java/org/eclipse/sirius/web/application/document/services/UploadFileLoader.java b/.../src/main/java/org/eclipse/sirius/web/application/document/services/UploadFileLoader.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -68,7 +68,7 @@ public UploadFileLoader(IMessageService messageService, IProxyValidator proxyVal
     @Override
     public IResult<Resource> load(ResourceSet resourceSet, IEMFEditingContext emfEditingContext, UploadFile file) {
         var fileName = file.getName();
-        var applyMigrationParticipants = this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(emfEditingContext));
+        var applyMigrationParticipants = this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(emfEditingContext.getId()));
         var optionalContent = this.getContent(resourceSet, file, applyMigrationParticipants);
         if (optionalContent.isPresent()) {
             var content = optionalContent.get();

diff --git a/...java/org/eclipse/sirius/web/application/editingcontext/services/EditingContextLoader.java b/...java/org/eclipse/sirius/web/application/editingcontext/services/EditingContextLoader.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -79,7 +79,7 @@ private void loadSemanticData(EditingContext editingContext, SemanticData semant
         resourceSet.getLoadOptions().put(JsonResource.OPTION_SCHEMA_LOCATION, true);
 
         semanticData.getDocuments().forEach(document -> this.resourceLoader.toResource(resourceSet, document.getId().toString(), document.getName(), document.getContent(),
-                this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(editingContext))));
+                this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(editingContext.getId()))));
 
         // The ECrossReferenceAdapter must be set after the resource loading because it needs to resolve proxies in case
         // of inter-resources references

diff --git a/...us/web/application/editingcontext/services/EditingContextMigrationParticipantHandler.java b/...us/web/application/editingcontext/services/EditingContextMigrationParticipantHandler.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -14,7 +14,6 @@
 
 import java.util.Objects;
 
-import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.web.application.editingcontext.services.api.IEditingContextMigrationParticipantPredicate;
 import org.eclipse.sirius.web.application.studio.services.api.IStudioCapableEditingContextPredicate;
 import org.springframework.stereotype.Service;
@@ -34,7 +33,7 @@ public EditingContextMigrationParticipantHandler(IStudioCapableEditingContextPre
     }
 
     @Override
-    public boolean test(IEditingContext editingContextId) {
+    public boolean test(String editingContextId) {
         return this.studioCapableEditingContextPredicate.test(editingContextId);
     }
 }
diff --git a/...ipse/sirius/web/application/editingcontext/services/EditingContextPersistenceService.java b/...ipse/sirius/web/application/editingcontext/services/EditingContextPersistenceService.java
@@ -76,7 +76,7 @@ public void persist(ICause cause, IEditingContext editingContext) {
         long start = System.currentTimeMillis();
 
         if (editingContext instanceof IEMFEditingContext emfEditingContext) {
-            var applyMigrationParticipants = this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(emfEditingContext));
+            var applyMigrationParticipants = this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(emfEditingContext.getId()));
             new UUIDParser().parse(editingContext.getId())
                     .map(AggregateReference::<Project, UUID>to)
                     .ifPresent(project -> {

diff --git a/...application/editingcontext/services/api/IEditingContextMigrationParticipantPredicate.java b/...application/editingcontext/services/api/IEditingContextMigrationParticipantPredicate.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -14,13 +14,11 @@
 
 import java.util.function.Predicate;
 
-import org.eclipse.sirius.components.core.api.IEditingContext;
-
 /**
  * Used to indicate if the editing context is concern by the migration participants.
  *
  * @author frouene
  */
-public interface IEditingContextMigrationParticipantPredicate extends Predicate<IEditingContext> {
+public interface IEditingContextMigrationParticipantPredicate extends Predicate<String> {
 
 }
diff --git a/...in/java/org/eclipse/sirius/web/application/studio/services/EditingContextInitializer.java b/...in/java/org/eclipse/sirius/web/application/studio/services/EditingContextInitializer.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -96,7 +96,7 @@ public void preProcess(IEditingContext editingContext) {
                 this.studioColorPalettesLoader.loadStudioColorPalettes(resourceSet);
 
                 semanticData.getDocuments().forEach(document -> this.resourceLoader.toResource(resourceSet, document.getId().toString(), document.getName(), document.getContent(),
-                        this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(editingContext))));
+                        this.migrationParticipantPredicates.stream().anyMatch(predicate -> predicate.test(semanticData.getProject().getId().toString()))));
                 resourceSet.eAdapters().add(new EditingContextCrossReferenceAdapter());
 
                 var treeIterator = resourceSet.getAllContents();

diff --git a/...us/web/application/studio/services/HideStudioColorPalettesTreeAlteredContentProvider.java b/...us/web/application/studio/services/HideStudioColorPalettesTreeAlteredContentProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -39,7 +39,7 @@ public HideStudioColorPalettesTreeAlteredContentProvider(IStudioCapableEditingCo
 
     @Override
     public boolean canHandle(IEditingContext editingContext, List<String> activeFilterIds) {
-        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext);
+        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext.getId());
         return isStudio && activeFilterIds.contains(StudioExplorerTreeFilterProvider.HIDE_STUDIO_COLOR_PALETTES_TREE_FILTER_ID);
     }
 

diff --git a/.../eclipse/sirius/web/application/studio/services/StudioCapableEditingContextPredicate.java b/.../eclipse/sirius/web/application/studio/services/StudioCapableEditingContextPredicate.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -14,7 +14,6 @@
 
 import java.util.Objects;
 
-import org.eclipse.sirius.components.core.api.IEditingContext;
 import org.eclipse.sirius.web.application.UUIDParser;
 import org.eclipse.sirius.web.application.studio.services.api.IStudioCapableEditingContextPredicate;
 import org.eclipse.sirius.web.domain.boundedcontexts.project.Nature;
@@ -37,8 +36,8 @@ public StudioCapableEditingContextPredicate(IProjectSearchService projectSearchS
     }
 
     @Override
-    public boolean test(IEditingContext editingContext) {
-        return new UUIDParser().parse(editingContext.getId())
+    public boolean test(String editingContextId) {
+        return new UUIDParser().parse(editingContextId)
                 .flatMap(this.projectSearchService::findById)
                 .filter(this::isStudio)
                 .isPresent();

diff --git a/...rg/eclipse/sirius/web/application/studio/services/StudioEditingContextActionProvider.java b/...rg/eclipse/sirius/web/application/studio/services/StudioEditingContextActionProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -50,7 +50,7 @@ public StudioEditingContextActionProvider(IStudioCapableEditingContextPredicate
     public List<EditingContextAction> getEditingContextAction(IEditingContext editingContext) {
         var actions = new ArrayList<EditingContextAction>();
 
-        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext);
+        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext.getId());
         if (isStudio && editingContext instanceof IEMFEditingContext emfEditingContext) {
             var nsURIs = emfEditingContext.getDomain().getResourceSet().getPackageRegistry().values()
                     .stream()

diff --git a/...a/org/eclipse/sirius/web/application/studio/services/StudioEditingContextInitializer.java b/...a/org/eclipse/sirius/web/application/studio/services/StudioEditingContextInitializer.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -53,7 +53,7 @@ public StudioEditingContextInitializer(IStudioCapableEditingContextPredicate stu
 
     @Override
     public void preProcess(IEditingContext editingContext) {
-        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext);
+        var isStudio = this.studioCapableEditingContextPredicate.test(editingContext.getId());
         if (isStudio && editingContext instanceof IEMFEditingContext emfEditingContext) {
             var packageRegistry = emfEditingContext.getDomain().getResourceSet().getPackageRegistry();
             packageRegistry.put(DomainPackage.eNS_URI, DomainPackage.eINSTANCE);

diff --git a/...ain/java/org/eclipse/sirius/web/application/studio/services/StudioStereotypeProvider.java b/...ain/java/org/eclipse/sirius/web/application/studio/services/StudioStereotypeProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -41,7 +41,7 @@ public StudioStereotypeProvider(IStudioCapableEditingContextPredicate studioCapa
 
     @Override
     public List<Stereotype> getStereotypes(IEditingContext editingContext) {
-        if (this.studioCapableEditingContextPredicate.test(editingContext)) {
+        if (this.studioCapableEditingContextPredicate.test(editingContext.getId())) {
             return List.of(
                     new Stereotype(DOMAIN_STEREOTYPE, "Domain"),
                     new Stereotype(VIEW_STEREOTYPE, "View")

diff --git a/...pse/sirius/web/application/studio/services/api/IStudioCapableEditingContextPredicate.java b/...pse/sirius/web/application/studio/services/api/IStudioCapableEditingContextPredicate.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -14,12 +14,10 @@
 
 import java.util.function.Predicate;
 
-import org.eclipse.sirius.components.core.api.IEditingContext;
-
 /**
  * Used to test if an editing context is capable of supporting a studio.
  *
  * @author sbegaudeau
  */
-public interface IStudioCapableEditingContextPredicate extends Predicate<IEditingContext> {
+public interface IStudioCapableEditingContextPredicate extends Predicate<String> {
 }
diff --git a/...ius/web/application/studio/services/representations/DomainDiagramDescriptionProvider.java b/...ius/web/application/studio/services/representations/DomainDiagramDescriptionProvider.java
@@ -1,5 +1,5 @@
 /*******************************************************************************
- * Copyright (c) 2024 Obeo.
+ * Copyright (c) 2024, 2025 Obeo.
  * 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
@@ -82,7 +82,7 @@ public String getDescriptionId() {
 
     @Override
     public void preProcess(IEditingContext editingContext) {
-        if (editingContext instanceof EditingContext siriusWebEditingContext && this.studioCapableEditingContextPredicate.test(editingContext)) {
+        if (editingContext instanceof EditingContext siriusWebEditingContext && this.studioCapableEditingContextPredicate.test(editingContext.getId())) {
             siriusWebEditingContext.getViews().add(this.view);
         }
     }

diff --git a/...us/web/application/studio/services/representations/DomainViewTreeDescriptionProvider.java b/...us/web/application/studio/services/representations/DomainViewTreeDescriptionProvider.java
@@ -80,7 +80,7 @@ public DomainViewTreeDescriptionProvider(IStudioCapableEditingContextPredicate s
 
     @Override
     public void preProcess(IEditingContext editingContext) {
-        if (editingContext instanceof EditingContext siriusWebEditingContext && this.studioCapableEditingContextPredicate.test(editingContext)) {
+        if (editingContext instanceof EditingContext siriusWebEditingContext && this.studioCapableEditingContextPredicate.test(editingContext.getId())) {
             siriusWebEditingContext.getViews().add(this.view);
         }
     }

diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.checkstyle b/packages/sirius-web/backend/sirius-web-tests-data/.checkstyle
@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<fileset-config file-format-version="1.2.0" simple-config="true" sync-formatter="false">
+  <fileset name="all" enabled="true" check-config-name="Sirius" local="false">
+    <file-match-pattern match-pattern="." include-pattern="true"/>
+  </fileset>
+  <filter name="FilesFromPackage" enabled="true">
+    <filter-data value="src/main/resources"/>
+  </filter>
+</fileset-config>
diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.classpath b/packages/sirius-web/backend/sirius-web-tests-data/.classpath
@@ -0,0 +1,58 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+	<classpathentry kind="src" output="target/classes" path="src/main/java">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/classes" path="src/main/resources">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="src/test/java">
+		<attributes>
+			<attribute name="test" value="true"/>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry excluding="**" kind="src" output="target/test-classes" path="src/test/resources">
+		<attributes>
+			<attribute name="ignore_optional_problems" value="true"/>
+			<attribute name="test" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="optional" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-17">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="con" path="org.eclipse.m2e.MAVEN2_CLASSPATH_CONTAINER">
+		<attributes>
+			<attribute name="maven.pomderived" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" path="target/generated-sources/annotations">
+		<attributes>
+			<attribute name="ignore_optional_problems" value="true"/>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="m2e-apt" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="src" output="target/test-classes" path="target/generated-test-sources/test-annotations">
+		<attributes>
+			<attribute name="optional" value="true"/>
+			<attribute name="maven.pomderived" value="true"/>
+			<attribute name="ignore_optional_problems" value="true"/>
+			<attribute name="m2e-apt" value="true"/>
+			<attribute name="test" value="true"/>
+		</attributes>
+	</classpathentry>
+	<classpathentry kind="output" path="target/classes"/>
+</classpath>
diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.project b/packages/sirius-web/backend/sirius-web-tests-data/.project
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+	<name>sirius-web-tests-data</name>
+	<comment></comment>
+	<projects>
+	</projects>
+	<buildSpec>
+		<buildCommand>
+			<name>org.eclipse.jdt.core.javabuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.springframework.ide.eclipse.boot.validation.springbootbuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>net.sf.eclipsecs.core.CheckstyleBuilder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+		<buildCommand>
+			<name>org.eclipse.m2e.core.maven2Builder</name>
+			<arguments>
+			</arguments>
+		</buildCommand>
+	</buildSpec>
+	<natures>
+		<nature>org.eclipse.jdt.core.javanature</nature>
+		<nature>org.eclipse.m2e.core.maven2Nature</nature>
+		<nature>net.sf.eclipsecs.core.CheckstyleNature</nature>
+	</natures>
+</projectDescription>
diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.core.resources.prefs b/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.core.resources.prefs
@@ -0,0 +1,6 @@
+eclipse.preferences.version=1
+encoding//src/main/java=UTF-8
+encoding//src/main/resources=UTF-8
+encoding//src/test/java=UTF-8
+encoding//src/test/resources=UTF-8
+encoding/<project>=UTF-8
diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.core.runtime.prefs b/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.core.runtime.prefs
@@ -0,0 +1,3 @@
+#Mon Sep 24 15:04:19 CEST 2007
+eclipse.preferences.version=1
+line.separator=\n
diff --git a/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.jdt.apt.core.prefs b/packages/sirius-web/backend/sirius-web-tests-data/.settings/org.eclipse.jdt.apt.core.prefs
@@ -0,0 +1,2 @@
+eclipse.preferences.version=1
+org.eclipse.jdt.apt.aptEnabled=false
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		eclipse.preferences.version=1
		org.eclipse.jdt.apt.aptEnabled=false