org.apache.lucene.store

Class MockDirectoryWrapper

java.lang.Object

org.apache.lucene.store.Directory

org.apache.lucene.store.FilterDirectory

org.apache.lucene.store.BaseDirectoryWrapper

org.apache.lucene.store.MockDirectoryWrapper

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable

public class MockDirectoryWrapper
extends BaseDirectoryWrapper

This is a Directory Wrapper that adds methods intended to be used only by unit tests. It also adds a number of features useful for testing:

• Instances created by LuceneTestCase.newDirectory() are tracked to ensure they are closed by the test.
• When a MockDirectoryWrapper is closed, it will throw an exception if it has any open files against it (with a stacktrace indicating where they were opened from).
• When a MockDirectoryWrapper is closed, it runs CheckIndex to test if the index was corrupted.
• MockDirectoryWrapper simulates some "features" of Windows, such as refusing to write/delete to open files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MockDirectoryWrapper.Failure Objects that represent fail-able conditions.
static class	MockDirectoryWrapper.FakeIOException Use this when throwing fake IOException, e.g.
static class	MockDirectoryWrapper.Throttling Enum for controlling hard disk throttling.

Field Summary

Fields inherited from class org.apache.lucene.store.BaseDirectoryWrapper

isOpen

Fields inherited from class org.apache.lucene.store.FilterDirectory

in

Constructor Summary

Constructors

Constructor and Description
MockDirectoryWrapper(java.util.Random random, Directory delegate)

Method Summary

