Source code

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.google;
018
019import static com.google.common.base.Preconditions.checkArgument;
020
021import com.google.common.annotations.GwtIncompatible;
022import com.google.common.collect.Multiset;
023import com.google.common.collect.Multiset.Entry;
024import com.google.common.collect.Multisets;
025import com.google.common.collect.testing.AbstractCollectionTestSuiteBuilder;
026import com.google.common.collect.testing.AbstractTester;
027import com.google.common.collect.testing.FeatureSpecificTestSuiteBuilder;
028import com.google.common.collect.testing.Helpers;
029import com.google.common.collect.testing.OneSizeTestContainerGenerator;
030import com.google.common.collect.testing.SampleElements;
031import com.google.common.collect.testing.SetTestSuiteBuilder;
032import com.google.common.collect.testing.TestSetGenerator;
033import com.google.common.collect.testing.features.CollectionFeature;
034import com.google.common.collect.testing.features.Feature;
035import com.google.common.collect.testing.testers.CollectionSerializationEqualTester;
036import com.google.common.testing.SerializableTester;
037import java.util.ArrayList;
038import java.util.Collection;
039import java.util.Collections;
040import java.util.HashSet;
041import java.util.LinkedHashMap;
042import java.util.LinkedHashSet;
043import java.util.List;
044import java.util.Map;
045import java.util.Set;
046import junit.framework.TestSuite;
047
048/**
049 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a {@code Multiset}
050 * implementation.
051 *
052 * @author Jared Levy
053 * @author Louis Wasserman
054 */
055@GwtIncompatible
056public class MultisetTestSuiteBuilder<E>
057    extends AbstractCollectionTestSuiteBuilder<MultisetTestSuiteBuilder<E>, E> {
058  public static <E> MultisetTestSuiteBuilder<E> using(TestMultisetGenerator<E> generator) {
059    return new MultisetTestSuiteBuilder<E>().usingGenerator(generator);
060  }
061
062  public enum NoRecurse implements Feature<Void> {
063    NO_ENTRY_SET;
064
065    @Override
066    public Set<Feature<? super Void>> getImpliedFeatures() {
067      return Collections.emptySet();
068    }
069  }
070
071  @Override
072  protected List<Class<? extends AbstractTester>> getTesters() {
073    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
074    testers.add(CollectionSerializationEqualTester.class);
075    testers.add(MultisetAddTester.class);
076    testers.add(MultisetContainsTester.class);
077    testers.add(MultisetCountTester.class);
078    testers.add(MultisetElementSetTester.class);
079    testers.add(MultisetEqualsTester.class);
080    testers.add(MultisetReadsTester.class);
081    testers.add(MultisetSetCountConditionallyTester.class);
082    testers.add(MultisetSetCountUnconditionallyTester.class);
083    testers.add(MultisetRemoveTester.class);
084    testers.add(MultisetEntrySetTester.class);
085    testers.add(MultisetIteratorTester.class);
086    testers.add(MultisetSerializationTester.class);
087    return testers;
088  }
089
090  private static Set<Feature<?>> computeEntrySetFeatures(Set<Feature<?>> features) {
091    Set<Feature<?>> derivedFeatures = new HashSet<>();
092    derivedFeatures.addAll(features);
093    derivedFeatures.remove(CollectionFeature.GENERAL_PURPOSE);
094    derivedFeatures.remove(CollectionFeature.SUPPORTS_ADD);
095    derivedFeatures.remove(CollectionFeature.ALLOWS_NULL_VALUES);
096    derivedFeatures.add(CollectionFeature.REJECTS_DUPLICATES_AT_CREATION);
097    if (!derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS)) {
098      derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
099    }
100    return derivedFeatures;
101  }
102
103  static Set<Feature<?>> computeElementSetFeatures(Set<Feature<?>> features) {
104    Set<Feature<?>> derivedFeatures = new HashSet<>();
105    derivedFeatures.addAll(features);
106    derivedFeatures.remove(CollectionFeature.GENERAL_PURPOSE);
107    derivedFeatures.remove(CollectionFeature.SUPPORTS_ADD);
108    if (!derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS)) {
109      derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
110    }
111    return derivedFeatures;
112  }
113
114  private static Set<Feature<?>> computeReserializedMultisetFeatures(Set<Feature<?>> features) {
115    Set<Feature<?>> derivedFeatures = new HashSet<>();
116    derivedFeatures.addAll(features);
117    derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
118    derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS);
119    return derivedFeatures;
120  }
121
122  @Override
123  protected List<TestSuite> createDerivedSuites(
124      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
125          parentBuilder) {
126    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
127
128    derivedSuites.add(createElementSetTestSuite(parentBuilder));
129
130    if (!parentBuilder.getFeatures().contains(NoRecurse.NO_ENTRY_SET)) {
131      derivedSuites.add(
132          SetTestSuiteBuilder.using(new EntrySetGenerator<E>(parentBuilder.getSubjectGenerator()))
133              .named(getName() + ".entrySet")
134              .withFeatures(computeEntrySetFeatures(parentBuilder.getFeatures()))
135              .suppressing(parentBuilder.getSuppressedTests())
136              .createTestSuite());
137    }
138
139    if (parentBuilder.getFeatures().contains(CollectionFeature.SERIALIZABLE)) {
140      derivedSuites.add(
141          MultisetTestSuiteBuilder.using(
142                  new ReserializedMultisetGenerator<E>(parentBuilder.getSubjectGenerator()))
143              .named(getName() + " reserialized")
144              .withFeatures(computeReserializedMultisetFeatures(parentBuilder.getFeatures()))
145              .suppressing(parentBuilder.getSuppressedTests())
146              .createTestSuite());
147    }
148    return derivedSuites;
149  }
150
151  TestSuite createElementSetTestSuite(
152      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
153          parentBuilder) {
154    return SetTestSuiteBuilder.using(
155            new ElementSetGenerator<E>(parentBuilder.getSubjectGenerator()))
156        .named(getName() + ".elementSet")
157        .withFeatures(computeElementSetFeatures(parentBuilder.getFeatures()))
158        .suppressing(parentBuilder.getSuppressedTests())
159        .createTestSuite();
160  }
161
162  static class ElementSetGenerator<E> implements TestSetGenerator<E> {
163    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
164
165    ElementSetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
166      this.gen = gen;
167    }
168
169    @Override
170    public SampleElements<E> samples() {
171      return gen.samples();
172    }
173
174    @Override
175    public Set<E> create(Object... elements) {
176      Object[] duplicated = new Object[elements.length * 2];
177      for (int i = 0; i < elements.length; i++) {
178        duplicated[i] = elements[i];
179        duplicated[i + elements.length] = elements[i];
180      }
181      return ((Multiset<E>) gen.create(duplicated)).elementSet();
182    }
183
184    @Override
185    public E[] createArray(int length) {
186      return gen.createArray(length);
187    }
188
189    @Override
190    public Iterable<E> order(List<E> insertionOrder) {
191      return gen.order(new ArrayList<E>(new LinkedHashSet<E>(insertionOrder)));
192    }
193  }
194
195  static class EntrySetGenerator<E> implements TestSetGenerator<Multiset.Entry<E>> {
196    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
197
198    private EntrySetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
199      this.gen = gen;
200    }
201
202    @Override
203    public SampleElements<Multiset.Entry<E>> samples() {
204      SampleElements<E> samples = gen.samples();
205      return new SampleElements<>(
206          Multisets.immutableEntry(samples.e0(), 3),
207          Multisets.immutableEntry(samples.e1(), 4),
208          Multisets.immutableEntry(samples.e2(), 1),
209          Multisets.immutableEntry(samples.e3(), 5),
210          Multisets.immutableEntry(samples.e4(), 2));
211    }
212
213    @Override
214    public Set<Multiset.Entry<E>> create(Object... entries) {
215      List<Object> contents = new ArrayList<>();
216      Set<E> elements = new HashSet<>();
217      for (Object o : entries) {
218        @SuppressWarnings("unchecked")
219        Multiset.Entry<E> entry = (Entry<E>) o;
220        checkArgument(
221            elements.add(entry.getElement()), "Duplicate keys not allowed in EntrySetGenerator");
222        for (int i = 0; i < entry.getCount(); i++) {
223          contents.add(entry.getElement());
224        }
225      }
226      return ((Multiset<E>) gen.create(contents.toArray())).entrySet();
227    }
228
229    @SuppressWarnings("unchecked")
230    @Override
231    public Multiset.Entry<E>[] createArray(int length) {
232      return new Multiset.Entry[length];
233    }
234
235    @Override
236    public Iterable<Entry<E>> order(List<Entry<E>> insertionOrder) {
237      // We mimic the order from gen.
238      Map<E, Entry<E>> map = new LinkedHashMap<>();
239      for (Entry<E> entry : insertionOrder) {
240        map.put(entry.getElement(), entry);
241      }
242
243      Set<E> seen = new HashSet<>();
244      List<Entry<E>> order = new ArrayList<>();
245      for (E e : gen.order(new ArrayList<E>(map.keySet()))) {
246        if (seen.add(e)) {
247          order.add(map.get(e));
248        }
249      }
250      return order;
251    }
252  }
253
254  static class ReserializedMultisetGenerator<E> implements TestMultisetGenerator<E> {
255    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
256
257    private ReserializedMultisetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
258      this.gen = gen;
259    }
260
261    @Override
262    public SampleElements<E> samples() {
263      return gen.samples();
264    }
265
266    @Override
267    public Multiset<E> create(Object... elements) {
268      return (Multiset<E>) SerializableTester.reserialize(gen.create(elements));
269    }
270
271    @Override
272    public E[] createArray(int length) {
273      return gen.createArray(length);
274    }
275
276    @Override
277    public Iterable<E> order(List<E> insertionOrder) {
278      return gen.order(insertionOrder);
279    }
280  }
281}