RESOLVED - bug 321428: [RemoteSrvc] OSGi DistributionProvider tests leave service registered in case of a test failure

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

2 files changed, 101 insertions, 151 deletions

diff --git a/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceAccessTest.java b/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceAccessTest.java
index 61093b711..a307a8bb6 100644
--- a/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceAccessTest.java
+++ b/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceAccessTest.java
@@ -26,14 +26,48 @@ import org.osgi.util.tracker.ServiceTracker;
 public abstract class AbstractRemoteServiceAccessTest extends
 		AbstractDistributionTest {
 
-	private static final String TESTPROP1_VALUE = "baz";
-	private static final String TESTPROP_VALUE = "foobar";
-	private static final String TESTPROP1_NAME = "org.eclipse.ecf.testprop1";
-	private static final String TESTPROP_NAME = "org.eclipse.ecf.testprop";
 	protected static final int REGISTER_WAIT = Integer.parseInt(System.getProperty("waittime","15000"));
 
+	private final String classname = TestServiceInterface1.class.getName();
+	private ServiceTracker st;
+	private ServiceRegistration registration;
+
+	/* (non-Javadoc)
+	 * @see org.eclipse.ecf.tests.osgi.services.distribution.AbstractDistributionTest#tearDown()
+	 */
+	protected void tearDown() throws Exception {
+		// Unregister on server
+		if (registration != null) {
+			registration.unregister();
+			registration = null;
+		}
+		if (st != null) {
+			st.close();
+			st = null;
+		}
+		Thread.sleep(REGISTER_WAIT);
+
+		super.tearDown();
+	}
+
+	protected void createServiceTrackerAndRegister(final Properties props) throws Exception {
+		// Setup service tracker for client
+		st = createProxyServiceTracker(classname);
+
+		// Actually register
+		registration = registerService(classname,
+				new TestService1(), props);
+
+		// Wait
+		Thread.sleep(REGISTER_WAIT);
+	}
+
+	protected void createServiceTrackerAndRegister() throws Exception {
+		createServiceTrackerAndRegister(getServiceProperties());
+	}
+
 	protected Properties getServiceProperties() {
-		Properties props = new Properties();
+		final Properties props = new Properties();
 		props.put(SERVICE_EXPORTED_CONFIGS, getServerContainerName());
 		props.put(SERVICE_EXPORTED_INTERFACES, SERVICE_EXPORTED_INTERFACES_WILDCARD);
 		return props;
@@ -59,177 +93,113 @@ public abstract class AbstractRemoteServiceAccessTest extends
 
 
 	public void testGetRemoteServiceReference() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client container
-		ServiceTracker st = createProxyServiceTracker(classname);
-		// Get service properties...and allow subclasses to override to add
-		// other service properties
-		Properties props = getServiceProperties();
-		// Service Host: register service
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), props);
-		// Wait
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Service Consumer - Get (remote) ervice references
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValidAndFirstHasCorrectType(remoteReferences, classname);
 		// Spec requires that the 'service.imported' property be set
 		assertTrue(remoteReferences[0].getProperty(SERVICE_IMPORTED) != null);
-		
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 	
 	public void testGetRemoteServiceReferenceWithExtraProperties() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client container
-		ServiceTracker st = createProxyServiceTracker(classname);
-		// Get service properties...and allow subclasses to override to add
-		// other service properties
-		Properties props = getServiceProperties();
+		final String TESTPROP1_VALUE = "baz";
+		final String TESTPROP_VALUE = "foobar";
+		final String TESTPROP1_NAME = "org.eclipse.ecf.testprop1";
+		final String TESTPROP_NAME = "org.eclipse.ecf.testprop";
+
+		final Properties props = getServiceProperties();
 		// Add other properties
 		props.put(TESTPROP_NAME, TESTPROP_VALUE);
 		props.put(TESTPROP1_NAME,TESTPROP1_VALUE);
-		// Service Host: register service
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), props);
-		// Wait
-		Thread.sleep(REGISTER_WAIT);
+		createServiceTrackerAndRegister(props);
 
 		// Service Consumer - Get (remote) ervice references
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValidAndFirstHasCorrectType(remoteReferences, classname);
 		// Spec requires that the 'service.imported' property be set
 		assertTrue(remoteReferences[0].getProperty(SERVICE_IMPORTED) != null);
 		
