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  @Override
054  protected List<Class<? extends AbstractTester>> getTesters() {
055    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
056    testers.add(SetMultimapAsMapTester.class);
057    testers.add(SetMultimapEqualsTester.class);
058    testers.add(SetMultimapPutTester.class);
059    testers.add(SetMultimapPutAllTester.class);
060    testers.add(SetMultimapReplaceValuesTester.class);
061    return testers;
062  }
063
064  @Override
065  TestSuite computeMultimapGetTestSuite(
066      FeatureSpecificTestSuiteBuilder<
067              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
068          parentBuilder) {
069    return SetTestSuiteBuilder.using(
070            new MultimapGetGenerator<K, V>(parentBuilder.getSubjectGenerator()))
071        .withFeatures(computeMultimapGetFeatures(parentBuilder.getFeatures()))
072        .named(parentBuilder.getName() + ".get[key]")
073        .suppressing(parentBuilder.getSuppressedTests())
074        .createTestSuite();
075  }
076
077  @Override
078  TestSuite computeMultimapAsMapGetTestSuite(
079      FeatureSpecificTestSuiteBuilder<
080              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
081          parentBuilder) {
082    Set<Feature<?>> features = computeMultimapAsMapGetFeatures(parentBuilder.getFeatures());
083    if (Collections.disjoint(features, EnumSet.allOf(CollectionSize.class))) {
084      return new TestSuite();
085    } else {
086      return SetTestSuiteBuilder.using(
087              new MultimapAsMapGetGenerator<K, V>(parentBuilder.getSubjectGenerator()))
088          .withFeatures(features)
089          .named(parentBuilder.getName() + ".asMap[].get[key]")
090          .suppressing(parentBuilder.getSuppressedTests())
091          .createTestSuite();
092    }
093  }
094
095  @Override
096  TestSuite computeEntriesTestSuite(
097      FeatureSpecificTestSuiteBuilder<
098              ?, ? extends OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>>>
099          parentBuilder) {
100    return SetTestSuiteBuilder.using(
101            new EntriesGenerator<K, V>(parentBuilder.getSubjectGenerator()))
102        .withFeatures(computeEntriesFeatures(parentBuilder.getFeatures()))
103        .named(parentBuilder.getName() + ".entries")
104        .suppressing(parentBuilder.getSuppressedTests())
105        .createTestSuite();
106  }
107
108  private static class EntriesGenerator<K, V>
109      extends MultimapTestSuiteBuilder.EntriesGenerator<K, V, SetMultimap<K, V>>
110      implements TestSetGenerator<Entry<K, V>> {
111
112    public EntriesGenerator(
113        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
114      super(multimapGenerator);
115    }
116
117    @Override
118    public Set<Entry<K, V>> create(Object... elements) {
119      return (Set<Entry<K, V>>) super.create(elements);
120    }
121  }
122
123  static class MultimapGetGenerator<K, V>
124      extends MultimapTestSuiteBuilder.MultimapGetGenerator<K, V, SetMultimap<K, V>>
125      implements TestSetGenerator<V> {
126    public MultimapGetGenerator(
127        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
128      super(multimapGenerator);
129    }
130
131    @Override
132    public Set<V> create(Object... elements) {
133      return (Set<V>) super.create(elements);
134    }
135  }
136
137  static class MultimapAsMapGetGenerator<K, V>
138      extends MultimapTestSuiteBuilder.MultimapAsMapGetGenerator<K, V, SetMultimap<K, V>>
139      implements TestSetGenerator<V> {
140    public MultimapAsMapGetGenerator(
141        OneSizeTestContainerGenerator<SetMultimap<K, V>, Entry<K, V>> multimapGenerator) {
142      super(multimapGenerator);
143    }
144
145    @Override
146    public Set<V> create(Object... elements) {
147      return (Set<V>) super.create(elements);
148    }
149  }
150}