org.eclipse.jgit.junit

Class RepositoryTestCase

java.lang.Object

org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

org.eclipse.jgit.junit.RepositoryTestCase

Direct Known Subclasses:

SampleDataRepositoryTestCase

public abstract class RepositoryTestCase
extends LocalDiskRepositoryTestCase

Base class for most JGit unit tests. Sets up a predefined test repository and has support for creating additional repositories and destroying them when the tests are finished.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ASSUME_UNCHANGED
static int	CONTENT
static int	CONTENT_ID
protected FileRepository	db Test repository, initialized for this test case.
static int	LENGTH
static int	MOD_TIME
static int	SMUDGE
protected File	trash Working directory of db.

Fields inherited from class org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

author, committer

Constructor Summary

Constructors

Constructor and Description
RepositoryTestCase()

Method Summary

Methods

Modifier and Type	Method and Description
protected static void	checkFile(File f, String checkData)
protected void	checkoutBranch(String branchName)
protected RevCommit	commitFile(String filename, String contents, String branch) Commit a file with the specified contents on the specified branch, creating the branch if it didn't exist before.
protected static void	copyFile(File src, File dst)
protected void	createBranch(ObjectId objectId, String branchName)
protected DirCacheEntry	createEntry(String path, FileMode mode)
protected DirCacheEntry	createEntry(String path, FileMode mode, int stage, String content)
protected DirCacheEntry	createEntry(String path, FileMode mode, String content)
protected void	deleteTrashFile(String name)
static long	fsTick(File lastFile) Waits until it is guaranteed that a subsequent file modification has a younger modification timestamp than the modification timestamp of the given file.
String	indexState(int includedOptions) Represent the state of the index in one String.
String	indexState(Repository repo, int includedOptions) Represent the state of the index in one String.
static String	lookup(Object l, String nameTemplate, Map<Object,String> lookupTable) Helper method to map arbitrary objects to user-defined names.
protected String	read(String name)
protected void	resetIndex(FileTreeIterator treeItr) Resets the index to represent exactly some filesystem content.
void	setUp()
protected File	writeTrashFile(String name, String data)
protected File	writeTrashFile(String subdir, String name, String data)
protected File	writeTrashFiles(boolean ensureDistinctTimestamps, String... contents) Writes a number of files in the working tree.

Methods inherited from class org.eclipse.jgit.junit.LocalDiskRepositoryTestCase

addRepoToClose, createBareRepository, createTempDirectory, createTempFile, createUniqueTestGitDir, createWorkRepository, getCeilings, read, recursiveDelete, runHook, tearDown, tick, write, write

Methods inherited from class java.lang.Object

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

Field Detail

db

protected FileRepository db

Test repository, initialized for this test case.

trash

protected File trash

Working directory of db.

MOD_TIME

public static final int MOD_TIME

See Also:

Constant Field Values

SMUDGE

public static final int SMUDGE

See Also:

Constant Field Values

LENGTH

public static final int LENGTH

See Also:

Constant Field Values

CONTENT_ID

public static final int CONTENT_ID

See Also:

Constant Field Values

CONTENT

public static final int CONTENT

See Also:

Constant Field Values

ASSUME_UNCHANGED

public static final int ASSUME_UNCHANGED

See Also:

Constant Field Values

Constructor Detail

RepositoryTestCase

public RepositoryTestCase()

Method Detail

copyFile

protected static void copyFile(File src,
            File dst)
                        throws IOException

Throws:

IOException

writeTrashFile

protected File writeTrashFile(String name,
                  String data)
                       throws IOException

Throws:

IOException

writeTrashFile

protected File writeTrashFile(String subdir,
                  String name,
                  String data)
                       throws IOException

Throws:

IOException

read

protected String read(String name)
               throws IOException

Throws:

IOException

deleteTrashFile

protected void deleteTrashFile(String name)
                        throws IOException

Throws:

IOException

checkFile

protected static void checkFile(File f,
             String checkData)
                         throws IOException

Throws:

IOException

setUp

public void setUp()
           throws Exception

Overrides:

setUp in class LocalDiskRepositoryTestCase

Throws:

Exception

indexState

public String indexState(Repository repo,
                int includedOptions)
                  throws IllegalStateException,
                         IOException

Represent the state of the index in one String. This representation is useful when writing tests which do assertions on the state of the index. By default information about path, mode, stage (if different from 0) is included. A bitmask controls which additional info about modificationTimes, smudge state and length is included.

The format of the returned string is described with this BNF:

 result = ( "[" path mode stage? time? smudge? length? sha1? content? "]" )* .
 mode = ", mode:" number .
 stage = ", stage:" number .
 time = ", time:t" timestamp-index .
 smudge = "" | ", smudged" .
 length = ", length:" number .
 sha1 = ", sha1:" hex-sha1 .
 content = ", content:" blob-data .
 

'stage' is only presented when the stage is different from 0. All reported time stamps are mapped to strings like "t0", "t1", ... "tn". The smallest reported time-stamp will be called "t0". This allows to write assertions against the string although the concrete value of the time stamps is unknown.

