386052: [UML Compare] In the case of nested comparison, we could get an IllegateStateException

https://bugs.eclipse.org/bugs/show_bug.cgi?id=386052

Commit the correction + the JUnit tests

5 files changed, 114 insertions, 22 deletions

diff --git a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/DefaultTransactionalMerger.java b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/DefaultTransactionalMerger.java
index a15e771081a..325094db01e 100644
--- a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/DefaultTransactionalMerger.java
+++ b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/DefaultTransactionalMerger.java
@@ -14,6 +14,7 @@
 package org.eclipse.papyrus.infra.emf.compare.diff.internal.merger;

 

 import java.util.ArrayList;

+import java.util.Collections;

 import java.util.Iterator;

 import java.util.List;

 

@@ -21,6 +22,7 @@ import org.eclipse.core.commands.ExecutionException;
 import org.eclipse.core.runtime.Assert;

 import org.eclipse.core.runtime.IAdaptable;

 import org.eclipse.core.runtime.IProgressMonitor;

+import org.eclipse.core.runtime.IStatus;

 import org.eclipse.emf.common.command.Command;

 import org.eclipse.emf.common.command.CompoundCommand;

 import org.eclipse.emf.common.command.IdentityCommand;

@@ -51,12 +53,15 @@ import org.eclipse.emf.ecore.EcorePackage;
 import org.eclipse.emf.ecore.resource.Resource;

 import org.eclipse.emf.ecore.util.EcoreUtil;

 import org.eclipse.emf.ecore.xmi.XMIResource;

+import org.eclipse.emf.edit.command.SetCommand;

 import org.eclipse.emf.transaction.TransactionalEditingDomain;

 import org.eclipse.emf.transaction.util.TransactionUtil;

 import org.eclipse.gmf.runtime.common.core.command.CommandResult;

+import org.eclipse.gmf.runtime.common.core.command.ICommand;

 import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;

 import org.eclipse.osgi.util.NLS;

 import org.eclipse.papyrus.commands.wrappers.GMFtoEMFCommandWrapper;

+import org.eclipse.papyrus.infra.emf.compare.diff.internal.util.CopyWithReferenceCommand;

 import org.eclipse.papyrus.infra.emf.compare.diff.merge.ITransactionalMerger;

 import org.eclipse.papyrus.infra.emf.compare.diff.service.TransactionalMergeFactory;

 import org.eclipse.papyrus.infra.emf.compare.diff.service.TransactionalMergeService;

@@ -158,7 +163,7 @@ public class DefaultTransactionalMerger extends AbstractDefaultMerger implements
 			element = (EObject)ClassUtils.invokeMethod(diffElement, "getLeftElement"); //$NON-NLS-1$

 		}

 		TransactionalEditingDomain domain = TransactionUtil.getEditingDomain(element);

-		

+

 		if(domain == null) {

 			element = (EObject)ClassUtils.invokeMethod(diffElement, "getRightParent"); //$NON-NLS-1$

 			if(element == null) {

@@ -341,25 +346,37 @@ public class DefaultTransactionalMerger extends AbstractDefaultMerger implements
 		}

 	}

 

+	//	/**

+	//	 * Creates a copy of the given EObject as would {@link EcoreUtil#copy(EObject)} would, except we use

+	//	 * specific handling for unmatched references.

+	//	 * 

+	//	 * @param eObject

+	//	 *        The object to copy.

+	//	 * @return the copied object.

+	//	 */

+	//	protected EObject copy(EObject eObject) {

+	//		final EMFCompareEObjectCopier copier = TransactionalMergeService.getCopier(diff);

+	//		if(copier.containsKey(eObject)) {

+	//			//385289: [UML Compare] Bad result after merginf UMLStereotypeApplicationAddition/Removal

+	//			//in some case, the elements are copied and merged twice!

+	//			return copier.get(eObject);

+	//		}

+	//		final EObject result = copier.copy(eObject);

+	//		copier.copyReferences();

+	//		copier.copyXMIIDs();

+	//		return result;

+	//	}

+

 	/**

-	 * Creates a copy of the given EObject as would {@link EcoreUtil#copy(EObject)} would, except we use

-	 * specific handling for unmatched references.

 	 * 

 	 * @param eObject

-	 *        The object to copy.

-	 * @return the copied object.

+	 *        the eobject copy

+	 * @return

+	 *         the result of the command is the copiedObject

+	 *         the copied object is immediately available doing copyCommand.getCommandResult().getReturnValue();

 	 */