-		String testProp = (String) remoteReferences[0].getProperty(TESTPROP_NAME);
-		String testProp1 = (String) remoteReferences[0].getProperty(TESTPROP1_NAME);
+		final String testProp = (String) remoteReferences[0].getProperty(TESTPROP_NAME);
+		final String testProp1 = (String) remoteReferences[0].getProperty(TESTPROP1_NAME);
 		assertTrue(TESTPROP_VALUE.equals(testProp));
 		assertTrue(TESTPROP1_VALUE.equals(testProp1));
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 
 	public void testProxy() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValidAndFirstHasCorrectType(remoteReferences, classname);
 
 		// Get proxy/service
-		TestServiceInterface1 proxy = (TestServiceInterface1) getContext()
+		final TestServiceInterface1 proxy = (TestServiceInterface1) getContext()
 				.getService(remoteReferences[0]);
 		assertNotNull(proxy);
 		// Now use proxy
-		String result = proxy.doStuff1();
+		final String result = proxy.doStuff1();
 		Trace.trace(Activator.PLUGIN_ID, "proxy.doStuff1 result=" + result);
 		assertTrue(TestServiceInterface1.TEST_SERVICE_STRING1.equals(result));
-
-		// Unregister on server and wait
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 	public void testCallSyncFromProxy() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValidAndFirstHasCorrectType(remoteReferences, classname);
 
 		// Get proxy
-		TestServiceInterface1 proxy = (TestServiceInterface1) getContext()
+		final TestServiceInterface1 proxy = (TestServiceInterface1) getContext()
 				.getService(remoteReferences[0]);
 
 		assertProxyValid(proxy);
 		
 		// Get IRemoteService from proxy
-		IRemoteService remoteService = getRemoteServiceFromProxy(proxy);
+		final IRemoteService remoteService = getRemoteServiceFromProxy(proxy);
 
 		// Call remote service synchronously
-		Object result = remoteService.callSync(createRemoteCall());
+		final Object result = remoteService.callSync(createRemoteCall());
 		Trace.trace(Activator.PLUGIN_ID, "proxy.doStuff1 result=" + result);
 		assertStringResultValid(result, TestServiceInterface1.TEST_SERVICE_STRING1);
-		
-		// Unregister on server and wait
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 	public void testCallSync() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValidAndFirstHasCorrectType(remoteReferences, classname);
 
-		Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
+		final Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
 		assertNotNull(o);
 		assertTrue(o instanceof IRemoteService);
-		IRemoteService rs = (IRemoteService) o;
+		final IRemoteService rs = (IRemoteService) o;
 
 		// Call synchronously
-		Object result = rs.callSync(createRemoteCall());
+		final Object result = rs.callSync(createRemoteCall());
 		Trace.trace(Activator.PLUGIN_ID, "callSync.doStuff1 result=" + result);
 		assertStringResultValid(result, TestServiceInterface1.TEST_SERVICE_STRING1);
-
-		// Unregister on server
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 	public void testCallAsync() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValid(remoteReferences);
 
-		Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
+		final Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
 		assertNotNull(o);
 		assertTrue(o instanceof IRemoteService);
