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.Helpers.copyToList;
020import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER;
021import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE;
022import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS;
023import static com.google.common.testing.SerializableTester.reserialize;
024
025import com.google.common.annotations.GwtIncompatible;
026import com.google.common.collect.testing.features.CollectionFeature;
027import com.google.common.collect.testing.features.Feature;
028import com.google.common.collect.testing.testers.CollectionSerializationEqualTester;
029import com.google.common.collect.testing.testers.ListAddAllAtIndexTester;
030import com.google.common.collect.testing.testers.ListAddAllTester;
031import com.google.common.collect.testing.testers.ListAddAtIndexTester;
032import com.google.common.collect.testing.testers.ListAddTester;
033import com.google.common.collect.testing.testers.ListCreationTester;
034import com.google.common.collect.testing.testers.ListEqualsTester;
035import com.google.common.collect.testing.testers.ListGetTester;
036import com.google.common.collect.testing.testers.ListHashCodeTester;
037import com.google.common.collect.testing.testers.ListIndexOfTester;
038import com.google.common.collect.testing.testers.ListLastIndexOfTester;
039import com.google.common.collect.testing.testers.ListListIteratorTester;
040import com.google.common.collect.testing.testers.ListRemoveAllTester;
041import com.google.common.collect.testing.testers.ListRemoveAtIndexTester;
042import com.google.common.collect.testing.testers.ListRemoveTester;
043import com.google.common.collect.testing.testers.ListReplaceAllTester;
044import com.google.common.collect.testing.testers.ListRetainAllTester;
045import com.google.common.collect.testing.testers.ListSetTester;
046import com.google.common.collect.testing.testers.ListSubListTester;
047import com.google.common.collect.testing.testers.ListToArrayTester;
048import java.util.ArrayList;
049import java.util.Collection;
050import java.util.HashSet;
051import java.util.List;
052import java.util.Set;
053import junit.framework.TestSuite;
054
055/**
056 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a List
057 * implementation.
058 *
059 * @author George van den Driessche
060 */
061@GwtIncompatible
062public final class ListTestSuiteBuilder<E>
063    extends AbstractCollectionTestSuiteBuilder<ListTestSuiteBuilder<E>, E> {
064  public static <E> ListTestSuiteBuilder<E> using(TestListGenerator<E> generator) {
065    return new ListTestSuiteBuilder<E>().usingGenerator(generator);
066  }
067
068  @SuppressWarnings("rawtypes") // class literals
069  @Override
070  protected List<Class<? extends AbstractTester>> getTesters() {
071    List<Class<? extends AbstractTester>> testers = copyToList(super.getTesters());
072
073    testers.add(CollectionSerializationEqualTester.class);
074    testers.add(ListAddAllAtIndexTester.class);
075    testers.add(ListAddAllTester.class);
076    testers.add(ListAddAtIndexTester.class);
077    testers.add(ListAddTester.class);
078    testers.add(ListCreationTester.class);
079    testers.add(ListEqualsTester.class);
080    testers.add(ListGetTester.class);
081    testers.add(ListHashCodeTester.class);
082    testers.add(ListIndexOfTester.class);
083    testers.add(ListLastIndexOfTester.class);
084    testers.add(ListListIteratorTester.class);
085    testers.add(ListRemoveAllTester.class);
086    testers.add(ListRemoveAtIndexTester.class);
087    testers.add(ListRemoveTester.class);
088    testers.add(ListReplaceAllTester.class);
089    testers.add(ListRetainAllTester.class);
090    testers.add(ListSetTester.class);
091    testers.add(ListSubListTester.class);
092    testers.add(ListToArrayTester.class);
093    return testers;
094  }
095
096  /**
097   * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since lists have an
098   * iteration ordering corresponding to the insertion order.
099   */
100  @Override
101  public TestSuite createTestSuite() {
102    withFeatures(KNOWN_ORDER);
103    return super.createTestSuite();
104  }
105
106  @Override
107  protected List<TestSuite> createDerivedSuites(
108      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
109          parentBuilder) {
110    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
111
112    if (parentBuilder.getFeatures().contains(SERIALIZABLE)) {
113      derivedSuites.add(
114          using(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  private static final 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>) 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}