Class LocalDiskRepositoryTestCase

java.lang.Object
org.eclipse.jgit.junit.LocalDiskRepositoryTestCase
Direct Known Subclasses:
CLIRepositoryTestCase, HttpTestCase, RepositoryTestCase

public abstract class LocalDiskRepositoryTestCase extends Object
JUnit TestCase with specialized support for temporary local repository.

A temporary directory is created for each test, allowing each test to use a fresh environment. The temporary directory is cleaned up after the test ends.

Callers should not use RepositoryCache from within these tests as it may wedge file descriptors open past the end of the test.

A system property jgit.junit.usemmap defines whether memory mapping is used. Memory mapping has an effect on the file system, in that memory mapped files in Java cannot be deleted as long as the mapped arrays have not been reclaimed by the garbage collector. The programmer cannot control this with precision, so temporary files may hang around longer than desired during a test, or tests may fail altogether if there is insufficient file descriptors or address space for the test process.

  • Field Details

    • useMMAP

      private static final boolean useMMAP
    • author

      protected PersonIdent author
      A fake (but stable) identity for author fields in the test.
    • committer

      protected PersonIdent committer
      A fake (but stable) identity for committer fields in the test.
    • mockSystemReader

      protected MockSystemReader mockSystemReader
      A SystemReader used to coordinate time, envars, etc.
      Since:
      4.2
    • toClose

      private final Set<Repository> toClose
    • tmp

      private File tmp
    • MOD_TIME

      public static final int MOD_TIME
      Constant MOD_TIME=1
      See Also:
    • SMUDGE

      public static final int SMUDGE
      Constant SMUDGE=2
      See Also:
    • LENGTH

      public static final int LENGTH
      Constant LENGTH=4
      See Also:
    • CONTENT_ID

      public static final int CONTENT_ID
      Constant CONTENT_ID=8
      See Also:
    • CONTENT

      public static final int CONTENT
      Constant CONTENT=16
      See Also:
    • ASSUME_UNCHANGED

      public static final int ASSUME_UNCHANGED
      Constant ASSUME_UNCHANGED=32
      See Also:
  • Constructor Details

    • LocalDiskRepositoryTestCase

      public LocalDiskRepositoryTestCase()
  • Method Details

    • setUp

      public void setUp() throws Exception
      Setup test
      Throws:
      Exception
    • getTemporaryDirectory

      protected File getTemporaryDirectory()
      Get temporary directory.
      Returns:
      the temporary directory
    • getCeilings

      protected List<File> getCeilings()
      Get list of ceiling directories
      Returns:
      list of ceiling directories
    • ceilTestDirectories

      private void ceilTestDirectories(List<File> ceilings)
    • makePath

      private static String makePath(List<?> objects)
    • tearDown

      public void tearDown() throws Exception
      Tear down the test
      Throws:
      Exception
    • tick

      protected void tick()
      Increment the author and committer times.
    • recursiveDelete

      protected void recursiveDelete(File dir)
      Recursively delete a directory, failing the test if the delete fails.
      Parameters:
      dir - the recursively directory to delete, if present.
    • recursiveDelete

      private static boolean recursiveDelete(File dir, boolean silent, boolean failOnError)
    • reportDeleteFailure

      private static void reportDeleteFailure(boolean failOnError, File f, Exception cause)
    • indexState

      public static 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
    • createBareRepository

      protected FileRepository createBareRepository() throws IOException
      Creates a new empty bare repository.
      Returns:
      the newly created bare repository, opened for access. The repository will not be closed in tearDown(); the caller is responsible for closing it.
      Throws:
      IOException - the repository could not be created in the temporary area
    • createWorkRepository

      protected FileRepository createWorkRepository() throws IOException
      Creates a new empty repository within a new empty working directory.
      Returns:
      the newly created repository, opened for access. The repository will not be closed in tearDown(); the caller is responsible for closing it.
      Throws:
      IOException - the repository could not be created in the temporary area
    • createRepository

      protected FileRepository createRepository(boolean bare) throws IOException
      Creates a new empty repository.
      Parameters:
      bare - true to create a bare repository; false to make a repository within its working directory
      Returns:
      the newly created repository, opened for access. The repository will not be closed in tearDown(); the caller is responsible for closing it.
      Throws:
      IOException - the repository could not be created in the temporary area
      Since:
      5.3
    • createRepository

      @Deprecated public FileRepository createRepository(boolean bare, boolean autoClose) throws IOException
      Deprecated.
      Creates a new empty repository.
      Parameters:
      bare - true to create a bare repository; false to make a repository within its working directory
      autoClose - auto close the repository in tearDown()
      Returns:
      the newly created repository, opened for access
      Throws:
      IOException - the repository could not be created in the temporary area
    • addRepoToClose

      public void addRepoToClose(Repository r)
      Adds a repository to the list of repositories which is closed at the end of the tests
      Parameters:
      r - the repository to be closed
    • createTempDirectory

      protected File createTempDirectory(String name) throws IOException
      Creates a unique directory for a test
      Parameters:
      name - a subdirectory
      Returns:
      a unique directory for a test
      Throws:
      IOException
    • createUniqueTestGitDir

      protected File createUniqueTestGitDir(boolean bare) throws IOException
      Creates a new unique directory for a test repository
      Parameters:
      bare - true for a bare repository; false for a repository with a working directory
      Returns:
      a unique directory for a test repository
      Throws:
      IOException
    • createTempFile

      protected File createTempFile() throws IOException
      Allocates a new unique file path that does not exist.

      Unlike the standard File.createTempFile the returned path does not exist, but may be created by another thread in a race with the caller. Good luck.

      This method is inherently unsafe due to a race condition between creating the name and the first use that reserves it.

      Returns:
      a unique path that does not exist.
      Throws:
      IOException
    • runHook

      protected int runHook(Repository db, File hook, String... args) throws IOException, InterruptedException
      Run a hook script in the repository, returning the exit status.
      Parameters:
      db - repository the script should see in GIT_DIR environment
      hook - path of the hook script to execute, must be executable file type on this platform
      args - arguments to pass to the hook script
      Returns:
      exit status code of the invoked hook
      Throws:
      IOException - the hook could not be executed
      InterruptedException - the caller was interrupted before the hook completed
    • putPersonIdent

      private static void putPersonIdent(Map<String,String> env, String type, PersonIdent who)
    • write

      protected File write(String body) throws IOException
      Create a string to a UTF-8 temporary file and return the path.
      Parameters:
      body - complete content to write to the file. If the file should end with a trailing LF, the string should end with an LF.
      Returns:
      path of the temporary file created within the trash area.
      Throws:
      IOException - the file could not be written.
    • write

      protected void write(File f, String body) throws IOException
      Write a string as a UTF-8 file.
      Parameters:
      f - file to write the string to. Caller is responsible for making sure it is in the trash directory or will otherwise be cleaned up at the end of the test. If the parent directory does not exist, the missing parent directories are automatically created.
      body - content to write to the file.
      Throws:
      IOException - the file could not be written.
    • read

      protected String read(File f) throws IOException
      Read a file's content
      Parameters:
      f - the file
      Returns:
      the content of the file
      Throws:
      IOException
    • toEnvArray

      private static String[] toEnvArray(Map<String,String> env)
    • cloneEnv

      private static HashMap<String,String> cloneEnv()