core/tests/org.eclipse.dltk.debug.tests/src/org/eclipse/dltk/internal/debug/tests/VariableNameComparatorTest.java

package org.eclipse.dltk.internal.debug.tests;

import static org.junit.Assert.assertArrayEquals;
import static org.junit.Assert.assertEquals;

import java.util.ArrayList;
import java.util.Arrays;

import org.eclipse.debug.core.DebugException;
import org.eclipse.debug.core.ILaunch;
import org.eclipse.debug.core.model.IDebugTarget;
import org.eclipse.debug.core.model.IValue;
import org.eclipse.debug.core.model.IVariable;
import org.eclipse.dltk.internal.debug.core.model.VariableNameComparator;
import org.junit.Before;
import org.junit.Test;

public class VariableNameComparatorTest {

	protected ArrayList<IVariable> list;
	protected VariableNameComparator comparator;

	@Before
	public void setUp() {
		comparator = new VariableNameComparator();
		if (list == null)
			list = new ArrayList<>();
		else
			list.clear();
	}

	protected void assertSortedListNamesEqual(String... expectedListNames) throws DebugException {
		// when comparator doesn't adhere to the "Comparator" contract this
		// could give an exception
		IVariable[] tmp = new IVariable[list.size()];

		Arrays.sort(list.toArray(tmp), comparator);
		String[] tmpNames = new String[tmp.length];
		for (int i = 0; i < tmp.length; i++) {
			tmpNames[i] = tmp[i].getName();
		}

		assertEquals(expectedListNames.length, tmp.length);
		assertArrayEquals(expectedListNames, tmpNames);
	}

	@Test
	public void testStringVariables1() throws DebugException {
		list.add(getNewVariable("b"));
		list.add(getNewVariable("c"));
		list.add(getNewVariable("a"));

		assertSortedListNamesEqual("a", "b", "c");
	}

	@Test
	public void testIntVariables1() throws DebugException {
		list.add(getNewVariable("3"));
		list.add(getNewVariable("2"));
		list.add(getNewVariable("1"));

		assertSortedListNamesEqual("1", "2", "3");
	}

	@Test
	public void testIntVariables2() throws DebugException {
		list.add(getNewVariable("115"));
		list.add(getNewVariable("2"));
		list.add(getNewVariable("003"));

		assertSortedListNamesEqual("2", "003", "115");
	}

	@Test
	public void testMixedVariables1() throws DebugException {
		list.add(getNewVariable("b"));
		list.add(getNewVariable("4"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("116"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("c"));
		list.add(getNewVariable("5"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("114"));
		list.add(getNewVariable("a"));

		// when the comparator doesn't respect it's contract this could get
		// ordered strangely for ArrayList
		assertSortedListNamesEqual("4", "5", "6", "114", "116", "2a", "2a", "2a", "a", "b", "c");
	}

	@Test
	public void testMixedVariables2() throws DebugException {
		// 33 items, enough to trigger merges in Java's Tim-sort alg. (< 32
		// doesn't do merges)
		// + a > 17 consecutive numbers to trigger merges in such a way as to
		// detect Comparator inconsistency

		list.add(getNewVariable("1"));
		list.add(getNewVariable("2"));
		list.add(getNewVariable("3"));
		list.add(getNewVariable("4"));
		list.add(getNewVariable("5"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("7"));
		list.add(getNewVariable("8"));
		list.add(getNewVariable("9"));
		list.add(getNewVariable("10"));
		list.add(getNewVariable("11"));

		list.add(getNewVariable("12"));
		list.add(getNewVariable("13"));
		list.add(getNewVariable("14"));
		list.add(getNewVariable("15"));
		list.add(getNewVariable("16"));
		list.add(getNewVariable("17"));
		list.add(getNewVariable("18"));

		list.add(getNewVariable("2a"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("114"));
		list.add(getNewVariable("a"));

		list.add(getNewVariable("b"));
		list.add(getNewVariable("4"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("116"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("c"));
		list.add(getNewVariable("5"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("114"));
		list.add(getNewVariable("a"));

		list.add(getNewVariable("b"));
		list.add(getNewVariable("4"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("116"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("c"));
		list.add(getNewVariable("5"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("114"));
		list.add(getNewVariable("a"));

		list.add(getNewVariable("b"));
		list.add(getNewVariable("4"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("116"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("c"));
		list.add(getNewVariable("5"));
		list.add(getNewVariable("2a"));
		list.add(getNewVariable("6"));
		list.add(getNewVariable("114"));
		list.add(getNewVariable("a"));

		// this array configuration used to throw an exception directly when
		// sorting
		// so it didn't even reach the compare expected sorted result part...

		// java.lang.IllegalArgumentException: Comparison method violates its
		// general contract!
		// at java.util.TimSort.mergeHi(TimSort.java:868)
		// at java.util.TimSort.mergeAt(TimSort.java:485)
		// at java.util.TimSort.mergeForceCollapse(TimSort.java:426)
		// at java.util.TimSort.sort(TimSort.java:223)
		// at java.util.TimSort.sort(TimSort.java:173)
		// at java.util.Arrays.sort(Arrays.java:659)
		// at
		// org.eclipse.dltk.internal.debug.tests.VariableNameComparatorTest.assertSortedListNamesEqual(VariableNameComparatorTest.java:31)
		// at
		// org.eclipse.dltk.internal.debug.tests.VariableNameComparatorTest.testMixedVariables2(VariableNameComparatorTest.java:158)
		// (...)

		assertSortedListNamesEqual("1", "2", "3", "4", "4", "4", "4", "5", "5", "5", "5", "6", "6", "6", "6", "6", "7",
				"8", "9", "10", "11", "12", "13", "14", "15", "16", "17", "18", "114", "114", "114", "114", "116",
				"116", "116", "2a", "2a", "2a", "2a", "2a", "2a", "2a", "2a", "2a", "2a", "a", "a", "a", "a", "b", "b",
				"b", "c", "c", "c");
	}

	protected IVariable getNewVariable(final String name) {
		return new IVariable() {

			@Override
			public boolean verifyValue(IValue value) {
				// dummy
				return false;
			}

			@Override
			public boolean verifyValue(String expression) {
				// dummy
				return false;
			}

			@Override
			public boolean supportsValueModification() {
				// dummy
				return false;
			}

			@Override
			public void setValue(IValue value) {
				// dummy
			}

			@Override
			public void setValue(String expression) {
				// dummy
			}

			@Override
			public <T> T getAdapter(Class<T> adapter) {
				// dummy
				return null;
			}

			@Override
			public String getModelIdentifier() {
				// dummy
				return null;
			}

			@Override
			public ILaunch getLaunch() {
				// dummy
				return null;
			}

			@Override
			public IDebugTarget getDebugTarget() {
				// dummy
				return null;
			}

			@Override
			public boolean hasValueChanged() {
				// dummy
				return false;
			}

			@Override
			public IValue getValue() {
				// dummy
				return null;
			}

			@Override
			public String getReferenceTypeName() {
				// dummy
				return null;
			}

			@Override
			public String getName() {
				return name;
			}

			@Override
			public String toString() {
				return name;
			}

		};
	}

}