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
17package com.google.common.collect.testing;
18
19import com.google.common.collect.testing.DerivedCollectionGenerators.Bound;
20import com.google.common.collect.testing.DerivedCollectionGenerators.SortedSetSubsetTestSetGenerator;
21import com.google.common.collect.testing.features.CollectionFeature;
22import com.google.common.collect.testing.features.Feature;
23import com.google.common.collect.testing.testers.NavigableSetNavigationTester;
24
25import junit.framework.TestSuite;
26
27import java.util.ArrayList;
28import java.util.Collection;
29import java.util.Collections;
30import java.util.List;
31import java.util.NavigableSet;
32import java.util.Set;
33import java.util.SortedSet;
34
35/**
36 * Creates, based on your criteria, a JUnit test suite that exhaustively tests
37 * a NavigableSet implementation.
38 */
39public final class NavigableSetTestSuiteBuilder<E>
40    extends SortedSetTestSuiteBuilder<E> {
41  public static <E> NavigableSetTestSuiteBuilder<E> using(
42      TestSortedSetGenerator<E> generator) {
43    NavigableSetTestSuiteBuilder<E> builder =
44        new NavigableSetTestSuiteBuilder<E>();
45    builder.usingGenerator(generator);
46    return builder;
47  }
48
49  @Override
50  protected List<TestSuite> createDerivedSuites(FeatureSpecificTestSuiteBuilder<
51      ?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>> parentBuilder) {
52    List<TestSuite> derivedSuites = new ArrayList<TestSuite>(
53        super.createDerivedSuites(parentBuilder));
54
55    if (!parentBuilder.getFeatures().contains(CollectionFeature.SUBSET_VIEW)) {
56      // Other combinations are inherited from SortedSetTestSuiteBuilder.
57      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.NO_BOUND, Bound.INCLUSIVE));
58      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.NO_BOUND));
59      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.EXCLUSIVE));
60      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.INCLUSIVE));
61      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.INCLUSIVE, Bound.INCLUSIVE));
62    }
63    if (!parentBuilder.getFeatures().contains(CollectionFeature.DESCENDING_VIEW)) {
64      derivedSuites.add(createDescendingSuite(parentBuilder));
65    }
66    return derivedSuites;
67  }
68
69  public static final class NavigableSetSubsetTestSetGenerator<E>
70      extends SortedSetSubsetTestSetGenerator<E> {
71    public NavigableSetSubsetTestSetGenerator(
72        TestSortedSetGenerator<E> delegate, Bound to, Bound from) {
73      super(delegate, to, from);
74    }
75
76    @Override NavigableSet<E> createSubSet(SortedSet<E> sortedSet, E firstExclusive,
77        E lastExclusive) {
78      NavigableSet<E> set = (NavigableSet<E>) sortedSet;
79      if (from == Bound.NO_BOUND && to == Bound.INCLUSIVE) {
80        return set.headSet(lastInclusive, true);
81      } else if (from == Bound.EXCLUSIVE && to == Bound.NO_BOUND) {
82        return set.tailSet(firstExclusive, false);
83      } else if (from == Bound.EXCLUSIVE && to == Bound.EXCLUSIVE) {
84        return set.subSet(firstExclusive, false, lastExclusive, false);
85      } else if (from == Bound.EXCLUSIVE && to == Bound.INCLUSIVE) {
86        return set.subSet(firstExclusive, false, lastInclusive, true);
87      } else if (from == Bound.INCLUSIVE && to == Bound.INCLUSIVE) {
88        return set.subSet(firstInclusive, true, lastInclusive, true);
89      } else {
90        return (NavigableSet<E>) super.createSubSet(set, firstExclusive, lastExclusive);
91      }
92    }
93  }
94
95  @Override
96  public NavigableSetTestSuiteBuilder<E> newBuilderUsing(
97      TestSortedSetGenerator<E> delegate, Bound to, Bound from) {
98    return using(new NavigableSetSubsetTestSetGenerator<E>(delegate, to, from));
99  }
100
101  /**
102   * Create a suite whose maps are descending views of other maps.
103   */
104  private TestSuite createDescendingSuite(final FeatureSpecificTestSuiteBuilder<?,
105          ? extends OneSizeTestContainerGenerator<Collection<E>, E>> parentBuilder) {
106    final TestSetGenerator<E> delegate =
107        (TestSetGenerator<E>) parentBuilder.getSubjectGenerator().getInnerGenerator();
108
109    List<Feature<?>> features = new ArrayList<Feature<?>>();
110    features.add(CollectionFeature.DESCENDING_VIEW);
111    features.addAll(parentBuilder.getFeatures());
112
113    return NavigableSetTestSuiteBuilder.using(new TestSetGenerator<E>() {
114
115          @Override
116          public SampleElements<E> samples() {
117            return delegate.samples();
118          }
119
120          @Override
121          public E[] createArray(int length) {
122            return delegate.createArray(length);
123          }
124
125          @Override
126          public Iterable<E> order(List<E> insertionOrder) {
127            List<E> list = new ArrayList<E>();
128            for (E e : delegate.order(insertionOrder)) {
129              list.add(e);
130            }
131            Collections.reverse(list);
132            return list;
133          }
134
135          @Override
136          public Set<E> create(Object... elements) {
137            NavigableSet<E> navigableSet = (NavigableSet<E>) delegate.create(elements);
138            return navigableSet.descendingSet();
139          }
140        })
141        .named(parentBuilder.getName() + " descending")
142        .withFeatures(features)
143        .suppressing(parentBuilder.getSuppressedTests())
144        .createTestSuite();
145  }
146
147  @Override protected List<Class<? extends AbstractTester>> getTesters() {
148    List<Class<? extends AbstractTester>> testers =
149        Helpers.copyToList(super.getTesters());
150    testers.add(NavigableSetNavigationTester.class);
151    return testers;
152  }
153}
154