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  @Override
068  protected List<Class<? extends AbstractTester>> getTesters() {
069    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
070
071    testers.add(CollectionSerializationEqualTester.class);
072    testers.add(ListAddAllAtIndexTester.class);
073    testers.add(ListAddAllTester.class);
074    testers.add(ListAddAtIndexTester.class);
075    testers.add(ListAddTester.class);
076    testers.add(ListCreationTester.class);
077    testers.add(ListEqualsTester.class);
078    testers.add(ListGetTester.class);
079    testers.add(ListHashCodeTester.class);
080    testers.add(ListIndexOfTester.class);
081    testers.add(ListLastIndexOfTester.class);
082    testers.add(ListListIteratorTester.class);
083    testers.add(ListRemoveAllTester.class);
084    testers.add(ListRemoveAtIndexTester.class);
085    testers.add(ListRemoveTester.class);
086    testers.add(ListReplaceAllTester.class);
087    testers.add(ListRetainAllTester.class);
088    testers.add(ListSetTester.class);
089    testers.add(ListSubListTester.class);
090    testers.add(ListToArrayTester.class);
091    return testers;
092  }
093
094  /**
095   * Specifies {@link CollectionFeature#KNOWN_ORDER} for all list tests, since lists have an
096   * iteration ordering corresponding to the insertion order.
097   */
098  @Override
099  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}