mapping/tests/org.eclipse.intent.mapping.tests/src/org/eclipse/intent/mapping/tests/connector/ConnectorRegistryTests.java

/*******************************************************************************
 * Copyright (c) 2015 Obeo.
 * 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:
 *    Obeo - initial API and implementation and/or initial documentation
 *    ...
 *******************************************************************************/
package org.eclipse.intent.mapping.tests.connector;

import org.eclipse.intent.mapping.base.BaseElementFactory.FactoryDescriptor;
import org.eclipse.intent.mapping.base.IBase;
import org.eclipse.intent.mapping.base.ILocation;
import org.eclipse.intent.mapping.base.ILocationContainer;
import org.eclipse.intent.mapping.base.ILocationDescriptor;
import org.eclipse.intent.mapping.connector.AbstractConnector;
import org.eclipse.intent.mapping.connector.IConnector;
import org.eclipse.intent.mapping.internal.connector.ConnectorRegistry;
import org.eclipse.intent.mapping.tests.base.BaseElementFactoryTests.TestLocation;
import org.eclipse.intent.mapping.tests.base.BaseRegistryTests.TestBase;
import org.junit.Before;
import org.junit.Test;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertTrue;

/**
 * Tests {@link ConnectorRegistry}.
 * 
 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
 */
public class ConnectorRegistryTests {

	/**
	 * A test {@link IConnector} implementation.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestConnector1 extends AbstractConnector {

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getLocationType(java.lang.Class,
		 *      java.lang.Object)
		 */
		public Class<? extends ILocation> getLocationType(Class<? extends ILocationContainer> containerType,
				Object element) {
			final Class<? extends ILocation> res;

			if (containerType == TestLocation1.class) {
				res = getType();
			} else {
				res = null;
			}

			return res;
		}

		@Override
		protected void initLocation(ILocationContainer container, ILocation location, Object element) {
			((ITestLocation1)location).setObject(element);
		}

		@Override
		protected boolean match(ILocation location, Object element) {
			return location.getContainer() instanceof TestLocation1 && ((ITestLocation1)location)
					.getObject() == element;
		}

		@Override
		protected boolean canUpdate(Object element) {
			return true;
		}

		public String getName(ILocation location) {
			final String res;

			if (location.getContainer() instanceof TestLocation1) {
				res = "TestLocation1 " + ((TestLocation1)location).getObject().toString();
			} else {
				res = null;
			}

			return res;
		}

