ListTestSuiteBuilder.java revision 3c77433663281544363151bf284b0240dfd22a42
11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2008 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.collect.testing; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.CollectionFeature; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.Feature; 213c77433663281544363151bf284b0240dfd22a42Paul Duffinimport com.google.common.collect.testing.testers.CollectionSerializationEqualTester; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListAddAllAtIndexTester; 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListAddAllTester; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListAddAtIndexTester; 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListAddTester; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListCreationTester; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListEqualsTester; 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListGetTester; 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListHashCodeTester; 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListIndexOfTester; 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListLastIndexOfTester; 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListListIteratorTester; 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListRemoveAllTester; 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListRemoveAtIndexTester; 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListRemoveTester; 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListRetainAllTester; 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListSetTester; 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListSubListTester; 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.testers.ListToArrayTester; 403c77433663281544363151bf284b0240dfd22a42Paul Duffinimport com.google.common.testing.SerializableTester; 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport junit.framework.TestSuite; 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 443c77433663281544363151bf284b0240dfd22a42Paul Duffinimport java.util.ArrayList; 453c77433663281544363151bf284b0240dfd22a42Paul Duffinimport java.util.Collection; 463c77433663281544363151bf284b0240dfd22a42Paul Duffinimport java.util.HashSet; 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.List; 483c77433663281544363151bf284b0240dfd22a42Paul Duffinimport java.util.Set; 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Creates, based on your criteria, a JUnit test suite that exhaustively tests 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * a List implementation. 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author George van den Driessche 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic final class ListTestSuiteBuilder<E> extends 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert AbstractCollectionTestSuiteBuilder<ListTestSuiteBuilder<E>, E> { 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public static <E> ListTestSuiteBuilder<E> using( 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert TestListGenerator<E> generator) { 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return new ListTestSuiteBuilder<E>().usingGenerator(generator); 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override protected List<Class<? extends AbstractTester>> getTesters() { 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert List<Class<? extends AbstractTester>> testers 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert = Helpers.copyToList(super.getTesters()); 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 673c77433663281544363151bf284b0240dfd22a42Paul Duffin testers.add(CollectionSerializationEqualTester.class); 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListAddAllAtIndexTester.class); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListAddAllTester.class); 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListAddAtIndexTester.class); 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListAddTester.class); 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListCreationTester.class); 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListEqualsTester.class); 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListGetTester.class); 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListHashCodeTester.class); 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListIndexOfTester.class); 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListLastIndexOfTester.class); 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListListIteratorTester.class); 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListRemoveAllTester.class); 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListRemoveAtIndexTester.class); 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListRemoveTester.class); 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListRetainAllTester.class); 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListSetTester.class); 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListSubListTester.class); 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert testers.add(ListToArrayTester.class); 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return testers; 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * lists have an iteration ordering corresponding to the insertion order. 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public TestSuite createTestSuite() { 943c77433663281544363151bf284b0240dfd22a42Paul Duffin withFeatures(CollectionFeature.KNOWN_ORDER); 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return super.createTestSuite(); 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 973c77433663281544363151bf284b0240dfd22a42Paul Duffin 983c77433663281544363151bf284b0240dfd22a42Paul Duffin @Override 993c77433663281544363151bf284b0240dfd22a42Paul Duffin protected 1003c77433663281544363151bf284b0240dfd22a42Paul Duffin List<TestSuite> 1013c77433663281544363151bf284b0240dfd22a42Paul Duffin createDerivedSuites( 1023c77433663281544363151bf284b0240dfd22a42Paul Duffin FeatureSpecificTestSuiteBuilder< 1033c77433663281544363151bf284b0240dfd22a42Paul Duffin ?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>> parentBuilder) { 1043c77433663281544363151bf284b0240dfd22a42Paul Duffin List<TestSuite> derivedSuites = new ArrayList<TestSuite>( 1053c77433663281544363151bf284b0240dfd22a42Paul Duffin super.createDerivedSuites(parentBuilder)); 1063c77433663281544363151bf284b0240dfd22a42Paul Duffin 1073c77433663281544363151bf284b0240dfd22a42Paul Duffin if (parentBuilder.getFeatures().contains(CollectionFeature.SERIALIZABLE)) { 1083c77433663281544363151bf284b0240dfd22a42Paul Duffin derivedSuites.add(ListTestSuiteBuilder 1093c77433663281544363151bf284b0240dfd22a42Paul Duffin .using(new ReserializedListGenerator<E>(parentBuilder.getSubjectGenerator())) 1103c77433663281544363151bf284b0240dfd22a42Paul Duffin .named(getName() + " reserialized") 1113c77433663281544363151bf284b0240dfd22a42Paul Duffin .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures())) 1123c77433663281544363151bf284b0240dfd22a42Paul Duffin .suppressing(parentBuilder.getSuppressedTests()) 1133c77433663281544363151bf284b0240dfd22a42Paul Duffin .createTestSuite()); 1143c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1153c77433663281544363151bf284b0240dfd22a42Paul Duffin return derivedSuites; 1163c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1173c77433663281544363151bf284b0240dfd22a42Paul Duffin 1183c77433663281544363151bf284b0240dfd22a42Paul Duffin static class ReserializedListGenerator<E> implements TestListGenerator<E>{ 1193c77433663281544363151bf284b0240dfd22a42Paul Duffin final OneSizeTestContainerGenerator<Collection<E>, E> gen; 1203c77433663281544363151bf284b0240dfd22a42Paul Duffin 1213c77433663281544363151bf284b0240dfd22a42Paul Duffin private ReserializedListGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) { 1223c77433663281544363151bf284b0240dfd22a42Paul Duffin this.gen = gen; 1233c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1243c77433663281544363151bf284b0240dfd22a42Paul Duffin 1253c77433663281544363151bf284b0240dfd22a42Paul Duffin @Override 1263c77433663281544363151bf284b0240dfd22a42Paul Duffin public SampleElements<E> samples() { 1273c77433663281544363151bf284b0240dfd22a42Paul Duffin return gen.samples(); 1283c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1293c77433663281544363151bf284b0240dfd22a42Paul Duffin 1303c77433663281544363151bf284b0240dfd22a42Paul Duffin @Override 1313c77433663281544363151bf284b0240dfd22a42Paul Duffin public List<E> create(Object... elements) { 1323c77433663281544363151bf284b0240dfd22a42Paul Duffin return (List<E>) SerializableTester.reserialize(gen.create(elements)); 1333c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1343c77433663281544363151bf284b0240dfd22a42Paul Duffin 1353c77433663281544363151bf284b0240dfd22a42Paul Duffin @Override 1363c77433663281544363151bf284b0240dfd22a42Paul Duffin public E[] createArray(int length) { 1373c77433663281544363151bf284b0240dfd22a42Paul Duffin return gen.createArray(length); 1383c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1393c77433663281544363151bf284b0240dfd22a42Paul Duffin 1403c77433663281544363151bf284b0240dfd22a42Paul Duffin @Override 1413c77433663281544363151bf284b0240dfd22a42Paul Duffin public Iterable<E> order(List<E> insertionOrder) { 1423c77433663281544363151bf284b0240dfd22a42Paul Duffin return gen.order(insertionOrder); 1433c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1443c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1453c77433663281544363151bf284b0240dfd22a42Paul Duffin 1463c77433663281544363151bf284b0240dfd22a42Paul Duffin private static Set<Feature<?>> computeReserializedCollectionFeatures( 1473c77433663281544363151bf284b0240dfd22a42Paul Duffin Set<Feature<?>> features) { 1483c77433663281544363151bf284b0240dfd22a42Paul Duffin Set<Feature<?>> derivedFeatures = new HashSet<Feature<?>>(); 1493c77433663281544363151bf284b0240dfd22a42Paul Duffin derivedFeatures.addAll(features); 1503c77433663281544363151bf284b0240dfd22a42Paul Duffin derivedFeatures.remove(CollectionFeature.SERIALIZABLE); 1513c77433663281544363151bf284b0240dfd22a42Paul Duffin derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS); 1523c77433663281544363151bf284b0240dfd22a42Paul Duffin return derivedFeatures; 1533c77433663281544363151bf284b0240dfd22a42Paul Duffin } 1541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 155