001/*
002 * Copyright (C) 2010 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;
018
019import static com.google.common.collect.testing.Helpers.castOrCopyToList;
020import static java.util.Collections.reverse;
021
022import com.google.common.annotations.GwtIncompatible;
023import com.google.common.collect.testing.DerivedCollectionGenerators.Bound;
024import com.google.common.collect.testing.DerivedCollectionGenerators.ForwardingTestMapGenerator;
025import com.google.common.collect.testing.DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator;
026import com.google.common.collect.testing.features.Feature;
027import com.google.common.collect.testing.testers.NavigableMapNavigationTester;
028import java.util.ArrayList;
029import java.util.List;
030import java.util.Map;
031import java.util.Map.Entry;
032import java.util.NavigableMap;
033import java.util.SortedMap;
034import junit.framework.TestSuite;
035
036/**
037 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a NavigableMap
038 * implementation.
039 */
040@GwtIncompatible
041public class NavigableMapTestSuiteBuilder<K, V> extends SortedMapTestSuiteBuilder<K, V> {
042  public static <K, V> NavigableMapTestSuiteBuilder<K, V> using(
043      TestSortedMapGenerator<K, V> generator) {
044    NavigableMapTestSuiteBuilder<K, V> result = new NavigableMapTestSuiteBuilder<>();
045    result.usingGenerator(generator);
046    return result;
047  }
048
049  @Override
050  protected List<Class<? extends AbstractTester>> getTesters() {
051    List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters());
052    testers.add(NavigableMapNavigationTester.class);
053    return testers;
054  }
055
056  @Override
057  protected List<TestSuite> createDerivedSuites(
058      FeatureSpecificTestSuiteBuilder<
059              ?, ? extends OneSizeTestContainerGenerator<Map<K, V>, Entry<K, V>>>
060          parentBuilder) {
061    List<TestSuite> derivedSuites = super.createDerivedSuites(parentBuilder);
062
063    if (!parentBuilder.getFeatures().contains(NoRecurse.DESCENDING)) {
064      derivedSuites.add(createDescendingSuite(parentBuilder));
065    }
066
067    if (!parentBuilder.getFeatures().contains(NoRecurse.SUBMAP)) {
068      // Other combinations are inherited from SortedMapTestSuiteBuilder.
069      derivedSuites.add(createSubmapSuite(parentBuilder, Bound.NO_BOUND, Bound.INCLUSIVE));
070      derivedSuites.add(createSubmapSuite(parentBuilder, Bound.EXCLUSIVE, Bound.NO_BOUND));
071      derivedSuites.add(createSubmapSuite(parentBuilder, Bound.EXCLUSIVE, Bound.EXCLUSIVE));
072      derivedSuites.add(createSubmapSuite(parentBuilder, Bound.EXCLUSIVE, Bound.INCLUSIVE));
073      derivedSuites.add(createSubmapSuite(parentBuilder, Bound.INCLUSIVE, Bound.INCLUSIVE));
074    }
075
076    return derivedSuites;
077  }
078
079  @Override
080  protected NavigableSetTestSuiteBuilder<K> createDerivedKeySetSuite(
081      TestSetGenerator<K> keySetGenerator) {
082    return NavigableSetTestSuiteBuilder.using((TestSortedSetGenerator<K>) keySetGenerator);
083  }
084
085  public static final class NavigableMapSubmapTestMapGenerator<K, V>
086      extends SortedMapSubmapTestMapGenerator<K, V> {
087    public NavigableMapSubmapTestMapGenerator(
088        TestSortedMapGenerator<K, V> delegate, Bound to, Bound from) {
089      super(delegate, to, from);
090    }
091
092    @Override
093    NavigableMap<K, V> createSubMap(SortedMap<K, V> sortedMap, K firstExclusive, K lastExclusive) {
094      NavigableMap<K, V> map = (NavigableMap<K, V>) sortedMap;
095      if (from == Bound.NO_BOUND && to == Bound.INCLUSIVE) {
096        return map.headMap(lastInclusive, true);
097      } else if (from == Bound.EXCLUSIVE && to == Bound.NO_BOUND) {
098        return map.tailMap(firstExclusive, false);
099      } else if (from == Bound.EXCLUSIVE && to == Bound.EXCLUSIVE) {
100        return map.subMap(firstExclusive, false, lastExclusive, false);
101      } else if (from == Bound.EXCLUSIVE && to == Bound.INCLUSIVE) {
102        return map.subMap(firstExclusive, false, lastInclusive, true);
103      } else if (from == Bound.INCLUSIVE && to == Bound.INCLUSIVE) {
104        return map.subMap(firstInclusive, true, lastInclusive, true);
105      } else {
106        return (NavigableMap<K, V>) super.createSubMap(map, firstExclusive, lastExclusive);
107      }
108    }
109  }
110
111  @Override
112  public NavigableMapTestSuiteBuilder<K, V> newBuilderUsing(
113      TestSortedMapGenerator<K, V> delegate, Bound to, Bound from) {
114    return subSuiteUsing(new NavigableMapSubmapTestMapGenerator<K, V>(delegate, to, from));
115  }
116
117  /** Create a suite whose maps are descending views of other maps. */
118  private TestSuite createDescendingSuite(
119      FeatureSpecificTestSuiteBuilder<
120              ?, ? extends OneSizeTestContainerGenerator<Map<K, V>, Entry<K, V>>>
121          parentBuilder) {
122    TestSortedMapGenerator<K, V> delegate =
123        (TestSortedMapGenerator<K, V>) parentBuilder.getSubjectGenerator().getInnerGenerator();
124
125    List<Feature<?>> features = new ArrayList<>();
126    features.add(NoRecurse.DESCENDING);
127    features.addAll(parentBuilder.getFeatures());
128
129    return subSuiteUsing(new DescendingTestMapGenerator<K, V>(delegate))
130        .named(parentBuilder.getName() + " descending")
131        .withFeatures(features)
132        .suppressing(parentBuilder.getSuppressedTests())
133        .createTestSuite();
134  }
135
136  NavigableMapTestSuiteBuilder<K, V> subSuiteUsing(TestSortedMapGenerator<K, V> generator) {
137    return using(generator);
138  }
139
140  static class DescendingTestMapGenerator<K, V> extends ForwardingTestMapGenerator<K, V>
141      implements TestSortedMapGenerator<K, V> {
142    DescendingTestMapGenerator(TestSortedMapGenerator<K, V> delegate) {
143      super(delegate);
144    }
145
146    @Override
147    public NavigableMap<K, V> create(Object... entries) {
148      NavigableMap<K, V> map = (NavigableMap<K, V>) delegate.create(entries);
149      return map.descendingMap();
150    }
151
152    @Override
153    public Iterable<Entry<K, V>> order(List<Entry<K, V>> insertionOrder) {
154      insertionOrder = castOrCopyToList(delegate.order(insertionOrder));
155      reverse(insertionOrder);
156      return insertionOrder;
157    }
158
159    TestSortedMapGenerator<K, V> delegate() {
160      return (TestSortedMapGenerator<K, V>) delegate;
161    }
162
163    @Override
164    public Entry<K, V> belowSamplesLesser() {
165      return delegate().aboveSamplesGreater();
166    }
167
168    @Override
169    public Entry<K, V> belowSamplesGreater() {
170      return delegate().aboveSamplesLesser();
171    }
172
173    @Override
174    public Entry<K, V> aboveSamplesLesser() {
175      return delegate().belowSamplesGreater();
176    }
177
178    @Override
179    public Entry<K, V> aboveSamplesGreater() {
180      return delegate().belowSamplesLesser();
181    }
182  }
183}