-		IRemoteService rs = (IRemoteService) o;
+		final IRemoteService rs = (IRemoteService) o;
 		// Call asynchronously
 		rs.callAsync(createRemoteCall(), new IRemoteCallListener() {
-			public void handleEvent(IRemoteCallEvent event) {
+			public void handleEvent(final IRemoteCallEvent event) {
 				if (event instanceof IRemoteCallCompleteEvent) {
-					Object result = ((IRemoteCallCompleteEvent) event)
+					final Object result = ((IRemoteCallCompleteEvent) event)
 							.getResponse();
 					Trace.trace(Activator.PLUGIN_ID,
 							"callSync.doStuff1 result=" + result);
@@ -240,69 +210,41 @@ public abstract class AbstractRemoteServiceAccessTest extends
 		});
 
 		syncWaitForNotify(REGISTER_WAIT);
-		// Unregister on server
-		registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 	public void testCallFuture() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValid(remoteReferences);
 
-		Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
+		final Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
 		assertNotNull(o);
 		assertTrue(o instanceof IRemoteService);
-		IRemoteService rs = (IRemoteService) o;
+		final IRemoteService rs = (IRemoteService) o;
 		// Call asynchronously
-		IFuture futureResult = rs.callAsync(createRemoteCall());
+		final IFuture futureResult = rs.callAsync(createRemoteCall());
 
 		// now get result from futureResult
-		Object result = futureResult.get();
+		final Object result = futureResult.get();
 		Trace.trace(Activator.PLUGIN_ID, "callSync.doStuff1 result=" + result);
 		assertStringResultValid(result, TestServiceInterface1.TEST_SERVICE_STRING1);
-
-		// Unregister on server
-		if (registration != null) registration.unregister();
-		st.close();
-		Thread.sleep(REGISTER_WAIT);
 	}
 
 	public void testFireAsync() throws Exception {
-		String classname = TestServiceInterface1.class.getName();
-		// Setup service tracker for client
-		ServiceTracker st = createProxyServiceTracker(classname);
-
-		// Actually register and wait a while
-		ServiceRegistration registration = registerService(classname,
-				new TestService1(), getServiceProperties());
-		Thread.sleep(REGISTER_WAIT);
-
+		createServiceTrackerAndRegister();
+		
 		// Client - Get service references from service tracker
-		ServiceReference[] remoteReferences = st.getServiceReferences();
+		final ServiceReference[] remoteReferences = st.getServiceReferences();
 		assertReferencesValid(remoteReferences);
 
-		Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
+		final Object o = remoteReferences[0].getProperty(SERVICE_IMPORTED);
 		assertNotNull(o);
 		assertTrue(o instanceof IRemoteService);
-		IRemoteService rs = (IRemoteService) o;
+		final IRemoteService rs = (IRemoteService) o;
 		// Call asynchronously
 		rs.fireAsync(createRemoteCall());
-		Thread.sleep(5000);
-		// Unregister on server
-		if (registration != null) registration.unregister();
-		st.close();
 		Thread.sleep(REGISTER_WAIT);
 	}
-
 }
diff --git a/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceRegisterTest.java b/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceRegisterTest.java
index 35eb6f3a9..fba70b723 100644
--- a/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceRegisterTest.java
+++ b/tests/bundles/org.eclipse.ecf.tests.osgi.services.distribution/src/org/eclipse/ecf/tests/osgi/services/distribution/AbstractRemoteServiceRegisterTest.java
@@ -24,11 +24,20 @@ public abstract class AbstractRemoteServiceRegisterTest extends
 		AbstractDistributionTest {
 
 	protected static final int REGISTER_WAIT = 2000;
+	private ServiceRegistration registration;
 
 	protected abstract String getServerContainerTypeName();
 	
 	protected void tearDown() throws Exception {
+		// Then unregister
+		if(registration != null) {
+			registration.unregister();
+			registration = null;
+		}
+		Thread.sleep(REGISTER_WAIT);
+		
 		super.tearDown();
+		
 		IContainer [] containers = getContainerManager().getAllContainers();
 		for(int i=0; i < containers.length; i++) {
 			containers[i].dispose();
@@ -39,14 +48,13 @@ public abstract class AbstractRemoteServiceRegisterTest extends
 	
 	protected void registerWaitAndUnregister(Properties props, boolean verifyRegistration) throws Exception {
 		// Actually register with default service (IConcatService)
-		ServiceRegistration registration = registerDefaultService(props);
+		registration = registerDefaultService(props);
 		// Wait a while
 		Thread.sleep(REGISTER_WAIT);
 		// Verify
-		if (verifyRegistration) verifyRemoteServiceRegisteredWithServer();
-		// Then unregister
-		registration.unregister();
-		Thread.sleep(REGISTER_WAIT);
+		if (verifyRegistration) {
+			verifyRemoteServiceRegisteredWithServer();
+		}
 	}
 
 	private void verifyRemoteServiceRegisteredWithServer() throws Exception {