| 1 |
/* |
| 2 |
* Copyright (C) 2010 The Guava Authors |
| 3 |
* |
| 4 |
* Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 |
* you may not use this file except in compliance with the License. |
| 6 |
* You may obtain a copy of the License at |
| 7 |
* |
| 8 |
* http://www.apache.org/licenses/LICENSE-2.0 |
| 9 |
* |
| 10 |
* Unless required by applicable law or agreed to in writing, software |
| 11 |
* distributed under the License is distributed on an "AS IS" BASIS, |
| 12 |
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 |
* See the License for the specific language governing permissions and |
| 14 |
* limitations under the License. |
| 15 |
*/ |
| 16 |
|
| 17 |
package com.google.common.collect.testing; |
| 18 |
|
| 19 |
import static com.google.common.collect.testing.features.CollectionFeature.KNOWN_ORDER; |
| 20 |
|
| 21 |
import com.google.common.annotations.GwtIncompatible; |
| 22 |
import com.google.common.collect.testing.DerivedCollectionGenerators.Bound; |
| 23 |
import com.google.common.collect.testing.DerivedCollectionGenerators.SortedMapSubmapTestMapGenerator; |
| 24 |
import com.google.common.collect.testing.features.Feature; |
| 25 |
import com.google.common.collect.testing.testers.SortedMapNavigationTester; |
| 26 |
import java.util.ArrayList; |
| 27 |
import java.util.Collections; |
| 28 |
import java.util.List; |
| 29 |
import java.util.Map; |
| 30 |
import java.util.Map.Entry; |
| 31 |
import java.util.Set; |
| 32 |
import junit.framework.TestSuite; |
| 33 |
import org.checkerframework.checker.nullness.qual.Nullable; |
| 34 |
|
| 35 |
/** |
| 36 |
* Creates, based on your criteria, a JUnit test suite that exhaustively tests a SortedMap |
| 37 |
* implementation. |
| 38 |
*/ |
| 39 |
@GwtIncompatible |
| 40 |
public class SortedMapTestSuiteBuilder<K, V> extends MapTestSuiteBuilder<K, V> { |
| 41 |
public static <K, V> SortedMapTestSuiteBuilder<K, V> using( |
| 42 |
TestSortedMapGenerator<K, V> generator) { |
| 43 |
SortedMapTestSuiteBuilder<K, V> result = new SortedMapTestSuiteBuilder<>(); |
| 44 |
result.usingGenerator(generator); |
| 45 |
return result; |
| 46 |
} |
| 47 |
|
| 48 |
@Override |
| 49 |
protected List<Class<? extends AbstractTester>> getTesters() { |
| 50 |
List<Class<? extends AbstractTester>> testers = Helpers.copyToList(super.getTesters()); |
| 51 |
testers.add(SortedMapNavigationTester.class); |
| 52 |
return testers; |
| 53 |
} |
| 54 |
|
| 55 |
@Override |
| 56 |
public TestSuite createTestSuite() { |
| 57 |
if (!getFeatures().contains(KNOWN_ORDER)) { |
| 58 |
List<Feature<?>> features = Helpers.copyToList(getFeatures()); |
| 59 |
features.add(KNOWN_ORDER); |
| 60 |
withFeatures(features); |
| 61 |
} |
| 62 |
return super.createTestSuite(); |
| 63 |
} |
| 64 |
|
| 65 |
@Override |
| 66 |
protected List<TestSuite> createDerivedSuites( |
| 67 |
FeatureSpecificTestSuiteBuilder< |
| 68 |
?, ? extends OneSizeTestContainerGenerator<Map<K, V>, Entry<K, V>>> |
| 69 |
parentBuilder) { |
| 70 |
List<TestSuite> derivedSuites = super.createDerivedSuites(parentBuilder); |
| 71 |
|
| 72 |
if (!parentBuilder.getFeatures().contains(NoRecurse.SUBMAP)) { |
| 73 |
derivedSuites.add(createSubmapSuite(parentBuilder, Bound.NO_BOUND, Bound.EXCLUSIVE)); |
| 74 |
derivedSuites.add(createSubmapSuite(parentBuilder, Bound.INCLUSIVE, Bound.NO_BOUND)); |
| 75 |
derivedSuites.add(createSubmapSuite(parentBuilder, Bound.INCLUSIVE, Bound.EXCLUSIVE)); |
| 76 |
} |
| 77 |
|
| 78 |
return derivedSuites; |
| 79 |
} |
| 80 |
|
| 81 |
@Override |
| 82 |
protected SetTestSuiteBuilder<K> createDerivedKeySetSuite(TestSetGenerator<K> keySetGenerator) { |
| 83 |
return keySetGenerator instanceof TestSortedSetGenerator |
| 84 |
? SortedSetTestSuiteBuilder.using((TestSortedSetGenerator<K>) keySetGenerator) |
| 85 |
: SetTestSuiteBuilder.using(keySetGenerator); |
| 86 |
} |
| 87 |
|
| 88 |
/** |
| 89 |
* To avoid infinite recursion, test suites with these marker features won't have derived suites |
| 90 |
* created for them. |
| 91 |
*/ |
| 92 |
enum NoRecurse implements Feature<@Nullable Void> { |
| 93 |
SUBMAP, |
| 94 |
DESCENDING; |
| 95 |
|
| 96 |
@Override |
| 97 |
public Set<Feature<? super @Nullable Void>> getImpliedFeatures() { |
| 98 |
return Collections.emptySet(); |
| 99 |
} |
| 100 |
} |
| 101 |
|
| 102 |
/** |
| 103 |
* Creates a suite whose map has some elements filtered out of view. |
| 104 |
* |
| 105 |
* <p>Because the map may be ascending or descending, this test must derive the relative order of |
| 106 |
* these extreme values rather than relying on their regular sort ordering. |
| 107 |
*/ |
| 108 |
final TestSuite createSubmapSuite( |
| 109 |
FeatureSpecificTestSuiteBuilder< |
| 110 |
?, ? extends OneSizeTestContainerGenerator<Map<K, V>, Entry<K, V>>> |
| 111 |
parentBuilder, |
| 112 |
Bound from, |
| 113 |
Bound to) { |
| 114 |
TestSortedMapGenerator<K, V> delegate = |
| 115 |
(TestSortedMapGenerator<K, V>) parentBuilder.getSubjectGenerator().getInnerGenerator(); |
| 116 |
|
| 117 |
List<Feature<?>> features = new ArrayList<>(); |
| 118 |
features.add(NoRecurse.SUBMAP); |
| 119 |
features.addAll(parentBuilder.getFeatures()); |
| 120 |
|
| 121 |
return newBuilderUsing(delegate, to, from) |
| 122 |
.named(parentBuilder.getName() + " subMap " + from + "-" + to) |
| 123 |
.withFeatures(features) |
| 124 |
.suppressing(parentBuilder.getSuppressedTests()) |
| 125 |
.withSetUp(parentBuilder.getSetUp()) |
| 126 |
.withTearDown(parentBuilder.getTearDown()) |
| 127 |
.createTestSuite(); |
| 128 |
} |
| 129 |
|
| 130 |
/** Like using() but overrideable by NavigableMapTestSuiteBuilder. */ |
| 131 |
SortedMapTestSuiteBuilder<K, V> newBuilderUsing( |
| 132 |
TestSortedMapGenerator<K, V> delegate, Bound to, Bound from) { |
| 133 |
return using(new SortedMapSubmapTestMapGenerator<K, V>(delegate, to, from)); |
| 134 |
} |
| 135 |
} |