tests/org.eclipse.ocl.examples.eventmanager.tests/src/org/eclipse/ocl/examples/eventmanager/tests/EventManagerTest.java

/*******************************************************************************
 * Copyright (c) 2009, 2018 SAP AG and others.
 * All rights reserved. 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
 * http://www.eclipse.org/legal/epl-v20.html
 *
 * Contributors:
 *     SAP AG - initial API and implementation
 ******************************************************************************/
package org.eclipse.ocl.examples.eventmanager.tests;

import org.eclipse.emf.common.notify.Adapter;
import org.eclipse.emf.common.notify.Notification;
import org.eclipse.emf.common.notify.impl.AdapterImpl;
import org.eclipse.emf.common.notify.impl.NotificationImpl;
import org.eclipse.emf.common.util.BasicEList;
import org.eclipse.emf.common.util.EList;
import org.eclipse.emf.ecore.EClass;
import org.eclipse.emf.ecore.EObject;
import org.eclipse.emf.ecore.EReference;
import org.eclipse.emf.ecore.EcoreFactory;
import org.eclipse.emf.ecore.impl.DynamicEObjectImpl;
import org.eclipse.emf.ecore.impl.ENotificationImpl;
import org.eclipse.emf.ecore.resource.ResourceSet;
import org.eclipse.emf.ecore.resource.impl.ResourceImpl;
import org.eclipse.emf.ecore.resource.impl.ResourceSetImpl;
import org.eclipse.ocl.examples.eventmanager.EventFilter;
import org.eclipse.ocl.examples.eventmanager.EventManager;
import org.eclipse.ocl.examples.eventmanager.EventManagerFactory;
import org.eclipse.ocl.examples.eventmanager.filters.AbstractEventFilter;
import org.eclipse.ocl.examples.eventmanager.filters.OrFilter;
import org.eclipse.ocl.examples.eventmanager.tests.filters.ClassFilterTest;
import org.eclipse.ocl.examples.eventmanager.tests.filters.EventFilterTest;
import org.eclipse.ocl.examples.eventmanager.tests.util.BaseTest;
import org.junit.Test;

import junit.textui.TestRunner;


public class EventManagerTest extends BaseTest {

	protected EventManager fixture = null;
	private ResourceImpl res;

	public static class Application extends AdapterImpl implements Adapter {
		private boolean b;

		public Application() {
			b = false;
		}
		public boolean isNotified() {
			return b;
		}
		public void reset() {
			b=false;
		}
		@Override
		public void notifyChanged(Notification msg) {
			this.b = true;

		}
		@Override
		public String toString() {
			return isNotified()?"":"not " + "notfied app";
		}

	}

	public static void main(String[] args) {
		TestRunner.run(EventManagerTest.class);
	}

	protected void setFixture(EventManager fixture) {
		this.fixture = fixture;
	}

	protected EventManager getFixture() {
		return fixture;
	}

	@Override
	public void setUp() throws  Exception {
		super.setUp();
		ResourceSet set = new ResourceSetImpl();
		res = new ResourceImpl();
		set.getResources().add(res);
		setFixture(EventManagerFactory.eINSTANCE.getEventManagerFor(set));
	}

	/**
	 * <!-- begin-user-doc --> <!-- end-user-doc -->
	 *
	 * @see junit.framework.TestCase#tearDown()
	 * @generated NOT
	 */
	@Override
	public void tearDown() {
		setFixture(null);
		res = null;
	}

	@Test
	public void testSimpleElementInsertFilter() {
		EClass cls = EcoreFactory.eINSTANCE.createEClass();

		EventFilter f = EventManagerFactory.eINSTANCE.createFilterForElementInsertionOrDeletion(cls);
		res.getContents().add(new DynamicEObjectImpl(cls));
		Application app = new Application();
		getFixture().subscribe(f, app);
		getFixture().handleEMFEvent(new NotificationImpl(Notification.ADD, null, new DynamicEObjectImpl(cls)){
			@Override
			public Object getFeature() {
				EReference ref = EcoreFactory.eINSTANCE.createEReference();
				ref.setContainment(true);
				return ref;
			}
		});
		assertTrue("Not notified",app.isNotified());
	}

	@Test
	public void testDoubleElementInsertFilter() {
		EClass cls = EcoreFactory.eINSTANCE.createEClass();

		EventFilter f1 = EventManagerFactory.eINSTANCE.createFilterForElementInsertionOrDeletion(cls);
		EventFilter f2 = EventManagerFactory.eINSTANCE.createFilterForElementInsertionOrDeletion(cls);
		EventFilter f = new OrFilter(f1, f2);
		Application app = new Application();
		getFixture().subscribe(f, app);
		getFixture().handleEMFEvent(new NotificationImpl(Notification.ADD, null, new DynamicEObjectImpl(cls)){
			@Override
			public Object getFeature() {
				EReference ref = EcoreFactory.eINSTANCE.createEReference();
				ref.setContainment(true);
				return ref;
			}
		});
		assertTrue("Not notified",app.isNotified());
	}

	/**
	 * Test whether a sucessfully {@link EventManager#subscribe(AbstractEventFilter, Adapter) subscribed} {@link Adapter adapter}
	 * get not {@link Adapter#notifyChanged(Notification) notified} after successful {@link EventManager#unsubscribe(Adapter) unsubscription}
	 */
	public void testUnsubscribe__Adapter() {
		EventFilterTest test = new ClassFilterTest();
		Application adapter = new Application();
		assertSubscribeAndUnsubscribe(test, adapter);
	}

