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(MultisetForEachEntryTester.class);
081    testers.add(MultisetReadsTester.class);
082    testers.add(MultisetSetCountConditionallyTester.class);
083    testers.add(MultisetSetCountUnconditionallyTester.class);
084    testers.add(MultisetRemoveTester.class);
085    testers.add(MultisetEntrySetTester.class);
086    testers.add(MultisetIteratorTester.class);
087    testers.add(MultisetSerializationTester.class);
088    return testers;
089  }
090
091  private static Set<Feature<?>> computeEntrySetFeatures(Set<Feature<?>> features) {
092    Set<Feature<?>> derivedFeatures = new HashSet<>();
093    derivedFeatures.addAll(features);
094    derivedFeatures.remove(CollectionFeature.GENERAL_PURPOSE);
095    derivedFeatures.remove(CollectionFeature.SUPPORTS_ADD);
096    derivedFeatures.remove(CollectionFeature.ALLOWS_NULL_VALUES);
097    derivedFeatures.add(CollectionFeature.REJECTS_DUPLICATES_AT_CREATION);
098    if (!derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS)) {
099      derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
100    }
101    return derivedFeatures;
102  }
103
104  static Set<Feature<?>> computeElementSetFeatures(Set<Feature<?>> features) {
105    Set<Feature<?>> derivedFeatures = new HashSet<>();
106    derivedFeatures.addAll(features);
107    derivedFeatures.remove(CollectionFeature.GENERAL_PURPOSE);
108    derivedFeatures.remove(CollectionFeature.SUPPORTS_ADD);
109    if (!derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS)) {
110      derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
111    }
112    return derivedFeatures;
113  }
114
115  private static Set<Feature<?>> computeReserializedMultisetFeatures(Set<Feature<?>> features) {
116    Set<Feature<?>> derivedFeatures = new HashSet<>();
117    derivedFeatures.addAll(features);
118    derivedFeatures.remove(CollectionFeature.SERIALIZABLE);
119    derivedFeatures.remove(CollectionFeature.SERIALIZABLE_INCLUDING_VIEWS);
120    return derivedFeatures;
121  }
122
123  @Override
124  protected List<TestSuite> createDerivedSuites(
125      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
126          parentBuilder) {
127    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
128
129    derivedSuites.add(createElementSetTestSuite(parentBuilder));
130
131    if (!parentBuilder.getFeatures().contains(NoRecurse.NO_ENTRY_SET)) {
132      derivedSuites.add(
133          SetTestSuiteBuilder.using(new EntrySetGenerator<E>(parentBuilder.getSubjectGenerator()))
134              .named(getName() + ".entrySet")
135              .withFeatures(computeEntrySetFeatures(parentBuilder.getFeatures()))
136              .suppressing(parentBuilder.getSuppressedTests())
137              .createTestSuite());
138    }
139
140    if (parentBuilder.getFeatures().contains(CollectionFeature.SERIALIZABLE)) {
141      derivedSuites.add(
142          MultisetTestSuiteBuilder.using(
143                  new ReserializedMultisetGenerator<E>(parentBuilder.getSubjectGenerator()))
144              .named(getName() + " reserialized")
145              .withFeatures(computeReserializedMultisetFeatures(parentBuilder.getFeatures()))
146              .suppressing(parentBuilder.getSuppressedTests())
147              .createTestSuite());
148    }
149    return derivedSuites;
150  }
151
152  TestSuite createElementSetTestSuite(
153      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
154          parentBuilder) {
155    return SetTestSuiteBuilder.using(
156            new ElementSetGenerator<E>(parentBuilder.getSubjectGenerator()))
157        .named(getName() + ".elementSet")
158        .withFeatures(computeElementSetFeatures(parentBuilder.getFeatures()))
159        .suppressing(parentBuilder.getSuppressedTests())
160        .createTestSuite();
161  }
162
163  static class ElementSetGenerator<E> implements TestSetGenerator<E> {
164    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
165
166    ElementSetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
167      this.gen = gen;
168    }
169
170    @Override
171    public SampleElements<E> samples() {
172      return gen.samples();
173    }
174
175    @Override
176    public Set<E> create(Object... elements) {
177      Object[] duplicated = new Object[elements.length * 2];
178      for (int i = 0; i < elements.length; i++) {
179        duplicated[i] = elements[i];
180        duplicated[i + elements.length] = elements[i];
181      }
182      return ((Multiset<E>) gen.create(duplicated)).elementSet();
183    }
184
185    @Override
186    public E[] createArray(int length) {
187      return gen.createArray(length);
188    }
189
190    @Override
191    public Iterable<E> order(List<E> insertionOrder) {
192      return gen.order(new ArrayList<E>(new LinkedHashSet<E>(insertionOrder)));
193    }
194  }
195
196  static class EntrySetGenerator<E> implements TestSetGenerator<Multiset.Entry<E>> {
197    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
198
199    private EntrySetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
200      this.gen = gen;
201    }
202
203    @Override
204    public SampleElements<Multiset.Entry<E>> samples() {
205      SampleElements<E> samples = gen.samples();
206      return new SampleElements<>(
207          Multisets.immutableEntry(samples.e0(), 3),
208          Multisets.immutableEntry(samples.e1(), 4),
209          Multisets.immutableEntry(samples.e2(), 1),
210          Multisets.immutableEntry(samples.e3(), 5),
211          Multisets.immutableEntry(samples.e4(), 2));
212    }
213
214    @Override
215    public Set<Multiset.Entry<E>> create(Object... entries) {
216      List<Object> contents = new ArrayList<>();
217      Set<E> elements = new HashSet<>();
218      for (Object o : entries) {
219        @SuppressWarnings("unchecked")
220        Multiset.Entry<E> entry = (Entry<E>) o;
221        checkArgument(
222            elements.add(entry.getElement()), "Duplicate keys not allowed in EntrySetGenerator");
223        for (int i = 0; i < entry.getCount(); i++) {
224          contents.add(entry.getElement());
225        }
226      }
227      return ((Multiset<E>) gen.create(contents.toArray())).entrySet();
228    }
229
230    @SuppressWarnings("unchecked")
231    @Override
232    public Multiset.Entry<E>[] createArray(int length) {
233      return new Multiset.Entry[length];
234    }
235
236    @Override
237    public Iterable<Entry<E>> order(List<Entry<E>> insertionOrder) {
238      // We mimic the order from gen.
239      Map<E, Entry<E>> map = new LinkedHashMap<>();
240      for (Entry<E> entry : insertionOrder) {
241        map.put(entry.getElement(), entry);
242      }
243
244      Set<E> seen = new HashSet<>();
245      List<Entry<E>> order = new ArrayList<>();
246      for (E e : gen.order(new ArrayList<E>(map.keySet()))) {
247        if (seen.add(e)) {
248          order.add(map.get(e));
249        }
250      }
251      return order;
252    }
253  }
254
255  static class ReserializedMultisetGenerator<E> implements TestMultisetGenerator<E> {
256    final OneSizeTestContainerGenerator<Collection<E>, E> gen;
257
258    private ReserializedMultisetGenerator(OneSizeTestContainerGenerator<Collection<E>, E> gen) {
259      this.gen = gen;
260    }
261
262    @Override
263    public SampleElements<E> samples() {
264      return gen.samples();
265    }
266
267    @Override
268    public Multiset<E> create(Object... elements) {
269      return (Multiset<E>) SerializableTester.reserialize(gen.create(elements));
270    }
271
272    @Override
273    public E[] createArray(int length) {
274      return gen.createArray(length);
275    }
276
277    @Override
278    public Iterable<E> order(List<E> insertionOrder) {
279      return gen.order(insertionOrder);
280    }
281  }
282}