org.eclipse.osbp.xtext.builder.participant.jvmtypes.tests/src/org/eclipse/osbp/dsl/xtext/builder/participant/jvmtypes/tests/JvmTypesBuilderParticipantTests.java

/**
 * Copyright (c) 2011, 2015 - Lunifera GmbH (Gross Enzersdorf, Austria), Loetz GmbH&Co.KG (69115 Heidelberg, Germany)
 * 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:
 *         Florian Pirchner - Initial implementation
 */

package org.eclipse.osbp.dsl.xtext.builder.participant.jvmtypes.tests;

import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertNotSame;
import static org.junit.Assert.assertNull;
import static org.junit.Assert.assertSame;
import static org.knowhowlab.osgi.testing.assertions.OSGiAssert.setDefaultBundleContext;
import static org.knowhowlab.osgi.testing.assertions.ServiceAssert.assertServiceUnavailable;
import static org.knowhowlab.osgi.testing.utils.BundleUtils.findBundle;
import static org.knowhowlab.osgi.testing.utils.ServiceUtils.getService;

import org.eclipse.emf.ecore.InternalEObject;
import org.eclipse.emf.ecore.util.EcoreUtil;
import org.eclipse.xtext.common.types.JvmType;
import org.junit.Before;
import org.junit.Test;
import org.eclipse.osbp.dsl.xtext.builder.participant.jvmtypes.IJvmTypeMetadataService;
import org.eclipse.osbp.xtext.builder.metadata.services.IMetadataBuilderService;
import org.osgi.framework.Bundle;
import org.osgi.framework.BundleException;

public class JvmTypesBuilderParticipantTests {

	private static final String STRING_CLASS = "java.lang.String";
	private static final String EXTENDER_CLASS2 = "org.eclipse.osbp.dsl.xtext.builder.participant.jvmtypes.extender.tests.ExtenderClass2ToLoad";
	private static final String EXTENDER_CLASS = "org.eclipse.osbp.dsl.xtext.builder.participant.jvmtypes.extender.tests.ExtenderClassToLoad";
	private static final String BUNDLE_METADATA_SERVICE = "org.eclipse.osbp.xtext.builder.metadata.services";
	private static final String BUNDLE_EXTENDER = "org.eclipse.osbp.xtext.builder.participant.jvmtypes.extender.tests";
	private static final int TIME_500 = 500;
	private static final int TIME_1000 = 1000;
	private static final int TIME_2000 = 2000;

	private Bundle extenderBundle;
	private Bundle builderBundle;

	@Before
	public void setup() throws BundleException, InterruptedException {

		setDefaultBundleContext(Activator.context);

		extenderBundle = findBundle(Activator.context, BUNDLE_EXTENDER);
		extenderBundle.stop();
		Thread.sleep(TIME_1000);

		// restart the metadata service
		builderBundle = findBundle(Activator.context, BUNDLE_METADATA_SERVICE);
		builderBundle.stop();
		builderBundle.start();
		getService(Activator.context, IMetadataBuilderService.class, TIME_2000);
	}

	@Test
	public void testCacheReset() {

		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(service);
		assertNotNull(builderService);

		JvmType type = service.getJvmType(String.class);
		assertEquals(STRING_CLASS, type.getQualifiedName());

		JvmType testClass = service.getJvmType(getClass());
		assertNull(testClass);

		// the new bundle resets the cache
		builderService.addToBundleSpace(Activator.context.getBundle());
		testClass = service.getJvmType(getClass());
		assertNotNull(testClass);
	}

	@Test
	public void testGetJvmTypeWithManuallyAddedBundleSpace() {

		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(service);
		assertNotNull(builderService);

		// add this test bundle to bundle space
		builderService.addToBundleSpace(Activator.context.getBundle());

		JvmType testClass = service.getJvmType(getClass());
		assertNotNull(testClass);

	}