-	protected EObject copy(EObject eObject) {

-		final EMFCompareEObjectCopier copier = TransactionalMergeService.getCopier(diff);

-		if(copier.containsKey(eObject)) {

-			//385289: [UML Compare] Bad result after merginf UMLStereotypeApplicationAddition/Removal

-			//in some case, the elements are copied and merged twice!

-			return copier.get(eObject);

-		}

-		final EObject result = copier.copy(eObject);

-		copier.copyReferences();

-		copier.copyXMIIDs();

-		return result;

+	protected AbstractTransactionalCommand getCopyWithReferenceCommand(final EObject eObject) {

+		return new CopyWithReferenceCommand(getTransactionalEditingDomain(diff), TransactionalMergeService.getCopier(diff), eObject);

 	}

 

 	/**

diff --git a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeLeftTargetTransactionalMerger.java b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeLeftTargetTransactionalMerger.java
index 00fb8605f8b..dceb3ab2a74 100644
--- a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeLeftTargetTransactionalMerger.java
+++ b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeLeftTargetTransactionalMerger.java
@@ -35,6 +35,7 @@ import org.eclipse.emf.ecore.InternalEObject;
 import org.eclipse.emf.ecore.util.EcoreUtil;

 import org.eclipse.emf.transaction.TransactionalEditingDomain;

 import org.eclipse.gmf.runtime.common.core.command.CommandResult;

+import org.eclipse.gmf.runtime.common.core.command.ICommand;

 import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;

 import org.eclipse.papyrus.commands.wrappers.GMFtoEMFCommandWrapper;

 import org.eclipse.papyrus.infra.emf.commands.AddToResourceCommand;

@@ -156,7 +157,9 @@ public class ModelElementChangeLeftTargetTransactionalMerger extends DefaultTran
 		// we should copy the element to the Origin one.

 		final EObject origin = theDiff.getRightParent();

 		final EObject element = theDiff.getLeftElement();

-		final EObject newOne = copy(element);

+		final ICommand copyCommand = getCopyWithReferenceCommand(element);

+		cmd.append(new GMFtoEMFCommandWrapper(copyCommand));

+		final EObject newOne = (EObject)copyCommand.getCommandResult().getReturnValue();

 		final EReference ref = element.eContainmentFeature();

 		if(ref != null) {

 			try {

diff --git a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeRightTargetTransactionalMerger.java b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeRightTargetTransactionalMerger.java
index baa0734c01d..758599c4315 100644
--- a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeRightTargetTransactionalMerger.java
+++ b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/merger/ModelElementChangeRightTargetTransactionalMerger.java
@@ -35,6 +35,7 @@ import org.eclipse.emf.ecore.InternalEObject;
 import org.eclipse.emf.ecore.util.EcoreUtil;

 import org.eclipse.emf.transaction.TransactionalEditingDomain;

 import org.eclipse.gmf.runtime.common.core.command.CommandResult;

+import org.eclipse.gmf.runtime.common.core.command.ICommand;

 import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;

 import org.eclipse.papyrus.commands.wrappers.GMFtoEMFCommandWrapper;

 import org.eclipse.papyrus.infra.emf.commands.AddToResourceCommand;

@@ -160,7 +161,9 @@ public class ModelElementChangeRightTargetTransactionalMerger extends DefaultTra
 		final ModelElementChangeRightTarget theDiff = (ModelElementChangeRightTarget)this.diff;

 		final EObject origin = theDiff.getLeftParent();

 		final EObject element = theDiff.getRightElement();

-		final EObject newOne = copy(element);

+		final ICommand copyCommand = getCopyWithReferenceCommand(element);

+		cmd.append(new GMFtoEMFCommandWrapper(copyCommand));

+		final EObject newOne = (EObject)copyCommand.getCommandResult().getReturnValue();

 		final EReference ref = element.eContainmentFeature();

 		if(ref != null) {

 			try {

diff --git a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/CopyWithReferenceCommand.java b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/CopyWithReferenceCommand.java
new file mode 100644
index 00000000000..7a7114408fd
--- /dev/null
+++ b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/CopyWithReferenceCommand.java
@@ -0,0 +1,72 @@
+/*****************************************************************************

+ * Copyright (c) 2012 CEA LIST.

+ *

+ *    

+ * All rights reserved. This program and the accompanying materials

+ * are made available under the terms of the Eclipse Public License v1.0

+ * which accompanies this distribution, and is available at

+ * http://www.eclipse.org/legal/epl-v10.html

+ *

+ * Contributors:

+ *  Vincent Lorenzo (CEA LIST) Vincent.Lorenzo@cea.fr - Initial API and implementation

+ *  

+ *****************************************************************************/

+package org.eclipse.papyrus.infra.emf.compare.diff.internal.util;

+

+import java.util.Collections;

+

+import org.eclipse.core.commands.ExecutionException;

+import org.eclipse.core.runtime.IAdaptable;

+import org.eclipse.core.runtime.IProgressMonitor;

+import org.eclipse.emf.compare.diff.merge.EMFCompareEObjectCopier;

+import org.eclipse.emf.ecore.EObject;

+import org.eclipse.emf.transaction.TransactionalEditingDomain;

+import org.eclipse.gmf.runtime.common.core.command.CommandResult;

+import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;

+

+/**

+ * 

+ * This command allows to copy an EObject getting the copy before the command execution. (copyCommand.getCommandResult().getReturnValue();)

+ * The references and the XMI_Dis are copied during the command excetion

+ * 

+ */

+public class CopyWithReferenceCommand extends AbstractTransactionalCommand {

+

+	/**

+	 * The copied used to do the copy

+	 */

+	final EMFCompareEObjectCopier copier;

+

+	/**

+	 * 

+	 * Constructor.

+	 * 

+	 * @param domain

+	 *        the editing domain

+	 * @param diff

+	 *        the diffElement

+	 * @param eObjectToCopy

+	 *        the object to copy

+	 */

+	public CopyWithReferenceCommand(final TransactionalEditingDomain domain, final EMFCompareEObjectCopier copier, final EObject eObjectToCopy) {

+		super(domain, "CopyWithReferenceCommand", Collections.EMPTY_LIST); //$NON-NLS-1$

+		this.copier = copier;

+		final EObject copiedElement;

+		if(copier.containsKey(eObjectToCopy)) {

+			//385289: [UML Compare] Bad result after merginf UMLStereotypeApplicationAddition/Removal

+			//in some case, the elements are copied and merged twice!

+			copiedElement = this.copier.get(eObjectToCopy);

+		} else {

+			copiedElement = this.copier.copy(eObjectToCopy);

+		}

+		final CommandResult result = CommandResult.newOKCommandResult(copiedElement);

+		setResult(result);

+	}

+

+	@Override

+	protected CommandResult doExecuteWithResult(IProgressMonitor monitor, IAdaptable info) throws ExecutionException {

+		this.copier.copyReferences();

+		this.copier.copyXMIIDs();

+		return getCommandResult();

+	}

+}

diff --git a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/PapyrusCompareEObjectCopier.java b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/PapyrusCompareEObjectCopier.java
index 84512b0ffc3..d72c9298440 100644
--- a/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/PapyrusCompareEObjectCopier.java
+++ b/extraplugins/uml/compare/org.eclipse.papyrus.infra.emf.compare.diff/src/org/eclipse/papyrus/infra/emf/compare/diff/internal/util/PapyrusCompareEObjectCopier.java
@@ -17,11 +17,9 @@ import java.util.ArrayList;
 import java.util.Collection;

 import java.util.Collections;

 import java.util.Comparator;

-import java.util.HashSet;

 import java.util.Iterator;

 import java.util.List;

 import java.util.Map;

-import java.util.Set;

 

 import org.eclipse.core.commands.ExecutionException;

 import org.eclipse.core.runtime.IAdaptable;

@@ -32,7 +30,6 @@ import org.eclipse.emf.common.notify.impl.AdapterImpl;
 import org.eclipse.emf.common.util.EList;

 import org.eclipse.emf.common.util.TreeIterator;

 import org.eclipse.emf.common.util.URI;

-import org.eclipse.emf.compare.diff.internal.DiffReferenceUtil;

 import org.eclipse.emf.compare.diff.merge.EMFCompareEObjectCopier;

 import org.eclipse.emf.compare.diff.metamodel.ComparisonResourceSnapshot;

 import org.eclipse.emf.compare.diff.metamodel.DiffModel;

@@ -71,7 +68,7 @@ public class PapyrusCompareEObjectCopier extends EMFCompareEObjectCopier {
 	 */

 	public PapyrusCompareEObjectCopier(final DiffResourceSet diff) {

 		super(diff);

-		throw new UnsupportedOperationException("not implemented");//we should initialize the map as it is done in the 2nd constructor

+		throw new UnsupportedOperationException("not yet implemented");//we should initialize the map as it is done in the 2nd constructor //$NON-NLS-1$

 	}

 

 	/**