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.testing.SerializableTester;
025import java.util.ArrayList;
026import java.util.Collection;
027import java.util.HashSet;
028import java.util.List;
029import java.util.Set;
030import junit.framework.TestSuite;
031
032/**
033 * Concrete instantiation of {@link AbstractCollectionTestSuiteBuilder} for testing collections that
034 * do not have a more specific tester like {@link ListTestSuiteBuilder} or {@link
035 * SetTestSuiteBuilder}.
036 *
037 * @author Chris Povirk
038 * @author Louis Wasserman
039 */
040@GwtIncompatible
041public class CollectionTestSuiteBuilder<E>
042    extends AbstractCollectionTestSuiteBuilder<CollectionTestSuiteBuilder<E>, E> {
043  public static <E> CollectionTestSuiteBuilder<E> using(TestCollectionGenerator<E> generator) {
044    return new CollectionTestSuiteBuilder<E>().usingGenerator(generator);
045  }
046
047  @Override
048  protected List<TestSuite> createDerivedSuites(
049      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
050          parentBuilder) {
051    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
052
053    if (parentBuilder.getFeatures().contains(SERIALIZABLE)) {
054      derivedSuites.add(
055          CollectionTestSuiteBuilder.using(
056                  new ReserializedCollectionGenerator<E>(parentBuilder.getSubjectGenerator()))
057              .named(getName() + " reserialized")
058              .withFeatures(computeReserializedCollectionFeatures(parentBuilder.getFeatures()))
059              .suppressing(parentBuilder.getSuppressedTests())
060              .createTestSuite());
061    }
062    return derivedSuites;
063  }
064
065  static class ReserializedCollectionGenerator<E> implements TestCollectionGenerator<E> {
066    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
067
068    private ReserializedCollectionGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
069      this.gen = gen;
070    }
071
072    @Override
073    public SampleElements<E> samples() {
074      return gen.samples();
075    }
076
077    @Override
078    public Collection<E> create(Object... elements) {
079      return SerializableTester.reserialize(gen.create(elements));
080    }
081
082    @Override
083    public E[] createArray(int length) {
084      return gen.createArray(length);
085    }
086
087    @Override
088    public Iterable<E> order(List<E> insertionOrder) {
089      return gen.order(insertionOrder);
090    }
091  }
092
093  private static Set<Feature<?>> computeReserializedCollectionFeatures(Set<Feature<?>> features) {
094    Set<Feature<?>> derivedFeatures = new HashSet<>();
095    derivedFeatures.addAll(features);
096    derivedFeatures.remove(SERIALIZABLE);
097    derivedFeatures.remove(SERIALIZABLE_INCLUDING_VIEWS);
098    return derivedFeatures;
099  }
100}