ServiceTrackerCollectionsTest.java

/**
 * Copyright (c) 2000-present Liferay, Inc. All rights reserved.
 *
 * This library is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Lesser General Public License as published by the Free
 * Software Foundation; either version 2.1 of the License, or (at your option)
 * any later version.
 *
 * This library is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
 * details.
 */

package com.liferay.registry.internal.test;

import com.liferay.registry.Filter;
import com.liferay.registry.Registry;
import com.liferay.registry.RegistryUtil;
import com.liferay.registry.ServiceReference;
import com.liferay.registry.ServiceRegistration;
import com.liferay.registry.ServiceTrackerCustomizer;
import com.liferay.registry.collections.ServiceTrackerCollections;
import com.liferay.registry.collections.ServiceTrackerList;
import com.liferay.registry.internal.InterfaceOne;

import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import java.util.concurrent.atomic.AtomicInteger;

import org.jboss.arquillian.junit.Arquillian;
import org.jboss.arquillian.test.api.ArquillianResource;

import org.junit.After;
import org.junit.Assert;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;

import org.osgi.framework.Bundle;
import org.osgi.framework.BundleException;

/**
 * @author Raymond Augé
 * @author Carlos Sierra Andrés
 */
@RunWith(Arquillian.class)
public class ServiceTrackerCollectionsTest {

	@Before
	public void setUp() throws BundleException {
		_bundle.start();

		_registry = RegistryUtil.getRegistry();
	}

	@After
	public void tearDown() throws BundleException {
		_bundle.stop();
	}

	@Test
	public void testClass() {
		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(InterfaceOne.class);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(InterfaceOne.class, interfaceOneA);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 2, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		serviceTrackerList.remove(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
	}

	@Test
	public void testClassFilter() throws Exception {
		Filter filter = _registry.getFilter("(a.property=G)");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(InterfaceOne.class, filter);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(
				InterfaceOne.class, interfaceOneA, properties);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		try {
			serviceTrackerList.add(interfaceOneB);

			Assert.fail();
		}
		catch (IllegalStateException ise) {
		}

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
	}

	@Test
	public void testClassFilterProperties() throws Exception {
		Filter filter = _registry.getFilter("(a.property=G)");

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, filter, properties);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(InterfaceOne.class, interfaceOneA);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
	}

