DiagramEventBrokerTests.java

/******************************************************************************
 * Copyright (c) 2005, 2008 IBM Corporation and others.
 * 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:
 *    IBM Corporation - initial API and implementation 
 ****************************************************************************/

package org.eclipse.gmf.tests.runtime.diagram.ui.logic;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.Map;

import junit.framework.Test;
import junit.framework.TestSuite;

import org.eclipse.core.commands.ExecutionException;
import org.eclipse.core.commands.operations.OperationHistoryFactory;
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.core.runtime.NullProgressMonitor;
import org.eclipse.core.runtime.Status;
import org.eclipse.draw2d.IFigure;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EStructuralFeature;
import org.eclipse.emf.transaction.Transaction;
import org.eclipse.emf.transaction.TransactionalEditingDomain;
import org.eclipse.emf.workspace.AbstractEMFOperation;
import org.eclipse.gef.commands.Command;
import org.eclipse.gmf.runtime.common.core.command.CommandResult;
import org.eclipse.gmf.runtime.common.core.util.StringStatics;
import org.eclipse.gmf.runtime.diagram.core.listener.DiagramEventBroker;
import org.eclipse.gmf.runtime.diagram.core.listener.NotificationListener;
import org.eclipse.gmf.runtime.diagram.ui.editparts.DiagramEditPart;
import org.eclipse.gmf.runtime.diagram.ui.editparts.GraphicalEditPart;
import org.eclipse.gmf.runtime.diagram.ui.requests.ArrangeRequest;
import org.eclipse.gmf.runtime.diagram.ui.requests.RequestConstants;
import org.eclipse.gmf.runtime.diagram.ui.services.layout.LayoutType;
import org.eclipse.gmf.runtime.emf.commands.core.command.AbstractTransactionalCommand;
import org.eclipse.gmf.runtime.notation.Diagram;
import org.eclipse.gmf.runtime.notation.NotationPackage;
import org.eclipse.gmf.runtime.notation.View;
import org.eclipse.gmf.tests.runtime.diagram.ui.AbstractShapeTests;
import org.eclipse.swt.widgets.Display;

public class DiagramEventBrokerTests extends AbstractShapeTests {

	private class TestListenningEditPart extends GraphicalEditPart {

		private boolean receivedTypeEvent = false;

		private DiagramEventBroker eventBroker;

		private DiagramEditPart diagremEditPart;

		public boolean receivedTypeEvent() {
			return receivedTypeEvent;
		}

		protected Diagram getDiagramView() {
			return diagremEditPart.getDiagramView();
		}

		public TestListenningEditPart(DiagramEditPart dEP,
				DiagramEventBroker eventBroker, EObject model) {
			super(model);
			this.eventBroker = eventBroker;
			this.diagremEditPart = dEP;
			addListenerFilter(
					"Type", this, model, NotationPackage.eINSTANCE.getView_Type()); //$NON-NLS-1$
		}

		public IFigure createFigure() {
			return null;
		}

		/**
		 * Adds a listener filter by adding the given listener to a passed
		 * notifier
		 * 
		 * @param filterId
		 *            A unique filter id (within the same editpart instance)
		 * @param listener
		 *            A listener instance
		 * @param element
		 *            An element to add the listener to
		 */
		protected void addListenerFilter(String filterId,
				NotificationListener listener, EObject element,
				EStructuralFeature feature) {
			if (element == null)
				return;
			Assert.isNotNull(filterId);
			Assert.isNotNull(listener);
			eventBroker.addNotificationListener(element, feature, listener);
		}

		/**
		 * Create an instance.
		 * 
		 * @param model
		 *            the underlying model.
		 */
		public TestListenningEditPart(EObject model) {
			super(model);
		}

		/**
		 * Handles the property changed event
		 * 
		 * @param event
		 *            the property changed event
		 */
		protected void handleNotificationEvent(Notification event) {
			if (NotationPackage.eINSTANCE.getView_Type().equals(
					event.getFeature()))
				receivedTypeEvent = true;
		}

		/**
		 * indicates if this edit part's model is a view or not
		 * 
		 * @return <code>true</code> or <code>false</code>
		 */
		public boolean hasNotationView() {
			return false;
		}

		/**
		 * This method adds all listeners to the semantic world
		 * (IUMLElement...etc) Override this method to add more semantic
		 * listeners down the hierarchy This method is called only if the
		 * semantic element is resolvable
		 */
		protected void addSemanticListeners() {
			// do not add any thing
		}
	}

	public DiagramEventBrokerTests(String arg0) {
		super(arg0);
	}

	public static Test suite() {
		return new TestSuite(DiagramEventBrokerTests.class);
	}

	protected void setTestFixture() {
		testFixture = new LogicTestFixture();
	}

	/** Return <code>(CanonicalTestFixture)getTestFixture();</code> */
	protected LogicTestFixture getLogicTestFixture() {
		return (LogicTestFixture) getTestFixture();
	}

