Coverage Summary for Class: ListTestSuiteBuilder (com.google.common.collect.testing)

1 /*
2  * Copyright (C) 2008 The Guava Authors
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 package com.google.common.collect.testing;
18 
19 import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
20 import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE;
21 import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS;
22 
23 import com.google.common.annotations.GwtIncompatible;
24 import com.google.common.collect.testing.features.CollectionFeature;
25 import com.google.common.collect.testing.features.Feature;
26 import com.google.common.collect.testing.testers.CollectionSerializationEqualTester;
27 import com.google.common.collect.testing.testers.ListAddAllAtIndexTester;
28 import com.google.common.collect.testing.testers.ListAddAllTester;
29 import com.google.common.collect.testing.testers.ListAddAtIndexTester;
30 import com.google.common.collect.testing.testers.ListAddTester;
31 import com.google.common.collect.testing.testers.ListCreationTester;
32 import com.google.common.collect.testing.testers.ListEqualsTester;
33 import com.google.common.collect.testing.testers.ListGetTester;
34 import com.google.common.collect.testing.testers.ListHashCodeTester;
35 import com.google.common.collect.testing.testers.ListIndexOfTester;
36 import com.google.common.collect.testing.testers.ListLastIndexOfTester;
37 import com.google.common.collect.testing.testers.ListListIteratorTester;
38 import com.google.common.collect.testing.testers.ListRemoveAllTester;
39 import com.google.common.collect.testing.testers.ListRemoveAtIndexTester;
40 import com.google.common.collect.testing.testers.ListRemoveTester;
41 import com.google.common.collect.testing.testers.ListReplaceAllTester;
42 import com.google.common.collect.testing.testers.ListRetainAllTester;
43 import com.google.common.collect.testing.testers.ListSetTester;
44 import com.google.common.collect.testing.testers.ListSubListTester;
45 import com.google.common.collect.testing.testers.ListToArrayTester;
46 import com.google.common.testing.SerializableTester;
47 import java.util.ArrayList;
48 import java.util.Collection;
49 import java.util.HashSet;
50 import java.util.List;
51 import java.util.Set;
52 import junit.framework.TestSuite;
53 
54 /**
55  * Creates, based on your criteria, a JUnit test suite that exhaustively tests a List
56  * implementation.
57  *
58  * @author George van den Driessche
59  */
60 @GwtIncompatible
61 public final class ListTestSuiteBuilder<E>
62     extends AbstractCollectionTestSuiteBuilder<ListTestSuiteBuilder<E>, E> {
63   public static <E> ListTestSuiteBuilder<E> using(TestListGenerator<E> generator) {
64     return new ListTestSuiteBuilder<E>().usingGenerator(generator);
65   }
66 
67   @Override
68   protected List<Class<? extends AbstractTester>> getTesters() {
69     List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
70 
71     testers.add(CollectionSerializationEqualTester.class);
72     testers.add(ListAddAllAtIndexTester.class);
73     testers.add(ListAddAllTester.class);
74     testers.add(ListAddAtIndexTester.class);
75     testers.add(ListAddTester.class);
76     testers.add(ListCreationTester.class);
77     testers.add(ListEqualsTester.class);
78     testers.add(ListGetTester.class);
79     testers.add(ListHashCodeTester.class);
80     testers.add(ListIndexOfTester.class);
81     testers.add(ListLastIndexOfTester.class);
82     testers.add(ListListIteratorTester.class);
83     testers.add(ListRemoveAllTester.class);
84     testers.add(ListRemoveAtIndexTester.class);
85     testers.add(ListRemoveTester.class);
86     testers.add(ListReplaceAllTester.class);
87     testers.add(ListRetainAllTester.class);
88     testers.add(ListSetTester.class);
89     testers.add(ListSubListTester.class);
90     testers.add(ListToArrayTester.class);
91     return testers;
92   }
93 
94   /**
95    * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since lists have an
96    * iteration ordering corresponding to the insertion order.
97    */
98   @Override
99   public TestSuite createTestSuite() {
100     withFeatures(KNOWN_ORDER);
101     return super.createTestSuite();
102   }
103 
104   @Override
105   protected List<TestSuite> createDerivedSuites(
106       FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
107           parentBuilder) {
108     List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
109 
110     if (parentBuilder.getFeatures().contains(SERIALIZABLE)) {
111       derivedSuites.add(
112           ListTestSuiteBuilder.using(
113                   new ReserializedListGenerator<E>(parentBuilder.getSubjectGenerator()))
114               .named(getName() + " reserialized")
115               .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures()))
116               .suppressing(parentBuilder.getSuppressedTests())
117               .createTestSuite());
118     }
119     return derivedSuites;
120   }
121 
122   static class ReserializedListGenerator<E> implements TestListGenerator<E> {
123     final OneSizeTestContainerGenerator<Collection<E>, E> gen;
124 
125     private ReserializedListGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
126       this.gen = gen;
127     }
128 
129     @Override
130     public SampleElements<E> samples() {
131       return gen.samples();
132     }
133 
134     @Override
135     public List<E> create(Object... elements) {
136       return (List<E>) SerializableTester.reserialize(gen.create(elements));
137     }
138 
139     @Override
140     public E[] createArray(int length) {
141       return gen.createArray(length);
142     }
143 
144     @Override
145     public Iterable<E> order(List<E> insertionOrder) {
146       return gen.order(insertionOrder);
147     }
148   }
149 
150   private static Set<Feature<?>> computeReserializedCollectionFeatures(Set<Feature<?>> features) {
151     Set<Feature<?>> derivedFeatures = new HashSet<>(features);
152     derivedFeatures.remove(SERIALIZABLE);
153     derivedFeatures.remove(SERIALIZABLE_INCLUDING_VIEWS);
154     return derivedFeatures;
155   }
156 }