		public ILocationDescriptor getLocationDescriptor(IBase base, Object element) {
			final ILocationDescriptor res;

			res = new ObjectLocationDescriptor(base, element, "TestLocation1 " + element.toString());

			return res;
		}

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getElement(org.eclipse.intent.mapping.base.ILocation)
		 */
		public Object getElement(ILocation location) {
			final Object res;

			if (location instanceof TestLocation1) {
				res = ((TestLocation1)location).getObject();
			} else {
				res = null;
			}

			return res;
		}

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getType()
		 */
		public Class<? extends ILocation> getType() {
			return ITestLocation1.class;
		}

	}

	/**
	 * A test location interface.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public interface ITestLocation1 extends ILocation {

		void setObject(Object o);

		Object getObject();

	}

	/**
	 * A test location.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestLocation1 extends TestLocation implements ITestLocation1 {

	}

	/**
	 * A test {@link IConnector} implementation.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestConnector2 extends AbstractConnector {

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getLocationType(java.lang.Class,
		 *      java.lang.Object)
		 */
		public Class<? extends ILocation> getLocationType(Class<? extends ILocationContainer> containerType,
				Object element) {
			final Class<? extends ILocation> res;

			if (containerType == TestLocation2.class) {
				res = getType();
			} else {
				res = null;
			}

			return res;
		}

		@Override
		protected void initLocation(ILocationContainer container, ILocation location, Object element) {
			((ITestLocation2)location).setObject(element);
		}

		@Override
		protected boolean match(ILocation location, Object element) {
			return location.getContainer() instanceof TestLocation2 && ((ITestLocation2)location)
					.getObject() == element;
		}

		@Override
		protected boolean canUpdate(Object element) {
			return true;
		}

		public String getName(ILocation location) {
			final String res;

			if (location.getContainer() instanceof TestLocation2) {
				res = "TestLocation2 " + ((TestLocation2)location).getObject().toString();
			} else {
				res = null;
			}

			return res;
		}

		public ILocationDescriptor getLocationDescriptor(IBase base, Object element) {
			final ILocationDescriptor res;

			res = new ObjectLocationDescriptor(base, element, "TestLocation2 " + element.toString());

			return res;
		}

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getElement(org.eclipse.intent.mapping.base.ILocation)
		 */
		public Object getElement(ILocation location) {
			final Object res;

			if (location instanceof TestLocation2) {
				res = ((TestLocation2)location).getObject();
			} else {
				res = null;
			}

			return res;
		}

		/**
		 * {@inheritDoc}
		 *
		 * @see org.eclipse.intent.mapping.connector.IConnector#getType()
		 */
		public Class<? extends ILocation> getType() {
			return ITestLocation2.class;
		}

	}

	/**
	 * A test location interface.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public interface ITestLocation2 extends ITestLocation1 {

		void setObject(Object o);

		Object getObject();

	}

	/**
	 * A test location.
	 *
	 * @author <a href="mailto:yvan.lussaud@obeo.fr">Yvan Lussaud</a>
	 */
	public static class TestLocation2 extends TestLocation implements ITestLocation2 {

	}

	/**
	 * The {@link ConnectorRegistry} to test.
	 */
	private ConnectorRegistry connectorRegistery;

	@Before
	public void before() {
		connectorRegistery = new ConnectorRegistry();
	}

	@Test
	public void register() {
		final IConnector connector = new TestConnector1();
		connectorRegistery.register(connector);

		assertTrue(connectorRegistery.getConnector(connector.getType()) instanceof TestConnector1);
	}

	@Test
	public void unregister() {
		final IConnector connector = new TestConnector1();
		connectorRegistery.register(connector);

		assertTrue(connectorRegistery.getConnector(connector.getType()) instanceof TestConnector1);

		connectorRegistery.unregister(connector);

		assertNull(connectorRegistery.getConnector(connector.getType()));
	}

	@Test
	public void getConnector() {
		final IConnector connector1 = new TestConnector1();
		final IConnector connector2 = new TestConnector2();
		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		assertTrue(connectorRegistery.getConnector(connector1.getType()) instanceof TestConnector1);
		assertTrue(connectorRegistery.getConnector(connector2.getType()) instanceof TestConnector2);
	}

	@Test
	public void createLocationNoConnectors() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final Object element = new Object();

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertEquals(null, location);
	}

	@Test(expected = java.lang.IllegalArgumentException.class)
	public void createLocationNotRegisteredInBase() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertTrue(location instanceof ITestLocation1);
		assertEquals(element, ((ITestLocation1)location).getObject());
	}

	@Test
	public void createLocationFirstConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertTrue(location instanceof ITestLocation1);
		assertEquals(element, ((ITestLocation1)location).getObject());
	}

	@Test
	public void createLocationSecondConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation2();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertTrue(location instanceof ITestLocation2);
		assertEquals(element, ((ITestLocation2)location).getObject());
	}

	@Test
	public void getLocationNoConnectors() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final ILocation container = new TestLocation1();
		final Object element = new Object();

		final ILocation location = connectorRegistery.getLocation(container, element);

		assertEquals(null, location);
	}

	@Test
	public void getLocationFirstConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);
		final ILocation found = connectorRegistery.getLocation(container, element);

		assertTrue(location instanceof ITestLocation1);
		assertEquals(element, ((ITestLocation1)location).getObject());
		assertEquals(location, found);
	}

	@Test
	public void getLocationSecondConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation2();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);
		final ILocation found = connectorRegistery.getLocation(container, element);

		assertTrue(location instanceof ITestLocation2);
		assertEquals(element, ((ITestLocation2)location).getObject());
		assertEquals(location, found);
	}

	@Test
	public void getNameMarkedAsDeleted() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);
		location.setMarkedAsDeleted(true);

		assertEquals("(deleted)", connectorRegistery.getName(location));
	}

	@Test
	public void getNameFirstConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation1();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertTrue(connectorRegistery.getName(location).startsWith("TestLocation1 "));
	}

	@Test
	public void getNameSecondConnector() throws InstantiationException, IllegalAccessException,
			ClassNotFoundException {
		final IBase base = new TestBase();
		final ILocation container = new TestLocation2();
		container.setContainer(base);
		final TestConnector1 connector1 = new TestConnector1();
		final TestConnector2 connector2 = new TestConnector2();
		final Object element = new Object();

		base.getFactory().addDescriptor(ITestLocation1.class, new FactoryDescriptor<TestLocation1>(
				TestLocation1.class));
		base.getFactory().addDescriptor(ITestLocation2.class, new FactoryDescriptor<TestLocation2>(
				TestLocation2.class));

		connectorRegistery.register(connector1);
		connectorRegistery.register(connector2);

		final ILocation location = connectorRegistery.createLocation(container, element);

		assertTrue(connectorRegistery.getName(location).startsWith("TestLocation2 "));
	}

}