PropertyServiceReferenceComparatorTest.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.osgi.service.tracker.collections.map;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

import org.junit.Assert;
import org.junit.Test;

import org.osgi.framework.Bundle;
import org.osgi.framework.ServiceReference;

/**
 * @author Carlos Sierra Andrés
 */
public class PropertyServiceReferenceComparatorTest {

	@Test
	public void testCompare() {
		PropertyServiceReferenceComparator<Object>
			propertyServiceReferenceComparator =
				new PropertyServiceReferenceComparator<>("ranking");

		ServiceReference<Object> serviceReference1 = new TestServiceReference<>(
			"ranking", 1);
		ServiceReference<Object> serviceReference2 = new TestServiceReference<>(
			"ranking", 2);

		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference1) < 0);
		Assert.assertEquals(
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference2),
			-propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference1));

		ServiceReference<Object> serviceReference3 = new TestServiceReference<>(
			"ranking", 1);

		Assert.assertEquals(
			0,
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference3));
	}

	@Test
	public void testCompareIsTransitiveWhenServiceReferencePropertiesAreNull() {
		PropertyServiceReferenceComparator<Object>
			propertyServiceReferenceComparator =
				new PropertyServiceReferenceComparator<>("ranking");

		ServiceReference<Object> serviceReference1 = new TestServiceReference<>(
			"ranking", -1);
		ServiceReference<Object> serviceReference2 = new TestServiceReference<>(
			"ranking", 0);
		ServiceReference<Object> serviceReference3 = new TestServiceReference<>(
			"ranking", 1);
		ServiceReference<Object> serviceReference4 =
			new TestServiceReference<>();

		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference4, serviceReference1) > 0);

		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference4, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference4, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference3) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference4, serviceReference3) > 0);
	}

	@Test
	public void testCompareIsTransitiveWhenServiceReferencesAreNull() {
		PropertyServiceReferenceComparator<Object>
			propertyServiceReferenceComparator =
				new PropertyServiceReferenceComparator<>("ranking");

		ServiceReference<Object> serviceReference1 = new TestServiceReference<>(
			"ranking", -1);
		ServiceReference<Object> serviceReference2 = new TestServiceReference<>(
			"ranking", 0);
		ServiceReference<Object> serviceReference3 = new TestServiceReference<>(
			"ranking", 1);

		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				null, serviceReference1) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				null, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				null, serviceReference2) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference3) > 0);
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				null, serviceReference3) > 0);
	}

	@Test
	public void testCompareWhenServiceReferencePropertiesAreNull() {
		PropertyServiceReferenceComparator<Object>
			propertyServiceReferenceComparator =
				new PropertyServiceReferenceComparator<>("ranking");

		ServiceReference<Object> serviceReference1 = new TestServiceReference<>(
			"ranking", 1);
		ServiceReference<Object> serviceReference2 =
			new TestServiceReference<>();

		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference2) < 0);
		Assert.assertEquals(
			propertyServiceReferenceComparator.compare(
				serviceReference1, serviceReference2),
			-propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference1));

		ServiceReference<Object> serviceReference3 =
			new TestServiceReference<>();

		Assert.assertEquals(
			0,
			propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference3));
		Assert.assertEquals(
			propertyServiceReferenceComparator.compare(
				serviceReference2, serviceReference3),
			-propertyServiceReferenceComparator.compare(
				serviceReference3, serviceReference2));
	}

	@Test
	public void testCompareWhenServiceReferencesAreNull() {
		PropertyServiceReferenceComparator<Object>
			propertyServiceReferenceComparator =
				new PropertyServiceReferenceComparator<>("ranking");

		ServiceReference<Object> serviceReference1 = new TestServiceReference<>(
			"ranking", 1);

		Assert.assertEquals(
			0, propertyServiceReferenceComparator.compare(null, null));
		Assert.assertTrue(
			propertyServiceReferenceComparator.compare(
				serviceReference1, null) < 0);
		Assert.assertEquals(
			propertyServiceReferenceComparator.compare(serviceReference1, null),
			-propertyServiceReferenceComparator.compare(
				null, serviceReference1));
	}

	private static class TestServiceReference<S>
		implements ServiceReference<S> {

		public TestServiceReference(Object... arguments) {
			Map<String, Object> properties = new HashMap<>();

			for (int i = 0; i < arguments.length; i += 2) {
				String key = String.valueOf(arguments[i]);
				Object value = arguments[i + 1];

				properties.put(key, value);
			}

			_properties = properties;
		}

		@Override
		public int compareTo(Object object) {
			if (object == null) {
				return 1;
			}

			String s = toString();

			return s.compareTo(object.toString());
		}

		@Override
		public Bundle getBundle() {
			throw new UnsupportedOperationException();
		}

		@Override
		public Object getProperty(String key) {
			return _properties.get(key);
		}

		@Override
		public String[] getPropertyKeys() {
			Set<String> keys = _properties.keySet();

			return keys.toArray(new String[keys.size()]);
		}

		@Override
		public Bundle[] getUsingBundles() {
			throw new UnsupportedOperationException();
		}

		@Override
		public boolean isAssignableTo(Bundle bundle, String className) {
			throw new UnsupportedOperationException();
		}

		private final Map<String, Object> _properties;

	}

}