	/**
	 * test whether one can subscribe an adapter twice
	 */
	public void testUnsubscribeDouble__Adapter() {
		EventFilterTest test = new ClassFilterTest();
		Application adapter = new Application();
		assertSubscribeAndUnsubscribe(test, adapter);
		assertSubscribeAndUnsubscribe(test, adapter);
	}

	public void testUnsubscribeDoubleAndDifferentFilters__Adapter() {
		Application adapter = new Application();
		assertSubscribeAndUnsubscribe(new ClassFilterTest(), adapter);
		assertSubscribeAndUnsubscribe(new ClassFilterTest(), adapter);
	}

	public void testUnsubscribeFiltersWithListAsCrit__Adapter() {
		EClass cls1 = EcoreFactory.eINSTANCE.createEClass();
		EClass cls2 = EcoreFactory.eINSTANCE.createEClass();
		cls1.getESuperTypes().add(cls2);
		Application adapter = new Application();
		EventFilter f = EventManagerFactory.eINSTANCE.createAndFilterFor(
				EventManagerFactory.eINSTANCE.createNewValueClassFilterIncludingSubclasses(cls2),
				EventManagerFactory.eINSTANCE.createNewValueClassFilterIncludingSubclasses(cls1));
		getFixture().subscribe(f, adapter);
		getFixture().unsubscribe(adapter);
		EList<EObject> list = new BasicEList<EObject>();
		list.add(new DynamicEObjectImpl(cls1));
		list.add(new DynamicEObjectImpl(cls2));
		getFixture().handleEMFEvent(new ENotificationImpl(null,	0, null, null, list));
		assertFalse("App get wrongly notified", adapter.isNotified());
	}

	private void assertSubscribeAndUnsubscribe(EventFilterTest test,
			Application adapter) {
		getFixture().subscribe(test.giveTestFilter(), adapter);
		getFixture().handleEMFEvent(test.giveMatchingNotifications()[0]);
		assertTrue("Subscription failed",adapter.isNotified());
		getFixture().unsubscribe(adapter);
		adapter.reset();
		getFixture().handleEMFEvent(test.giveMatchingNotifications()[0]);
		assertFalse("Unsubscription failed", adapter.isNotified());
	}

	public void testResourceAddContainmentFilter(){
		Application app = new Application();
		getFixture().subscribe(EventManagerFactory.eINSTANCE.createContainmentFilter(), app);
		EClass cls = EcoreFactory.eINSTANCE.createEClass();
		res.getContents().add(new DynamicEObjectImpl(cls));
		assertTrue("Not notified",app.isNotified());
	}

	public void testDoubleSubscribeOneFilter(){
		EClass cls = EcoreFactory.eINSTANCE.createEClass();

		Application app1 = new Application();
		Application app2 = new Application();
		EventFilter f = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls);

		getFixture().subscribe(f, app1);
		getFixture().subscribe(f, app2);

		getFixture().handleEMFEvent(new ENotificationImpl(new DynamicEObjectImpl(cls), 0, null, null, null));

		assertTrue("App1 not get notified", app1.isNotified());
		assertTrue("App2 not get notified", app2.isNotified());
	}

	public void testDoubleSubscribeTwoFilter(){
		EClass cls = EcoreFactory.eINSTANCE.createEClass();

		Application app1 = new Application();
		Application app2 = new Application();
		EventFilter f1 = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls);
		EventFilter f2 = EventManagerFactory.eINSTANCE.createOrFilterFor(
				EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls),
				EventManagerFactory.eINSTANCE.createContainmentFilter());

		getFixture().subscribe(f1, app1);
		getFixture().subscribe(f2, app2);

		getFixture().handleEMFEvent(new ENotificationImpl(new DynamicEObjectImpl(cls), 0, null, null, null));

		assertTrue("App1 not get notified", app1.isNotified());
		assertTrue("App2 not get notified", app2.isNotified());
	}

	public void testDoubleSubscribeCreate2MatchingFilterTableEntries(){
		EClass cls1 = EcoreFactory.eINSTANCE.createEClass();
		EClass cls2 = EcoreFactory.eINSTANCE.createEClass();
		cls1.getESuperTypes().add(cls2);
		Application app1 = new Application();
		Application app2 = new Application();
		EventFilter f1 = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls1);
		EventFilter f2 = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls2);


		getFixture().subscribe(f1, app1);
		getFixture().subscribe(f2, app2);

		getFixture().handleEMFEvent(new ENotificationImpl(new DynamicEObjectImpl(cls1), 0, null, null, null));

		assertTrue("App1 not get notified", app1.isNotified());
		assertTrue("App2 not get notified", app2.isNotified());
	}

	public void testDoubleSubscribeCreate2MatchingFilterTableEntriesSameApp(){
		EClass cls1 = EcoreFactory.eINSTANCE.createEClass();
		EClass cls2 = EcoreFactory.eINSTANCE.createEClass();
		cls1.getESuperTypes().add(cls2);
		EventFilter f1 = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls1);
		EventFilter f2 = EventManagerFactory.eINSTANCE.createClassFilterIncludingSubclasses(cls2);

		Application app = new Application(){
			public Integer count = 0;

			@Override
			public void notifyChanged(Notification msg) {
				super.notifyChanged(msg);
				count++;
			}
			@Override
			public boolean isNotified() {
				return count-->1;
			}
		};

		getFixture().subscribe(f1, app);
		getFixture().subscribe(f2, app);

		getFixture().handleEMFEvent(new ENotificationImpl(new DynamicEObjectImpl(cls1), 0, null, null, null));

		assertTrue("App not get notified", app.isNotified());
		assertFalse("App get notified more than once", app.isNotified());
	}
} // EventManagerTest