Modifier and Type	Method and Description
void	clearCrash()
void	close() Closes the store.
void	copyFrom(Directory from, java.lang.String src, java.lang.String dest, IOContext context) Copies the file src in from to this directory under the new file name dest.
void	corruptFiles(java.util.Collection<java.lang.String> files)
void	corruptUnknownFiles()
void	crash() Simulates a crash of OS or machine by overwriting unsynced files.
IndexOutput	createOutput(java.lang.String name, IOContext context) Creates a new, empty file in the directory with the given name.
IndexOutput	createTempOutput(java.lang.String prefix, java.lang.String suffix, IOContext context) Creates a new, empty file for writing in the directory, with a temporary file name including prefix and suffix, ending with the reserved extension .tmp.
void	deleteFile(java.lang.String name) Removes an existing file in the directory.
protected void	ensureOpen()
void	failOn(MockDirectoryWrapper.Failure fail) add a Failure object to the list of objects to be evaluated at every potential failure point
long	fileLength(java.lang.String name) Returns the length of a file in the directory.
boolean	getAssertNoDeleteOpenFile()
long	getFileHandleCount() returns current open file handle count
int	getInputCloneCount()
long	getMaxSizeInBytes()
long	getMaxUsedSizeInBytes() Returns the peek actual storage used (bytes) in this directory.
java.util.Set<java.lang.String>	getOpenDeletedFiles()
double	getRandomIOExceptionRate()
double	getRandomIOExceptionRateOnOpen()
long	getRecomputedActualSizeInBytes() Like getRecomputedSizeInBytes(), but, uses actual file lengths rather than buffer allocations (which are quantized up to nearest RAMOutputStream.BUFFER_SIZE (now 1024) bytes.
long	getRecomputedSizeInBytes() Provided for testing purposes.
java.lang.String[]	listAll() Returns an array of strings, one for each entry in the directory, in sorted (UTF16, java's String.compare) order.
Lock	obtainLock(java.lang.String name) Returns an obtained Lock.
ChecksumIndexInput	openChecksumInput(java.lang.String name, IOContext context) Returns a stream reading an existing file, computing checksum as it reads
IndexInput	openInput(java.lang.String name, IOContext context) Returns a stream reading an existing file.
void	removeIndexInput(IndexInput in, java.lang.String name)
void	removeIndexOutput(IndexOutput out, java.lang.String name)
void	rename(java.lang.String source, java.lang.String dest) Renames source to dest as an atomic operation, where dest does not yet exist in the directory.
void	resetMaxUsedSizeInBytes()
void	setAllowRandomFileNotFoundException(boolean value) If set to true (the default), when we throw random IOException on openInput or createOutput, we may sometimes throw FileNotFoundException or NoSuchFileException.
void	setAllowReadingFilesStillOpenForWrite(boolean value) If set to true, you can open an inputstream on a file that is still open for writes.
void	setAssertNoDeleteOpenFile(boolean value) Trip a test assert if there is an attempt to delete an open file.
void	setAssertNoUnrefencedFilesOnClose(boolean v)
void	setFailOnCreateOutput(boolean v)
void	setFailOnOpenInput(boolean v)
void	setMaxSizeInBytes(long maxSize)
void	setRandomIOExceptionRate(double rate) If 0.0, no exceptions will be thrown.
void	setRandomIOExceptionRateOnOpen(double rate) If 0.0, no exceptions will be thrown during openInput and createOutput.
void	setThrottling(MockDirectoryWrapper.Throttling throttling)
void	setTrackDiskUsage(boolean v)
void	setUseSlowOpenClosers(boolean v) Add a rare small sleep to catch race conditions in open/close
void	setVerboseClone(boolean v) If set to true, we print a fake exception with filename and stacktrace on every indexinput clone()
long	sizeInBytes()
void	sync(java.util.Collection<java.lang.String> names) Ensure that any writes to these files are moved to stable storage.
void	syncMetaData() Ensure that directory metadata, such as recent file renames, are made durable.
java.lang.String	toString()

Methods inherited from class org.apache.lucene.store.BaseDirectoryWrapper

getCheckIndexOnClose, getCrossCheckTermVectorsOnClose, isOpen, setCheckIndexOnClose, setCrossCheckTermVectorsOnClose

Methods inherited from class org.apache.lucene.store.FilterDirectory

getDelegate, unwrap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MockDirectoryWrapper

public MockDirectoryWrapper(java.util.Random random,
                            Directory delegate)

Method Detail

getInputCloneCount

public int getInputCloneCount()

setVerboseClone

public void setVerboseClone(boolean v)

If set to true, we print a fake exception with filename and stacktrace on every indexinput clone()

setTrackDiskUsage

public void setTrackDiskUsage(boolean v)

setAllowRandomFileNotFoundException

public void setAllowRandomFileNotFoundException(boolean value)

If set to true (the default), when we throw random IOException on openInput or createOutput, we may sometimes throw FileNotFoundException or NoSuchFileException.

setAllowReadingFilesStillOpenForWrite

public void setAllowReadingFilesStillOpenForWrite(boolean value)

If set to true, you can open an inputstream on a file that is still open for writes.

setThrottling

public void setThrottling(MockDirectoryWrapper.Throttling throttling)

setUseSlowOpenClosers

public void setUseSlowOpenClosers(boolean v)

Add a rare small sleep to catch race conditions in open/close

You can enable this if you need it.

sync

public void sync(java.util.Collection<java.lang.String> names)
          throws java.io.IOException

Description copied from class: Directory

Ensure that any writes to these files are moved to stable storage. Lucene uses this to properly commit changes to the index, to prevent a machine/OS crash from corrupting the index.
NOTE: Clients may call this method for same files over and over again, so some impls might optimize for that. For other impls the operation can be a noop, for various reasons.

Overrides:

sync in class FilterDirectory

Throws:

java.io.IOException

rename

public void rename(java.lang.String source,
                   java.lang.String dest)
            throws java.io.IOException

Description copied from class: Directory

Renames source to dest as an atomic operation, where dest does not yet exist in the directory.

Notes: This method is used by IndexWriter to publish commits. It is ok if this operation is not truly atomic, for example both source and dest can be visible temporarily. It is just important that the contents of dest appear atomically, or an exception is thrown.

Overrides:

rename in class FilterDirectory

Throws:

java.io.IOException

syncMetaData

public void syncMetaData()
                  throws java.io.IOException

Description copied from class: Directory

Ensure that directory metadata, such as recent file renames, are made durable.

Overrides:

syncMetaData in class FilterDirectory

Throws:

java.io.IOException

sizeInBytes

public final long sizeInBytes()
                       throws java.io.IOException

Throws:

java.io.IOException

corruptUnknownFiles

public void corruptUnknownFiles()
                         throws java.io.IOException

Throws:

java.io.IOException

corruptFiles

public void corruptFiles(java.util.Collection<java.lang.String> files)
                  throws java.io.IOException

Throws:

java.io.IOException

crash

public void crash()
           throws java.io.IOException

Simulates a crash of OS or machine by overwriting unsynced files.

Throws:

java.io.IOException

clearCrash

public void clearCrash()

setMaxSizeInBytes

public void setMaxSizeInBytes(long maxSize)

getMaxSizeInBytes

public long getMaxSizeInBytes()

getMaxUsedSizeInBytes

public long getMaxUsedSizeInBytes()

Returns the peek actual storage used (bytes) in this directory.

resetMaxUsedSizeInBytes

public void resetMaxUsedSizeInBytes()
                             throws java.io.IOException

Throws:

java.io.IOException

setAssertNoDeleteOpenFile

public void setAssertNoDeleteOpenFile(boolean value)

Trip a test assert if there is an attempt to delete an open file.

getAssertNoDeleteOpenFile

public boolean getAssertNoDeleteOpenFile()

setRandomIOExceptionRate

public void setRandomIOExceptionRate(double rate)

If 0.0, no exceptions will be thrown. Else this should be a double 0.0 - 1.0. We will randomly throw an IOException on the first write to an OutputStream based on this probability.

getRandomIOExceptionRate

public double getRandomIOExceptionRate()

setRandomIOExceptionRateOnOpen

public void setRandomIOExceptionRateOnOpen(double rate)

If 0.0, no exceptions will be thrown during openInput and createOutput. Else this should be a double 0.0 - 1.0 and we will randomly throw an IOException in openInput and createOutput with this probability.

getRandomIOExceptionRateOnOpen

public double getRandomIOExceptionRateOnOpen()

getFileHandleCount

public long getFileHandleCount()

returns current open file handle count

deleteFile

public void deleteFile(java.lang.String name)
                throws java.io.IOException

Description copied from class: Directory

Removes an existing file in the directory.

Overrides:

deleteFile in class FilterDirectory

Throws:

java.io.IOException

getOpenDeletedFiles

public java.util.Set<java.lang.String> getOpenDeletedFiles()

setFailOnCreateOutput

public void setFailOnCreateOutput(boolean v)

createOutput

public IndexOutput createOutput(java.lang.String name,
                                IOContext context)
                         throws java.io.IOException

Description copied from class: Directory

Creates a new, empty file in the directory with the given name. Returns a stream writing this file.

Overrides:

createOutput in class FilterDirectory

Throws:

java.io.IOException

createTempOutput

public IndexOutput createTempOutput(java.lang.String prefix,
                                    java.lang.String suffix,
                                    IOContext context)
                             throws java.io.IOException

Description copied from class: Directory

Creates a new, empty file for writing in the directory, with a temporary file name including prefix and suffix, ending with the reserved extension .tmp. Use IndexOutput.getName() to see what name was used.

Overrides:

createTempOutput in class FilterDirectory

Throws:

java.io.IOException

setFailOnOpenInput

public void setFailOnOpenInput(boolean v)

openInput

public IndexInput openInput(java.lang.String name,
                            IOContext context)
                     throws java.io.IOException

Description copied from class: Directory

Returns a stream reading an existing file.

Throws FileNotFoundException or NoSuchFileException if the file does not exist.

Overrides:

openInput in class FilterDirectory

Throws:

java.io.IOException

getRecomputedSizeInBytes

public final long getRecomputedSizeInBytes()
                                    throws java.io.IOException

Provided for testing purposes. Use sizeInBytes() instead.

Throws:

java.io.IOException

getRecomputedActualSizeInBytes

public final long getRecomputedActualSizeInBytes()
                                          throws java.io.IOException

Like getRecomputedSizeInBytes(), but, uses actual file lengths rather than buffer allocations (which are quantized up to nearest RAMOutputStream.BUFFER_SIZE (now 1024) bytes.

Throws:

java.io.IOException

setAssertNoUnrefencedFilesOnClose

public void setAssertNoUnrefencedFilesOnClose(boolean v)

close

public void close()
           throws java.io.IOException

Description copied from class: Directory

Closes the store.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class BaseDirectoryWrapper

Throws:

java.io.IOException

removeIndexOutput

public void removeIndexOutput(IndexOutput out,
                              java.lang.String name)

removeIndexInput

public void removeIndexInput(IndexInput in,
                             java.lang.String name)

failOn

public void failOn(MockDirectoryWrapper.Failure fail)

add a Failure object to the list of objects to be evaluated at every potential failure point

listAll

public java.lang.String[] listAll()
                           throws java.io.IOException

Description copied from class: Directory

Returns an array of strings, one for each entry in the directory, in sorted (UTF16, java's String.compare) order.

Overrides:

listAll in class FilterDirectory

Throws:

java.io.IOException - in case of IO error

fileLength

public long fileLength(java.lang.String name)
                throws java.io.IOException

Description copied from class: Directory

Returns the length of a file in the directory. This method follows the following contract:

• Throws FileNotFoundException or NoSuchFileException if the file does not exist.
• Returns a value ≥0 if the file exists, which specifies its length.

Overrides:

fileLength in class FilterDirectory

Parameters:

name - the name of the file for which to return the length.

Throws:

java.io.IOException - if there was an IO error while retrieving the file's length.

obtainLock

public Lock obtainLock(java.lang.String name)
                throws java.io.IOException

Description copied from class: Directory

Returns an obtained Lock.

Overrides:

obtainLock in class FilterDirectory

Parameters:

name - the name of the lock file

Throws:

LockObtainFailedException - (optional specific exception) if the lock could not be obtained because it is currently held elsewhere.

java.io.IOException - if any i/o error occurs attempting to gain the lock

toString

public java.lang.String toString()

Overrides:

toString in class FilterDirectory

openChecksumInput

public final ChecksumIndexInput openChecksumInput(java.lang.String name,
                                                  IOContext context)
                                           throws java.io.IOException

Description copied from class: Directory

Returns a stream reading an existing file, computing checksum as it reads

Overrides:

openChecksumInput in class Directory

Throws:

java.io.IOException

copyFrom

public final void copyFrom(Directory from,
                           java.lang.String src,
                           java.lang.String dest,
                           IOContext context)
                    throws java.io.IOException

Description copied from class: Directory

Copies the file src in from to this directory under the new file name dest.

If you want to copy the entire source directory to the destination one, you can do so like this:

 Directory to; // the directory to copy to
 for (String file : dir.listAll()) {
   to.copyFrom(dir, file, newFile, IOContext.DEFAULT); // newFile can be either file, or a new name
 }
 

NOTE: this method does not check whether dest exist and will overwrite it if it does.

Overrides:

copyFrom in class Directory

Throws:

java.io.IOException

ensureOpen

protected final void ensureOpen()
                         throws AlreadyClosedException

Overrides:

ensureOpen in class Directory

Throws:

AlreadyClosedException - if this Directory is closed