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.ListRetainAllTester; 042import com.google.common.collect.testing.testers.ListSetTester; 043import com.google.common.collect.testing.testers.ListSubListTester; 044import com.google.common.collect.testing.testers.ListToArrayTester; 045import com.google.common.testing.SerializableTester; 046import java.util.ArrayList; 047import java.util.Collection; 048import java.util.HashSet; 049import java.util.List; 050import java.util.Set; 051import junit.framework.TestSuite; 052 053/** 054 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a List 055 * implementation. 056 * 057 * @author George van den Driessche 058 */ 059@GwtIncompatible 060public final class ListTestSuiteBuilder<E> 061 extends AbstractCollectionTestSuiteBuilder<ListTestSuiteBuilder<E>, E> { 062 public static <E> ListTestSuiteBuilder<E> using(TestListGenerator<E> generator) { 063 return new ListTestSuiteBuilder<E>().usingGenerator(generator); 064 } 065 066 @Override 067 protected List<Class<? extends AbstractTester>> getTesters() { 068 List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters()); 069 070 testers.add(CollectionSerializationEqualTester.class); 071 testers.add(ListAddAllAtIndexTester.class); 072 testers.add(ListAddAllTester.class); 073 testers.add(ListAddAtIndexTester.class); 074 testers.add(ListAddTester.class); 075 testers.add(ListCreationTester.class); 076 testers.add(ListEqualsTester.class); 077 testers.add(ListGetTester.class); 078 testers.add(ListHashCodeTester.class); 079 testers.add(ListIndexOfTester.class); 080 testers.add(ListLastIndexOfTester.class); 081 testers.add(ListListIteratorTester.class); 082 testers.add(ListRemoveAllTester.class); 083 testers.add(ListRemoveAtIndexTester.class); 084 testers.add(ListRemoveTester.class); 085 testers.add(ListRetainAllTester.class); 086 testers.add(ListSetTester.class); 087 testers.add(ListSubListTester.class); 088 testers.add(ListToArrayTester.class); 089 return testers; 090 } 091 092 /** 093 * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since lists have an 094 * iteration ordering corresponding to the insertion order. 095 */ 096 @Override 097 public TestSuite createTestSuite() { 098 withFeatures(KNOWN_ORDER); 099 return super.createTestSuite(); 100 } 101 102 @Override 103 protected List<TestSuite> createDerivedSuites( 104 FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>> 105 parentBuilder) { 106 List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder)); 107 108 if (parentBuilder.getFeatures().contains(SERIALIZABLE)) { 109 derivedSuites.add( 110 ListTestSuiteBuilder.using( 111 new ReserializedListGenerator<E>(parentBuilder.getSubjectGenerator())) 112 .named(getName() + " reserialized") 113 .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures())) 114 .suppressing(parentBuilder.getSuppressedTests()) 115 .createTestSuite()); 116 } 117 return derivedSuites; 118 } 119 120 static class ReserializedListGenerator<E> implements TestListGenerator<E> { 121 final OneSizeTestContainerGenerator<Collection<E>, E> gen; 122 123 private ReserializedListGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) { 124 this.gen = gen; 125 } 126 127 @Override 128 public SampleElements<E> samples() { 129 return gen.samples(); 130 } 131 132 @Override 133 public List<E> create(Object... elements) { 134 return (List<E>) SerializableTester.reserialize(gen.create(elements)); 135 } 136 137 @Override 138 public E[] createArray(int length) { 139 return gen.createArray(length); 140 } 141 142 @Override 143 public Iterable<E> order(List<E> insertionOrder) { 144 return gen.order(insertionOrder); 145 } 146 } 147 148 private static Set<Feature<?>> computeReserializedCollectionFeatures(Set<Feature<?>> features) { 149 Set<Feature<?>> derivedFeatures = new HashSet<>(); 150 derivedFeatures.addAll(features); 151 derivedFeatures.remove(SERIALIZABLE); 152 derivedFeatures.remove(SERIALIZABLE_INCLUDING_VIEWS); 153 return derivedFeatures; 154 } 155}