Fix flaky test failure in 'AbstractCollectionTest.testCollectionToArray2'
Use the AbstractCollectionTest iteration order flag in Map and Bag tests. These tests have inner classes that extend AbstractCollectionTest to test their values collection. This should be robust to an unspecified iteration order.
diff --git a/src/test/java/org/apache/commons/collections4/bag/CollectionBagTest.java b/src/test/java/org/apache/commons/collections4/bag/CollectionBagTest.java
index 4abdc72..7ed1b7f 100644
--- a/src/test/java/org/apache/commons/collections4/bag/CollectionBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/CollectionBagTest.java
@@ -76,6 +76,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/CollectionBag.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/bag/HashBagTest.java b/src/test/java/org/apache/commons/collections4/bag/HashBagTest.java
index 1323ca0..b1639b8 100644
--- a/src/test/java/org/apache/commons/collections4/bag/HashBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/HashBagTest.java
@@ -45,6 +45,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// Bag<T> bag = makeObject();
// writeExternalFormToDisk((java.io.Serializable) bag, "src/test/resources/data/test/HashBag.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/bag/PredicatedBagTest.java b/src/test/java/org/apache/commons/collections4/bag/PredicatedBagTest.java
index 5670607..82a1657 100644
--- a/src/test/java/org/apache/commons/collections4/bag/PredicatedBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/PredicatedBagTest.java
@@ -61,6 +61,11 @@
return decorateBag(new HashBag<T>(), stringPredicate());
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testlegalAddRemove() {
diff --git a/src/test/java/org/apache/commons/collections4/bag/TransformedBagTest.java b/src/test/java/org/apache/commons/collections4/bag/TransformedBagTest.java
index bafb138..cff890f 100644
--- a/src/test/java/org/apache/commons/collections4/bag/TransformedBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/TransformedBagTest.java
@@ -46,6 +46,11 @@
(Transformer<T, T>) TransformedCollectionTest.NOOP_TRANSFORMER);
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testTransformedBag() {
diff --git a/src/test/java/org/apache/commons/collections4/bag/UnmodifiableBagTest.java b/src/test/java/org/apache/commons/collections4/bag/UnmodifiableBagTest.java
index 1a2c834..2d8369a 100644
--- a/src/test/java/org/apache/commons/collections4/bag/UnmodifiableBagTest.java
+++ b/src/test/java/org/apache/commons/collections4/bag/UnmodifiableBagTest.java
@@ -74,6 +74,11 @@
return false;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
@Test
public void testUnmodifiable() {
assertTrue(makeObject() instanceof Unmodifiable);
diff --git a/src/test/java/org/apache/commons/collections4/bidimap/AbstractBidiMapTest.java b/src/test/java/org/apache/commons/collections4/bidimap/AbstractBidiMapTest.java
index 8c69f7e..8a9a0b6 100644
--- a/src/test/java/org/apache/commons/collections4/bidimap/AbstractBidiMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/bidimap/AbstractBidiMapTest.java
@@ -464,6 +464,10 @@
return main.isRemoveSupported();
}
+ @Override
+ protected int getIterationBehaviour() {
+ return main.getIterationBehaviour();
+ }
}
public BulkTest bulkTestBidiMapIterator() {
diff --git a/src/test/java/org/apache/commons/collections4/bidimap/DualHashBidiMapTest.java b/src/test/java/org/apache/commons/collections4/bidimap/DualHashBidiMapTest.java
index d9e67e4..219adde 100644
--- a/src/test/java/org/apache/commons/collections4/bidimap/DualHashBidiMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/bidimap/DualHashBidiMapTest.java
@@ -17,6 +17,7 @@
package org.apache.commons.collections4.bidimap;
import org.apache.commons.collections4.BulkTest;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
/**
* JUnit tests.
@@ -47,6 +48,11 @@
return new String[] { "DualHashBidiMapTest.bulkTestInverseMap.bulkTestInverseMap" };
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) map, "src/test/resources/data/test/DualHashBidiMap.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMapTest.java b/src/test/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMapTest.java
index 7a0f267..8950b5a 100644
--- a/src/test/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/bidimap/UnmodifiableBidiMapTest.java
@@ -24,6 +24,7 @@
import org.apache.commons.collections4.BidiMap;
import org.apache.commons.collections4.BulkTest;
import org.apache.commons.collections4.Unmodifiable;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.junit.jupiter.api.Test;
/**
@@ -79,6 +80,11 @@
return false;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
@Test
public void testUnmodifiable() {
assertTrue(makeObject() instanceof Unmodifiable);
diff --git a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
index fa6e201..7add046 100644
--- a/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
+++ b/src/test/java/org/apache/commons/collections4/collection/AbstractCollectionTest.java
@@ -147,7 +147,7 @@
* then the behaviour is assumed to be ordered and the output order of the iterator is matched by
* the toArray method.
*/
- protected static final int UNORDERED = 0x1;
+ public static final int UNORDERED = 0x1;
// These fields are used by reset() and verify(), and any test
// method that tests a modification.
diff --git a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
index 21fca7c..c96edf8 100644
--- a/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/AbstractMapTest.java
@@ -63,6 +63,13 @@
* <li>{@link #getOtherValues()}
* </ul>
*
+ * <b>Indicate Map Behaviour</b>
+ * <p>
+ * Override these if your map makes specific behaviour guarantees:
+ * <ul>
+ * <li>{@link #getIterationBehaviour()}</li>
+ * </ul>
+ *
* <b>Supported Operation Methods</b>
* <p>
* Override these methods if your map doesn't support certain operations:
@@ -524,6 +531,18 @@
}
}
+ /**
+ * Return a flag specifying the iteration behaviour of the collection.
+ * This is used to change the assertions used by specific tests.
+ * The default implementation returns 0 which indicates ordered iteration behaviour.
+ *
+ * @return the iteration behaviour
+ * @see AbstractCollectionTest#UNORDERED
+ */
+ protected int getIterationBehaviour(){
+ return 0;
+ }
+
// tests begin here. Each test adds a little bit of tested functionality.
// Many methods assume previous methods passed. That is, they do not
// exhaustively recheck things that have already been checked in a previous
@@ -1619,6 +1638,11 @@
TestMapEntrySet.this.setConfirmed(AbstractMapTest.this.getConfirmed().entrySet());
}
+ @Override
+ protected int getIterationBehaviour(){
+ return AbstractMapTest.this.getIterationBehaviour();
+ }
+
@Test
public void testMapEntrySetIteratorEntry() {
resetFull();
@@ -1801,6 +1825,12 @@
super.verify();
AbstractMapTest.this.verify();
}
+
+ @Override
+ protected int getIterationBehaviour(){
+ return AbstractMapTest.this.getIterationBehaviour();
+ }
+
}
/**
@@ -1900,6 +1930,11 @@
AbstractMapTest.this.verify();
}
+ @Override
+ protected int getIterationBehaviour(){
+ return AbstractMapTest.this.getIterationBehaviour();
+ }
+
// TODO: should test that a remove on the values collection view
// removes the proper mapping and not just any mapping that may have
// the value equal to the value returned from the values iterator.
diff --git a/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java b/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
index f190e76..62e98fc 100644
--- a/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/map/PassiveExpiringMapTest.java
@@ -24,6 +24,7 @@
import java.util.concurrent.TimeUnit;
import org.apache.commons.collections4.BulkTest;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.apache.commons.collections4.map.PassiveExpiringMap.ExpirationPolicy;
import org.junit.jupiter.api.Test;
@@ -91,6 +92,11 @@
return new PassiveExpiringMap<>();
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
private Map<Integer, String> makeTestMap() {
final Map<Integer, String> m =
new PassiveExpiringMap<>(new TestExpirationPolicy());
diff --git a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
index a3723fa..e4b7e69 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/AbstractMultiValuedMapTest.java
@@ -60,6 +60,7 @@
/** MultiValuedHashMap created by reset(). */
protected MultiValuedMap<K, V> confirmed;
+
public AbstractMultiValuedMapTest(final String testName) {
super(testName);
}
@@ -211,6 +212,18 @@
}
}
+ /**
+ * Return a flag specifying the iteration behaviour of the map.
+ * This is used to change the assertions used by specific tests.
+ * The default implementation returns 0 which indicates ordered iteration behaviour.
+ *
+ * @return the iteration behaviour
+ * @see AbstractCollectionTest#UNORDERED
+ */
+ protected int getIterationBehaviour() {
+ return 0;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testNoMappingReturnsEmptyCol() {
@@ -954,6 +967,11 @@
return null;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiValuedMapTest.this.getIterationBehaviour();
+ }
+
}
/**
@@ -1009,6 +1027,10 @@
return false;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiValuedMapTest.this.getIterationBehaviour();
+ }
}
/**
@@ -1090,6 +1112,10 @@
return null;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiValuedMapTest.this.getIterationBehaviour();
+ }
}
/**
@@ -1160,6 +1186,10 @@
TestMultiValuedMapKeys.this.setConfirmed(AbstractMultiValuedMapTest.this.getConfirmed().keys());
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiValuedMapTest.this.getIterationBehaviour();
+ }
}
public BulkTest bulkTestAsMap() {
@@ -1257,6 +1287,11 @@
public boolean isTestSerialization() {
return false;
}
+
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiValuedMapTest.this.getIterationBehaviour();
+ }
}
}
diff --git a/src/test/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMapTest.java
index aac4a26..83853ff 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/ArrayListValuedHashMapTest.java
@@ -26,6 +26,7 @@
import org.apache.commons.collections4.BulkTest;
import org.apache.commons.collections4.ListValuedMap;
import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.junit.jupiter.api.Test;
/**
@@ -48,6 +49,11 @@
return new ArrayListValuedHashMap<>();
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testListValuedMapAdd() {
diff --git a/src/test/java/org/apache/commons/collections4/multimap/HashSetValuedHashMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/HashSetValuedHashMapTest.java
index fc9da21..0c4f3d9 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/HashSetValuedHashMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/HashSetValuedHashMapTest.java
@@ -24,6 +24,7 @@
import org.apache.commons.collections4.BulkTest;
import org.apache.commons.collections4.MultiValuedMap;
import org.apache.commons.collections4.SetValuedMap;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.junit.jupiter.api.Test;
/**
@@ -56,6 +57,11 @@
return true;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testSetValuedMapAdd() {
diff --git a/src/test/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMapTest.java
index 37b276d..7995bd6 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/TransformedMultiValuedMapTest.java
@@ -22,6 +22,7 @@
import org.apache.commons.collections4.MultiValuedMap;
import org.apache.commons.collections4.Transformer;
import org.apache.commons.collections4.TransformerUtils;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.apache.commons.collections4.collection.TransformedCollectionTest;
import org.junit.jupiter.api.Test;
@@ -46,6 +47,11 @@
TransformerUtils.<K>nopTransformer(), TransformerUtils.<V>nopTransformer());
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testKeyTransformedMap() {
diff --git a/src/test/java/org/apache/commons/collections4/multimap/UnmodifiableMultiValuedMapTest.java b/src/test/java/org/apache/commons/collections4/multimap/UnmodifiableMultiValuedMapTest.java
index dbae6e9..6038350 100644
--- a/src/test/java/org/apache/commons/collections4/multimap/UnmodifiableMultiValuedMapTest.java
+++ b/src/test/java/org/apache/commons/collections4/multimap/UnmodifiableMultiValuedMapTest.java
@@ -31,6 +31,7 @@
import org.apache.commons.collections4.MultiSet;
import org.apache.commons.collections4.MultiValuedMap;
import org.apache.commons.collections4.Unmodifiable;
+import org.apache.commons.collections4.collection.AbstractCollectionTest;
import org.junit.jupiter.api.Test;
/**
@@ -82,6 +83,11 @@
return UnmodifiableMultiValuedMap.<K, V>unmodifiableMultiValuedMap(map);
}
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractCollectionTest.UNORDERED;
+ }
+
@Test
public void testUnmodifiable() {
assertTrue(makeObject() instanceof Unmodifiable);
diff --git a/src/test/java/org/apache/commons/collections4/multiset/AbstractMultiSetTest.java b/src/test/java/org/apache/commons/collections4/multiset/AbstractMultiSetTest.java
index 1b9cfb7..1f41f14 100644
--- a/src/test/java/org/apache/commons/collections4/multiset/AbstractMultiSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/multiset/AbstractMultiSetTest.java
@@ -687,6 +687,11 @@
public void verify() {
super.verify();
}
+
+ @Override
+ protected int getIterationBehaviour() {
+ return AbstractMultiSetTest.this.getIterationBehaviour();
+ }
}
diff --git a/src/test/java/org/apache/commons/collections4/multiset/HashMultiSetTest.java b/src/test/java/org/apache/commons/collections4/multiset/HashMultiSetTest.java
index f7556d5..65c0924 100644
--- a/src/test/java/org/apache/commons/collections4/multiset/HashMultiSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/multiset/HashMultiSetTest.java
@@ -46,6 +46,11 @@
return "4.1";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// MultiSet<T> multiset = makeObject();
// writeExternalFormToDisk((java.io.Serializable) multiset, "src/test/resources/data/test/HashMultiSet.emptyCollection.version4.1.obj");
diff --git a/src/test/java/org/apache/commons/collections4/multiset/PredicatedMultiSetTest.java b/src/test/java/org/apache/commons/collections4/multiset/PredicatedMultiSetTest.java
index 853c520..c2aa7aa 100644
--- a/src/test/java/org/apache/commons/collections4/multiset/PredicatedMultiSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/multiset/PredicatedMultiSetTest.java
@@ -61,6 +61,11 @@
return decorateMultiSet(new HashMultiSet<T>(), stringPredicate());
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
@Test
@SuppressWarnings("unchecked")
public void testLegalAddRemove() {
diff --git a/src/test/java/org/apache/commons/collections4/multiset/SynchronizedMultiSetTest.java b/src/test/java/org/apache/commons/collections4/multiset/SynchronizedMultiSetTest.java
index dec0bed..6052517 100644
--- a/src/test/java/org/apache/commons/collections4/multiset/SynchronizedMultiSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/multiset/SynchronizedMultiSetTest.java
@@ -46,6 +46,11 @@
return "4.1";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// MultiSet<T> multiset = makeObject();
// writeExternalFormToDisk((java.io.Serializable) multiset, "src/test/resources/data/test/SynchronizedMultiSet.emptyCollection.version4.1.obj");
diff --git a/src/test/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSetTest.java b/src/test/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSetTest.java
index a89658c..45029f5 100644
--- a/src/test/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/multiset/UnmodifiableMultiSetTest.java
@@ -73,6 +73,11 @@
return false;
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
@Test
public void testUnmodifiable() {
assertTrue(makeObject() instanceof Unmodifiable);
diff --git a/src/test/java/org/apache/commons/collections4/set/CompositeSetTest.java b/src/test/java/org/apache/commons/collections4/set/CompositeSetTest.java
index f7b9d4c..669ebea 100644
--- a/src/test/java/org/apache/commons/collections4/set/CompositeSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/set/CompositeSetTest.java
@@ -191,6 +191,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/CompositeSet.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/set/PredicatedSetTest.java b/src/test/java/org/apache/commons/collections4/set/PredicatedSetTest.java
index d3c4e38..9edaf2e 100644
--- a/src/test/java/org/apache/commons/collections4/set/PredicatedSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/set/PredicatedSetTest.java
@@ -99,6 +99,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/PredicatedSet.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/set/TransformedSetTest.java b/src/test/java/org/apache/commons/collections4/set/TransformedSetTest.java
index 605d9f2..80b432a 100644
--- a/src/test/java/org/apache/commons/collections4/set/TransformedSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/set/TransformedSetTest.java
@@ -102,6 +102,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/TransformedSet.emptyCollection.version4.obj");
diff --git a/src/test/java/org/apache/commons/collections4/set/UnmodifiableSetTest.java b/src/test/java/org/apache/commons/collections4/set/UnmodifiableSetTest.java
index a1e12eb..e37f993 100644
--- a/src/test/java/org/apache/commons/collections4/set/UnmodifiableSetTest.java
+++ b/src/test/java/org/apache/commons/collections4/set/UnmodifiableSetTest.java
@@ -82,6 +82,11 @@
return "4";
}
+ @Override
+ protected int getIterationBehaviour() {
+ return UNORDERED;
+ }
+
// public void testCreate() throws Exception {
// resetEmpty();
// writeExternalFormToDisk((java.io.Serializable) getCollection(), "src/test/resources/data/test/UnmodifiableSet.emptyCollection.version4.obj");
