001/*
002 * Copyright (C) 2012 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 com.google.common.annotations.GwtIncompatible;
020import com.google.common.collect.SetMultimap;
021import com.google.common.collect.testing.AbstractTester;
022import com.google.common.collect.testing.FeatureSpecificTestSuiteBuilder;
023import com.google.common.collect.testing.Helpers;
024import com.google.common.collect.testing.OneSizeTestContainerGenerator;
025import com.google.common.collect.testing.SetTestSuiteBuilder;
026import com.google.common.collect.testing.TestSetGenerator;
027import com.google.common.collect.testing.features.CollectionSize;
028import com.google.common.collect.testing.features.Feature;
029import java.util.Collections;
030import java.util.EnumSet;
031import java.util.List;
032import java.util.Map.Entry;
033import java.util.Set;
034import junit.framework.TestSuite;
035
036/**
037 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a {@code SetMultimap}
038 * implementation.
039 *
040 * @author Louis Wasserman
041 */
042@GwtIncompatible
043public class SetMultimapTestSuiteBuilder<K, V>
044    extends MultimapTestSuiteBuilder<K, V, SetMultimap<K, V>> {
045
046  public static <K, V> SetMultimapTestSuiteBuilder<K, V> using(
047      TestSetMultimapGenerator<K, V> generator) {
048    SetMultimapTestSuiteBuilder<K, V> result = new SetMultimapTestSuiteBuilder<>();
049    result.usingGenerator(generator);
050    return result;
051  }
052
053  @SuppressWarnings("rawtypes") // class literals
054  @Override
055  protected List<Class<? extends AbstractTester>> getTesters() {
056    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
057    testers.add(SetMultimapAsMapTester.class);
058    testers.add(SetMultimapEqualsTester.class);
059    testers.add(SetMultimapPutTester.class);
060    testers.add(SetMultimapPutAllTester.class);
061    testers.add(SetMultimapReplaceValuesTester.class);
062    return testers;
063  }
064
065  @Override
066  TestSuite computeMultimapGetTestSuite(
067      FeatureSpecificTestSuiteBuilder<
068              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
069          parentBuilder) {
070    return SetTestSuiteBuilder.using(
071            new MultimapGetGenerator<K, V>(parentBuilder.getSubjectGenerator()))
072        .withFeatures(computeMultimapGetFeatures(parentBuilder.getFeatures()))
073        .named(parentBuilder.getName() + ".get[key]")
074        .suppressing(parentBuilder.getSuppressedTests())
075        .createTestSuite();
076  }
077
078  @Override
079  TestSuite computeMultimapAsMapGetTestSuite(
080      FeatureSpecificTestSuiteBuilder<
081              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
082          parentBuilder) {
083    Set<Feature<?>> features = computeMultimapAsMapGetFeatures(parentBuilder.getFeatures());
084    if (Collections.disjoint(features, EnumSet.allOf(CollectionSize.class))) {
085      return new TestSuite();
086    } else {
087      return SetTestSuiteBuilder.using(
088              new MultimapAsMapGetGenerator<K, V>(parentBuilder.getSubjectGenerator()))
089          .withFeatures(features)
090          .named(parentBuilder.getName() + ".asMap[].get[key]")
091          .suppressing(parentBuilder.getSuppressedTests())
092          .createTestSuite();
093    }
094  }
095
096  @Override
097  TestSuite computeEntriesTestSuite(
098      FeatureSpecificTestSuiteBuilder<
099              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
100          parentBuilder) {
101    return SetTestSuiteBuilder.using(
102            new EntriesGenerator<K, V>(parentBuilder.getSubjectGenerator()))
103        .withFeatures(computeEntriesFeatures(parentBuilder.getFeatures()))
104        .named(parentBuilder.getName() + ".entries")
105        .suppressing(parentBuilder.getSuppressedTests())
106        .createTestSuite();
107  }
108
109  private static class EntriesGenerator<K, V>
110      extends MultimapTestSuiteBuilder.EntriesGenerator<K, V, SetMultimap<K, V>>
111      implements TestSetGenerator<Entry<K, V>> {
112
113    public EntriesGenerator(
114        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
115      super(multimapGenerator);
116    }
117
118    @Override
119    public Set<Entry<K, V>> create(Object... elements) {
120      return (Set<Entry<K, V>>) super.create(elements);
121    }
122  }
123
124  static class MultimapGetGenerator<K, V>
125      extends MultimapTestSuiteBuilder.MultimapGetGenerator<K, V, SetMultimap<K, V>>
126      implements TestSetGenerator<V> {
127    public MultimapGetGenerator(
128        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
129      super(multimapGenerator);
130    }
131
132    @Override
133    public Set<V> create(Object... elements) {
134      return (Set<V>) super.create(elements);
135    }
136  }
137
138  static class MultimapAsMapGetGenerator<K, V>
139      extends MultimapTestSuiteBuilder.MultimapAsMapGetGenerator<K, V, SetMultimap<K, V>>
140      implements TestSetGenerator<V> {
141    public MultimapAsMapGetGenerator(
142        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
143      super(multimapGenerator);
144    }
145
146    @Override
147    public Set<V> create(Object... elements) {
148      return (Set<V>) super.create(elements);
149    }
150  }
151}