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