Parameters:

repo - the repository the index state should be determined for

includedOptions - a bitmask constructed out of the constants MOD_TIME, SMUDGE, LENGTH, CONTENT_ID and CONTENT controlling which info is present in the resulting string.

Returns:

a string encoding the index state

Throws:

IllegalStateException

IOException

indexState

public String indexState(int includedOptions)
                  throws IllegalStateException,
                         IOException

Represent the state of the index in one String. This representation is useful when writing tests which do assertions on the state of the index. By default information about path, mode, stage (if different from 0) is included. A bitmask controls which additional info about modificationTimes, smudge state and length is included.

The format of the returned string is described with this BNF:

 result = ( "[" path mode stage? time? smudge? length? sha1? content? "]" )* .
 mode = ", mode:" number .
 stage = ", stage:" number .
 time = ", time:t" timestamp-index .
 smudge = "" | ", smudged" .
 length = ", length:" number .
 sha1 = ", sha1:" hex-sha1 .
 content = ", content:" blob-data .
 

'stage' is only presented when the stage is different from 0. All reported time stamps are mapped to strings like "t0", "t1", ... "tn". The smallest reported time-stamp will be called "t0". This allows to write assertions against the string although the concrete value of the time stamps is unknown.

Parameters:

includedOptions - a bitmask constructed out of the constants MOD_TIME, SMUDGE, LENGTH, CONTENT_ID and CONTENT controlling which info is present in the resulting string.

Returns:

a string encoding the index state

Throws:

IllegalStateException

IOException

resetIndex

protected void resetIndex(FileTreeIterator treeItr)
                   throws FileNotFoundException,
                          IOException

Resets the index to represent exactly some filesystem content. E.g. the following call will replace the index with the working tree content:

resetIndex(new FileSystemIterator(db))

This method can be used by testcases which first prepare a new commit somewhere in the filesystem (e.g. in the working-tree) and then want to have an index which matches their prepared content.

Parameters:

treeItr - a FileTreeIterator which determines which files should go into the new index

Throws:

FileNotFoundException

IOException

lookup

public static String lookup(Object l,
            String nameTemplate,
            Map<Object,String> lookupTable)

Helper method to map arbitrary objects to user-defined names. This can be used create short names for objects to produce small and stable debug output. It is guaranteed that when you lookup the same object multiple times even with different nameTemplates this method will always return the same name which was derived from the first nameTemplate. nameTemplates can contain "%n" which will be replaced by a running number before used as a name.

Parameters:

l - the object to lookup

nameTemplate - the name for that object. Can contain "%n" which will be replaced by a running number before used as a name. If the lookup table already contains the object this parameter will be ignored

lookupTable - a table storing object-name mappings.

Returns:

a name of that object. Is not guaranteed to be unique. Use nameTemplates containing "%n" to always have unique names

fsTick

public static long fsTick(File lastFile)
                   throws InterruptedException,
                          IOException

Waits until it is guaranteed that a subsequent file modification has a younger modification timestamp than the modification timestamp of the given file. This is done by touching a temporary file, reading the lastmodified attribute and, if needed, sleeping. After sleeping this loop starts again until the filesystem timer has advanced enough.

Parameters:

lastFile - the file on which we want to wait until the filesystem timer has advanced more than the lastmodification timestamp of this file

Returns:

return the last measured value of the filesystem timer which is greater than then the lastmodification time of lastfile.

Throws:

InterruptedException

IOException

createBranch

protected void createBranch(ObjectId objectId,
                String branchName)
                     throws IOException

Throws:

IOException

checkoutBranch

protected void checkoutBranch(String branchName)
                       throws IllegalStateException,
                              IOException

Throws:

IllegalStateException

IOException

writeTrashFiles

protected File writeTrashFiles(boolean ensureDistinctTimestamps,
                   String... contents)
                        throws IOException,
                               InterruptedException

Writes a number of files in the working tree. The first content specified will be written into a file named '0', the second into a file named "1" and so on. If null is specified as content then this file is skipped.

Parameters:

ensureDistinctTimestamps - if set to true then between two write operations this method will wait to ensure that the second file will get a different lastmodification timestamp than the first file.

contents - the contents which should be written into the files

Returns:

the File object associated to the last written file.

Throws:

IOException

InterruptedException

commitFile

protected RevCommit commitFile(String filename,
                   String contents,
                   String branch)

Commit a file with the specified contents on the specified branch, creating the branch if it didn't exist before.

It switches back to the original branch after the commit if there was one.

Parameters:

filename -

contents -

branch -

Returns:

the created commit

createEntry

protected DirCacheEntry createEntry(String path,
                        FileMode mode)

createEntry

protected DirCacheEntry createEntry(String path,
                        FileMode mode,
                        String content)

createEntry

protected DirCacheEntry createEntry(String path,
                        FileMode mode,
                        int stage,
                        String content)