	/**
	 * Gets the diagram event broker from the editing domain.
	 * 
	 * @return the diagram event broker
	 */
	public DiagramEventBroker getDiagramEventBroker(
			TransactionalEditingDomain theEditingDomain) {
		if (theEditingDomain != null) {
			return DiagramEventBroker.getInstance(theEditingDomain);
		}
		return null;
	}

	/**
	 * Test to verify that copy appearance properties is working properly
	 * 
	 * @throws Exception
	 */
	public void testDiagramEventBroker() throws Exception {
		final View view = getDiagramEditPart().getNotationView();
		DiagramEditPart diagramEP = getDiagramEditPart();

		TestListenningEditPart ep = new TestListenningEditPart(diagramEP,
				getDiagramEventBroker(diagramEP.getEditingDomain()), view);

		final TransactionalEditingDomain editingDomain = ep.getEditingDomain();
		ep.activate();
		AbstractEMFOperation operation = new AbstractEMFOperation(
				editingDomain, "") { //$NON-NLS-1$
			protected IStatus doExecute(IProgressMonitor monitor,
					IAdaptable info) throws ExecutionException {
				view.setType("ddd"); //$NON-NLS-1$
				return Status.OK_STATUS;
			};
		};
		try {
			OperationHistoryFactory.getOperationHistory().execute(operation,
					new NullProgressMonitor(), null);
		} catch (ExecutionException e) {
			e.printStackTrace();
			assertFalse(false);
		}
		flushEventQueue();
		assertTrue(ep.receivedTypeEvent());
	}

	public void testBlockingUI_Protected() {
		DiagramEditPart diagramEP = getDiagramEditPart();
		final TransactionalEditingDomain editingDomain = diagramEP
				.getEditingDomain();

		final Boolean result[] = new Boolean[2];
		result[0] = Boolean.FALSE;

		final AbstractTransactionalCommand command = new AbstractTransactionalCommand(
				editingDomain, StringStatics.BLANK, null,
				new ArrayList()) {

			protected CommandResult doExecuteWithResult(
					IProgressMonitor monitor, IAdaptable info)
					throws ExecutionException {
				try {
					result[0] = Boolean.TRUE;

					Thread.sleep(10000);
				} catch (InterruptedException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
				return new CommandResult(Status.OK_STATUS);
			}

		};

		final Thread transactionThread = new Thread(new Runnable() {
			public void run() {
				try {
					command.execute(new NullProgressMonitor(), null);
				} catch (ExecutionException e) {
					// TODO Auto-generated catch block
					e.printStackTrace();
				}
			}
		});

		// get rid of queued asynch commands
		Display.getDefault().readAndDispatch();

		transactionThread.start();

		while (!result[0].booleanValue()) {
			Display.getDefault().readAndDispatch();
		}

		// try to access the UI while the transaction is running
		ArrangeRequest arrRequest = new ArrangeRequest(
				RequestConstants.REQ_ARRANGE_DEFERRED, LayoutType.DEFAULT);

		arrRequest.setViewAdaptersToArrange(new ArrayList());
		Command arrCmd = getDiagramEditPart().getCommand(arrRequest);

		// make sure that the command is not valid and can't be executed
		// which validates that the UI has been disabled while the transaction
		// is running
		assertTrue(arrCmd == null || !arrCmd.canExecute());

		transactionThread.stop();
	}

	public void testBlockingUI_Unprotected() {
		DiagramEditPart diagramEP = getDiagramEditPart();
		final TransactionalEditingDomain editingDomain = diagramEP
				.getEditingDomain();

		final Map unchecked_options = new HashMap();
		unchecked_options.put(Transaction.OPTION_NO_UNDO, Boolean.TRUE);
		unchecked_options.put(Transaction.OPTION_UNPROTECTED, Boolean.TRUE);

		final Boolean result[] = new Boolean[2];
		result[0] = Boolean.FALSE;
		result[1] = Boolean.FALSE;

		final AbstractTransactionalCommand command = new AbstractTransactionalCommand(
				editingDomain, StringStatics.BLANK, unchecked_options,
				new ArrayList()) {

			protected CommandResult doExecuteWithResult(
					IProgressMonitor monitor, IAdaptable info)
					throws ExecutionException {
				final Thread accessCommandThread = new Thread(new Runnable() {
					public void run() {
						// try to access the UI while the transaction is running
						ArrangeRequest arrRequest = new ArrangeRequest(
								RequestConstants.REQ_ARRANGE_DEFERRED,
								LayoutType.DEFAULT);

						arrRequest.setViewAdaptersToArrange(new ArrayList());
						Command arrCmd = getDiagramEditPart().getCommand(
								arrRequest);
						
						result[0] = new Boolean(arrCmd == null || !arrCmd.canExecute());
						result[1] = Boolean.TRUE;
					}
				});

				accessCommandThread.start();
				while (!result[1].booleanValue()) {
					Display.getDefault().readAndDispatch();
				}
				accessCommandThread.stop();
				return new CommandResult(Status.OK_STATUS);
			}

		};
		
		try {
			command.execute(new NullProgressMonitor(), null);
		} catch (ExecutionException e) {
			// TODO Auto-generated catch block
			e.printStackTrace();
		}

		assertTrue(result[0].booleanValue());
	}
}