001/* 002 * Copyright (C) 2008 The Guava Authors 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 */ 016 017package com.google.common.collect.testing; 018 019import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER; 020import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE; 021import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS; 022 023import com.google.common.annotations.GwtIncompatible; 024import com.google.common.collect.testing.features.CollectionFeature; 025import com.google.common.collect.testing.features.Feature; 026import com.google.common.collect.testing.testers.CollectionSerializationEqualTester; 027import com.google.common.collect.testing.testers.ListAddAllAtIndexTester; 028import com.google.common.collect.testing.testers.ListAddAllTester; 029import com.google.common.collect.testing.testers.ListAddAtIndexTester; 030import com.google.common.collect.testing.testers.ListAddTester; 031import com.google.common.collect.testing.testers.ListCreationTester; 032import com.google.common.collect.testing.testers.ListEqualsTester; 033import com.google.common.collect.testing.testers.ListGetTester; 034import com.google.common.collect.testing.testers.ListHashCodeTester; 035import com.google.common.collect.testing.testers.ListIndexOfTester; 036import com.google.common.collect.testing.testers.ListLastIndexOfTester; 037import com.google.common.collect.testing.testers.ListListIteratorTester; 038import com.google.common.collect.testing.testers.ListRemoveAllTester; 039import com.google.common.collect.testing.testers.ListRemoveAtIndexTester; 040import com.google.common.collect.testing.testers.ListRemoveTester; 041import com.google.common.collect.testing.testers.ListReplaceAllTester; 042import com.google.common.collect.testing.testers.ListRetainAllTester; 043import com.google.common.collect.testing.testers.ListSetTester; 044import com.google.common.collect.testing.testers.ListSubListTester; 045import com.google.common.collect.testing.testers.ListToArrayTester; 046import com.google.common.testing.SerializableTester; 047import java.util.ArrayList; 048import java.util.Collection; 049import java.util.HashSet; 050import java.util.List; 051import java.util.Set; 052import junit.framework.TestSuite; 053 054/** 055 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a List 056 * implementation. 057 * 058 * @author George van den Driessche 059 */ 060@GwtIncompatible 061public final class ListTestSuiteBuilder<E> 062 extends AbstractCollectionTestSuiteBuilder<ListTestSuiteBuilder<E>, E> { 063 public static <E> ListTestSuiteBuilder<E> using(TestListGenerator<E> generator) { 064 return new ListTestSuiteBuilder<E>().usingGenerator(generator); 065 } 066 067 @SuppressWarnings("rawtypes") // class literals 068 @Override 069 protected List<Class<? extends AbstractTester>> getTesters() { 070 List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters()); 071 072 testers.add(CollectionSerializationEqualTester.class); 073 testers.add(ListAddAllAtIndexTester.class); 074 testers.add(ListAddAllTester.class); 075 testers.add(ListAddAtIndexTester.class); 076 testers.add(ListAddTester.class); 077 testers.add(ListCreationTester.class); 078 testers.add(ListEqualsTester.class); 079 testers.add(ListGetTester.class); 080 testers.add(ListHashCodeTester.class); 081 testers.add(ListIndexOfTester.class); 082 testers.add(ListLastIndexOfTester.class); 083 testers.add(ListListIteratorTester.class); 084 testers.add(ListRemoveAllTester.class); 085 testers.add(ListRemoveAtIndexTester.class); 086 testers.add(ListRemoveTester.class); 087 testers.add(ListReplaceAllTester.class); 088 testers.add(ListRetainAllTester.class); 089 testers.add(ListSetTester.class); 090 testers.add(ListSubListTester.class); 091 testers.add(ListToArrayTester.class); 092 return testers; 093 } 094 095 /** 096 * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since lists have an 097 * iteration ordering corresponding to the insertion order. 098 */ 099 @Override 100 public TestSuite createTestSuite() { 101 withFeatures(KNOWN_ORDER); 102 return super.createTestSuite(); 103 } 104 105 @Override 106 protected List<TestSuite> createDerivedSuites( 107 FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>> 108 parentBuilder) { 109 List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder)); 110 111 if (parentBuilder.getFeatures().contains(SERIALIZABLE)) { 112 derivedSuites.add( 113 ListTestSuiteBuilder.using( 114 new ReserializedListGenerator<E>(parentBuilder.getSubjectGenerator())) 115 .named(getName() + " reserialized") 116 .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures())) 117 .suppressing(parentBuilder.getSuppressedTests()) 118 .withSetUp(parentBuilder.getSetUp()) 119 .withTearDown(parentBuilder.getTearDown()) 120 .createTestSuite()); 121 } 122 return derivedSuites; 123 } 124 125 static class ReserializedListGenerator<E> implements TestListGenerator<E> { 126 final OneSizeTestContainerGenerator<Collection<E>, E> gen; 127 128 private ReserializedListGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) { 129 this.gen = gen; 130 } 131 132 @Override 133 public SampleElements<E> samples() { 134 return gen.samples(); 135 } 136 137 @Override 138 public List<E> create(Object... elements) { 139 return (List<E>) SerializableTester.reserialize(gen.create(elements)); 140 } 141 142 @Override 143 public E[] createArray(int length) { 144 return gen.createArray(length); 145 } 146 147 @Override 148 public Iterable<E> order(List<E> insertionOrder) { 149 return gen.order(insertionOrder); 150 } 151 } 152 153 private static Set<Feature<?>> computeReserializedCollectionFeatures(Set<Feature<?>> features) { 154 Set<Feature<?>> derivedFeatures = new HashSet<>(features); 155 derivedFeatures.remove(SERIALIZABLE); 156 derivedFeatures.remove(SERIALIZABLE_INCLUDING_VIEWS); 157 return derivedFeatures; 158 } 159}