- *
- *
- * If you
- * override either setUp() or
- * tearDown() in your unit test, make sure you
- * call super.setUp() and
- * super.tearDown()
- *
@After - replaces setup
- * @Before - replaces teardown
- * @Test - any public method with this annotation is a test case, regardless
- * of its name
- * - *
- * See Junit4 documentation for a complete list of features. - *
- * Import from org.junit rather than junit.framework. - *
- * You should be able to use this class anywhere you used LuceneTestCase - * if you annotate your derived class correctly with the annotations above - * @see #assertSaneFieldCaches(String) - */ - -@RunWith(LuceneTestCase.LuceneTestCaseRunner.class) -public abstract class LuceneTestCase extends Assert { - - /** - * true iff tests are run in verbose mode. Note: if it is false, tests are not - * expected to print any messages. - */ - public static final boolean VERBOSE = Boolean.getBoolean("tests.verbose"); - - /** Use this constant when creating Analyzers and any other version-dependent stuff. - *
NOTE: Change this when development starts for new Lucene version:
- */
- public static final Version TEST_VERSION_CURRENT = Version.LUCENE_33;
-
- /**
- * If this is set, it is the only method that should run.
- */
- static final String TEST_METHOD;
-
- /** Create indexes in this directory, optimally use a subdir, named after the test */
- public static final File TEMP_DIR;
- static {
- String method = System.getProperty("testmethod", "").trim();
- TEST_METHOD = method.length() == 0 ? null : method;
- String s = System.getProperty("tempDir", System.getProperty("java.io.tmpdir"));
- if (s == null)
- throw new RuntimeException("To run tests, you need to define system property 'tempDir' or 'java.io.tmpdir'.");
- TEMP_DIR = new File(s);
- TEMP_DIR.mkdirs();
- }
-
- /** set of directories we created, in afterclass we try to clean these up */
- private static final Map
- * This method will be called by tearDown to clean up FieldCache.DEFAULT.
- * If a (poorly written) test has some expectation that the FieldCache
- * will persist across test methods (ie: a static IndexReader) this
- * method can be overridden to do nothing.
- *
- * If any problems are found, they are logged to System.err
- * (allong with the msg) when the Assertion is thrown.
- *
- * This method is called by tearDown after every test method,
- * however IndexReaders scoped inside test methods may be garbage
- * collected prior to this method being called, causing errors to
- * be overlooked. Tests are encouraged to keep their IndexReaders
- * scoped at the class level, or to explicitly call this method
- * directly in the same scope as the IndexReader.
- *
- * The actual number returned will be influenced by whether {@link #TEST_NIGHTLY}
- * is active and {@link #RANDOM_MULTIPLIER}, but also with some random fudge.
- */
- public static int atLeast(Random random, int i) {
- int min = (TEST_NIGHTLY ? 5*i : i) * RANDOM_MULTIPLIER;
- int max = min+(min/2);
- return _TestUtil.nextInt(random, min, max);
- }
-
- public static int atLeast(int i) {
- return atLeast(random, i);
- }
-
- /**
- * Returns true if something should happen rarely,
- *
- * The actual number returned will be influenced by whether {@link #TEST_NIGHTLY}
- * is active and {@link #RANDOM_MULTIPLIER}.
- */
- public static boolean rarely(Random random) {
- int p = TEST_NIGHTLY ? 25 : 5;
- p += (p * Math.log(RANDOM_MULTIPLIER));
- int min = 100 - Math.min(p, 90); // never more than 90
- return random.nextInt(100) >= min;
- }
-
- public static boolean rarely() {
- return rarely(random);
- }
-
- public static boolean usually(Random random) {
- return !rarely(random);
- }
-
- public static boolean usually() {
- return usually(random);
- }
-
- // These deprecated methods should be removed soon, when all tests using no Epsilon are fixed:
-
- @Deprecated
- static public void assertEquals(double expected, double actual) {
- assertEquals(null, expected, actual);
- }
-
- @Deprecated
- static public void assertEquals(String message, double expected, double actual) {
- assertEquals(message, Double.valueOf(expected), Double.valueOf(actual));
- }
-
- @Deprecated
- static public void assertEquals(float expected, float actual) {
- assertEquals(null, expected, actual);
- }
-
- @Deprecated
- static public void assertEquals(String message, float expected, float actual) {
- assertEquals(message, Float.valueOf(expected), Float.valueOf(actual));
- }
-
- // Replacement for Assume jUnit class, so we can add a message with explanation:
-
- private static final class TestIgnoredException extends RuntimeException {
- TestIgnoredException(String msg) {
- super(msg);
- }
-
- TestIgnoredException(String msg, Throwable t) {
- super(msg, t);
- }
-
- @Override
- public String getMessage() {
- StringBuilder sb = new StringBuilder(super.getMessage());
- if (getCause() != null)
- sb.append(" - ").append(getCause());
- return sb.toString();
- }
-
- // only this one is called by our code, exception is not used outside this class:
- @Override
- public void printStackTrace(PrintStream s) {
- if (getCause() != null) {
- s.println(super.toString() + " - Caused by:");
- getCause().printStackTrace(s);
- } else {
- super.printStackTrace(s);
- }
- }
- }
-
- public static void assumeTrue(String msg, boolean b) {
- Assume.assumeNoException(b ? null : new TestIgnoredException(msg));
- }
-
- public static void assumeFalse(String msg, boolean b) {
- assumeTrue(msg, !b);
- }
-
- public static void assumeNoException(String msg, Exception e) {
- Assume.assumeNoException(e == null ? null : new TestIgnoredException(msg, e));
- }
-
- /**
- * Convenience method for logging an iterator.
- *
- * @param label String logged before/after the items in the iterator
- * @param iter Each next() is toString()ed and logged on it's own line. If iter is null this is logged differnetly then an empty iterator.
- * @param stream Stream to log messages to.
- */
- public static void dumpIterator(String label, Iterator iter,
- PrintStream stream) {
- stream.println("*** BEGIN " + label + " ***");
- if (null == iter) {
- stream.println(" ... NULL ...");
- } else {
- while (iter.hasNext()) {
- stream.println(iter.next().toString());
- }
- }
- stream.println("*** END " + label + " ***");
- }
-
- /**
- * Convenience method for logging an array. Wraps the array in an iterator and delegates
- *
- * @see #dumpIterator(String,Iterator,PrintStream)
- */
- public static void dumpArray(String label, Object[] objs,
- PrintStream stream) {
- Iterator iter = (null == objs) ? null : Arrays.asList(objs).iterator();
- dumpIterator(label, iter, stream);
- }
-
- /** create a new index writer config with random defaults */
- public static IndexWriterConfig newIndexWriterConfig(Version v, Analyzer a) {
- return newIndexWriterConfig(random, v, a);
- }
-
- /** create a new index writer config with random defaults using the specified random */
- public static IndexWriterConfig newIndexWriterConfig(Random r, Version v, Analyzer a) {
- IndexWriterConfig c = new IndexWriterConfig(v, a);
- if (r.nextBoolean()) {
- c.setMergePolicy(newTieredMergePolicy());
- } else if (r.nextBoolean()) {
- c.setMergePolicy(newLogMergePolicy());
- } else {
- c.setMergePolicy(new MockRandomMergePolicy(r));
- }
-
- if (r.nextBoolean()) {
- c.setMergeScheduler(new SerialMergeScheduler());
- }
- if (r.nextBoolean()) {
- if (rarely(r)) {
- // crazy value
- c.setMaxBufferedDocs(_TestUtil.nextInt(r, 2, 7));
- } else {
- // reasonable value
- c.setMaxBufferedDocs(_TestUtil.nextInt(r, 8, 1000));
- }
- }
- if (r.nextBoolean()) {
- if (rarely(r)) {
- // crazy value
- c.setTermIndexInterval(random.nextBoolean() ? _TestUtil.nextInt(r, 1, 31) : _TestUtil.nextInt(r, 129, 1000));
- } else {
- // reasonable value
- c.setTermIndexInterval(_TestUtil.nextInt(r, 32, 128));
- }
- }
- if (r.nextBoolean()) {
- c.setMaxThreadStates(_TestUtil.nextInt(r, 1, 20));
- }
-
- if (r.nextBoolean()) {
- c.setMergePolicy(new MockRandomMergePolicy(r));
- } else {
- c.setMergePolicy(newLogMergePolicy());
- }
-
- c.setReaderPooling(r.nextBoolean());
- c.setReaderTermsIndexDivisor(_TestUtil.nextInt(r, 1, 4));
- return c;
- }
-
- public static LogMergePolicy newLogMergePolicy() {
- return newLogMergePolicy(random);
- }
-
- public static TieredMergePolicy newTieredMergePolicy() {
- return newTieredMergePolicy(random);
- }
-
- public static LogMergePolicy newLogMergePolicy(Random r) {
- LogMergePolicy logmp = r.nextBoolean() ? new LogDocMergePolicy() : new LogByteSizeMergePolicy();
- logmp.setUseCompoundFile(r.nextBoolean());
- logmp.setCalibrateSizeByDeletes(r.nextBoolean());
- if (rarely(r)) {
- logmp.setMergeFactor(_TestUtil.nextInt(r, 2, 4));
- } else {
- logmp.setMergeFactor(_TestUtil.nextInt(r, 5, 50));
- }
- return logmp;
- }
-
- public static TieredMergePolicy newTieredMergePolicy(Random r) {
- TieredMergePolicy tmp = new TieredMergePolicy();
- if (rarely(r)) {
- tmp.setMaxMergeAtOnce(_TestUtil.nextInt(r, 2, 4));
- tmp.setMaxMergeAtOnceExplicit(_TestUtil.nextInt(r, 2, 4));
- } else {
- tmp.setMaxMergeAtOnce(_TestUtil.nextInt(r, 5, 50));
- tmp.setMaxMergeAtOnceExplicit(_TestUtil.nextInt(r, 5, 50));
- }
- tmp.setMaxMergedSegmentMB(0.2 + r.nextDouble() * 2.0);
- tmp.setFloorSegmentMB(0.2 + r.nextDouble() * 2.0);
- tmp.setExpungeDeletesPctAllowed(0.0 + r.nextDouble() * 30.0);
- tmp.setSegmentsPerTier(_TestUtil.nextInt(r, 2, 20));
- tmp.setUseCompoundFile(r.nextBoolean());
- tmp.setNoCFSRatio(0.1 + r.nextDouble()*0.8);
- tmp.setReclaimDeletesWeight(r.nextDouble()*4);
- return tmp;
- }
-
- public static LogMergePolicy newLogMergePolicy(boolean useCFS) {
- LogMergePolicy logmp = newLogMergePolicy();
- logmp.setUseCompoundFile(useCFS);
- return logmp;
- }
-
- public static LogMergePolicy newLogMergePolicy(boolean useCFS, int mergeFactor) {
- LogMergePolicy logmp = newLogMergePolicy();
- logmp.setUseCompoundFile(useCFS);
- logmp.setMergeFactor(mergeFactor);
- return logmp;
- }
-
- public static LogMergePolicy newLogMergePolicy(int mergeFactor) {
- LogMergePolicy logmp = newLogMergePolicy();
- logmp.setMergeFactor(mergeFactor);
- return logmp;
- }
-
- /**
- * Returns a new Directory instance. Use this when the test does not
- * care about the specific Directory implementation (most tests).
- *
- * The Directory is wrapped with {@link MockDirectoryWrapper}.
- * By default this means it will be picky, such as ensuring that you
- * properly close it and all open files in your test. It will emulate
- * some features of Windows, such as not allowing open files to be
- * overwritten.
- */
- public static MockDirectoryWrapper newDirectory() throws IOException {
- return newDirectory(random);
- }
-
- /**
- * Returns a new Directory instance, using the specified random.
- * See {@link #newDirectory()} for more information.
- */
- public static MockDirectoryWrapper newDirectory(Random r) throws IOException {
- Directory impl = newDirectoryImpl(r, TEST_DIRECTORY);
- MockDirectoryWrapper dir = new MockDirectoryWrapper(r, impl);
- stores.put(dir, Thread.currentThread().getStackTrace());
- return dir;
- }
-
- /**
- * Returns a new Directory instance, with contents copied from the
- * provided directory. See {@link #newDirectory()} for more
- * information.
- */
- public static MockDirectoryWrapper newDirectory(Directory d) throws IOException {
- return newDirectory(random, d);
- }
-
- /** Returns a new FSDirectory instance over the given file, which must be a folder. */
- public static MockDirectoryWrapper newFSDirectory(File f) throws IOException {
- return newFSDirectory(f, null);
- }
-
- /** Returns a new FSDirectory instance over the given file, which must be a folder. */
- public static MockDirectoryWrapper newFSDirectory(File f, LockFactory lf) throws IOException {
- String fsdirClass = TEST_DIRECTORY;
- if (fsdirClass.equals("random")) {
- fsdirClass = FS_DIRECTORIES[random.nextInt(FS_DIRECTORIES.length)];
- }
-
- if (fsdirClass.indexOf(".") == -1) {// if not fully qualified, assume .store
- fsdirClass = "org.apache.lucene.store." + fsdirClass;
- }
-
- Class clazz;
- try {
- try {
- clazz = Class.forName(fsdirClass).asSubclass(FSDirectory.class);
- } catch (ClassCastException e) {
- // TEST_DIRECTORY is not a sub-class of FSDirectory, so draw one at random
- fsdirClass = FS_DIRECTORIES[random.nextInt(FS_DIRECTORIES.length)];
-
- if (fsdirClass.indexOf(".") == -1) {// if not fully qualified, assume .store
- fsdirClass = "org.apache.lucene.store." + fsdirClass;
- }
-
- clazz = Class.forName(fsdirClass).asSubclass(FSDirectory.class);
- }
- MockDirectoryWrapper dir = new MockDirectoryWrapper(random, newFSDirectoryImpl(clazz, f));
- if (lf != null) {
- dir.setLockFactory(lf);
- }
- stores.put(dir, Thread.currentThread().getStackTrace());
- return dir;
- } catch (Exception e) {
- throw new RuntimeException(e);
- }
- }
-
- /**
- * Returns a new Directory instance, using the specified random
- * with contents copied from the provided directory. See
- * {@link #newDirectory()} for more information.
- */
- public static MockDirectoryWrapper newDirectory(Random r, Directory d) throws IOException {
- Directory impl = newDirectoryImpl(r, TEST_DIRECTORY);
- for (String file : d.listAll()) {
- d.copy(impl, file, file);
- }
- MockDirectoryWrapper dir = new MockDirectoryWrapper(r, impl);
- stores.put(dir, Thread.currentThread().getStackTrace());
- return dir;
- }
-
- /** Returns a new field instance.
- * See {@link #newField(String, String, Field.Store, Field.Index, Field.TermVector)} for more information */
- public static Field newField(String name, String value, Index index) {
- return newField(random, name, value, index);
- }
-
- /** Returns a new field instance.
- * See {@link #newField(String, String, Field.Store, Field.Index, Field.TermVector)} for more information */
- public static Field newField(String name, String value, Store store, Index index) {
- return newField(random, name, value, store, index);
- }
-
- /**
- * Returns a new Field instance. Use this when the test does not
- * care about some specific field settings (most tests)
- * i
- *
- *
- */
- public static Field newField(String name, String value, Store store, Index index, TermVector tv) {
- return newField(random, name, value, store, index, tv);
- }
-
- /** Returns a new field instance, using the specified random.
- * See {@link #newField(String, String, Field.Store, Field.Index, Field.TermVector)} for more information */
- public static Field newField(Random random, String name, String value, Index index) {
- return newField(random, name, value, Store.NO, index);
- }
-
- /** Returns a new field instance, using the specified random.
- * See {@link #newField(String, String, Field.Store, Field.Index, Field.TermVector)} for more information */
- public static Field newField(Random random, String name, String value, Store store, Index index) {
- return newField(random, name, value, store, index, TermVector.NO);
- }
-
- /** Returns a new field instance, using the specified random.
- * See {@link #newField(String, String, Field.Store, Field.Index, Field.TermVector)} for more information */
- public static Field newField(Random random, String name, String value, Store store, Index index, TermVector tv) {
- if (usually(random)) {
- // most of the time, don't modify the params
- return new Field(name, value, store, index, tv);
- }
-
- if (!index.isIndexed())
- return new Field(name, value, store, index, tv);
-
- if (!store.isStored() && random.nextBoolean())
- store = Store.YES; // randomly store it
-
- tv = randomTVSetting(random, tv);
-
- return new Field(name, value, store, index, tv);
- }
-
- static final TermVector tvSettings[] = {
- TermVector.NO, TermVector.YES, TermVector.WITH_OFFSETS,
- TermVector.WITH_POSITIONS, TermVector.WITH_POSITIONS_OFFSETS
- };
-
- private static TermVector randomTVSetting(Random random, TermVector minimum) {
- switch(minimum) {
- case NO: return tvSettings[_TestUtil.nextInt(random, 0, tvSettings.length-1)];
- case YES: return tvSettings[_TestUtil.nextInt(random, 1, tvSettings.length-1)];
- case WITH_OFFSETS: return random.nextBoolean() ? TermVector.WITH_OFFSETS
- : TermVector.WITH_POSITIONS_OFFSETS;
- case WITH_POSITIONS: return random.nextBoolean() ? TermVector.WITH_POSITIONS
- : TermVector.WITH_POSITIONS_OFFSETS;
- default: return TermVector.WITH_POSITIONS_OFFSETS;
- }
- }
-
- /** return a random Locale from the available locales on the system */
- public static Locale randomLocale(Random random) {
- Locale locales[] = Locale.getAvailableLocales();
- return locales[random.nextInt(locales.length)];
- }
-
- /** return a random TimeZone from the available timezones on the system */
- public static TimeZone randomTimeZone(Random random) {
- String tzIds[] = TimeZone.getAvailableIDs();
- return TimeZone.getTimeZone(tzIds[random.nextInt(tzIds.length)]);
- }
-
- /** return a Locale object equivalent to its programmatic name */
- public static Locale localeForName(String localeName) {
- String elements[] = localeName.split("\\_");
- switch(elements.length) {
- case 3: return new Locale(elements[0], elements[1], elements[2]);
- case 2: return new Locale(elements[0], elements[1]);
- case 1: return new Locale(elements[0]);
- default: throw new IllegalArgumentException("Invalid Locale: " + localeName);
- }
- }
-
- private static final String FS_DIRECTORIES[] = {
- "SimpleFSDirectory",
- "NIOFSDirectory",
- "MMapDirectory"
- };
-
- private static final String CORE_DIRECTORIES[] = {
- "RAMDirectory",
- FS_DIRECTORIES[0], FS_DIRECTORIES[1], FS_DIRECTORIES[2]
- };
-
- public static String randomDirectory(Random random) {
- if (rarely(random)) {
- return CORE_DIRECTORIES[random.nextInt(CORE_DIRECTORIES.length)];
- } else {
- return "RAMDirectory";
- }
- }
-
- private static Directory newFSDirectoryImpl(
- Class clazz, File file)
- throws IOException {
- FSDirectory d = null;
- try {
- // Assuming every FSDirectory has a ctor(File), but not all may take a
- // LockFactory too, so setting it afterwards.
- Constructor ctor = clazz.getConstructor(File.class);
- d = ctor.newInstance(file);
- } catch (Exception e) {
- d = FSDirectory.open(file);
- }
- return d;
- }
-
- /** Registers a temp file that will be deleted when tests are done. */
- public static void registerTempFile(File tmpFile) {
- tempDirs.put(tmpFile.getAbsoluteFile(), Thread.currentThread().getStackTrace());
- }
-
- static Directory newDirectoryImpl(Random random, String clazzName) {
- if (clazzName.equals("random"))
- clazzName = randomDirectory(random);
- if (clazzName.indexOf(".") == -1) // if not fully qualified, assume .store
- clazzName = "org.apache.lucene.store." + clazzName;
- try {
- final Class clazz = Class.forName(clazzName).asSubclass(Directory.class);
- // If it is a FSDirectory type, try its ctor(File)
- if (FSDirectory.class.isAssignableFrom(clazz)) {
- final File tmpFile = _TestUtil.createTempFile("test", "tmp", TEMP_DIR);
- tmpFile.delete();
- tmpFile.mkdir();
- registerTempFile(tmpFile);
- return newFSDirectoryImpl(clazz.asSubclass(FSDirectory.class), tmpFile);
- }
-
- // try empty ctor
- return clazz.newInstance();
- } catch (Exception e) {
- throw new RuntimeException(e);
- }
- }
-
- /** create a new searcher over the reader.
- * This searcher might randomly use threads. */
- public static IndexSearcher newSearcher(IndexReader r) throws IOException {
- return newSearcher(r, true);
- }
-
- /** create a new searcher over the reader.
- * This searcher might randomly use threads.
- * if maybeWrap is true, this searcher might wrap the reader
- * with one that returns null for getSequentialSubReaders.
- */
- public static IndexSearcher newSearcher(IndexReader r, boolean maybeWrap) throws IOException {
- if (random.nextBoolean()) {
- if (maybeWrap && rarely()) {
- r = new SlowMultiReaderWrapper(r);
- }
- return new AssertingIndexSearcher(r);
- } else {
- int threads = 0;
- final ExecutorService ex = (random.nextBoolean()) ? null
- : Executors.newFixedThreadPool(threads = _TestUtil.nextInt(random, 1, 8),
- new NamedThreadFactory("LuceneTestCase"));
- if (ex != null && VERBOSE) {
- System.out.println("NOTE: newSearcher using ExecutorService with " + threads + " threads");
- }
- return new AssertingIndexSearcher(r, ex) {
- @Override
- public void close() throws IOException {
- super.close();
- shutdownExecutorService(ex);
- }
- };
- }
- }
-
- static void shutdownExecutorService(ExecutorService ex) {
- if (ex != null) {
- ex.shutdown();
- try {
- ex.awaitTermination(1000, TimeUnit.MILLISECONDS);
- } catch (InterruptedException e) {
- e.printStackTrace();
- }
- }
- }
-
- public String getName() {
- return this.name;
- }
-
- /** Gets a resource from the classpath as {@link File}. This method should only be used,
- * if a real file is needed. To get a stream, code should prefer
- * {@link Class#getResourceAsStream} using {@code this.getClass()}.
- */
-
- protected File getDataFile(String name) throws IOException {
- try {
- return new File(this.getClass().getResource(name).toURI());
- } catch (Exception e) {
- throw new IOException("Cannot find resource: " + name);
- }
- }
-
- // We get here from InterceptTestCaseEvents on the 'failed' event....
- public void reportAdditionalFailureInfo() {
- System.err.println("NOTE: reproduce with: ant test -Dtestcase=" + getClass().getSimpleName()
- + " -Dtestmethod=" + getName() + " -Dtests.seed=" + new TwoLongs(staticSeed, seed)
- + reproduceWithExtraParams());
- }
-
- // extra params that were overridden needed to reproduce the command
- private String reproduceWithExtraParams() {
- StringBuilder sb = new StringBuilder();
- if (!TEST_LOCALE.equals("random")) sb.append(" -Dtests.locale=").append(TEST_LOCALE);
- if (!TEST_TIMEZONE.equals("random")) sb.append(" -Dtests.timezone=").append(TEST_TIMEZONE);
- if (!TEST_DIRECTORY.equals("random")) sb.append(" -Dtests.directory=").append(TEST_DIRECTORY);
- if (RANDOM_MULTIPLIER > 1) sb.append(" -Dtests.multiplier=").append(RANDOM_MULTIPLIER);
- if (TEST_NIGHTLY) sb.append(" -Dtests.nightly=true");
- return sb.toString();
- }
-
- // recorded seed: for beforeClass
- private static long staticSeed;
- // seed for individual test methods, changed in @before
- private long seed;
-
- private static final Random seedRand = new Random();
- protected static final Random random = new Random(0);
-
- private String name = "