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.SERIALIZABLE;
020import static com.google.common.collect.testing.features.CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS;
021
022import com.google.common.annotations.GwtIncompatible;
023import com.google.common.collect.testing.features.Feature;
024import com.google.common.collect.testing.testers.CollectionSerializationEqualTester;
025import com.google.common.collect.testing.testers.SetAddAllTester;
026import com.google.common.collect.testing.testers.SetAddTester;
027import com.google.common.collect.testing.testers.SetCreationTester;
028import com.google.common.collect.testing.testers.SetEqualsTester;
029import com.google.common.collect.testing.testers.SetHashCodeTester;
030import com.google.common.collect.testing.testers.SetRemoveTester;
031import com.google.common.testing.SerializableTester;
032import java.util.ArrayList;
033import java.util.Collection;
034import java.util.HashSet;
035import java.util.List;
036import java.util.Set;
037import junit.framework.TestSuite;
038
039/**
040 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a Set implementation.
041 *
042 * @author George van den Driessche
043 */
044@GwtIncompatible
045public class SetTestSuiteBuilder<E>
046    extends AbstractCollectionTestSuiteBuilder<SetTestSuiteBuilder<E>, E> {
047  public static <E> SetTestSuiteBuilder<E> using(TestSetGenerator<E> generator) {
048    return new SetTestSuiteBuilder<E>().usingGenerator(generator);
049  }
050
051  @Override
052  protected List<Class<? extends AbstractTester>> getTesters() {
053    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
054
055    testers.add(CollectionSerializationEqualTester.class);
056    testers.add(SetAddAllTester.class);
057    testers.add(SetAddTester.class);
058    testers.add(SetCreationTester.class);
059    testers.add(SetHashCodeTester.class);
060    testers.add(SetEqualsTester.class);
061    testers.add(SetRemoveTester.class);
062    // SetRemoveAllTester doesn't exist because, Sets not permitting
063    // duplicate elements, there are no tests for Set.removeAll() that aren't
064    // covered by CollectionRemoveAllTester.
065    return testers;
066  }
067
068  @Override
069  protected List<TestSuite> createDerivedSuites(
070      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
071          parentBuilder) {
072    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
073
074    if (parentBuilder.getFeatures().contains(SERIALIZABLE)) {
075      derivedSuites.add(
076          SetTestSuiteBuilder.using(
077                  new ReserializedSetGenerator<E>(parentBuilder.getSubjectGenerator()))
078              .named(getName() + " reserialized")
079              .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures()))
080              .suppressing(parentBuilder.getSuppressedTests())
081              .withSetUp(parentBuilder.getSetUp())
082              .withTearDown(parentBuilder.getTearDown())
083              .createTestSuite());
084    }
085    return derivedSuites;
086  }
087
088  static class ReserializedSetGenerator<E> implements TestSetGenerator<E> {
089    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
090
091    private ReserializedSetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
092      this.gen = gen;
093    }
094
095    @Override
096    public SampleElements<E> samples() {
097      return gen.samples();
098    }
099
100    @Override
101    public Set<E> create(Object... elements) {
102      return (Set<E>) SerializableTester.reserialize(gen.create(elements));
103    }
104
105    @Override
106    public E[] createArray(int length) {
107      return gen.createArray(length);
108    }
109
110    @Override
111    public Iterable<E> order(List<E> insertionOrder) {
112      return gen.order(insertionOrder);
113    }
114  }
115
116  private static Set<Feature<?>> computeReserializedCollectionFeatures(Set<Feature<?>> features) {
117    Set<Feature<?>> derivedFeatures = new HashSet<>(features);
118    derivedFeatures.remove(SERIALIZABLE);
119    derivedFeatures.remove(SERIALIZABLE_INCLUDING_VIEWS);
120    return derivedFeatures;
121  }
122}