	@Test
	public void testLoadClassThenRemoveParticipant() {
		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(builderService);
		assertNotNull(service);

		// add this test bundle to bundle space
		builderService.addToBundleSpace(Activator.context.getBundle());

		JvmType testClass = service.getJvmType(Class1ToLoad.class);
		assertNotNull(testClass);

		// remove the bundle again from bundle space
		builderService.removeFromBundleSpace(Activator.context.getBundle());
		// then load class2
		JvmType testClass2 = service.getJvmType(Class2ToLoad.class);
		assertNull(testClass2);

		// load the class1 again -> Needs to be cached
		testClass = service.getJvmType(Class1ToLoad.class);
		assertNotNull(testClass);

		// add this test bundle to bundle space again
		builderService.addToBundleSpace(Activator.context.getBundle());

		testClass2 = service.getJvmType(Class2ToLoad.class);
		assertNotNull(testClass2);
	}

	@Test
	public void testBundleSpaceExtenderBundle() throws BundleException,
			InterruptedException {
		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(builderService);
		assertNotNull(service);

		extenderBundle.start();
		Thread.sleep(TIME_500);
		extenderBundle.stop();
		Thread.sleep(TIME_1000);
		
		// then load class
		JvmType testClass = service.getJvmType(EXTENDER_CLASS);
		assertNull(testClass);
		JvmType testClass2 = service.getJvmType(EXTENDER_CLASS2);
		assertNull(testClass2);

		// now start the extender bundle
		assertEquals(Bundle.RESOLVED, extenderBundle.getState());
		extenderBundle.start();
		// wait TIME_500 ms since bundle start is async
		Thread.sleep(TIME_500);

		testClass = service.getJvmType(EXTENDER_CLASS);
		assertNotNull(testClass);

		// now stop the extender bundle again
		extenderBundle.stop();
		// wait TIME_500 ms since bundle stop is async
		Thread.sleep(TIME_500);

		// test class1 is still available, since cached
		testClass = service.getJvmType(EXTENDER_CLASS);
		assertNotNull(testClass);

		// test class2 can not be loaded, since not available in bundle space
		testClass2 = service.getJvmType(EXTENDER_CLASS2);
		assertNull(testClass2);
	}

	@Test
	public void testDeactivateService() throws Exception {
		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(service);
		assertNotNull(builderService);

		JvmType type = service.getJvmType(String.class);
		assertEquals(STRING_CLASS, type.getQualifiedName());

		builderBundle.stop();
		Thread.sleep(TIME_500);

		assertServiceUnavailable(IJvmTypeMetadataService.class);
		assertServiceUnavailable(IMetadataBuilderService.class);

		builderBundle.start();
		Thread.sleep(TIME_500);

		service = getService(Activator.context, IJvmTypeMetadataService.class,
				TIME_1000);
		builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(service);
		assertNotNull(builderService);

		JvmType type2 = service.getJvmType(String.class);
		assertEquals(STRING_CLASS, type.getQualifiedName());

		assertNotSame(type, type2);

		// since the resource was unloaded, the type loaded with old service is
		// an EProxy now
		InternalEObject iType = (InternalEObject) type;
		assertFalse(iType.eIsProxy());
		assertFalse(EcoreUtil.equals(type, type2));
	}

	@Test
	public void testCache() throws Exception {
		IJvmTypeMetadataService service = getService(Activator.context,
				IJvmTypeMetadataService.class, TIME_1000);
		IMetadataBuilderService builderService = getService(Activator.context,
				IMetadataBuilderService.class, TIME_1000);
		assertNotNull(service);
		assertNotNull(builderService);

		JvmType type = service.getJvmType(String.class);
		assertEquals(STRING_CLASS, type.getQualifiedName());

		JvmType type2 = service.getJvmType(String.class);
		assertEquals(STRING_CLASS, type.getQualifiedName());

		InternalEObject iType = (InternalEObject) type;
		assertFalse(iType.eIsProxy());
		assertSame(type, type2);
	}
}