	@Test
	public void testClassFilterServiceTrackerCustomizer() throws Exception {
		Filter filter = _registry.getFilter("(a.property=G)");

		AtomicInteger counter = new AtomicInteger();

		ServiceTrackerCustomizer<InterfaceOne, InterfaceOne>
			serviceTrackerCustomizer = new MockServiceTrackerCustomizer(
				counter);

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, filter, serviceTrackerCustomizer);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(
				InterfaceOne.class, interfaceOneA, properties);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		try {
			serviceTrackerList.add(interfaceOneB);

			Assert.fail();
		}
		catch (IllegalStateException ise) {
		}

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		Assert.assertEquals(1, counter.intValue());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(2, counter.intValue());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(2, counter.intValue());
	}

	@Test
	public void testClassFilterServiceTrackerCustomizerProperties()
		throws Exception {

		Filter filter = _registry.getFilter("(a.property=G)");

		AtomicInteger counter = new AtomicInteger();

		ServiceTrackerCustomizer<InterfaceOne, InterfaceOne>
			serviceTrackerCustomizer = new MockServiceTrackerCustomizer(
				counter);

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, filter, serviceTrackerCustomizer,
				properties);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(InterfaceOne.class, interfaceOneA);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		Assert.assertEquals(1, counter.intValue());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());
		Assert.assertEquals(1, counter.intValue());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(2, counter.intValue());
	}

	@Test
	public void testClassProperties() throws Exception {
		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(InterfaceOne.class, properties);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(
				InterfaceOne.class, interfaceOneA, properties);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 2, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 2, interfaceOnes.size());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
	}

	@Test
	public void testClassServiceTrackerCustomizer() {
		AtomicInteger counter = new AtomicInteger();

		ServiceTrackerCustomizer<InterfaceOne, InterfaceOne>
			serviceTrackerCustomizer = new MockServiceTrackerCustomizer(
				counter);

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, serviceTrackerCustomizer);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(InterfaceOne.class, interfaceOneA);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 2, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Assert.assertEquals(2, counter.intValue());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());
		Assert.assertEquals(3, counter.intValue());

		serviceTrackerList.remove(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(4, counter.intValue());
	}

	@Test
	public void testClassServiceTrackerCustomizerCustomizerProperties1()
		throws Exception {

		AtomicInteger counter = new AtomicInteger();

		ServiceTrackerCustomizer<InterfaceOne, InterfaceOne>
			serviceTrackerCustomizer = new MockServiceTrackerCustomizer(
				counter);

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, serviceTrackerCustomizer, properties);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(
				InterfaceOne.class, interfaceOneA, properties);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 2, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 2, interfaceOnes.size());

		Assert.assertEquals(2, counter.intValue());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());
		Assert.assertEquals(3, counter.intValue());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(4, counter.intValue());
	}

	@Test
	public void testClassServiceTrackerCustomizerCustomizerProperties2()
		throws Exception {

		AtomicInteger counter = new AtomicInteger();

		ServiceTrackerCustomizer<InterfaceOne, InterfaceOne>
			serviceTrackerCustomizer = new MockServiceTrackerCustomizer(
				counter);

		Map<String, Object> properties = new HashMap<>();

		properties.put("a.property", "G");

		ServiceTrackerList<InterfaceOne> serviceTrackerList =
			ServiceTrackerCollections.openList(
				InterfaceOne.class, serviceTrackerCustomizer, properties);

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());

		InterfaceOne interfaceOneA = getInstance();

		ServiceRegistration<InterfaceOne> serviceRegistrationA =
			_registry.registerService(InterfaceOne.class, interfaceOneA);

		Assert.assertNotNull(serviceRegistrationA);

		InterfaceOne interfaceOneB = getInstance();

		serviceTrackerList.add(interfaceOneB);

		Assert.assertEquals(
			serviceTrackerList.toString(), 2, serviceTrackerList.size());

		for (InterfaceOne interfaceOne : serviceTrackerList) {
			Assert.assertNotNull(interfaceOne);
		}

		Collection<InterfaceOne> interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		Assert.assertEquals(2, counter.intValue());

		serviceRegistrationA.unregister();

		Assert.assertEquals(
			serviceTrackerList.toString(), 1, serviceTrackerList.size());
		Assert.assertEquals(3, counter.intValue());

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 1, interfaceOnes.size());

		serviceTrackerList.remove(interfaceOneB);

		interfaceOnes = _registry.getServices(
			InterfaceOne.class, "(a.property=G)");

		Assert.assertEquals(interfaceOnes.toString(), 0, interfaceOnes.size());

		Assert.assertEquals(
			serviceTrackerList.toString(), 0, serviceTrackerList.size());
		Assert.assertEquals(4, counter.intValue());
	}

	protected InterfaceOne getInstance() {
		return new InterfaceOne() {};
	}

	@ArquillianResource
	private Bundle _bundle;

	private Registry _registry;

	private class MockServiceTrackerCustomizer
		implements ServiceTrackerCustomizer<InterfaceOne, InterfaceOne> {

		public MockServiceTrackerCustomizer(AtomicInteger counter) {
			_counter = counter;
		}

		@Override
		public InterfaceOne addingService(
			ServiceReference<InterfaceOne> serviceReference) {

			InterfaceOne one = _registry.getService(serviceReference);

			_counter.incrementAndGet();

			return one;
		}

		@Override
		public void modifiedService(
			ServiceReference<InterfaceOne> serviceReference,
			InterfaceOne interfaceOne) {

			_counter.incrementAndGet();
		}

		@Override
		public void removedService(
			ServiceReference<InterfaceOne> serviceReference,
			InterfaceOne interfaceOne) {

			_registry.ungetService(serviceReference);

			_counter.incrementAndGet();
		}

		private final AtomicInteger _counter;

	}

}