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.copyToList;
020import static com.google.common.collect.testing.features.CollectionFeature.DESCENDING_VIEW;
021import static com.google.common.collect.testing.features.CollectionFeature.SUBSET_VIEW;
022
023import com.google.common.annotations.GwtIncompatible;
024import com.google.common.collect.testing.DerivedCollectionGenerators.Bound;
025import com.google.common.collect.testing.DerivedCollectionGenerators.SortedSetSubsetTestSetGenerator;
026import com.google.common.collect.testing.features.Feature;
027import com.google.common.collect.testing.testers.NavigableSetNavigationTester;
028import java.util.ArrayList;
029import java.util.Collection;
030import java.util.Collections;
031import java.util.List;
032import java.util.NavigableSet;
033import java.util.Set;
034import java.util.SortedSet;
035import junit.framework.TestSuite;
036
037/**
038 * Creates, based on your criteria, a JUnit test suite that exhaustively tests a NavigableSet
039 * implementation.
040 */
041@GwtIncompatible
042public final class NavigableSetTestSuiteBuilder<E> extends SortedSetTestSuiteBuilder<E> {
043  public static <E> NavigableSetTestSuiteBuilder<E> using(TestSortedSetGenerator<E> generator) {
044    NavigableSetTestSuiteBuilder<E> builder = new NavigableSetTestSuiteBuilder<>();
045    builder.usingGenerator(generator);
046    return builder;
047  }
048
049  @Override
050  protected List<TestSuite> createDerivedSuites(
051      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
052          parentBuilder) {
053    List<TestSuite> derivedSuites = new ArrayList<>(super.createDerivedSuites(parentBuilder));
054
055    if (!parentBuilder.getFeatures().contains(SUBSET_VIEW)) {
056      // Other combinations are inherited from SortedSetTestSuiteBuilder.
057      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.NO_BOUND, Bound.INCLUSIVE));
058      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.NO_BOUND));
059      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.EXCLUSIVE));
060      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.EXCLUSIVE, Bound.INCLUSIVE));
061      derivedSuites.add(createSubsetSuite(parentBuilder, Bound.INCLUSIVE, Bound.INCLUSIVE));
062    }
063    if (!parentBuilder.getFeatures().contains(DESCENDING_VIEW)) {
064      derivedSuites.add(createDescendingSuite(parentBuilder));
065    }
066    return derivedSuites;
067  }
068
069  public static final class NavigableSetSubsetTestSetGenerator<E>
070      extends SortedSetSubsetTestSetGenerator<E> {
071    public NavigableSetSubsetTestSetGenerator(
072        TestSortedSetGenerator<E> delegate, Bound to, Bound from) {
073      super(delegate, to, from);
074    }
075
076    @Override
077    NavigableSet<E> createSubSet(SortedSet<E> sortedSet, E firstExclusive, E lastExclusive) {
078      NavigableSet<E> set = (NavigableSet<E>) sortedSet;
079      if (from == Bound.NO_BOUND && to == Bound.INCLUSIVE) {
080        return set.headSet(lastInclusive, true);
081      } else if (from == Bound.EXCLUSIVE && to == Bound.NO_BOUND) {
082        return set.tailSet(firstExclusive, false);
083      } else if (from == Bound.EXCLUSIVE && to == Bound.EXCLUSIVE) {
084        return set.subSet(firstExclusive, false, lastExclusive, false);
085      } else if (from == Bound.EXCLUSIVE && to == Bound.INCLUSIVE) {
086        return set.subSet(firstExclusive, false, lastInclusive, true);
087      } else if (from == Bound.INCLUSIVE && to == Bound.INCLUSIVE) {
088        return set.subSet(firstInclusive, true, lastInclusive, true);
089      } else {
090        return (NavigableSet<E>) super.createSubSet(set, firstExclusive, lastExclusive);
091      }
092    }
093  }
094
095  @Override
096  public NavigableSetTestSuiteBuilder<E> newBuilderUsing(
097      TestSortedSetGenerator<E> delegate, Bound to, Bound from) {
098    return using(new NavigableSetSubsetTestSetGenerator<E>(delegate, to, from));
099  }
100
101  /** Create a suite whose maps are descending views of other maps. */
102  private TestSuite createDescendingSuite(
103      FeatureSpecificTestSuiteBuilder<?, ? extends OneSizeTestContainerGenerator<Collection<E>, E>>
104          parentBuilder) {
105    TestSetGenerator<E> delegate =
106        (TestSetGenerator<E>) parentBuilder.getSubjectGenerator().getInnerGenerator();
107
108    List<Feature<?>> features = new ArrayList<>();
109    features.add(DESCENDING_VIEW);
110    features.addAll(parentBuilder.getFeatures());
111
112    return NavigableSetTestSuiteBuilder.using(
113            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<>();
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  @SuppressWarnings("rawtypes") // class literals
148  @Override
149  protected List<Class<? extends AbstractTester>> getTesters() {
150    List<Class<? extends AbstractTester>> testers = copyToList(super.getTesters());
151    testers.add(NavigableSetNavigationTester.class);
152    return testers;
153  }
154}