11d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/* 21d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Copyright (C) 2008 The Guava Authors 31d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 41d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Licensed under the Apache License, Version 2.0 (the "License"); 51d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * you may not use this file except in compliance with the License. 61d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * You may obtain a copy of the License at 71d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 81d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * http://www.apache.org/licenses/LICENSE-2.0 91d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Unless required by applicable law or agreed to in writing, software 111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * distributed under the License is distributed on an "AS IS" BASIS, 121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * See the License for the specific language governing permissions and 141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * limitations under the License. 151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpackage com.google.common.collect.testing; 181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.CollectionSize; 201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.Feature; 211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport com.google.common.collect.testing.features.FeatureUtil; 221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport junit.framework.TestSuite; 241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.lang.reflect.Method; 261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.ArrayList; 271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Arrays; 281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.List; 291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.Set; 301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertimport java.util.logging.Logger; 311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert/** 331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * This builder creates a composite test suite, containing a separate test suite 341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * for each {@link CollectionSize} present in the features specified 351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * by {@link #withFeatures(Feature...)}. 361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @param <B> The concrete type of this builder (the 'self-type'). All the 381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Builder methods of this class (such as {@link #named(String)}) return this 391d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * type, so that Builder methods of more derived classes can be chained onto 401d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * them without casting. 411d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @param <G> The type of the generator to be passed to testers in the 421d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * generated test suite. An instance of G should somehow provide an 431d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * instance of the class under test, plus any other information required 441d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * to parameterize the test. 451d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 461d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @see FeatureSpecificTestSuiteBuilder 471d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * 481d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * @author George van den Driessche 491d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 501d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringertpublic abstract class PerCollectionSizeTestSuiteBuilder< 511d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert B extends PerCollectionSizeTestSuiteBuilder<B, G, T, E>, 521d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert G extends TestContainerGenerator<T, E>, 531d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert T, 541d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert E> 551d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert extends FeatureSpecificTestSuiteBuilder<B, G> { 561d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private static final Logger logger = Logger.getLogger( 571d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert PerCollectionSizeTestSuiteBuilder.class.getName()); 581d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 591d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** 601d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert * Creates a runnable JUnit test suite based on the criteria already given. 611d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert */ 621d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override public TestSuite createTestSuite() { 631d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert checkCanCreate(); 641d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 651d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert String name = getName(); 661d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Copy this set, so we can modify it. 671d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Set<Feature<?>> features = Helpers.copyToSet(getFeatures()); 681d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert List<Class<? extends AbstractTester>> testers = getTesters(); 691d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 701d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert logger.fine(" Testing: " + name); 711d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 721d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert // Split out all the specified sizes. 731d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Set<Feature<?>> sizesToTest = 741d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Helpers.<Feature<?>>copyToSet(CollectionSize.values()); 751d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert sizesToTest.retainAll(features); 761d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert features.removeAll(sizesToTest); 771d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 781d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert FeatureUtil.addImpliedFeatures(sizesToTest); 791d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert sizesToTest.retainAll(Arrays.asList( 801d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert CollectionSize.ZERO, CollectionSize.ONE, CollectionSize.SEVERAL)); 811d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 821d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert logger.fine(" Sizes: " + formatFeatureSet(sizesToTest)); 831d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 841d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert if (sizesToTest.isEmpty()) { 851d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert throw new IllegalStateException(name 861d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert + ": no CollectionSizes specified (check the argument to " 871d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert + "FeatureSpecificTestSuiteBuilder.withFeatures().)"); 881d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 891d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 901d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert TestSuite suite = new TestSuite(name); 911d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (Feature<?> collectionSize : sizesToTest) { 921d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert String oneSizeName = Platform.format("%s [collection size: %s]", 931d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert name, collectionSize.toString().toLowerCase()); 941d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert OneSizeGenerator<T, E> oneSizeGenerator = new OneSizeGenerator<T, E>( 951d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert getSubjectGenerator(), (CollectionSize) collectionSize); 961d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Set<Feature<?>> oneSizeFeatures = Helpers.copyToSet(features); 971d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert oneSizeFeatures.add(collectionSize); 981d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert Set<Method> oneSizeSuppressedTests = getSuppressedTests(); 991d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1001d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert OneSizeTestSuiteBuilder<T, E> oneSizeBuilder = 1011d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert new OneSizeTestSuiteBuilder<T, E>(testers) 1021d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .named(oneSizeName) 1031d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .usingGenerator(oneSizeGenerator) 1041d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .withFeatures(oneSizeFeatures) 1051d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .withSetUp(getSetUp()) 1061d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .withTearDown(getTearDown()) 1071d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert .suppressing(oneSizeSuppressedTests); 1081d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert TestSuite oneSizeSuite = oneSizeBuilder.createTestSuite(); 1091d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert suite.addTest(oneSizeSuite); 1101d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1111d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert for (TestSuite derivedSuite : createDerivedSuites(oneSizeBuilder)) { 1121d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert oneSizeSuite.addTest(derivedSuite); 1131d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1141d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1151d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return suite; 1161d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1171d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1181d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert List<TestSuite> createDerivedSuites(FeatureSpecificTestSuiteBuilder< 1191d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert ?, ? extends OneSizeTestContainerGenerator<T, E>> parentBuilder) { 1201d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return new ArrayList<TestSuite>(); 1211d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1221d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1231d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert /** Builds a test suite for one particular {@link CollectionSize}. */ 1241d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private static final class OneSizeTestSuiteBuilder<T, E> extends 1251d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert FeatureSpecificTestSuiteBuilder< 1261d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert OneSizeTestSuiteBuilder<T, E>, OneSizeGenerator<T, E>> { 1271d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert private final List<Class<? extends AbstractTester>> testers; 1281d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1291d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert public OneSizeTestSuiteBuilder( 1301d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert List<Class<? extends AbstractTester>> testers) { 1311d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert this.testers = testers; 1321d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1331d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert 1341d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert @Override protected List<Class<? extends AbstractTester>> getTesters() { 1351d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert return testers; 1361d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1371d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert } 1381d580d0f6ee4f21eb309ba7b509d2c6d671c4044Bjorn Bringert} 139